StarfinderWiki
Log in

Template:Contents/doc

From StarfinderWiki

{{Contents}} produces a list of contents for a publication by following the same template markup as {{Cite complex}}. This allows chroniclers to copy and paste a complex citation template directly onto a publication page and get a formatted list of contents.

Template

Basic

{{Contents
| article1 = 
| author1  = 
| page1    = 
| description1 = 

...
}}

Advanced

{{Contents
| listtype = 

| indent1  = 
| prefix1  = 
| article1 = 
| author1  = 
| page1    = 
| suffix1  = 
| description1 = 

...
}}

Usage

Basic parameters

These four basic parameters can be repeated any number of times.

articlen (required)
The title of the article or section.
authorn (optional)
The article's author, if known, as wikitext. Link author names if relevant.
pagen (required)
The number of the article or section's first page.
descriptionn (optional)
A description of the article or section. To indent the description text as most contents sections already do, start the description on the next line after the parameter with a colon (:); see the example below.
If descriptionn is omitted, the template inserts {{Sectstub}}. To prevent the template from adding {{Sectstub}}, set descriptionn for that section to none.

Advanced parameters (optional)

Use these optional advanced parameters to further tailor the list's format.

listtype
The type of list to create: unordered (bulleted) or default (no bullets or numbers). If omitted, the default unbulleted listtype is used.
To number an ordered list, use prefixn for each item and add the number manually.
prefixn and suffixn
Adds any text to the start or end, respectively, of the list item for that article or section.
indentn
If this parameter contains anything, indent the list item. This overrides the bullet or number for that item if set by listtype, and instead indents the line as if it began with a colon (:). Use this to indent subsections of an article or section.

Examples

Basic example

{{Contents
| article1 = Foreword: Robots, Lasers, and Spaceships, Oh My!
| author1  = [[James Jacobs]]
| page1    = 4
| description1 = none<!-- disable {{Sectstub}} -->

| article2 = Fires of Creation
| author2  = [[Neil Spicer]]
| page2    = 6
| description2 = none<!-- disable {{Sectstub}} -->

| article3 = NPC Gallery
| author3  = [[Neil Spicer]]
| page3    = 54
| description3 = 
:* [[Khonnir Baine]]
:* [[Meyanda]]
:* [[Sanvil Trett]]
}}

Foreword: Robots, Lasers, and Spaceships, Oh My! by James Jacobs (4)

Fires of Creation by Neil Spicer (6)

NPC Gallery by Neil Spicer (54)


Advanced example

{{Contents
| prefix1  = '''1.'''
| article1 = Foreword: Robots, Lasers, and Spaceships, Oh My!
| author1  = [[James Jacobs]]
| page1    = 4
| description1 =
: [[Paizo Inc.]] Creative Director James Jacobs discusses the role of [[technology]] in the Iron Gods adventure path and offers suggestions for dealing with players who insist on pushing all the buttons they find.

| prefix2  = '''2.'''
| article2 = Fires of Creation
| author2  = [[Neil Spicer]]
| page2    = 6
| description2 = 
: After the strange flame that gives the town of Torch its name is inexplicably extinguished, the PCs must descend into the otherworldly ruins beneath the town and reveal the truths within.

| indent3  = yes
| article3 = NPC Gallery
| author3  = [[Neil Spicer]]
| page3    = 54
| description3 = 
::* [[Khonnir Baine]]
::* [[Meyanda]]
::* [[Sanvil Trett]]
}}

results in:

1. Foreword: Robots, Lasers, and Spaceships, Oh My! by James Jacobs (4)

Paizo Inc. Creative Director James Jacobs discusses the role of technology in the Iron Gods adventure path and offers suggestions for dealing with players who insist on pushing all the buttons they find.

2. Fires of Creation by Neil Spicer (6)

After the strange flame that gives the town of Torch its name is inexplicably extinguished, the PCs must descend into the otherworldly ruins beneath the town and reveal the truths within.

NPC Gallery by Neil Spicer (54)