projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 17

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 18

changes.mady.by.user Robert Reiner

Saved on

Key

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

...

Section


Column


Document Properties Marker
overridefalse


Short DescriptionA short introduction to use projectdoc services in the context of velocity to integrate with user macros.
Doctypetopichide
NameUser Macro Integration
Short Name
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
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide
Since4.1



Section
show-titlefalse
titleDescription

This Application Programming Interface (API) allows users of the projectdoc Toolbox to use a limited API to access projectdoc domain objects from User Marcos.

The services are registered in the Velocity context.


Section
titleSummary


Section
titlePrerequisites

Readers need to know how to write User Macros on Confluence and how to access services via the Velocity Context Module.



Column
width40%


Panel
titleContents

Table of Contents
indent15px
stylenone





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"))




...

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