Versions Compared

Key

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

...

The different macros explained

Image

Macro name(s)

What it does

Image Modified

Single

cite

Cite

A single cite (e.g. the reference to a book) is reflected by

that

this macro.

It consists out of

You have to specify a unique ID, an optional

page range and the reference itself - like: ID: Miller92, pages: 1-10, reference: Miller, "The art of citation", London 1992. Unique ID and page range are parameters of the macro which you have to enter when you add the macro. The reference has to be specified in the macro body (the white part of the box) what allows you to add formatting, links etc

location (like a page number) and can select some options:

  • Use superscript: If checked the number will be displayed as superscript

  • Define only: If checked a hidden cite definition is generated that can be referenced later

  • Bibliography output: If checked output the output will be in the format citeID: cite. This option is suitable when building bibliography pages. This option overrides other output options.

The actual citation must be entered in the macro body - you can define any markup Confluence allows.

Note

This macro was one of the main macros used before Atlassian introduced their new editor. Since then the macro suffers from the inline-rendering issue which is (up to now) not fixed by Atlassian. Please avoid using this macro unless you want to define a citation bucket somewhere.

Image Modified

Single

cite plain

Cite Basic

This macro offers

the same

a similar functionality as the one above but only allows

to define plain text cites without any

limited formatting. This macro was introduced to mitigate the inline-rendering issue mentioned above.

You can add internal and external links to a plain cite.

Image Modified

Single

cite short

Cite Short

Once a cite has been fully qualified by the single cite macro it is possible to use that macro to refer to the same reference again just using the unique ID and the page-range if needed.

Image Modified

DOI Cite

With the DOI cite macro you can refer to a DOI (Digital Object Identifier) which automatically gets rendered in the specified CSL style (e.g. apa).

The DOI 10.1109/VETECS.2010.5493979 requested in apa CSL style results in:

Kusume, K., Dietl, G., Abe, T., Taoka, H., & Nagata, S. (2010). System Level Performance of Downlink MU-MIMO Transmission for 3GPP LTE-Advanced. 2010 IEEE 71st Vehicular Technology Conference. doi:10.1109/vetecs.2010.5493979

Image Modified

BibTeX File Cite

BibTeX Direct Cite

The BibTeX File Cite macro allows you to reference to a cite provided in a BibTeX file (*.bib). Simply specify the bib-file and provide the cite ID from the bib-file. You also have to define the CSL style (e.g. apa).

(info) You can select bib-files attached to any Confluence page or specify an URL. When using an URL please note that only https-connections are accepted.

The BibTeX Direct Cite macro allows you to enter a single BibTeX cite directly.

Image Modified

Single

cite import

Cite Import

You may use this macro to refer to a cite you defined on another Confluence page. Simply select the page you want to import the cite from and specify the ID of the cite.

Image Modified

Cite Summary

At the end of a page containing cites you will probably want to have a reference section which shows you all the references you made in the article. This is achieved by the Cite Summary Macro.

Image Modified

Space

cite summary

Cite Summary

The space cite summary macro allows you to specify a list of spaces (comma-separated list of space keys) and then shows all cites used in these spaces. The table generated allows to get an overview of e.g. which pages refer to a certain reference like a standard.

Image Modified

BibTeX

listing

Listing

Show a listing of all BibTeX cites of the given bib-file.

(info) Please note that the BibTeX listing is rendered when you insert it. Subsequent changes of the bib file to not change the listing unless you update the macro-

Tips for creating a bibliography

...

Stay tuned 🔜

Frequent support cases

Observation/Question

Explanation/Answer

PDF/Word export times out

In case you have many cites (> 100) on a page it might happen that the generation of a PDF or Word document times out. The reason is that Confluence Cloud requests each cite in a row not parallel. There is currently no mitigation.

Migration from Server or Data Center

Please refer to migration guide for further details.

We continuously amend this list.

...