Edgewall Software
Modify

Opened 10 years ago

Closed 3 years ago

#9401 closed enhancement (fixed)

Enhance TracIni macro to be able to reference specific options

Reported by: anatoly techtonik <techtonik@…> Owned by: Jun Omae
Priority: normal Milestone: 1.2.1
Component: wiki system Version:
Severity: minor Keywords: bitesized, trac.ini
Cc: Ryan J Ollos Branch:
Release Notes:

Added an anchor to each option and highlight the corresponding entry in [[TracIni]] macro.

API Changes:

Description

TracIni has too many options to remember what do they do. That's why it would be extremely convenient to be able to reference these options from other places of documentation for quick lookup.

I propose:

  1. tweak TracIni macro so that it will generate anchors for sections and options
  2. add [[TracOption(name)]] to generate more convenient link to option that will additionally display option description (and section name) in popup

Attachments (0)

Change History (13)

comment:1 by Remy Blank, 10 years ago

Component: generalwiki system
Milestone: unscheduled

That sounds useful.

comment:2 by Remy Blank, 10 years ago

Keywords: bitesized added

comment:3 by Christian Boos, 10 years ago

Keywords: tracini added
Milestone: unschedulednext-major-0.1X
Owner: set to Christian Boos
Severity: normalminor

Note that anchors for sections are already generated, e.g. TracIni#logging-section. We could indeed extend that to individual options (<section>-<option>).

Ideally, the TracIni option should be able to get the anchor from the context URL and highlight the corresponding entry.

Patch still welcomed, but otherwise I may have a look at this myself.

comment:4 by Ryan J Ollos, 6 years ago

Keywords: trac.ini added; tracini removed

Normalizing keywords.

comment:5 by Ryan J Ollos, 5 years ago

Cc: Ryan J Ollos added

comment:6 by Ryan J Ollos, 5 years ago

Owner: Christian Boos removed

comment:7 by Jun Omae, 3 years ago

Proposed changes in jomae.git@t9401.

comment:8 by Ryan J Ollos, 3 years ago

Milestone: next-major-releases1.2.1

comment:9 by Ryan J Ollos, 3 years ago

One minor issue: I can see the anchor when hovering over an option row in the table output by TracIni, but it's very difficult to click on the anchor. Tested with FF 50 and Chrome 54 on OSX.

comment:10 by Jun Omae, 3 years ago

Thanks for the testing!

Revised proposed changes in [98c056c43/jomae.git] (jomae.git@t9401.1). In the changes, make entire of the option name anchor.

comment:11 by Ryan J Ollos, 3 years ago

Latest change work well. Thanks!

comment:12 by Jun Omae, 3 years ago

Owner: set to Jun Omae
Status: newassigned

comment:13 by Jun Omae, 3 years ago

Release Notes: modified (diff)
Resolution: fixed
Status: assignedclosed

Thanks. Committed in [15298] and merged in [15299].

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Jun Omae.
The resolution will be deleted. Next status will be 'reopened'.
to as closed The owner will be changed from Jun Omae to the specified user.

Add Comment


E-mail address and name can be saved in the Preferences .
 
Note: See TracTickets for help on using tickets.