Changes between Version 8 and Version 9 of TracDev/Proposals/NewHelp

Timestamp:

Apr 15, 2010, 10:39:03 AM (14 years ago)

Author:

mrelbe <mikael@…>

Comment:

Added some food for thought regarding core vs plugin based solution

TracDev/Proposals/NewHelp

@@ -89 +89 @@
 Trac itself will not supply any localised documentation pages - only default pages. Hopefully people will start projects at trac-hacks.org for maintaining localised language packs for major languages, perhaps also including pages for plugins other than Trac as well. 
 
+{{{#!div style="background-color:#efe;padding-left:4em"
+**mrelbe**:
+
+''"Trac itself will not supply any localised documentation pages - only default pages."'' -- Why? Since the core of Trac 0.12 is localised, I would expect help pages to be presented in the same language as I've selected in the preferences panel, without having to add separate plugins.
+
+Shouldn't help pages be handled in a fashion inspired by the way text strings are now? Today, a message.po file defines text strings for each locale. 
+
+Some thoughts (for what it's worth): Define a help-page-directory for each locale containing files of translated help pages. The physical name of each file shall be same as for the implementation language (cf. gettext strings).
+
+{{{
+trac/locale/en_US/help/index.po
+trac/locale/en_US/help/Permissions
+trac/locale/en_US/help/Tickets
+
+trac/locale/sv/help/index.po
+trac/locale/sv/help/Hjälp     # unique help file for Swedes
+trac/locale/sv/help/Tickets
+}}}
+
+index.po contains translations of localised help page names to the physical file name.
+
+Example for Swedish:
+
+ * "Permissions" --> "" (not translated)
+ * "Tickets" --> "Ärenden"
+
+When Swedish language is selected:
+
+ * `[[help:Ärenden]]` shows "sv/help/Tickets".
+
+ * `[[help:Tickets]]` shows "sv/help/Tickets".
+
+ * `[[help:Permissions]]` falls back to show "en_US/help/Permissions" since that page has not been translated.
+
+ * `[[help:Hjälp]]` shows "sv/help/Hjälp" since this is a unique Swedish help page, not present in index.po but a file exists with the referred name for selected locale. ''(If Unicode characters in filenames is a problem, then it should be possible to define an ASCII-based filename and extend index.po, or similar.)''
+}}}
+
 == Tasks and questions ==