projectdoc Toolbox

Macros to help authors to reference other documents that are relevant to the current document.

Parent: Macros Introduction
Audience: Author, Template Author
Level of Experience: Novice
Type: Tutorial

Reference in a document allow readers to find related documents quickly. Good references enhance the navigability of the documentation.

Automatic Lists

By using automatic lists, document authors may specify links to related documents that have been written after the current document. Therefore automatic lists are a major enhancement to manually adjusted lists of references.

Value References

Creates references to documents by their names or other identifying information.

Name	Short Description
External Link Macro	Renders a locale dependent link to an external resource. The body of the macro contains the link label.
Hudson Link Macro	Render links to jobs and services on a Hudson server.
Javadoc Link Macro	Links API documentation pages for Java elements.
Nexus Link Macro	Renders a link to an artifact stored on a Nexus server.
Site Link Macro	Links to a resource on a versioned site.
Sonar Link Macro	Renders a link to a project on a Sonar service.
Subversion Link Macro	Renders a link to a resource on a Subversion (SVN) repository.
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.
Wiki Link Macro	Allows to render a link to a wiki page.

Remote References

Creates references to remote information servers.

Name	Short Description
Subversion Link Macro	Renders a link to a resource on a Subversion (SVN) repository.
System Link Macro	Links to a resource on a server.

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

Automatic Lists

Value References

Remote References

About

Keep up-to-date!

Powered by