This will list all headings of level 1 or 2 in outline style.
{toc:outline=true|style=none|maxLevel=2}
Filtered Table of Contents
This will list all headings that end with '.1' or '.2' as a flat list with each item separated by ' - '. See Sun's Regex documentation for details on how to use this.
{toc:type=flat|separator=" - "|filter=.*\.[1//2]}
The TOC Zone
Below is an example of the {toc-zone} macro in action. This macro will only list headings which occur in inside the macro body - that is, 'Level 1.1' through 'Level 1.2.1'. You can specify if the TOC should appear at the top, bottom or in both locations. Otherwise, it has the same options as the regular {toc} macro.
I want to use this plugin, but we are still using Confluence 2.2 (2.2.3 Build:#518 09 Jun 2006).
Is TOC 2.4 compatible with this version of Confluence?
I would have to rate that as highly unlikely, since there were some significant API changes in Confluence between 2.2 and 2.3. It is a fairly simple plugin however, so you never know.
I need also to sort the table by page. I am playing with {text-sort} macro but seems I am missing something and don't get the order I need..
The pages hierarchy I have (as per standard children panel in Confluence at the bottom of Home page) :
01 Introduction
02 Development Methodology
03 Change Management Process
03.01 The PTF Process
03.02 Submitting a PTF Form
03.03 Build Requests
04 Architectural Standards
All pages are children of Home page and sorted by Confluence in the order I need. This is not chronological order - the pages were changed at random times.. So I think Confluence sorts them by page title..
01 Introduction
02 Development Methodology
03.01 The PTF Process
03.02 Submitting a PTF Form
03.03 Build Requests
03 Change Management Process
04 Architectural Standards
The order is different because '.' comes before ' ' in the standard ASCII character set, so the '03.XX' numbers come before the '03 ' value.
The solution is to use the default mode - 'natural' sorting - which takes into account numbers, etc.
Also, even though what you have seems to actually work, conventionally I put the {report-column} macros outside the reporter. So, the final example should look something like this:
I having trouble geting the toc-zone macro to work across sections. I am not sure if it is a bug of some kind or something that I am doing wrong. What I want is a toc in the left column but that contains the headings for all defined below. My code is below. I do get the toc for the "first create item" but the rest seems to ignore the other toc-zone. Any ideas?
{toc-zone:location=top}
\h3. first create item
{toc-zone}
The problem is that you have the opening {toc-zone} inside the first column but close it outside the whole {section}. The {section}, {column} and {toc-zone} macros need to be self-contained - that is, they need any macros which open inside them to also close inside them.
I'm not sure that there is any way to get the effect you're after with {toc-zone} unfortunately.
I found a Jira issue that you submitted for the Confluence TOC macro which addresses a function that I would like to use. I posted this comment on Jira (TOC-42) and am including it here. I would be most grateful for your help.
----------------------------------
TOC-42:
Since TOC generates links only as the '#anchor', if the toc is generated with the Reporting plugin for a different page, the link will not work, since it's expecting to be rendered on the existing page.
The best solution is to add an 'absoluteUrl' parameter (off by default) which can be set to true if the TOC should render the full URL of the page. It should be off by default because it's quite common to actually include the page content on the current page - eg, using the
{include}
macro, and having the URL as part of the link by default will have the TOC jump to the original page, not the named section on the current page.
------------------------------------
I am trying to use this feature but I am confused about how to enable the absolute URL parameter. I am also confused about which toc macro/plugin to use, too, since there is the TOC macro from Confluence and the toc macro in the Table of Contents plugin (CustomWare). If you could explain which macro/plugin to use, how to ensure that the "right" one is reference (if both are installed in the repository), and how to enable the absolute URL parameter (not documented anywhere except here), I would be most grateful. An example would be terrific (e.g.
I just re-read your Jira issue and now see that I read it in a hurry and misunderstood your intent. As I understand it now, you have suggested that a new argument be added to TOC to force it to render the full URL of the page. I initially thought that you were referring to an undocumented argument.
Online documentation now added to Builder User Guide:
http://www.adaptavist.com/display/USERGUIDE/toc+macro