Information on how to use the fragments cache.
Transclusions are slow. For every transclusion at least one other document has to be accessed and the transcluded part has to be rendered. If the transcluded part also transcludes information from other pages, this calculation will reasonably slow down the rendering time of a document.
In order to support teams that use transclusions heavily, projectdoc provides a fragments cache that stores pre-rendered fragments in a database. This feature is available from projectdoc version 1.9.0 and is currently only provided for the use of the Transclusion Macro.
When to use?
The fragment cache should be used if your team works on a space collaboratively and uses transclusions heavily.
How to use?
To activate this feature, set the space property Caching Fragments to true.
The use of the cache may be disabled on a macro basis. For further information please refer to the No Cache parameter of the Transclusion Macro.
Document-centric Caches
The document property projectdoc.transclusion.id-specifier
allows to define a marker. Fragment rendered on behalf of transclusions on this page will use this marker as part of their fragment identifier. This way it is possible to define a fragment set that is exclusively used by a page or a set of pages, sharing this marker.
Resources
More information on this topic: