Modify

Opened 5 years ago

Last modified 5 years ago

#4884 new enhancement

Documentation inadequate

Reported by: anonymous Owned by: coderanger
Priority: normal Component: TocMacro
Severity: normal Keywords:
Cc: Trac Release: 0.11

Description

"'sectionindex' allows to generate a title index for all pages in a given section of the wiki. A section is defined by wiki page name, using '/' as a section level delimiter (like directories in a file system). Giving '/' or '*' as the page name produces the same result as 'titleindex' (title of all pages). If a page name ends with a '/', only children of this page will be processed. Else the page given in the argument is also included, if it exists. For 'sectionindex' argument, an empty pagelist will evaluate to all page below the same parent as the current page:"

No clue here as to what the syntax is - reasonable guesses made so far do not work.

Is there an inconsistent use of [parametername] replaced versus [parametername]=blah?

Need to document sectionindex and titleindex clearly with examples.

Attachments (0)

Change History (1)

comment:1 Changed 5 years ago by anonymous

  • Type changed from defect to enhancement

I am confused by this as well.

It appears to me though that it doesn't take a specific value for itself, rather it uses a list of pages that you give it. If nothing is found, it will list all pages.

The confusing issue 'I think', is that 2 other arguments (heading and depth) require a value. However, in the instance of 'titleindex' and 'sectionindex', they use the values given as described here:

"To generate a table of contents for a set of pages, simply pass them as comma separated arguments to the TOC macro. This is the macro call for the table of contents visible on the right side of this page:"

If this is the case, I think a better approach would be that a new arguement called 'pagelist' be created. In here a pipe-separated list (or whatever syntax would work) would be added. For example:

[[TOC(heading=Contents, pagelist=TracInstall|TracAdmin|TracIni, depth=2)]]

Add Comment

Modify Ticket

Action
as new .
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.