projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 15

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 16

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
doctypetopic
overridefalse


Short DescriptionProperty values should only change when a document is saved. They should not be dependent on request-time. If they are, then they are called 'dynamic'.
NameDynamic Property Valueshide
Short Namehide
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Documentation Gardener, Documentation Architect
property-restrict-value-rangetrue
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
property-restrict-value-rangetrue
propertyCategories

Tags
Tag List
propertyTags

Flagshide
Iteration

Iteration
value

focused

filled

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTutorial
property-restrict-value-rangetrue
propertyType


Level of Experience

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


Expected Duration
Sponsors
Name List
doctypestakeholder,organization,person,role
render-no-hits-as-blanktrue
propertySponsors

Since
5.2

Sort Keyhide



Section
show-titlefalse
titleDescription

The concept of dynamic property values should be mastered by users right from the start.

Using dynamic property values with the projectdoc Toolbox seems quite natural. Especially novice users may not be aware of the issues that come with them.

This short article explains the problem with dynamic property values and shows use cases to handle them.

The information is based on the projectdoc Toolbox version 5.2.

...

Section
titleModes

The mode to handle dynamic properties is defined by the administrator via the configuration screen 

Static Document Link
documentDynamic Property Value Handling
.

The following modes are available with the projectdoc Toolbox with version 5.2.

Content Marker
idtable-of-modes


ModeDescription
allow

No restriction. Dynamic values are allowed. Users are responsible to use them correctly.

This mode is used for backward compatibility.

lenient

Dynamic values are allowed, and if proper control are not set, then 

Static Document Link
documentno-property
is assumed.

The following controls are considered proper:

  • Static Document Link
    documentnoindex
  • Static Document Link
    documentno-render-cache
  • Static Document Link
    documentno-property
  • Static Document Link
    documentforce-property

Health checks will signal the use of deprecated features of macros considered to be dynamic.

This mode may be selected to allow users to use dynamic values.

strict

Dynamic values are allowed, and if proper control are not set, then 

Static Document Link
documentno-property
is assumed.

The following controls are considered proper:

  • Static Document Link
    documentnoindex
  • Static Document Link
    documentno-render-cache
  • Static Document Link
    documentno-property

This mode will be the default mode for the next major version of the projectdoc Toolbox. It is the recommended mode for new users.

explicit

Dynamic values are allowed, if proper controls are set:

  • Static Document Link
    documentnoindex
  • Static Document Link
    documentno-render-cache
  • Static Document Link
    documentno-property
  • Static Document Link
    documentforce-property

The implicit flagging of 

Static Document Link
documentno-property
when a dynamic property is encountered, is not allowed.

This mode should only be used for testing the health of documents, not as a runtime mode.

block

No dynamic value is allowed.

This mode may be helpful to find all locations of dynamic values with a health check. Not recommended as a runtime mode.




Section
titleHealth Service

Administrators may check the current status of the projectdoc documents by the use of the REST service projectdoc-internal/1/health/find-dynamic-values.

The service allows to check spaces with different modes.

For version 5.2 of the projectdoc Toolbox the default mode is allow for compatibility reasons. For new users a value of strict or lenient is recommended.

The interface of the health service shown in the REST API Browser

With the parameters additional-dynamic-macros and use-default-configuration, administrators may test configurations in addition and without the default configuration.

...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH