User Macro Integration

Document Properties Marker

override	false

Short Description

A short introduction to use projectdoc services in the context of velocity to integrate with user macros.

Doctype

topic

hide

Name

User Macro Integration

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property-restrict-value-range	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Sort Key

hide

Since

4.1

Section

title	Description

Section

title	Summary

Section

title	Prerequisites

Section

title	Services

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

Section

title	projectdoc Document Manager

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

Section

title	getDocumentByPageId

pageId	The identifier of a Confluence page.

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

Code Block

language	xml

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

Section

title	getDocumentByPage

page	A Confluence page.

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

Code Block

language	xml

#set ( $page = $pageManager.getPage(819207)) 

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

Section

title	getDocumentBasicsByPageId

pageId	The 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

title	getDocumentBasicsByPage

page	A 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

title	projectdoc Document Property Manager

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

Section

title	getDocumentPropertyAsString (by page)

page	A Confluence page.
name	The name of the property.

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

Code Block

language	xml

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

Section

title	getDocumentPropertyAsString (by page ID)

pageId	The identifier of a Confluence page.
name	The name of the property.

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

Code Block

language	xml

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

Section

title	getDocumentPropertyByKeyAsString (by page)

page	A Confluence page.
name	The 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

language	xml

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

Section

title	getDocumentPropertyByKeyAsString (by page ID)

pageId	The identifier of a Confluence page.
name	The 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

language	xml

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

Section

ignore-template-buttons	true
title	Subordinate Topics

Hide From Reader

Create from template

blueprintModuleCompleteKey	de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-core:projectdoc-blueprint-doctype-topic
buttonLabel	Create Topic

Display Table

doctype	topic
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

Section

required-permissions	write-access
title	Notes

Section

title	References

Tour

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description

Section

title	Resources

Tour

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description
Writing User Macros	User macros are useful if you want to create your own custom macros. These can be to perform specific actions, apply custom formatting and much more.
Confluence objects accessible from Velocity	Confluence has a few distinct Velocity contexts for different purposes in the application (user macros, email templates, and exports), but the most commonly used context is called the "default context".

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 2

New Version 3

Key

About

Keep up-to-date!

Powered by