Changes between Version 4 and Version 5 of DevelopersGuide/HelpSystem


Ignore:
Timestamp:
2011-01-02T14:14:16+01:00 (15 years ago)
Author:
stoecker
Comment:

Fix link.

Legend:

Unmodified
Added
Removed
Modified

  • DevelopersGuide/HelpSystem

    v4 v5  
    99 * there is a '''default content tree''' under [wiki:/Help /Help]. Content in this tree is maintained in english.
    1010 * for each supported language there is a '''language specific tree''' unter {{{/Xy:Help}}} where {{{Xy}}} is the ISO language code in title case. Examples:
    11    * [wiki:/De:Help /De:Help] - help in german
    12    * [wiki:/Fr:Help /Fr:Help] - help in french
     11   * [wiki:/De:Help /De:Help] - help in German
     12   * [wiki:/Fr:Help /Fr:Help] - help in French
    1313
    1414=== Help topics ===
    1515Help topics are "addresses" of individual help pages in the JOSM help content. There are two kinds of help topics:
    1616  * '''absolute help topics''' - absolute help topics consist of a pointer to help content '''including''' the language specific root. Examples:
    17     * [wiki:/Help/Action/Download /Help/Action/Download] - help topic for the help content about the download action, in english
    18     * [wiki:/Fr:Help/Dialog/LayerDialog /Fr:Help/Dialog/LayerDialog] - help topic for the help content about the layer dialog, in french
     17    * [wiki:/Help/Action/Download /Help/Action/Download] - help topic for the help content about the download action, in English
     18    * [wiki:/Fr:Help/Dialog/LayerList /Fr:Help/Dialog/LayerList] - help topic for the help content about the layer dialog, in French
    1919
    2020  * '''relative help topics''' - relative help topics consist of a pointer to help content '''not including''' the language specific root. They are language independent references to help content. Examples:
    2121    * {{{/Action/Download}}} - help topic for the help content about the download action
    22     * {{{/Dialog/LayerDialog}}} - help topic for the help content about the layer dialog
     22    * {{{/Dialog/LayerList}}} - help topic for the help content about the layer dialog
    2323
    2424Optionally, help topics can include a fragment after a {{{#}}}. Example: {{{/ErrorMessages#BadRequest}}}. The fragment refers to a named section in the help content and the help content should either include a HTML element with an id or a name whose value is equal to the fragment. There are two approaches for creating these HTML elements:
    … …  
    3838You're encouraged to translate help content into your language. You may start with [wiki:/DevelopersGuide/HelpSystem/HelpTopicsList this list of expected help pages] and either translate already existing pages or fill in new pages with content in other languages.
    3939
    40 '''Do not''' translate the relative help topics, though. The names of relative help topics, including the optional fragments after a {{{#}}} have to be the same in all languages. The german help page for {{{/Help/Action/Upload}}} should be {{{/De:Help/Action/Upload}}}, not {{{/Help/Aktion/Hochladen}}} or even {{{/Hilfe/Aktion/Hochladen}}}.
     40'''Do not''' translate the relative help topics, though. The names of relative help topics, including the optional fragments after a {{{#}}} have to be the same in all languages. The German help page for {{{/Help/Action/Upload}}} should be {{{/De:Help/Action/Upload}}}, not {{{/Help/Aktion/Hochladen}}} or even {{{/Hilfe/Aktion/Hochladen}}}.
    4141
    4242=== Help content within help pages ===