Changes between Version 5 and Version 6 of DevelopersGuide/HelpSystem


Ignore:
Timestamp:
2018-02-12T12:23:27+01:00 (7 years ago)
Author:
Hb---
Comment:

Language Codes linked, Chinese example, simple HTML id creation with [=#idhere text here)

Legend:

Unmodified
Added
Removed
Modified

  • DevelopersGuide/HelpSystem

    v5 v6  
    88The content is structured into language specific content trees.
    99 * there is a '''default content tree''' under [wiki:/Help /Help]. Content in this tree is maintained in english.
    10  * for each supported language there is a '''language specific tree''' unter {{{/Xy:Help}}} where {{{Xy}}} is the ISO language code in title case. Examples:
     10 * for each supported language there is a '''language specific tree''' unter {{{/Xyz:Help}}} where {{{Xyz}}} is the [wiki:/Translations/Wiki#Languagecodes ISO language code] in title case. Examples:
    1111   * [wiki:/De:Help /De:Help] - help in German
    12    * [wiki:/Fr:Help /Fr:Help] - help in French
     12   * [wiki:/Zh_CN:Help /Zh_CN:Help] - help in Chinese for a specific country
    1313
    1414=== Help topics ===
    … …  
    2222    * {{{/Dialog/LayerList}}} - help topic for the help content about the layer dialog
    2323
    24 Optionally, 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:
     24Optionally, 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 three approaches for creating these HTML elements:
    2525  1.  declare the id of a wiki heading, i.e.
    2626{{{
    2727== Error message for bad request == #BadRequest
    2828}}}
    29   2.  include an HTML anchor, i.e.
     29  2.  create a <span> with an id, i.e.
     30{{{
     31[=#BadRequest In case of a bad request file…]
     32}}}
     33  3.  include an HTML anchor, i.e.
    3034{{{
    3135{{{