Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
hide
Document Properties Marker
doctypetopic
overridefalse
Short DescriptionInformation on how to use the fragments cache.
 Doctypetopic

NameFragments Cache for Transclusions
 

Parent
Parent Property
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
 

Expected Duration
 

Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags

Tag List
namesScroll Exporter
propertyTags

 

Iteration

Iteration
value

filled

finished

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType
 

Since1.9.0
 

Sort Keyhide
Section
show-titlefalse
titleDescription

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 pre-rendered fragments in a database. This feature is available for from projectdoc version 1.9.0 + and is currently only provided for the use of the Transclusion Macro.

...

Section
titleHow to use?

To activate this feature, set the space property de.smartics.projectdoc.admin.caching.fragments 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.

Section
titleScroll 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.

Version Box
since4.4

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

Section
titleDocument-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. 

projectdoc-box-version
since4.4

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

If you have use cases for these macros to participate in using the cache, please get in touch!
projectdoc-section
titleMacros 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.
Note Box
Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...

Section
titleResources

More information on this topic:

Tour
render-as-definition-listtrue
replace-title-with-nametrue
 
TitleShort Description
de.smartics.projectdoc.admin.caching.fragments
transclusion-box.suppress-date 
Caching Fragments
transclusion-box.date-format
 

Transclusion Box Suppress Date
Transclusion Macro
 

Logging