Renders template button to create a page. After the page is created, the macro renders a link to this page.
Details
Basic Workflow
Design the Document
The template author adds the macro to the page.
- Define the title of the page
- Decide if the button should be shown as a link or not be rendered after the document is created
- Label the button
On the right you see the macro parameter options. Typically the macro is used at template design time, so the macro is added as XML (Confluence storage format).
<ac:structured-macro ac:name="projectdoc-create-one-document-macro">
<ac:parameter ac:name="blueprint-module-complete-key">
de.smartics.atlassian.confluence.smartics-projectdoc-confluence
:projectdoc-blueprint-doctype-blank
</ac:parameter>
<ac:parameter ac:name="title">Retrospective</ac:parameter>
<ac:parameter ac:name="fade-on-creation">false</ac:parameter>
<ac:parameter ac:name="button-label">Create Retrospective</ac:parameter>
</ac:structured-macro>
See whitebox example for details and source code.
Working with the Document
From the author's (or team member's) point of view, who is working with a document that contains the macro, the flow of work is as follows.
Button in the view and
page does not yet exist
User hits the button
and creates the page
Button in the view
after the page is created
Hide on Creation controls if the button is rendered at all
Note that the macro simply checks that a page with the given name exists. If the page is renamed, the button (instead of the link reappears).
Therefore it is not possible for the document author to change the title or the space. In either case the macro will conclude that the page does not exist and still render the create button.
If the blueprint is a projectdoc blueprint the wizard allows to change the name. That is the title of the page is set as provided by the template author, but the name is changed to the title provided by the document author. Macros of the projectdoc Toolbox typically work with the name of the document (e.g in the Display Table Macro the names and not the titles of the documents are listed).
Prior to Confluence 5.10 and projectdoc Toolbox 1.12.1 the wizard is not supported by the title information from the button. So the template must deal with determining the title on its own (see example below).
