Versions Compared

Key

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

...

Document Properties Marker
doctypetopic
overridefalse


Short DescriptionA system service to check the compatibility of the projectdoc Toolbox with installed extensions and doctype add-ons.
NameDependency Check Messagehide
Short Namehide
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

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

Tags
Tag List
propertyTags

Flagshide
Iteration

Iteration
valueproduction

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

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

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

Since5.0.2
Sort Keyhide



Section
show-titlefalse
titleDescription

The health check ensures that the extensions and add-ons for the projectdoc Toolbox are compatible on a source code or interface level. Since the projectdoc apps use semantic versioning, dependency issues are communicated by the change of the major version.

If there is a database migration and macros of these extensions are used as values of document properties, the incompatibility may show in property values that show error messages rendered by these macros. Therefore this health check warns users that some of the projectdoc apps need to be updated.

Please check the 

Static Document Link
documentRelease Notes
for specific information on changes provided by your version of the projectdoc Toolbox.

...

Section
titleDetails

The message is rendered as an error in a box.

Image Added

Additionally, the identifiers and versions of the incompatible extensions and add-ons are shown together with the smallest version that is compatible with your version of the projectdoc Toolbox. Note that is typically recommended to use the latest version of the projectdoc Toolbox and the related extensions and add-ons.

Please note: The rendered text has been updated in version 6.0.5. So the text of previous version differs from the one shown above.

Section
titleCSS Classes

The message box is rendered with the following classes.

Code Block
languagetext
titleCSS Classes provided since Version 6.0.5
projectdoc-healthcheck-dependency projectdoc-healthcheck-failed

You may use this classes to suppress the rendering of the box in the browser.

Code Block
languagecss
titleSuppress Rendering of Message Box
.projectdoc-healthcheck-dependency.projectdoc-healthcheck-failed {
  display: none;
}
The rendered text has been updated in version 6.0.5.




Section
ignore-template-buttonstrue
titleSubordinate Topics


Hide From Reader

Create from template
blueprintModuleCompleteKeyde.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-core:projectdoc-blueprint-doctype-topic
buttonLabelCreate Topic

Display Table
doctypetopic
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name
render-classeschildren-table, display-table, children

...