...
Section | ||
---|---|---|
| ||
The building blocks of a modular documentation are documents. The building blocks of documents are properties (defined by the Document Properties Marker Macro) and sections (defined by the Section Macro). The projectdoc Toolbox allows to reuse these building blocks - properties and sections - easily with the Transclusion Macro and Display Document Property Macro. You may even replace placeholders in the content while transcluding.
|
projectdoc-section | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
Why easily? Suppose an author transcludes content from another page. In view mode the transcluded content is highlighted. By clicking on the name of the document at the top-right of the box, the author is able to jump to the page quickly. If clicking on the edit icon (pencil), the document is opened for editing with one click. For performance reasons the fragments may be cached. In this case every transcluded content shows the last updated date and an icon to refresh the content from the cache (although the system typically recognizes stale content quickly).
If an author is interested in where a particular content is used, the information can be displayed on the page easily. The projectdoc Toolbox also provided macros to make these sections only available for authors. But note that the content is only hidden and therefore not secure.
For more information on transclusion, please refer to Use Display Table for Transclusion References.
Since version 1.10 of the projectdoc Toolbox you may even transclude tagged content from a document automatically and add additional sections and properties to the transcluding document. This feature is called delegate document. The delegate document is defined with the Document Properties Marker Macro. |
...
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...