Cite Macro

...

Document Properties Marker

doctype	macro
override	false

Short Description

Renders a cite to a resource document.

Doctype

macro

hide

Name

Cite Macro

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true

Tags

Tag List

names	Quote

Iteration


value	production

hide

Sort Key

hide

Section

index	true
show-title	false
title	Description

The Cite Macro helps to render cites of resources in a standard manner. While it is easy within the Confluence wiki to add references to pages, a cite asks for more. You may want to add the title of a book, the authors and the page.

This is the template used by the macro to render cites:

Panel
$[Name] (${Authors}, ${page})

Section

title	Properties

Section

title	Document

The Resource document to reference. Leave blank, if the citation refers to current resource document.

Section

title	Template

The template to render the values. If you do not specify a page (refer to 'Source Page'), remove the page from the template.

This is the format of the template:

Panel
$[Name] (${Authors}, ${page})

Section

title	Tooltip

The text entered with this parameter is rendered as a tooltip. If no tooltip is specified, the short description of the referenced resource document is used as a tooltip.

A blank value (e.g. a single space) will instruct the macro to render no tooltip.

Version Box

since	4.5

This parameter is supported since version 4.5.

Section

title	Source Page

The page within the resource the citation points to. Usually this takes the form

p. 42
p. 23f
p. 23ff
p. 23-42.

Section

title	Default Value

The default value to render, if the template resolves to a blank value.

Usually the default is a blank value. Set it to a non-blank to make sure that a template resolving to nothing is rendered with an alert message.

Section

title	Details

Section

index	true
title	Related macros

The following macros help with citing or quoting resources:

Display Table

doctype	macro
render-no-hits-as-blank	true
select	Name, Short Description
sort-by	Sort Key, Name
where	Categories = "Resource / Cite"
exclude-self	true

...

Section

title	References

Section

title	Resources

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-macro
Type	resource

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 4

New Version 5

Key

About

Keep up-to-date!

Powered by