[PATCH] Allow custom index page

[alexandrul.ct@…]

Currently the index page is hard-coded to 'TitleIndex'. The attached patch allows the customization of the page used as the index.

[alexandrul.ct@…]

wiki: allow custom index page

[framay <franz.mayer@…>]

See also #10543 and ​NavigationDisplayPlugin, which provides a user preference for the mainnav entry "Wiki". Maybe the plugin or approach is also useful for you?

[alexandrul.ct@…]

It is interesting, but not enough. Start page and Index are hard-coded inside web_ui.py and I need them to be customizable.

As a side-note, I want the wiki to be as clean as possible, so I moved the administrative pages under the Wiki namespace, with /Wiki set as start page and /Wiki/TitleIndex and /Wiki/RecentChanges used for index. As a bonus, from TitleIndex I can choose the Up link and arrive at the start page.

Of course, all the initial content of the wiki would be made available to the end-users in a separate environment, which will be recreated after every Trac update.

[alexandrul.ct@…]

wiki: allow custom start page

[alexandrul.ct@…]

wiki: allow custom help page

[alexandrul.ct@…]

I have attached the last patch that allows a custom help page, so at this moment web_ui.py contains no hardcoded page names.

For the future I would split the Help/Guide link in two: the Help page could have only info about the current environment, and the Guide could link to another clean/read-only Trac environment (or even ​http://trac.edgewall.org) where the users can learn about Trac.

[Eduard <alexandrul.ct@…>]

All 3 patches (applied on 0.12-stable) can be pulled from here: ​https://bitbucket.org/alexandrul/trac

[Eduard <alexandrul.ct@…>]

wiki: optional guide link, uses intertrac syntax

[Eduard <alexandrul.ct@…>]

The Help/Guide link would be splitted into Help and Trac Guide if the option guide_href is non-empty.

I'm not quite sure about the intertrac way, I could use a guide_page option as for the rest of the patches, and if the link needs to point to an external url, just redefine it in [metanav] section. Your feedback is welcome.

[Christian Boos]

Not for 0.12-stable, but worth a 2nd look after 1.0.

[Peter Suter]

May be considered a duplicate of #4422.

[Ryan J Ollos]

Replying to Eduard <alexandrul.ct@…>:

The Help/Guide link would be splitted into Help and Trac Guide if the option guide_href is non-empty.

The enhancements in this ticket look useful to varying degrees, but we have to be concerned about option bloat (as noted in #4422). I don't see the reason for separating Help and Trac Guide. Could you explain that one a bit more? Isn't the Trac Guide just the index for the help pages? I could even see renaming Help/Guide to Help.

I'm not quite sure about the intertrac way, I could use a guide_page option as for the rest of the patches, and if the link needs to point to an external url, just redefine it in [metanav] section. Your feedback is welcome.

Having the option to link to external help documentation seems useful. The linked documentation could be on t.e.o, or for a single Trac project in a multiple project / multiple environment setup, so that all users are seeing and editing the same wiki documentation (as you noted in comment:3).

Users would probably like the option to use an external URL, as well as relative URLs, wiki page names and perhaps InterTrac link syntax.

[Ryan J Ollos]

Replying to rjollos:

Having the option to link to external help documentation seems useful. The linked documentation could be on t.e.o, or for a single Trac project in a multiple project / multiple environment setup, so that all users are seeing and editing the same wiki documentation.

I should have realized, this is already possible. The Help/Guide link can be customized through the [metanav] section of trac.ini. See TracNavigation for more details.

[metanav]
help.href = //trac.edgewall.org/wiki/TracGuide

You can even change the label:

[metanav]
help.label = Help

#11317 proposes to allow the addition of new items, obsoleting the ​th:NavAddPlugin. Once that is implemented you'd be able to add a second link to support splitting Help/Guide into two links.

[Ryan J Ollos]

Expanding on comment:13, a more generic approach of handling the scenarios you describe would allow customizing the contextual navigation items through a [contextnav] section (TracNavigation#ctxtnav-bar), complementing the [mainnav] and [metanav] sections. This looks like it could be more challenging to implement than the customization of the [metanav] and [mainnav] sections.

[Eduard <alexandrul.ct@…>]

Replying to rjollos:

Replying to Eduard <alexandrul.ct@…>:

The Help/Guide link would be splitted into Help and Trac Guide if the option guide_href is non-empty.

The enhancements in this ticket look useful to varying degrees, but we have to be concerned about option bloat (as noted in #4422). I don't see the reason for separating Help and Trac Guide. Could you explain that one a bit more? Isn't the Trac Guide just the index for the help pages? I could even see renaming Help/Guide to Help.

Trac Guide would be a link to a separate project, intended as a Trac reference.

Help would be specific to each project: more details about the project (to help new joiners), contact persons, links to dedicated pages like guidelines for raising issues, and so on.

[Ryan J Ollos]

Retargetting tickets to narrow focus for milestone:1.2. Please move the ticket back to milestone:next-dev-1.1.x if you intend to resolve it by milestone:1.2.

[Peter Suter]

attachment:start_page.patch​ is related to #9487 / #5319.

[Ryan J Ollos]

Replying to Ryan J Ollos:

#11317 proposes to allow the addition of new items, obsoleting the ​th:NavAddPlugin. Once that is implemented you'd be able to add a second link to support splitting Help/Guide into two links.

This has been implemented, so the request for splitting Help/Guide is possible in Trac 1.3.2 and later.

Closing as duplicate of #9487.