Content Formatting Macros for Confluence Server and DC

BibTeX Referencing

The BibTeX Referencing Macro and the BibTeX Display Macro enabled BibTeX style references to be displayed as links on a page, and within a searchable and sortable table in a set location on the same page.

This can be useful when transferring a LaTeX document to Confluence, which includes a list of references formatting using BibTeX.

Please note that this macro requires some previous knowledge of using LaTeX and BibTeX.

Usage

  1. Go to the form you wish to edit.

  2. Click Edit

  3. Click Insert More Content, and select Other Macros.

  4. This will take you to the Macro Browser, where you can search and select the BibTeX Referencing Macro or BibTeX Display Macro from the list.

    bibtex 02

Parameters

If references are not properly formed following BibTeX convention then the BibTeX display table macro will show a warning message. Note that only the following BibTeX entry types are supported:

  • article

  • book

  • booklet

  • conference

  • inbook

  • incollection

  • inproceedings

  • manual

  • masterthesis

  • misc

  • phdthesis

  • proceedings

  • techreport

  • unpublished

There are three parameters that can be set for the BibTeX Referencing Macro. These are as follows:

bibtex 03
Parameter Description Type Default Required

Reference

The BibTeX form of the reference to be displayed

string

check

Type

Specify the type of reference link that will be displayed. The options include "number" or "author".

enum

number

error

Author Name

If reference type is "author", include text to be displayed as the link, e.g. Howard et al (2017). This is required if "author" is selected as type.

string

error

The BibTeX Referencing Macro will be displayed on the page as shown below. It should be positioned in the desired location of the reference link, within the text, and will appear inline.

bibtex 04

The BibTeX Display Macro does not have any parameters. It will be displayed on the page as shown below.

bibtex 05

Examples

Below are examples of setting the parameters for the BibTeX Referencing macro.

Number Reference Parameters

bibtex 06

Author Reference Parameters

bibtex 07

This will be displayed on the page as shown below.

bibtex 08

If the type has been set to "number", the link will be displayed as follows.

bibtex 09

If the type has been set to "author", the link will be displayed as follows.

bibtex 10

Bibliography Display

The BibTeX Display macro will display a table of references, based on each BibTeX Referencing macro included on the page, in the position of the macro itself. This will generally be at the bottom of the same page. It will be displayed as follows.

bibtex 11