Changes between Version 2 and Version 3 of DevelopersGuide/HelpSystem

Timestamp:

2009-11-08T17:17:23+01:00 (16 years ago)

Author:

Gubaer

Comment:

updated

DevelopersGuide/HelpSystem

@@ -22 +22 @@
     * {{{/Dialog/LayerDialog}}} - help topic for the help content about the layer dialog
 
-
+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:
+  1.  declare the id of a wiki heading, i.e. 
+{{{
+== Error message for bad request == #BadRequest
+}}} 
+  2.  include an HTML anchor, i.e.
+{{{
+{{{
+#!html
+<a name="BadRequest"/>
+}}}
+}}}
+
+=== Translating help content ===
+You'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. 
+
+'''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}}}.
+
+=== Help content within help pages ===
+You will notice that JOSMs help browser doesn't display the complete help page available on the wiki. JOSM extracts the core help content from wiki pages and slightly transforms it such that its internal browser can render it. 
 
 == Enabling context-sensitive help ==