projectdoc Toolbox

Information on how to use the fragments cache.

Tags
Since
1.9.0

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.

 

It is important to note that the cache does its caching per site and not per user! Therefore content put to the cache by one user may reveal information that is usually not available to another user. Therefore you must make sure that the cache is only used for spaces where users have the same page access privileges!

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.

Scroll Product Support

The fragments cache handles captions for table and image for Scroll products properly by assigning these fragments separately.

For large documents this may imply that the rendering of a PDF document needs to be rendered in multiple steps.

Since 4.4

 

This feature is available since version 4.4 of the projectdoc Toolbox.

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. 

Since 4.4

 

This feature is available since version 4.4 of the projectdoc Toolbox.

Macros not Using Caching

Currently only the Transclusion Macro uses the page fragments cache.

So the following macros and features currently do not support it:

  1. Transclude Documents Macro
  2. Document Properties Marker Macro (Delegate Document Feature)
  3. Display Table Macro and other macros accessing section content via the document property API.

Resources

More information on this topic:

Caching Fragments
Activates the page fragment cache for a space.
transclusion-box.date-format
Transclusion Box Suppress Date
Controls the rendering of dates on the transclusion box.
Transclusion Macro
Transcludes content from a document marked with the content marker macro.
Logging
List of loggers for monitoring projectdoc.