- Created by Robert Reiner, last modified on 04. Jun 2018
projectdoc Toolbox
Tools to provide or consume content to support reuse.
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.
Documents
The following documents provide information on transclusion.
| Name | Short Description | Doctype |
|---|---|---|
| Excerpt and Transclusion | Explains the differences between and commonalities of the Confluence Excerpt and the projectdoc Toolbox Transclusion features. | topic |
| Modular Documentation | Use rich multi-excerpts (transclusion) for content reuse - even from page result lists. Replace parameters in excerpts. Include properties and sections from pages. Hide content dependent on roles and properties. | topic |
| Agile Documentation | Agile documentation is not another buzzword. There is actually a set of rules to follow which will lead to meaningful documentation. Writing helpful documentation is not easy, but it gets a lot easier with the agile mindset - and with the projectdoc Toolbox. | topic |
| Caching Fragments | Activates the page fragment cache for a space. | property |
| Content Marker Macro | Marks a piece of content within a document. This content can be referenced for transclusion. | app-macro |
| 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. | topic |
| Delegate Document Suppress Error Message Section | Controls if missing sections should render an error message ( false) or just display nothing (true). | property |
| Enterprise Architect Image Link Macro | Renders an image generated from an Enterprise Architect diagram, transcluded from a server. | macro |
| Heading Level Transposition | Reusing sections typically includes the transcluded content to match the document structure of the transcluding document. The projectdoc Toolbox does this automatically. | topic |
| Impersonator - using Live Templates | A short introduction using the impersonator feature of the projectdoc Toolbox. In this example we examine what to do to reuse a layout defined in another document. | topic |
| Index Card Macro | Renders transcluded content fetched from documents of a result set. | macro |
| Macros | List of macros provided by the projectdoc Toolbox. | docsection |
| Module | A documentation module is a fragment which is usually transcluded by other documents. The lifetime of a module document is independent of the lifetimes of the documents that reference it. | doctype |
| projectdoc Toolbox Online Manual | The online manual for version 1 of the projectdoc Toolbox for Confluence. | topic |
| Random Transclusion Macro | Transcludes random content from a document marked with the content marker macro. | macro |
| Render Transclusion Box | Controls the rendering of transclusion boxes. | property |
| Section Compiler by Reference Macro | Compiles local sections with transcluded content by a reference list. | app-macro |
| 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. | app-macro |
| Suppress Transclusion | Suppresses transclusions when set to 'true' on a space. | property |
| Suppress Transclusion Mode | Sets the mode for rendering transcluded content in transclusion suppression mode. | property |
| System Image Link Macro | Renders an image transcluded from a remote server. | macro |
| The hidden Section | The Content Marker Macro identifies content that can be displayed using the Display Table Macro. This is a short tip on how to transclude content from a projectdoc document. | topic |
| Transclude Documents Macro | Renders transcluded content fetched from documents of a result set. | macro |
| Transclude transcluded Sections | Shows how to transclude transcluded content. | topic |
| Transclusion Box Date Format | Controls the format of the date rendered on the transclusion box. | property |
| Transclusion Box Suppress Date | Controls the rendering of dates on the transclusion box. | property |
| Transclusion Macro | Transcludes content from a document marked with the content marker macro. | macro |
| Transclusion Reference Macro | Transcludes content via a reference from a document marked with the content marker macro. | macro |
| Transclusion to Text Macro | Transcludes content from a document marked with the content marker macro and renders it as plain text. | macro |
| Two central Use Cases for the projectdoc Toolbox | The projectdoc Toolbox provides a lot of macros to create documentation. It also replaces two macros provided by Confluence. The Excerpt Macro and the Page Properties Macro. | topic |
| Use Display Table for Transclusion References | It is easy to list all pages that transclude a section from the current page. This allows you, as an author, to check quickly if changes to a document that is transcluded, needs changes to the transcluding documents. | topic |
| Using Placeholders | An overview over features employing placeholders to create a modular documentation. | topic |
Resources
Related information to transclusion.
- Reference
- A reference is a directed relation to an entity.
