File:  [mozdev] / calendarhelp / www / help.html
Revision 1.3: download - view: text, annotated - select for diffs - revision graph
Wed May 31 10:24:16 2006 UTC (11 years, 4 months ago) by whiteley
Branches: MAIN
CVS tags: HEAD
move text around

<!-- MAIN CONTENT -->
<h3>
<img src="calhelp-small.png" style="vertical-align:middle;" width="48" height="48">
Help documentation for Mozilla Calendar
</h3>

<p>
The Calendar Help project aims to provide help documentation
for end users of Mozilla Calendar:
<ul>
<li>In all Calendar versions (the extensions for
<a href="http://www.mozilla.org/products/thunderbird/">Thunderbird</a>,
<a href="http://www.mozilla.org/products/firefox/">Firefox</a> and
<a href="http://www.mozilla.org/products/mozilla1.x/">Mozilla Application Suite</a>,
and the standalone
<a href="http://www.mozilla.org/projects/calendar/sunbird.html">Sunbird</a>
)</li>
<li>On all operating system platforms that Calendar and Sunbrd run on</li>
<li>In English and all Calendar and Sunbird's other languages</li>
</ul>
</p>

<h4>How Calendar Help works</h4>
<p>
You normally install Calendar Help as an extension.
It is also available <a href="open.xul">online</a>, but the
online version is experimental and it has some limitations.
</p>

<p>
When you are using your Calendar application
with the Calendar Help extension, there is a new item in the
Help menu: Context Help.
This item opens a separate help window that contains the help,
with a table of contents, index, search facility and glossary.
</p>

<p>
The F1 key (or Help key) opens the help if it is not already open,
and switches to the topic that describes the element in the user interface
that has keyboard focus.
</p>

<p>
If you are working with a dialog, a Help button at the bottom of the dialog window
opens the help if it is not already open,
and switches to the topic that describes the dialog.
</p>

<p>
For a picture of the prototype, see the 
<a href="screenshots.html">screenshots</a> page.
Future versions will look a little different,
because of changes in the help viewer.
</p>

<h4>Current status</h4>
<p style="border:1px solid #900; margin-left:-4px; padding:4px;">
Calendar Help does not currently support Sunbird 0.3 alpha releases or Lightning.
This support is planned for future versions.
</p>

<p>
The current version 0.5.1 of Calendar Help documents most of the user interface
in Sunbird and Calendar extensions.
It also contains information on customizing Calendar, on servers and on troubleshooting.
</p>

<p>
A test version 0.6 of Calendar Help is available for nightly test builds of Sunbird 0.2+.
These builds are not all stable, so they are not recommended for general use.
Version 0.6 of Calendar Help does not completely document Sunbird 0.2+,
but it will gradually improve as the content is reviewed and updated.
</p>

<p><b>Note: &nbsp;</b>
There is no relationship between the version numbers of Calendar Help,
Sunbird, and the Calendar extension.
The projects are not synchronized.
</p>

<p>
To download and install Calendar Help, see the
<a href="http://calendarhelp.mozdev.org/installation.html">Installation</a> page.
</p>

<p>
You can find other information about Calendar in Mozilla Calendar's
<a href="http://www.mozilla.org/projects/calendar/faq.html">FAQ</a>,
in its <a href="news://news.mozilla.org/netscape.public.mozilla.calendar">newsgroup</a>
and in its <a href="http://wiki.mozilla.org/Calendar:Home_Page">wiki</a>.
</p>


<h4>Calendar Help online</h4>
<p>
The <a href="open.xul">online version</a> of Calendar Help is experimental.
It might be moved to a different web server, or withdrawn completely.
</p>

<p>
The online version is built from the same source text as the installable version.
At times, the online version might contain more recent revisions than
the installable version.
However the online version is currently frozen while work progresses on
version 0.6.
</p>

<p>
The online version has some limitations:
</p>

<ul class="plain-list">
<li>It only works in Mozilla browsers.</li>
<li>It contains only the help for Windows versions, so Macintosh and Unix users might find it a little less easy to use..</li>
<li>It combines the help for Sunbird and the help for Calendar extensions,
so some topics are less easy to understand.</li>
<li>It does not support the F1 key to go directly to a help topic related to a field in the user interface.</li>
</ul>


<h4>How you can help</h4>
<p>
This project needs reviewers and translators.
</p>

<p>
If you use Mozilla Calendar,
and if you have a good understanding of how it works,
then you can contribute to the project by reviewing one or more chapters.
For more information, see the
<a href="http://calendarhelp.mozdev.org/contribute.html">Join in</a> page.
</p>

<p>
If you use Mozilla Calendar in another language, and if you can translate the English
help into your language, then you can contribute to the project by translating
one or more chapters.
For more information, see the
<a href="http://calendarhelp.mozdev.org/contribute.html">Join in</a> page.
</p>

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>