Edgewall Software

Changes between Version 10 and Version 11 of TracDev/Proposals/NewHelp


Ignore:
Timestamp:
Feb 20, 2021, 11:41:15 AM (8 days ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TracDev/Proposals/NewHelp

    v10 v11  
    1414Speaking of, the help menu should be sectioned - not just a list of pages, but perhaps split into sections based on general content, general admin content, ticket system, wiki system, version control and so on.
    1515
    16 With the i18n branch in incubation, the natural question is: "What about all the default pages?" How are they to be transated? How are we to switch to localised version of the pages per request depending on who accesses them? If this stays in the wiki, no-one is going to find any project-related wiki pages - 95% would be help pages...
     16With the i18n branch in incubation, the natural question is: "What about all the default pages?" How are they to be transated? How are we to switch to localised version of the pages per request depending on who accesses them? If this stays in the wiki, no-one is going to find any project-related wiki pages - 95% would be help pages.
    1717
    1818== Proposal ==
    1919
    2020The proposal is quite simple:
    21  * Make the help system its own module
     21 * Make the help system its own module.
    2222 * Have it provide an API to allow content to be provided from anywhere, and in whatever locale.
    2323 * Stop using the project wikis for help, and instead make a help page provider that renders the Help pages from resources (files) stored inside the Trac egg.
     
    163163 * Unit tests.
    164164
    165 (To be updated.)
    166 
    167165== trac.edgewall.org ==
    168166
     
    185183 * #9876: wiki:TicketComponent does not exist
    186184
    187 (To be updated - no doubt other related tickets as well as a proper search has not yet been done...)
     185This list is to be updated as no doubt other related tickets on this topic exist.
    188186
    189187Additionally, it is very much related to the various i18n tickets as it allows plugins to provide 'language packs' also for default and custom help pages.