Opened 14 years ago
Closed 8 years ago
#9401 closed enhancement (fixed)
Enhance TracIni macro to be able to reference specific options
| Reported by: | 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 |
||
| API Changes: | |||
| Internal 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:
- tweak TracIni macro so that it will generate anchors for sections and options
- 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 , 14 years ago
| Component: | general → wiki system |
|---|---|
| Milestone: | → unscheduled |
comment:2 by , 14 years ago
| Keywords: | bitesized added |
|---|
comment:3 by , 14 years ago
| Keywords: | tracini added |
|---|---|
| Milestone: | unscheduled → next-major-0.1X |
| Owner: | set to |
| Severity: | normal → minor |
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:5 by , 10 years ago
| Cc: | added |
|---|
comment:6 by , 10 years ago
| Owner: | removed |
|---|
comment:8 by , 8 years ago
| Milestone: | next-major-releases → 1.2.1 |
|---|
comment:9 by , 8 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 , 8 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:12 by , 8 years ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
comment:13 by , 8 years ago
| Release Notes: | modified (diff) |
|---|---|
| Resolution: | → fixed |
| Status: | assigned → closed |
That sounds useful.