Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
{
Wiki Markup
Composition Setup
}
deck.tab.active.background = #6495ED
{composition-setup}
{section}
{column:width=15%}
{
Section
Column
width15%
Excerpt Include
:
Advanced
Macros
Plugin
|
nopanel
=true} {column} {column:width=60%} {deck:id=TOC|width=907px} {card:label=Overview} This macro generates a Table of Contents for the current page based on its headings. h4. Table of Contents Plugin * *toc* - Generates a table of contents based on what headings are present in the current page. * *toc-zone* - Lists all the headings within the macro's body. {card} {card:label=Documentation} {deck:id=TOCm} {card:label=toc} Generates a table of contents based on what headings are present in the current page. h3. The Code {code} {toc} {code} h3. {toggle-cloak:id=1} Result {cloak:id=1} {toc} {cloak} h3. {toggle-cloak:id=2} Parameters {cloak:id=2} ||*Name*||*Required?*||*Default*||*Description*|| |type|(x)|list|The type of TOC to output. May be 'list' or 'flat'. | |outlne|(x)|false|If true each item will be prefixed by a hierarchical number (e.g. '1.3'). | |style|(x)|none| The style of bullet-point to use for each item. Any CSS styles are valid.| |separator|(x)|brackets|The type of separator when in 'flat' mode. May be any of the following: *brackets*, *braces*. *parentheses* (parens), etc.| |indent|(x)| |When displayed as a 'list', the amount to indent each heading level. Note: This is a CSS quantity, so make sure you use the quantity type (eg. '10px' not '10'). | |minLevel|(x)|1|The minimum level to report headings for, inclusive. Eg. '2' will list 'h2.' and 'h3.' headings, but not 'h1.'.| |maxLevel|(x)|7|The maximum level to report headings for, inclusive. Eg. '2' will list 'h1.' and 'h2.' headings, but not 'h3.' or above.| |include|(x)| |If set, any headings not matching the regular expression will be ignored. | |exclude|(x)| |If set, any headings which do match the regular expression will be ignored. | |printable|(x)|true|If set to false, the TOC will not be visible when printing. | |class|(x)| |If specified, a <div> surrounding the TOC will be output with the specified 'class' attribute. Use CSS styles to customize the look of the TOC.| {cloak} {card} {card:label=toc-zone} Allows you to split a table of contents based on the headings of the current page. By default, the macro will also display links to headings both above and below the content which it contains. h3. The Code {code}
true
Advanced Macros Plugin
Column
width60%
Deck of Cards
width907px
idTOC
Card
labelOverview

This macro generates a Table of Contents for the current page based on its headings.

Table of Contents Plugin

  • toc - Generates a table of contents based on what headings are present in the current page.
  • toc-zone - Lists all the headings within the macro's body.
Card
labelDocumentation
Deck of Cards
idTOCm

Card
labeltoc

Generates a table of contents based on what headings are present in the current page.

The Code

Code Block

{toc}

Toggle Cloak
id1
Result

Cloak
id1

Toggle Cloak
id2
Parameters

Cloak
id2

Name

Required?

Default

Description

type

list

The type of TOC to output. May be 'list' or 'flat'.

outlne

false

If true each item will be prefixed by a hierarchical number (e.g. '1.3').

style

none

The style of bullet-point to use for each item. Any CSS styles are valid.

separator

brackets

The type of separator when in 'flat' mode. May be any of the following: brackets, braces. parentheses (parens), etc.

indent

 

When displayed as a 'list', the amount to indent each heading level. Note: This is a CSS quantity, so make sure you use the quantity type (eg. '10px' not '10').

minLevel

1

The minimum level to report headings for, inclusive. Eg. '2' will list 'h2.' and 'h3.' headings, but not 'h1.'.

maxLevel

7

The maximum level to report headings for, inclusive. Eg. '2' will list 'h1.' and 'h2.' headings, but not 'h3.' or above.

include

 

If set, any headings not matching the regular expression will be ignored.

exclude

 

If set, any headings which do match the regular expression will be ignored.

printable

true

If set to false, the TOC will not be visible when printing.

class

 

If specified, a <div> surrounding the TOC will be output with the specified 'class' attribute. Use CSS styles to customize the look of the TOC.

Card
labeltoc-zone

Allows you to split a table of contents based on the headings of the current page. By default, the macro will also display links to headings both above and below the content which it contains.

The Code

Code Block

{toc-zone}
h4. Heading 1
Some Content.

h4. Heading 2
More content.

h4. Heading 3
Some more content.
{toc-zone}
{code} h3. {

Toggle Cloak

:

id

=

3

} Result {cloak:id=3} {toc-zone} h4. Heading 1 Some Content. h4. Heading 2 More content. h4. Heading 3 Some more content. {toc-zone} {cloak} h3. {toggle-cloak:id=4} Parameters {cloak:id=4} ||*Name*||*Required?*||*Default*||*Description*|| |location|(x)|both|This parameter allows you to specify where the table of contents should be displayed, either top or bottom of the content contained within the macro. If you do not specify anything with this parameter then the contents will be displayed at both the top and bottom of the content| |type|(x)|list|The type of TOC to output. May be 'list' or 'flat'. | |outlne|(x)|false|If true each item will be prefixed by a hierarchical number (e.g.

Result

Cloak
id3

Heading 1

Some Content.

Heading 2

More content.

Heading 3

Some more content.

Toggle Cloak
id4
Parameters

Cloak
id4

Name

Required?

Default

Description

location

both

This parameter allows you to specify where the table of contents should be displayed, either top or bottom of the content contained within the macro. If you do not specify anything with this parameter then the contents will be displayed at both the top and bottom of the content

type

list

The type of TOC to output. May be 'list' or 'flat'.

outlne

false

If true each item will be prefixed by a hierarchical number (e.g. '1.3').

| |style|(x)|none| The style of

style

none

The style of bullet-point

to

use

for

each

item.

Any

CSS

styles

are

valid.

| |separator|(x)|brackets|The type of separator when in

separator

brackets

The type of separator when in 'flat'

mode.

May

be

any

of

the

following:

*

brackets

*

,

*

braces

*

.

*

parentheses

*

(parens),

etc.

| |indent|(x)| |When displayed as a

indent

 

When displayed as a 'list',

the

amount

to

indent

each

heading

level.

Note:

This

is

a

CSS

quantity,

so

make

sure

you

use

the

quantity

type

(eg.

'10px'

not

'10').

| |minLevel|(x)|1|The minimum level to report headings for, inclusive. Eg. '2' will list

minLevel

1

The minimum level to report headings for, inclusive. Eg. '2' will list 'h2.'

and

'h3.'

headings,

but

not

'h1.'.

| |maxLevel|(x)|7|The maximum level to report headings for, inclusive. Eg. '2' will list

maxLevel

7

The maximum level to report headings for, inclusive. Eg. '2' will list 'h1.'

and

'h2.'

headings,

but

not

'h3.'

or

above.

| |includePages|(x)| |If set to true, then the contents will also include any headings within included pages within the current page | |filter|(x)| |Allows you to use a Regular Expression to filter headings based on matching criteria. Not for the feint hearted!| |printable|(x)|true|If set to false, the TOC will not be visible when printing. | |class|(x)| |If specified, a <div> surrounding the TOC will be output with the specified 'class' attribute. Use CSS styles to customize the look of the TOC.| {cloak} {card} {deck} {card} {deck} {roundrect:bgcolor=#828282|width=909px|height=50px|corners=false,false,true,true} {roundrect} {column} {column:width=20%} {column} {section}

includePages

 

If set to true, then the contents will also include any headings within included pages within the current page

filter

 

Allows you to use a Regular Expression to filter headings based on matching criteria. Not for the feint hearted!

printable

true

If set to false, the TOC will not be visible when printing.

class

 

If specified, a <div> surrounding the TOC will be output with the specified 'class' attribute. Use CSS styles to customize the look of the TOC.

Card

Deck of Cards

Round Rectangle
cornersfalse,false,true,true
bgcolor#828282
width909px
height50px

Column
width20%