projectdoc Toolbox

A document template that uses query macros enables documents to dynamically render links to a set of related documents. If new documents are added to the system that meet the query criteria, links to these documents are automatically added to the querying document. This feature is also called dynamic lists or automatic linking.

Dynamic linking allows to render links dependent on the context at request time. Request time is the time when a page is rendered for a reader in the web browser. Dynamic Linking refers to a list or table of links, which is called Dynamic List, or a single link, which is called a Dynamic Link.

Dynamic Lists & Tables

A dynamic list may be rendered as a list or as a table. Sometimes it is also called and automatic list, because the links are rendered dynamically and automatic at request time.

Each list item or table row represents information from one document that is member of the query result set.  A query contains constraints to match all documents of a given document type and a couple of tags. When a user browses to a page with a dynamic list, the system executes the query and shows all pages that match that query at request time. 

In the following screenshot you see a dynamic list, rendered in form of a table.

You specify queries like this:

SELECT PropertyOne, PropertyTwo, PropertyFour
WHERE PropertyOne = "Some String" AND 
        (PropertyTwo = "Another String" OR PropertyFive = "Something")
SORT BY PropertyOne, PropertyThree

Note that this is pseudo syntax. The values for SELECT, WHERE and SORT BY are passed to the macros as parameters.

Dynamic lists is supported with

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 Table Macro
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
Index Card Macro
Renders transcluded content fetched from documents of a result set.
Index Entries Table Macro
Renders a table of index entries.
Transclude Documents Macro
Renders transcluded content fetched from documents of a result set.


Resources

More information on this feature.

Dynamic List
Tools to render information based on queries at view-time.
Glossary
Terms used in and defined for projectdoc.
Dynamic List
In the glossary: Enhances navigation by showing a list of links to related information that is the result of a query on document properties.
Rendering Navigation Links
There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox.
Dynamic Links
Build a navigation to related and associated information by the use of document properties and dynamic linking.

More Features

List of features of the projectdoc Toolbox for Confluence.

Deep Links
With deep links properties from referenced properties can be accessed for rendering.
Default Locations
Document types have their default location within a documentation space. These default locations are called 'homepages'. If authors create new documents they can send them to these default locations within a given space. Delegate spaces expand this feature to find the default location in associated spaces.
Delegate Document
Delegating documents transclude sections and properties from a delegate document. Information may be overridden.
Document Types
Document types allow to guide authors producing information of a given type. They also help readers to find the information they are looking for quickly.
Enhanced Transclusion
Transclude more than one self-contained snippet and mark transcluded information for authors. The projectdoc toolbox allows multi-transclusion from one document and even several documents.
Extensible by Spaces, Templates, and Macros
Never be limited to the vendor's ideas: Create your own spaces, templates/blueprints/doctypes and macros based on components provided by the projectdoc Toolbox!
Guided Writing & clutter-free Reading
Do not clutter the view with non-information sections. Instead help authors writing identical structured content by the use of templates.
Information Systems Integration
Via a free extension information from remote information systems may be rendered on a wiki page.
Live Templates / Impersonator
Use the structure from a page and render it in the current page's context.
Remote Control
The projectdoc Toolbox supports rendering a page controlled by request properties. This way a URL controls the contents of a page.
Rich Custom Document Metadata
Authors may add any metadata to a document and use these in their queries. The metadata may be displayed or hidden. This way authors can use metadata target at the reader and metadata used for authoring purpose.
Single Sourcing
The projectdoc Toolbox provides doctypes and macros to support teams to modularize their documentation.
Space Hierarchies
Organize spaces in hierachies with delegate and search spaces.
Space Properties
Properties may be set on space level and are inherited through space hierarchies.
Variables
Space and document properties may be used as variables with the projectdoc Toolbox.
Web API
To integrate projectdoc documents with remote systems the projectdoc Toolbox provides a REST API. This API is installed separately with a free extension add-on.