Changes between Version 13 and Version 14 of DevelopersGuide/HelpSystem


Ignore:
Timestamp:
2020-02-20T16:57:52+01:00 (5 years ago)
Author:
Hb---
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • DevelopersGuide/HelpSystem

    v13 v14  
    2424  * '''translated''' - translated addressing is used inside the wiki. Links point always to the default content using the `[wikitr:/Help/Action/Download]` macro. If translated content is available, Trac rewrites the target URL to it. This addressing is recommend for the Wiki. It is possible since [/ticket/16101 March 2018].
    2525
    26 Optionally, help topics can include a fragment after a {{{#}}}. Example: {{{/ErrorMessages#BadRequest}}}. The fragment refers to a named section in the content. So the page should either include a HTML element with an id or a name equal to the fragment. Three approaches for creating these HTML elements are possible:
     26Optionally, help topics can include a fragment after a {{{#}}}. Example: {{{/ErrorMessages#BadRequest}}}. The fragment refers to a named section in the content. So the page should either include a HTML element with an id or a name equal to the fragment. Three approaches for creating these HTML anchors are possible:
    2727  1.  declare the id of a wiki heading, i.e.
    2828{{{
    … …  
    4040}}}
    4141}}}
     42Anchors are case sensitive and not translatable. They shall be in CamelCaseAfterSpace format but must obey the source code.
    4243
    4344=== Translating help content ===
    4445You're encouraged to [wikitr:/Translations translate] help content into your language.
    4546
    46 '''Do not''' translate the relative help topics, though. Their names have to be the same in all languages. The help page for {{{/Help/Action/Upload}}} in German should be {{{/De:Help/Action/Upload}}} and not {{{/Help/Aktion/Hochladen}}}. And take '''care''' of the optional fragments after a {{{#}}} and their targets.
     47'''Do not''' translate the relative help topics, though. Their names have to be the same in all languages. The help page for {{{/Help/Action/Upload}}} in German should be {{{/De:Help/Action/Upload}}} and not {{{/Help/Aktion/Hochladen}}}.
    4748
    4849=== Help content within help pages ===