You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

projectdoc Toolbox

Information on how to use the fragments cache.

Since
1.9.0

Description

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 prerendered fragments in a database. This feature is available for 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 de.smartics.projectdoc.admin.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.

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.
 

If you have use cases for these macros to participate in using the cache, please get in touch!

Resources

More information on this topic:

transclusion-box.date-format
Transclusion Macro
Transcludes content from a document marked with the content marker macro.
  • No labels