From 6922c0cea2bd3abfc0fb860ad7014e17fe54491e Mon Sep 17 00:00:00 2001 From: Jonathan Ernst Date: Wed, 9 Feb 2005 23:59:09 +0000 Subject: [PATCH] - improve the sidebar links to the help system (only one link instead of two) - remove the help about user rating as it doesn't exist anymore - improve exisiting help documentation and FAQs (remove out of date informations, dead link, etc.) - add new help page for maintainers with details on how to maintain an application --- help/appdb_faq.help | 34 ++++++----- help/generic.help | 2 +- help/maintainer_guidelines.help | 105 ++++++++++++++++++++++++++++++++ help/maintainer_ratings.help | 9 +-- help/privacy.help | 10 +-- help/ratings.help | 95 ----------------------------- include/sidebar.php | 9 ++- support.php | 41 ------------- 8 files changed, 133 insertions(+), 172 deletions(-) create mode 100644 help/maintainer_guidelines.help delete mode 100644 help/ratings.help delete mode 100644 support.php diff --git a/help/appdb_faq.help b/help/appdb_faq.help index 72cfeb8..5cc8d72 100644 --- a/help/appdb_faq.help +++ b/help/appdb_faq.help @@ -53,33 +53,35 @@ work in Wine, and also what are the tricks to get it working best.

A: In order to ensure consistency, only authorized application database maintainers are permitted to add new applications to the database. -Anyone can comment on, or rate a particular application.

+Any application database can comment on a particular application.

Anyone can request that an application be added to the database, but the application is not actually added until after it has been -reviewed and categorized by a maintainer.

+reviewed by a maintainer or administrator.

-

Q: How can I submit HowTo's and Screenshots?

+

Q: How can I submit Screenshots?

-

A: We love to hear from our users. Send those helpful HowTos and -Screenshots right on over to appdb@winehq.org. -We'll be happy to post them, and give you proper credit for your great contribution.

+

A: We love to hear from our users. Send those helpful screenshots by clicking on any screenshot image you will see in the specific version page of the application you want to add a screenshot for. If you are not a maintainer, your screenshot will be reviewed and will then be added to the database.

- -

Q: How do I become an authorized application database maintainer.

+

Q: How can I submit How-to's?

-

A: Pretty much anyone with an established reputation supporting Wine -is welcome (begged?) to be an application maintainer. -Simply send email to appdb@winehq.org -to apply. Once we have a community of maintainers, we hope that community -will further refine the policies and procedures.

+

A:If you are not a maintainer, you can't create new official How-to's. So the best way to proceed is to post your How-to as a comment in the specific version page of the application of interest. A maintainer might then choose to add your How-to as an official How-to for this database entry.

+ +

Q: How do I become an application database maintainer?

+
+

A: Pretty much anyone supporting Wine is welcome (begged?) to be an application maintainer. +Simply click on the button you will find in the application overview or specific version page to send your request. An administrator will then review your proposal and add you the the maintainer's team for this application or version. Once we have a community of maintainers, we hope that community will further refine the policies and procedures.

+
+ + +

Q: What is the difference between a super maintainer and a maintainer?

+
+

A: A super maintainer maintains an application and all it's versions. A maintainer maintains only one specific version of an application.

+
If you have more questions you would like to add to our FAQ, please contact us at appdb@winehq.org. - -

 

- diff --git a/help/generic.help b/help/generic.help index 574c49e..763ec45 100644 --- a/help/generic.help +++ b/help/generic.help @@ -1,4 +1,4 @@ - + This is meant as generic instructions in case an AppDB entry for a certain program doesn't exist. diff --git a/help/maintainer_guidelines.help b/help/maintainer_guidelines.help new file mode 100644 index 0000000..99c1327 --- /dev/null +++ b/help/maintainer_guidelines.help @@ -0,0 +1,105 @@ + + +

Maintainers Guidelines

+ +

+Getting a (super) maintainer gives you certain rights on the Application Database. However as you may know, with great power, comes great responsibility... +

+ +

An application maintainer is someone who runs the application regularly and who is willing to be active in reporting regressions with newer versions of Wine and to help other users run this application under Wine.

+ +You are expected to: + + +You will: + + +
+ +

Application overview page guidlines

+

N.B. Only super maintainers can change the general description of an application.
+You can edit an application overview page by clicking on the "Edit Application" button in an application overview page. You'll be then presented with a form whose fields are explained thereafter. +

+

+ +

Version page guidlines

+

+You can edit a version page by clicking on the "Edit Version" button in any version page for which you are a (super) maintainer. You'll be then presented with a form whose fields are explained thereafter. +

+ +

Additional URLs guidlines

+

+In both application and version editing page you can add additional URLs. These URLs can for example help the user find native alternatives for this application (in application overview page) or find specific dll (in version page). +

+ +

Screenshots guidlines

+

+As a maintainer you are encouraged to provide screenshots for the versions you tested under Wine. To ass a screenshot, simply click on the screenshot thumbnail you'll find in the version page you want to provide a screenshot for. +

+ +

Notes guidlines

+

+In the version page you can add, edit and delete notes for the versions you maintain. Just click on "Add note" button. +

+ + +

How-to guidlines

+

+How-to's are just a special kind of notes. You can provide step-by-step explanations on how to install or run a specific version of the current application here. Please try to keep How-to's up to date (for example some steps might not be needed anymore using a more recent version of Wine). +

+ +

Warnings guidlines

+

+Warnings are just a special kind of note. Warnings appear in red and should catch the attention of the reader. If you are warning users agains potential data corruption for example, please keep the warning up-to-date if it is not true anymore using a recent Wine version (in this case you might choose to keep the warning and tell users that since Wine X.Y, this has been fixed). +

+ +

Comments guidlines

+

+As a maintainer you are entitled to delete comments. Use this feature wisely and always explain why you deleted a comment. If a comment is useless or is not true anymore, you can safely delete it. Whenever you can, extract how-to's, other people's tests (for you test history table for example) from the comments and put it in your version's page and how-to notes. +

+ + +

Using the HTML editor

+

+Here you'll find informations and hints about the HTML editor used when editing informations in the Application Database.
+At this time detailed informations are not available. Please check back later. +

+
+

If you have additionnal questions, please do not hesitate to contact us on appdb@winehq.org.

diff --git a/help/maintainer_ratings.help b/help/maintainer_ratings.help index 0a96a31..7ad7160 100644 --- a/help/maintainer_ratings.help +++ b/help/maintainer_ratings.help @@ -1,6 +1,6 @@ - + -

Maintainers Ratings System Help

+

Maintainers Ratings Definitions

The Application Database features a Maintainers rating system that allows you to see @@ -20,7 +20,7 @@ An application can be rated as Gold if it installs and runs "out of the box".

If an application needs DLL overrides (native DLL's from a Windows installation) to install and -run but runs flawlessly otherwise, then it can be rated as silver. There should be an accompanying "HowTo" +run but runs flawlessly otherwise, then it can be rated as silver. There should be an accompanying "How-To" written to allow users to get this application to run.

@@ -39,6 +39,3 @@ There should be at least one bug report in bugzilla if an app gets this rating.

- - -

 

diff --git a/help/privacy.help b/help/privacy.help index 9eba10b..a30f97e 100644 --- a/help/privacy.help +++ b/help/privacy.help @@ -1,6 +1,6 @@ - + -

Application DB Privacy Policy

+

Application Database Privacy Policy

WineHQ is dedicated to the privacy of its users.
@@ -36,9 +36,3 @@

-

-NOTICE: Click here -for important information about safe surfing from the Federal Trade Commission. -

- -

 

diff --git a/help/ratings.help b/help/ratings.help deleted file mode 100644 index 2b5c037..0000000 --- a/help/ratings.help +++ /dev/null @@ -1,95 +0,0 @@ - - -

Application Ratings System Help

- -

-The Application Database features a rating system that allows us and you to see -which applications work the best in Wine. This voting system is designed to be -pessimistic. -

- -
    - -
  1. Log into the Application Database.

    2. - -

  2. Browse to the Application you wish to rate.

    3. - -

  3. In the sidebar, choose whether you are rating Wine running - in Windows mode, or Fake Windows Mode.
    -
      -
    • With Windows With Windows = Wine Configured to use a Windows partition.
      • -
    • Without Windows Without Windows = Wine using its own internal Windows (Fake Windows).
      • -
    -

    4. - -

  4. In the sidebar, click the number of stars you want to - rate this application.
    -
      -
    • 0 -- Unrated. -
    • 1 -- Totally nonfunctional. Crashes on load. -
    • 2 -- Partial functionality. Good enough for a carefully scripted demo. -
    • 3 -- Sufficient functionality for non critical work. Occasional crashes okay, - as are weird setup problems, required patches, or missing major functionality. - Alpha quality. -
    • 4 -- Substantially correct. Good enough for general use, with possible - caveats. -
    • 5 -- Perfect. No flaws under any mode -
    -

    5. - -

  5. Click the Rate! button to store your vote for this - application. -

    6. - -

- - - How to rate an application
- -Please don't exaggerate how well things work. -It only creates expectations which -can't be met, and doesn't do anybody -any good in the long run. -Here is a simple flowchart for testing applications. - - - -Remember: only you can prevent rating inflation. - -

 

diff --git a/include/sidebar.php b/include/sidebar.php index 83e7b8f..ff08f7e 100644 --- a/include/sidebar.php +++ b/include/sidebar.php @@ -9,14 +9,13 @@ function global_sidebar_menu() { $g->add("Back to ".APPDB_OWNER, APPDB_OWNER_URL); $g->done(); - $g = new htmlmenu("App DB"); + $g = new htmlmenu("AppDB"); $g->add("AppDB Home", BASE); $g->add("Browse Apps", BASE."appbrowse.php"); $g->add("Top 25", BASE."votestats.php"); - $g->add("Submit App", BASE."appsubmit.php?apptype=1"); - $g->add("Documentation", BASE."help/"); - $g->add("Help & Support", BASE."support.php"); - $g->add("Appdb Stats", BASE."appdbStats.php"); + $g->add("Submit Application", BASE."appsubmit.php?apptype=1"); + $g->add("Help & Documentation", BASE."help/"); + $g->add("AppDB Stats", BASE."appdbStats.php"); $g->done(); $g = new htmlmenu("Search"); diff --git a/support.php b/support.php deleted file mode 100644 index d96b1ed..0000000 --- a/support.php +++ /dev/null @@ -1,41 +0,0 @@ - -

Who Can Help Me Out?

- -

-If you have questions, comments on the Application Database, you can contact -us at . -

- -

-If you notice something that seems to be wrong, or busticated, there is a way you can -help us out.
-We also have a Bug Tracking Database -where you can register bugs. This is the best way to get problems fixed. You can go directly -to the App DB Bug Database by following this -link. -

- -

-If you need more information on this project, there are plenty of resources. -

- - -