A scaffold for documenting a Confluence plugin. It is (pretty much) the scaffold I use for my plugins as listed on Confluence Bits. This also uses the Composition Plugin
{composition-setup}
{scaffold:Plugin}
{section}
{column:width=200px}
{anchor:Details}\\
{panel:title=Details|borderStyle=solid|borderColor=#206808|titleBGColor=#569b35|bgColor=#8acf67}
*Plugin Name:*
{content-info:value=title}Page Title{content-info}
*Confluence Versions:*
{text-data:Confluence Versions|width=150px}{text-data}
*Author(s):*
{text-data:Authors|width=150px}{text-data}
*License:*
{text-data:License|width=150px}[BSD|http://www.opensource.org/licenses/bsd-license.php]{text-data}
*Visits:*
{content-info:value=viewCount|digits=4|type=gif}{content-info}
{text-data:Extra Details|type=area|width=150px|height=100px}{text-data}
{panel}
{column}
{column}
h1. {content-info:value=title}Page Title{content-info}
*{excerpt-data:Excerpt|type=area|width=500px|height=50px}A short, one-sentence, discription of the plugin goes here.{excerpt-data}*
{hidden-data:whenEmpty=Overview}[Overview|#Overview] | {hidden-data} [Downloads|#Downloads] {hidden-data:whenNoRows=Release History}| [Release History|#Release History] {hidden-data} | [Bugs & Feature Requests|#Bugs & Feature Requests] {hidden-data:whenEmpty=KnownIssues}| [Known Issues|#Known Issues] {hidden-data} | [Macros|#Macros] {hidden-data:whenEmpty=Other Components}| [Other Components|#Other Components]{hidden-data} {hidden-data:whenNoRows=Examples}| [Examples|#Examples] {hidden-data} {hidden-data:whenEmpty=Other Information}| [Other Information|#Other Information] {hidden-data}
{hidden-data:whenEmpty=Overview}
h2. {toggle-cloak:id=Overview} Overview
{cloak:id=Overview|visible=true}
{text-data:Overview|type=area|width=500px|height=150px}A more detailed description of the macro goes here.{text-data}
{cloak}
{hidden-data}
h2. {toggle-cloak:id=Downloads} Downloads
{cloak:id=Downloads|visible=true}
{text-data:Download Instructions|type=area|width=500px|height=80px}For information on installing the plugins once you've downloaded them, see these [instructions|Installation Instructions].{text-data}
{repeating-data:Downloads|initialRows=1}
h3. {toggle-cloak:id=*|exlusive=true} {text-data:Title|required=true|width=400px}Title{text-data}
{cloak:id=*}
{text-data:Description|type=area|width=500px|height=75px}{text-data}
|| Plugin Package: | {list-data:Binary}
{list-option:None}_None_{list-option}
{attachment-options:filter=.*jar}
{list-data} | {text-data:Binary Details}({content-info:^plugins.jar|value=viewCount}{content-info} downloads){text-data} |
|| Source Code: | {list-data:Source Code}
{list-option:None}_None_{list-option}
{attachment-options:filter=.*zip}
{list-data} | {text-data:Source Code Details}({content-info:^src.zip|value=viewCount}{content-info} downloads){text-data} |
{hidden-data:whenEmpty=Notes}
{note:title=Note}{text-data:Notes|type=area|width=400px|height=75px}{text-data}{note}
{hidden-data}
{cloak}
{repeating-data}
{cloak}
h2. {toggle-cloak:id=Release History} Release History
{cloak:id=Release History}
{info:icon=false}*Key:* (+) = new feature, (*) = improvement, (-) = bug{info}
{repeating-data:Release History|order=desc|initialRows=1}
h3. {toggle-cloak:id=*|exclusive=true} Version: {text-data:Version|required=true|width=50px}{text-data}
{cloak:id=*}
|| Date: | {date-data:Date|format=dd-MMM-yyyy|required=true|minYear=2004|maxYear=+0}today{date-data} || Author: | {list-data:Author}{list-option}{list-option}{user-options:space=CONF:edit}{list-data} |
{text-data:Notes|type=area|width=500px|height=100px}{text-data}
{cloak}
{repeating-data}
{cloak}
h2. {toggle-cloak:id=Bugs} Bugs & Feature Requests
{cloak:id=Bugs|visible=true}
Bug reports and feature requests can be made entered via {text-data:Bugs|width=150px}[Jira|CONFEXT@jira]{text-data}.
{cloak}
{hidden-data:whenEmpty=Known Issues}
h2. {toggle-cloak:id=Known Issues} Known Issues
{cloak:id=Known Issues}
{text-data:Known Issues|type=area|width=500px|height=150px}{text-data}
{cloak}
{hidden-data}
h2. {toggle-cloak:id=Macros} Macros
{cloak:id=Macros}
{text-data:Macros|type=area|width=500px|height=200px}{text-data}
{cloak}
{hidden-data:whenEmpty=Other Components}
h2. {toggle-cloak:id=Other Components} Other Components
{cloak:id=Other Components}
{text-data:Other Components|type=area|width=500px|height=250px}{text-data}
{cloak}
{hidden-data}
{hidden-data:whenNoRows=Examples}
h2. {toggle-cloak:id=Examples} Examples
{cloak:id=Examples}
{repeating-data:Examples}
h3. {toggle-cloak:id=*|exclusive=true} {text-data:Title|width=300px}Title{text-data}
{cloak:id=*}
{text-data:Description|type=area|width=500px|height=200px}{text-data}
{cloak}
{repeating-data}
{cloak}
{hidden-data}
{hidden-data:whenEmpty=Other Information}
h2. {toggle-cloak:id=Other Information} Other Information
{cloak:id=Other Information}
{text-data:Other Information|type=area|width=500px|height=250px}{text-data}
{cloak}
{hidden-data}
{column}
{section}
{scaffold}
