- Created by Robert Reiner, last modified on 04. Jun 2018
projectdoc Toolbox
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.
The projectdoc Toolbox provides macros to transclude elements from a document into another document. These elements may be properties or sections / marked content. There is no limitation on the number of properties and sections to transclude.
Transclusion is the technique to render parts of one document within another document.
The inclusion of part of one hypertext document in another one by means of reference rather than copying.
Wiktionary. transclusion
The projectdoc Toolbox provides macros to define content within a document to be transcluded (by the use of the Section Macro and the Content Marker Macro) and macros to transclude this content into a document (for instance Transclusion Macro and Transclude Documents Macro).
Excerpt and multi-excerpt
Users of Confluence know transclusion support by the Excerpt Macro and the Excerpt Include Macro. The article Excerpt and Transclusion compares the features of the native Confluence macros with those of the projectdoc Toolbox.
Checkout Compare with built-in Features to learn more about the differences between built-in features of Confluence and features of the projectdoc Toolbox.
Note that the projectdoc Toolbox makes it easy to list documents that transclude from a document (see Module) and there are tools for authors (see Transclusion Box) to make jumping to transcluded content very easy.
The tip Content Reuse provides an overview over the transclusion or excerpt features of the projectdoc Toolbox.
Resources
More information on this feature.
- Transclusion
- Tools to provide or consume content to support reuse.
- Content Reuse
- The projectdoc Toolbox provides a number of features to help teams to reuse content. Content can be transcluded individually or in form of a multitransclude. Authors can even transclude content from multiple documents in the wiki, effectively combining transclusion with automatic lists.
- Multi-transclusion
- Describes the technique to transclude one or more content fragments from one or more documents.
- Multi-excerpt
- The term is used by Confluence to describe the technique to transclude one or more content fragments from one or more documents.
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.
- Dynamic Linking
- 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.
- 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.