mozdev.org

CalendarHelp

resources:
developer:
project:
projects:

Help documentation for Mozilla Calendar

The Calendar Help project aims to provide help documentation for end users of Mozilla Calendar:

How Calendar Help works

You normally install Calendar Help as an extension. It is also available online, but the online version is experimental and it has some limitations.

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.

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.

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.

For a picture of the prototype, see the screenshots page. Future versions will look a little different, because of changes in the help viewer.

Current status

Calendar Help does not currently support Sunbird 0.3 alpha releases or Lightning. This support is planned for future versions.

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.

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.

Note:   There is no relationship between the version numbers of Calendar Help, Sunbird, and the Calendar extension. The projects are not synchronized.

To download and install Calendar Help, see the Installation page.

You can find other information about Calendar in Mozilla Calendar's FAQ, in its newsgroup and in its wiki.

Calendar Help online

The online version of Calendar Help is experimental. It might be moved to a different web server, or withdrawn completely.

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.

The online version has some limitations:

How you can help

This project needs reviewers and translators.

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 Join in page.

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 Join in page.

The calendarhelp project can be contacted through the mailing list or the member list.
Copyright © 2000-2017. All rights reserved. Terms of Use & Privacy Policy.