Ticket #5857 (closed defect: fixed)
Opened 5 years ago
Last modified 4 years ago
Need mainnav and metanav documentation
| Reported by: | ecarter | Owned by: | jonas |
|---|---|---|---|
| Priority: | normal | Milestone: | 0.11 |
| Component: | general | Version: | devel |
| Severity: | normal | Keywords: | documentation |
| Cc: | nkantrowitz, ilias@… | ||
| Release Notes: | |||
| API Changes: | |||
Description
The [mainnav] and [metanav] sections are not documented. We need to create a TracNavigation page documenting them. That page should also autodetermine the available navigation items to help the user in overriding them.
Attachments
Change History
comment:1 Changed 5 years ago by nkantrowitz
- Cc nkantrowitz added
- Keywords documentation added
- Milestone set to 0.11
- Version set to devel
comment:2 Changed 5 years ago by ecarter
comment:3 follow-up: ↓ 4 Changed 4 years ago by ThurnerRupert
- Milestone changed from 0.11 to 0.11.1
its not a bug, so it seems to block 0.11 unecessarily ...
comment:4 in reply to: ↑ 3 Changed 4 years ago by nkantrowitz
- Milestone changed from 0.11.1 to 0.11
Replying to ThurnerRupert:
its not a bug, so it seems to block 0.11 unecessarily ...
When the bug is submitted by two members of the dev team, you can safely assume they put it where it shoud be.
comment:5 Changed 4 years ago by cmlenz
If this is not dev-oriented documentation, it should probably be added to TracInterfaceCustomization.
comment:6 follow-up: ↓ 7 Changed 4 years ago by ilias@…
added some text to TracNavigation
comment:7 in reply to: ↑ 6 Changed 4 years ago by nkantrowitz
Replying to ilias@lazaridis.com:
added some text to TracNavigation
Documentation was incorrect and removed.
comment:10 Changed 4 years ago by ThurnerRupert
- Resolution set to fixed
- Status changed from new to closed
added cboos text from r521 in wiki:0.11/TracInterfaceCustomization?action=diff&version=4 as suggested by cmlenz resp elias. pls reopen if not yet sufficient.
should we delete TracNavigation?
comment:11 Changed 4 years ago by ilias@…
Thank you.
Yes, it looks that TracNavigation is not needed anymore.
comment:12 Changed 4 years ago by nkantrowitz
- Cc ilias@… removed
The TracNavigation page should be expanded to include information about other navigation issues. For example, sample code for adding a new link should be available. I agree it should also be summarized in TracInterfaceCustomization but as the information has a low churn rate, having it be slightly duplicitous seems okay to me given that it should be more useful to users.
comment:13 Changed 4 years ago by ilias@…
- Cc ilias@… added
This sounds rational.
Possibly the TracNavigation document should be used for developer level customization.
Mr. Kantrowitz, I ask you friendly to leave the CC field intact. It's not upon you to decide who get's notified about a ticket change and who not.
Finding all the navigation items: trunk/trac/web/chrome.py@5898#L375
The 'View Tickets' nav item: trunk/trac/ticket/report.py@5898#L50