- 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
This commit is contained in:
Jonathan Ernst
WineHQ
@@ -53,33 +53,35 @@ work in Wine, and also what are the tricks to get it working best.<p>
|
||||
<blockquote>
|
||||
<p><b>A:</b> 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.</p>
|
||||
Any application database can comment on a particular application.</p>
|
||||
<p>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.</p>
|
||||
reviewed by a maintainer or administrator.</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>Q: How can I submit HowTo's and Screenshots?</b></p>
|
||||
<p><b>Q: How can I submit Screenshots?</b></p>
|
||||
<blockquote>
|
||||
<p><b>A:</b> We love to hear from our users. Send those helpful HowTos and
|
||||
Screenshots right on over to <a href="mailto:appdb@winehq.org">appdb@winehq.org</a>.
|
||||
We'll be happy to post them, and give you proper credit for your great contribution.</p>
|
||||
<p><b>A:</b> 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.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<p><b>Q: How do I become an authorized application database maintainer.</b></p>
|
||||
<p><b>Q: How can I submit How-to's?</b></p>
|
||||
<blockquote>
|
||||
<p><b>A:</b> Pretty much anyone with an established reputation supporting Wine
|
||||
is welcome (begged?) to be an application maintainer.
|
||||
Simply send email to <a href="mailto:appdb@winehq.org">appdb@winehq.org</a>
|
||||
to apply. Once we have a community of maintainers, we hope that community
|
||||
will further refine the policies and procedures.</p>
|
||||
<p><b>A:</b>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.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<p><b>Q: How do I become an application database maintainer?</b></p>
|
||||
<blockquote>
|
||||
<p><b>A:</b> 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.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<p><b>Q: What is the difference between a super maintainer and a maintainer?</b></p>
|
||||
<blockquote>
|
||||
<p><b>A:</b> A super maintainer maintains an application and all it's versions. A maintainer maintains only one specific version of an application.</p>
|
||||
</blockquote>
|
||||
</ul>
|
||||
|
||||
If you have more questions you would like to add to our FAQ, please contact us
|
||||
at <a href="mailto:appdb@winehq.org">appdb@winehq.org</a>.
|
||||
|
||||
<p> </p>
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<!--TITLE: Additional Wine Help -->
|
||||
<!--TITLE: General help on running appliations under Wine -->
|
||||
|
||||
This is meant as generic instructions in case an AppDB entry
|
||||
for a certain program doesn't exist.
|
||||
|
||||
105
help/maintainer_guidelines.help
Normal file
105
help/maintainer_guidelines.help
Normal file
@@ -0,0 +1,105 @@
|
||||
<!--TITLE: Maintainers Guidelines -->
|
||||
|
||||
<h3>Maintainers Guidelines</h3>
|
||||
|
||||
<p>
|
||||
Getting a (super) maintainer gives you certain rights on the Application Database. However as you may know, with great power, comes great responsibility...
|
||||
</p>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
You are expected to:
|
||||
<ul>
|
||||
<li>Keep the application comments clean, all stale data should be removed</li>
|
||||
<li>Be an active user of that application and version</li>
|
||||
<li>Keep up-to-date with all Wine releases, if there are regressions they should be reported to <a href="mailto:wine-devel@winehq.org">wine-devel@winehq.org</a> and <a href="http://bugs.winehq.org">Bugzilla</a></li>
|
||||
</ul>
|
||||
|
||||
You will:
|
||||
<ul>
|
||||
<li>Receive an email anytime a comment is posted or deleted for the application or the application information is modified</li>
|
||||
<li>Be able to modify all aspects of your application(s) and version(s), including description, screenshots, how-to's, notes, comments, etc.</li>
|
||||
</ul>
|
||||
|
||||
<br />
|
||||
|
||||
<h4>Application overview page guidlines</h4>
|
||||
<p><i>N.B. Only super maintainers can change the general description of an application.</i><br />
|
||||
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.
|
||||
<ul>
|
||||
<li>
|
||||
Application name should be checked against official application name and should not contain the vendor's name.
|
||||
</li>
|
||||
<li>
|
||||
Application vendor should be set correctly. If the vendor is missing, please contact <a href="mailto:appdb@winehq.org">appdb@winehq.org</a>.
|
||||
</li>
|
||||
<li>
|
||||
Keywords are used by the search engine, you don't need to repeat the application's name but you are encouraged to provide some keywords in this field.
|
||||
</li>
|
||||
<li>
|
||||
Description should describe the application in a general manner (what it does). Wine and version specific considerations goes in version-specific pages (described below). If you want to add more than a short sentence, please add a cariage return after the first sentence as it will be used when showing application summary in the search engine, top-25 page and so on. <br />You are encouraged to make use of the template provided for application description; you can copy/paste this template from the "<a href="../appsubmit.php?apptype=1">Submit application page</a>".
|
||||
</li>
|
||||
<li>
|
||||
Webpage should contain the home page for this application. Please remember that an URL starts with http://.
|
||||
</li>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
<h4>Version page guidlines</h4>
|
||||
<p>
|
||||
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.
|
||||
<ul>
|
||||
<li>
|
||||
Version name should be checked against official version name. However if you feel that two minor revision of an application will share the same problems or success, you are encouraged to use wildcards in the version number to don't fill the database with hundreds of versions. For example if you know that Adobe Acrobat 6.0, 6.01 and 6.1 are about the same application, just choose 6.x as a version name. You can however use the full version name in an history table in the description field (see below).
|
||||
</li>
|
||||
<li>
|
||||
Description should describe the application version and not be a repetition of the application description. Please use a short sentence as the first line of your description to describe what this version is and then add a cariage return after this first sentence as it will be used when showing version summary in the application page for example. <br />You are encouraged to make use of the template provided for version description; you can copy/paste this template from the "<a href="../appsubmit.php?apptype=2">Submit version page</a>".<br />
|
||||
As you'll see in this template usefull informations to place in this field are the specification of what works and what doesn't in wine and you can also add what is called an history table to keep track of improvemetns and regression. Using the html editor described later in this document and the provided template it is easy to produce such a table which will contains columns like version number, wine version, installs, runs, rating. You can then use the styles drop down list of the editor to set the color of the row according to the rating (gold, silver, bronze or garbage). You can see an example <a href="../appview.php?versionId=2602">here</a>.
|
||||
</li>
|
||||
<li>
|
||||
Rating let's you rate how this version ran with the latest Wine version you tested it with. For rating definitions, please see this <a href="index.php?topic=maintainer_ratings">page</a>.
|
||||
</li>
|
||||
<li>
|
||||
Release is the latest release of Wine you tested this version with.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Additional URLs guidlines</h4>
|
||||
<p>
|
||||
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).
|
||||
</p>
|
||||
|
||||
<h4>Screenshots guidlines</h4>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
<h4>Notes guidlines</h4>
|
||||
<p>
|
||||
In the version page you can add, edit and delete notes for the versions you maintain. Just click on "Add note" button.
|
||||
</p>
|
||||
|
||||
|
||||
<h4>How-to guidlines</h4>
|
||||
<p>
|
||||
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).
|
||||
</p>
|
||||
|
||||
<h4>Warnings guidlines</h4>
|
||||
<p>
|
||||
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).
|
||||
</p>
|
||||
|
||||
<h4>Comments guidlines</h4>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
|
||||
<h4>Using the HTML editor</h4>
|
||||
<p>
|
||||
Here you'll find informations and hints about the HTML editor used when editing informations in the Application Database.<br />
|
||||
At this time detailed informations are not available. Please check back later.
|
||||
</p>
|
||||
<br />
|
||||
<p>If you have additionnal questions, please do not hesitate to contact us on <a href="mailto:appdb@winehq.org">appdb@winehq.org</a>.</p>
|
||||
@@ -1,6 +1,6 @@
|
||||
<!--TITLE: Maintainers Ratings Help -->
|
||||
<!--TITLE: Maintainers Ratings Definitions -->
|
||||
|
||||
<h3>Maintainers Ratings System Help</h3>
|
||||
<h3>Maintainers Ratings Definitions</h3>
|
||||
|
||||
<p>
|
||||
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".
|
||||
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
@@ -39,6 +39,3 @@ There should be at least one bug report in bugzilla if an app gets this rating.
|
||||
</p>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<p> </p>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<!--TITLE: Application DB Privacy Policy -->
|
||||
<!--TITLE: Application Database Privacy Policy -->
|
||||
|
||||
<h3>Application DB Privacy Policy</h3>
|
||||
<h3>Application Database Privacy Policy</h3>
|
||||
|
||||
<p>
|
||||
<b>WineHQ is dedicated to the privacy of its users.</b><br>
|
||||
@@ -36,9 +36,3 @@
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<b>NOTICE:</b> <a href="http://www.ftc.gov/bcp/conline/pubs/online/sitesee/index.html">Click here</a>
|
||||
for important information about safe surfing from the Federal Trade Commission.
|
||||
</p>
|
||||
|
||||
<p> </p>
|
||||
|
||||
@@ -1,95 +0,0 @@
|
||||
<!--TITLE: Ratings Help -->
|
||||
|
||||
<h3>Application Ratings System Help</h3>
|
||||
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
|
||||
<ol>
|
||||
|
||||
<li>Log into the Application Database.</li><p>
|
||||
|
||||
<li>Browse to the Application you wish to rate.</li><p>
|
||||
|
||||
<li>In the sidebar, choose whether you are rating Wine running
|
||||
in Windows mode, or Fake Windows Mode.<br>
|
||||
<ul>
|
||||
<li><img src='../images/w1.gif' alt='With Windows'> <b>With Windows</b> = Wine Configured to use a Windows partition.</li>
|
||||
<li><img src='../images/w0.gif' alt='Without Windows'> <b>Without Windows</b> = Wine using its own internal Windows (Fake Windows).</li>
|
||||
</ul>
|
||||
</li><p>
|
||||
|
||||
<li>In the sidebar, click the number of stars you want to
|
||||
rate this application.<br>
|
||||
<ul>
|
||||
<li> <b>0</b> -- Unrated.
|
||||
<li> <b>1</b> -- Totally nonfunctional. Crashes on load.
|
||||
<li> <b>2</b> -- Partial functionality. Good enough for a carefully scripted demo.
|
||||
<li> <b>3</b> -- Sufficient functionality for non critical work. Occasional crashes okay,
|
||||
as are weird setup problems, required patches, or missing major functionality.
|
||||
Alpha quality.
|
||||
<li> <b>4</b> -- Substantially correct. Good enough for general use, with possible
|
||||
caveats.
|
||||
<li> <b>5</b> -- Perfect. No flaws under any mode
|
||||
</ul>
|
||||
</li><p>
|
||||
|
||||
<li>Click the Rate! button to store your vote for this
|
||||
application.
|
||||
</li><p>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
<b> How to rate an application </b></br>
|
||||
|
||||
<i>Please</i> 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.
|
||||
|
||||
<ul>
|
||||
|
||||
<li> First, figure out the name of the app, the vendor, and the product
|
||||
version number.</li><p>
|
||||
|
||||
<li> Try to start the application under the emulator.
|
||||
If it completes loading,
|
||||
without crashing, and displaying more or less what it would under
|
||||
some version of Windows, then the app deserves a 2. Otherwise, it gets a
|
||||
1.</li><p>
|
||||
|
||||
<li> Try doing a few things with it. If you can
|
||||
find several useful operations
|
||||
which can be correctly performed with the app, such that you would be
|
||||
willing to stand in front of a large group of people, saying ``This app
|
||||
works nearly perfectly on Wine'' and doing those operations, give it a 3.
|
||||
</li><p>
|
||||
|
||||
<li> If you don't normally use the app, stop here. Higher ratings should
|
||||
only be given for app performance under actual use.</li><p>
|
||||
|
||||
<li> At some time when there is something which you need to do with the
|
||||
app, try doing it under Wine. If you can get the job done without putting
|
||||
your fist through the screen, then the application deserves a 4. Note that
|
||||
this is not, ``Someone <i>could</i> do useful work with this app'' but
|
||||
``I have used this app for useful work, not just fooling around.''</li><p>
|
||||
|
||||
<li> If you use an app under Wine for months, and its behavior is robust
|
||||
under a variety of uses, its performance is adequate, and
|
||||
these characteristics are stable as Wine changes from release to release,
|
||||
and it works for a lot of people with varying setups under various OSes,
|
||||
then it deserves a 5.</li><p>
|
||||
|
||||
<li> After a new version of Wine, test the application again. If the app
|
||||
improves or gets worse, come back and change your vote.</li><p>
|
||||
|
||||
</ul>
|
||||
|
||||
Remember: only <i>you</i> can prevent rating inflation.
|
||||
|
||||
<p> </p>
|
||||
@@ -13,10 +13,9 @@ function global_sidebar_menu() {
|
||||
$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");
|
||||
|
||||
41
support.php
41
support.php
@@ -1,41 +0,0 @@
|
||||
<?php
|
||||
/****************/
|
||||
/* support page */
|
||||
/****************/
|
||||
|
||||
/*
|
||||
* application environment
|
||||
*/
|
||||
include("path.php");
|
||||
require(BASE."include/"."incl.php");
|
||||
|
||||
apidb_header("Help and Support");
|
||||
|
||||
?>
|
||||
<p><big><b>Who Can Help Me Out?</b></big></p>
|
||||
|
||||
<p>
|
||||
If you have questions, comments on the Application Database, you can contact
|
||||
us at <a href="mailto:<?php echo APPDB_OWNER_EMAIL;?>"><?php echo APPDB_OWNER_EMAIL;?></a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
If you notice something that seems to be wrong, or busticated, there is a way you can
|
||||
help us out.<br />
|
||||
We also have a <a href="http://bugs.winehq.org/">Bug Tracking Database</a>
|
||||
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
|
||||
<a href="http://bugs.winehq.org/buglist.cgi?product=WineHQ+Apps+Database">link</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
If you need more information on this project, there are plenty of resources.
|
||||
</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="<?php echo APPDB_OWNER_URL;?>"><?php echo APPDB_OWNER;?></a></li>
|
||||
<li><a href="http://www.codeweavers.com">CodeWeavers Home Page</a></li>
|
||||
</ul>
|
||||
<?php
|
||||
apidb_footer();
|
||||
?>
|
||||
Reference in New Issue
Block a user