Versions Compared

Key

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

...

Section
titleServices

This section lists services available in the velocity context to be used with user macros in Confluence.

Section
titleprojectdoc Document Manager

projectdoc documents are accessible via the projectdoc document manager by the key projectdocDocumentManager.

Section
titlegetDocumentByPageId


pageIdThe identifier of a Confluence page.

Provides access to a document with all properties set. The document is referenced by a page identifier.

Code Block
languagexml
#set ( $document = $projectdocDocumentManager.getDocumentBasicsByPageId(819207)) 
#set ( $property = $document.getProperty($paramName)) 
#set ( $propertyValue = $property.getRenderedValue()) 



Section
titlegetDocumentByPage


pageA Confluence page.

Provides access to a document with all properties set. The document is referenced by a page.

Code Block
languagexml
#set ( $page = $pageManager.getPage(819207)) 

#set ( $document = $projectdocDocumentManager.getDocumentBasicsByPage($page)) 
#set ( $property = $document.getProperty($paramName)) 
#set ( $propertyValue = $property.getRenderedValue()) 



Section
titlegetDocumentBasicsByPageId


pageIdThe identifier of a Confluence page.

Provides access to a document with basic properties set. The document is referenced by a page identifier.

This version is faster in case only properties entered by a user are to accessed.


Section
titlegetDocumentBasicsByPage


pageA confluence page.

Provides access to a document with basic properties set. The document is referenced by a page.

This version is faster in case only properties entered by a user are to accessed.



Section
titleprojectdoc Document Property Manager

Properties of projectdoc documents are directly accessible via the projectdoc document property manager by the key  projectdocDocumentPropertyManager .

Section
titlegetDocumentPropertyAsString (by page)


pageA Confluence page.
nameThe name of the property.

Provides access to a document property by page and document property name.

Code Block
languagexml
#set ( $page = $pageManager.getPage(819207)) 
#set ( $propertyValue = $projectdocDocumentPropertyManager.getDocumentPropertyAsString($page, "Name")) 



Section
titlegetDocumentPropertyAsString (by page ID)


pageIdThe identifier of a Confluence page.
nameThe name of the property.

Provides access to a document property by page identifier and document property name.

Code Block
languagexml
#set ( $propertyValue = $projectdocDocumentPropertyManager.getDocumentPropertyAsString(819207, "Name")) 



Section
titlegetDocumentPropertyByKeyAsString (by page)


pageA Confluence page.
nameThe name of the property.

Provides access to a document property value by page identifier and document property name key.

This allows to access a property dependent on the currently used locale.

Code Block
languagexml
#set ( $page = $pageManager.getPage(819207)) 
#set ( $propertyValue = 
  $projectdocDocumentPropertyManager.getDocumentPropertyByKeyAsString($page, "projectdoc.doctype.common.name")) 



Section
titlegetDocumentPropertyByKeyAsString (by page ID)


pageIdThe identifier of a Confluence page.
nameThe name of the property.

Provides access to a document property value by page identifier and document property name.

This allows to access a property dependent on the currently used locale.

Code Block
languagexml
#set ( $propertyValue = 
  $projectdocDocumentPropertyManager.getDocumentPropertyByKeyAsString(819207, "projectdoc.doctype.common.name")) 




...