Edgewall Software

Changes between Version 3 and Version 4 of TracDev/Proposals/NewHelp


Ignore:
Timestamp:
Apr 17, 2008, 2:05:35 AM (16 years ago)
Author:
Christian Boos
Comment:

Being able to search in the help is quite important

Legend:

Unmodified
Added
Removed
Modified
  • TracDev/Proposals/NewHelp

    v3 v4  
    8585}}}
    8686
    87 A Norwegain 'language pack' will similarly just need to include the `TracTickets` help page id in its list of translated pages, mapped inside the `help_pages` using `no_NB` locale specification.
     87A Norwegian 'language pack' will similarly just need to include the `TracTickets` help page id in its list of translated pages, mapped inside the `help_pages` using `no_NB` locale specification.
    8888
    8989Trac 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.
     
    103103Questions / Open Issues:
    104104
    105  * i18n: Provide 3 stage resolving? First see if page exists for specific locale (`no_NB`). If not, see if any plugins reponds to `no` only - catching both `no_NB` and `no_NY`. Lastly, check the default (`''`)?
     105 * i18n: Provide 3 stage resolving? First see if page exists for specific locale (`no_NB`). If not, see if any plugins responds to `no` only - catching both `no_NB` and `no_NY`. Lastly, check the default (`''`)?
    106106 * Search: This is not implemented, and full text search could be problematic as that would mean reading the files (or indexing them), but other providers may also fetch from locations outside Trac. Perhaps some smart plugin decides to use the Google APIs to translate help pages on-the-fly, and that would be very costly localised searches. If we are to do something about search, we could just search the page titles and ids.
     107   ''Well, perhaps I'm overestimating it, but I'd rate the ability to search in the ''Trac Help'' as quite high. At least the content of the bundled pages could be also stored in a table and the search can be performed there. --cboos ''
    107108 * Timeline: Help events do not show up in the timeline anymore, and no real need for them to do so either.
    108109 * Distributed or not? Like for templates, my vote (osimons) goes to using same strategy as for templates, so that major modules provide their own help pages, while maintaining the minor and general help pages as part of the help module. That way, if some installation does `trac.versioncontrol.* = disabled`, all the help pages will also disappear.
    109  * When/if pages gets translated, there will be some link problems as we use a couple of links directly to anchors on the page. If so we need to use explicit anchors that do not change, and this must be supported by language plugins as well. How do we handle links to anchors?
     110  [[br]] +1 from cboos
     111 * When/if pages gets translated, there will be some link problems as we use a couple of links directly to anchors on the page. If so we need to use explicit anchors that do not change, and this must be supported by language plugins as well. How do we handle links to anchors? [[br]]
     112  '' By using explicitly the ids from the canonical document, like this:''
     113  {{{
     114== Tâches et questions == #Tasksandquestions
     115  }}}
    110116
    111117To be done:
     
    114120 * Update all links in the various documentation pages to point to `[help:]` instead of wiki.
    115121 * Likely use the opportunity to convert them to rst format and improve them where we can - leaving the essence for the docs, and the wiki to be contributed specifics.
     122   ''Well, no. Let's dissociate the question of the format in which the documentation should be written, for now, and simply do with what we have at this point. -- cboos''
    116123 * i18n adjustments to pick up the locale when these gets merged.
    117124 * Remove the `[[TracGuideToc]]` macro - still useful during development as a direct comparison between menus, but it should not really be needed anymore.