projectdoc Toolbox

Shows how to use the Wiki Link Macro based on Remote Controls to alternate between two different views on a single document.

Type: Tip
Level of Experience: Proficient

Remote controls allow to override macro parameters with HTTP request parameters. This way a view on a document can be altered. For instance a release notes document could show changes in a condensed form. By providing a link to override the parameters of the macro displaying the changes, the view could expand the information on each change. Since version 4.5 of the projectdoc Toolbox the Wiki Link Macro allows to toggle between the two states.

This tip shows how to configure the Display Table Macro and Wiki Link Macro to create two views on a document.

Use Case

For this tip we want to show you a live example with a list of macros from the projectdoc Toolbox. We show them in a short overview and in an expanded version.

Configuration Display Table

To make the Display Table Macro ready to be remote controlled, the Identifier parameter needs to be set.

You can also use the Identifier Classes parameter in case you need to control a selection of macros in a single action.

Configure your query with the Select, Where and Sort By parameter according to your use case. For our example we only select the macro documents of this space.

Configure Wiki Link Macro

The Wiki Link Macro allows to add Remote Controls with the Request Parameters parameter.

The following controls alter the selected information, switch to the section render mode, and render the section title as link to the macro document.

list-of-macros:select=Name, Short Description, Description,Tags|&
list-of-macros:render-mode=*s&
list-of-macros:render-heading-as-link=true

Since the Wiki Link Macro refers per default to the current document, when clicking the link, the view will be expanded to the section view. Therefore we set the label of the link to Details View and add an appropriate tooltip.

Now we do the same for the toggle state. Besides the label and tooltp for the toggle state the next screenshot also shows the request parameters we set before.

By specifying a Request Toggle Label and by providing Request Parameters the Wiki Link Macro provides a toggle mode.

You may want to deselect the styling options, since these options are not relevant for self-referencing links.

Wrap Buttons

You probably do not want to print the toggle link when exporting the page to PDF.

To do so wrap the Wiki Link Macro inside a Content Marker Macro.

Use the Pretend Being A space property to hide the content area in case the property is set to printer.

Live Example

Details View

Action Button Macro: Renders an action button to link to a projectdoc document, Confluence page, or external resource.
Actor Type Macro: Allows to select the type of an actor.
Ancestor Property Macro: Render the property value of an ancestor of this document, for the first ancestor that matches the specified document type.
Aside Panel Macro: Renders apanel with title and body, layouted with a custom CSS configuration.
Aspect Properties Macro: Access properties from aspect documents.
Aspect References Macro: Autoconnect to aspect documents.
Aspect Sections Macro: Access sections from aspect documents.
Attachment Code Block Placeholder Macro: Renders a code block from an attached file with placeholders replaced by properties.
Attachment Link Macro: Renders a link to an attached file for download.
Body Graph Macro: Renders a document graph in a graph language allowing the body to contain arbitrary content (including transclusions).
Bookmarklet Button Macro: Renders a drag-and-dropable button for a bookmarklet.
Bookmarklet Macro: Tool to create bookmarklets using the REST API.
Bookmarklets List Macro: List of bookmarklets provided by the projectdoc Toolbox.
Breadcrumb Macro: Renders a breadcrumb for the current page.
Calculation Macro: Run calculations on a set of result documents and renders the results.
Calculation Result Macro: Renders a single result of a calculation provided by the Calculation Macro.
Caution Box Macro: Renders a box containing a caution message.
Changelog Macro: Renders document history information.
Child Documents Macro: Renders the list of child documents, matching the given filter criteria.
Cite Macro: Renders a cite to a resource document.
Code Block Placeholder Macro: Passes a text containing placeholders to the Code Block Macro. The placeholders are replaced by the properties of a document and/or the space properties.
Communication Type Macro: Allows to select the type of communication between two entities.
Compact Definition List Macro: Renders wiki syntax as a definition list. Does allow HTML tags and therefore is vulnerable to XSS attacks.
Compact No-HTML Definition List Macro: Renders wiki syntax as a definition list. Does not allow any HTML tags.
Complexity: Allows to select the complexity for an item.
Content Marker Macro: Marks a piece of content within a document. This content can be referenced for transclusion.
Count Macro: Renders the count of rows, list items, or definition terms.
Create One Document Macro: Renders template button to create a page. After the page is created, the macro renders a link to this page.
Day Rating: Allows a user to select a rating for a day.
Definition List Macro: Renders term and definition information as a definition list. Currently Conflucene does not easily support authors to write definition lists. But definition lists allow to render this form of information efficiently.
Deprecated Box Macro: Renders a box containing a deprecation warning for the reader.
Display All Document Properties Macro: Displays all properties of a document as a writing tool for authors.
Display All Space Properties: Renders all properties referenced by the current space.
Display Document Properties Macro: Renders a template with property references.
Display Document Property As Image Macro: Renders the value of a document property as an image. The property value is required to an URL that points to an image.
Display Document Property As Link Macro: Renders the value of a document property as a link with an alternative label.
Display Document Property As List Macro: Renders the list value of a document property.
Display Document Property Macro: Renders the value of a property of a document.
Display Document Property Ref Concat Macro: Displays a single property of a document that is referred by a property of another document and concatenates it with the value of a local property.
Display Document Property Ref Macro: Displays a document property from a referenced document.
Display List Macro: Lists references to projectdoc documents in a list. List contain names and optional short descriptions.
Display List Template Macro: Lists references to projectdoc documents in a list. List items are defined by templates referencing properties.
Display Space Attribute Macro: Renders a space attribute value.
Display Space Property Macro: Renders a space property value.
Display Table Macro: Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
Document Properties Marker Macro: A table containing document properties. Three columns: name, value and meta data (aka controls) to a property.
Document Properties Supplier Attachment Macro: A table supplying additional document properties from an attached file.
Document Properties Supplier From Documents Macro: Import properties from another projectdoc document.
Document Properties Supplier Macro: A table containing additional document properties. Three columns: name, value and meta data (aka controls) to a property.
Documented Information Type Macro: Defines the type of a documented information.
Dynamic Document Link Macro: Renders a dynamic link to a projectdoc document in the wiki. A dynamic link is a link to a Confluence page that is identified by the page title and the delegate space closure. The target of the link is calculated at render time. In case the delegate space closure changes, a different document may be the target of the link.
Enterprise Architect Image Link Macro: Renders an image generated from an Enterprise Architect diagram, transcluded from a server.
Even Rating: Allows to select a rating from values between one and four. Since there is no middle ground, the selection is either on the lower or on the upper side.
Example Box Macro: Renders an example within a box.
External Link Macro: Renders a locale dependent link to an external resource. The body of the macro contains the link label.
External Quote Macro: Renders a quote to an external resource with author and source.
Fault Box Macro: Renders a box containing a fault message reported by a team member for the author.
Feature Importance Macro: Allows to select the importance of a feature.
Feedback Box Macro: Renders a box containing a feedback message from a reader with write privilege.
Generic Box Macro: Generic boxes help to easily define one's own boxes to apply certain CSS styles to them.
Graph Macro: Renders a document graph in a graph language.
Hide From Anonymous User: Hides a text fragment from an anonymous user.
Hide From Reader: Hides a page fragment from a user with read-only permissions.
Hide From Viewer Macro: Hides a text fragment from a user that has no edit permissions.
HML Rating: Allows to rate an item in three simple categories: High, Mid, and Low. This categories are especially useful to rate scenarios in quality trees.
HTML Snippet Macro: Transclude HTML content from a remote server.
HTML Span Macro: Renders simple HTML span elements into a page.
Hudson Link Macro: Render links to jobs and services on a Hudson server.
Image Element Macro: Renders an image with an overlay text.
In-Document Link Macro: Renders a static link to a location within the same document. This is a static document link macro with a specialized interface.
Index Card Macro: Renders transcluded content fetched from documents of a result set.
Index Entries Table Macro: Renders a table of index entries.
Info Box Macro: Renders a box containing an info message.
Iteration Macro: Selects an iteration phase from a fixed set of stages.
Javadoc Link Macro: Links API documentation pages for Java elements.
Layout Element Macro: Renders an block or inline element of a page.
Level Macro: Renders the level of the document within its hierarchy. The level is derived from a parent document's level of the same document type.
Name Body List Macro: Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body.
Name List Macro: Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name.
Nexus Link Macro: Renders a link to an artifact stored on a Nexus server.
Note Box Macro: Renders something to note by the reader.
Open Issue Severity Macro: Allows to select a severity for an open issue.
Open Issue Status Macro: Allows to select a status for an open issue.
Page Include Macro: Supports page inclusion dependent on the space of the primary page.
Parent Property Macro: Renders the property of the parent document, if it has the same doctype.
Pattern Domain: Allows to select the domain for a pattern.
Pending Box Macro: Renders a box containing a pending message to be handled later by the author.
Primary Page Display Document Property Macro: Renders the value of a document property from the primary page.
Priority: Allows to prioritize an item in a range of five categories.
Project Constraint Type Macro: Allows to select the type of a project constraint.
Property Calculation Macro: Execute a calculation in the context of a property value.
Quality Scenario Type Macro: Allows to select the type of a quality scenario.
Question Box Macro: Renders a box containing an open question.
Quote Macro: Renders a quote from a resource with author and source.
Random Transclusion Macro: Transcludes random content from a document marked with the content marker macro.
Reference Attachment Code Block Placeholder Macro: Renders code of attached file, referenced by local property, with placeholders replaced by properties.
References Box Macro: Renders a box with references to further information.
Resource Type: Allows to select the type of a resource from a fixed set of values.
Risk Phase Macro: Allows to select a phase of a risk.
Risk Probability Macro: Allows to select a probability for a risk.
Risk Severity Macro: Allows to select a severity for a risk.
Role List Macro: Renders a name list while taking care of special role semantics. Confluence names of groups with view permissions are added to the list of values.
Section Compiler by Reference Macro: Compiles local sections with transcluded content by a reference list.
Section Index Macro: Renderes an index over the section on a document with intra-page links.
Section Macro: Renders a section, if the body is not empty. Supports authors to create content, clutter-free rendering without empty sections. Allows to transclude the content.
Selection Macros: Lists macros that allow to select from a fixed set of values. These macros are used to define the range of document property values. So they are a tool for template authors.
Severity: Allows to select a value to define the severity for an item.
Site Link Macro: Links to a resource on a versioned site.
Sonar Link Macro: Renders a link to a project on a Sonar service.
Space List Macro: Renders spaces with their attributes in a table or list.
Stakeholder Rating Macro: Renders the stakeholder rating that is based on the power and interest of a stakeholder in the project.
Static Document Link Macro: Renders a static link to a projectdoc document in the wiki. A static link is a link to a Confluence page that is identified by its space key and document title.
Status: Allows to select a status for an issue.
Steps Macro: Present a step-by-step guide. Use the Section Macro to define each step with a section inside the steps macro.
Subversion Link Macro: Renders a link to a resource on a Subversion (SVN) repository.
Subversion Transclusion Macro: Transcludes a snippet from a project on a Subversion (SVN) server.
System Image Link Macro: Renders an image transcluded from a remote server.
System Link Macro: Links to a resource on a server.
System Transclusion Macro: Transclude content from a resource from a remote system.
Table Merger Macro: Merges tables (and lists) into one table (or list).
Table Set Macro: Applies a simple set operation on tables in its body.
Tag Body List Macro: Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body.
Tag List Macro: Renders a name list while taking care of special tag semantics. Confluence labels are added virtually to this list and displayed in the tags table row of the document properties table.
Tasks Report Macro: Similar to the original Tasks Report Macro provided by Confluence, but allows to select on document with a Where clause.
Technical Debt Quality Macro: Allows to select the quality type of technical debt.
Template Document Link Macro: Allows to render a link constructed with a template to a document dependent on the space closure.
Term Link Macro: Renders a dynamic link to a Glossary Item in the wiki.
Text Snippet Macro: Transclude text content from a remote server.
Tip Box Macro: Renders a box with a tip for the reader.
Tour Macro: Renders a predefined list of documents in a table.
Tour-by-Property Macro: Renders a predefined list of documents in a table . Documents are selected by a document property. Allows to select document properties for columns. Also non-list representations are provided.
Transclude Documents Macro: Renders transcluded content fetched from documents of a result set.
Transclusion Macro: Transcludes content from a document marked with the content marker macro.
Transclusion Reference Macro: Transcludes content via a reference from a document marked with the content marker macro.
Transclusion to Text Macro: Transcludes content from a document marked with the content marker macro and renders it as plain text.
Use Case Level Macro: Allows to select the level of an use case.
User Character Type Macro: Allows to select the type of an user character.
User Story Macro: Renders a user story of a user story doctype.
Version Box Macro: Renders information related to a version.
Vision Statement Type Macro: Allows to select the type of a vision statement.
Wiki Link Macro: Allows to render a link to a wiki page.
Word Type: Allows to select the type of word for a glossary term.

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Use Case

Configuration Display Table

Configure Wiki Link Macro

Wrap Buttons

Live Example

About

Keep up-to-date!

Powered by