Edgewall Software

Ticket #5857 (closed defect: fixed)

Opened 16 months ago

Last modified 14 months 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@…

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

  Changed 16 months ago by nkantrowitz

  • cc nkantrowitz added
  • keywords documentation added
  • version set to devel
  • milestone set to 0.11

  Changed 16 months ago by ecarter

Finding all the navigation items: trunk/trac/web/chrome.py@5898#L375

The 'View Tickets' nav item: /trunk/trac/ticket/report.py@5898#L50

follow-up: ↓ 4   Changed 15 months ago by ThurnerRupert

  • milestone changed from 0.11 to 0.11.1

its not a bug, so it seems to block 0.11 unecessarily ...

in reply to: ↑ 3   Changed 15 months 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.

  Changed 15 months ago by cmlenz

If this is not dev-oriented documentation, it should probably be added to TracInterfaceCustomization.

follow-up: ↓ 7   Changed 14 months ago by ilias@…

added some text to TracNavigation

in reply to: ↑ 6   Changed 14 months ago by nkantrowitz

Replying to ilias@lazaridis.com:

added some text to TracNavigation

Documentation was incorrect and removed.

  Changed 14 months ago by ThurnerRupert

  • status changed from new to closed
  • resolution set to fixed

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?

  Changed 14 months ago by ilias@…

Thank you.

Yes, it looks that TracNavigation is not needed anymore.

  Changed 14 months 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.

  Changed 14 months 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.

Add/Change #5857 (Need mainnav and metanav documentation)

Author



Change Properties
<Author field>
Action
as closed
Next status will be 'reopened'
to The owner will change from jonas. Next status will be 'closed'
 
Note: See TracTickets for help on using tickets.