• View
• Edit
• History
• Print

Bib Options

 

The general markup for a bibliography block is:

(:bib <options> :)

: <key1> : <citation1>
: <key2> : <citation2>
...

(:bibend:)

A bibliography consists of up to 4 parts:

• citations referenced in the body of the page with cite(key) markup
• citations defined in the bib block but not referenced in the body
• citations referenced in the body but not defined in the bib block
• duplicate citation keys — the same key is used more than once in the bib block

Here are some of the commonly-used bib options. The bibliography automatically lists any duplicate keys used.

The default — no options specified

A plain (:bib:) ... (:bibend:) block generates author-year references, sorted by citation key. Unreferenced citations are omitted.

Equivalent to (:bib fmt=text sort=yes:). To suppress sorting, use sort=no.

Bibliography — turn the bib block into a reading list

The (:bib fmt=bib:) option, with no cite references on the page, lists the citations in the bib block, sorted by key. Any cited references are omitted.

Equivalent to (:bib fmt=bib sort=yes:).

Numbered references

A (:bib fmt=num:) ... (:bibend:) block generates numbered references, sorted and numbered in citation key order. Unreferenced citations are omitted.

Equivalent to (:bib fmt=num sort=yes:).

To sort and number citations in the order cited, use (:bib fmt=num sort=cite:).

Display referenced and unreferenced citations

A (:bib fmt=*:) ... (:bibend:) block generates author-year references and produces a separate list of unreferenced citations.

To sort just the references, add sort=ref. Or, to sort just the unreferenced citations, add sort=bib.

A (:bib fmt=#:) ... (:bibend:) block generates numbered references and produces a separate list of unreferenced citations. To sort the references in the order cited, add sort=cite.

Include citations from another page

A (:bib page=PageName:) block will include the citations defined in the bib block on PageName.

To include citations from more than one page, use (:bib page="Page1 Page2 ...":).

Abbreviate common text strings

A (:bib abbr=PageName:) block will translate strings in citations of the form {Term} into the string corresponding to “Term” on PageName, using :Term:Definition markup. Term must start with a capital letter and contain no spaces.

If the term is undefined, it is displayed as a link to a new term form.

List undefined references

A (:bib unk=unk:) block will look for any citations of undefined references and list them in alphabetical order at the end of the page.

Suppress output if no citations found

By default, the bibliography handler prints “none cited” if a page with a bib block contains no citations for defined references. A (:bib terse=terse:) block will suppress this message.

« less common cite options | User Guide | less common bib options »