TxStyle · Textile Documentation

The Textile Markup Reference for Textpattern


Auto-numbered notes

Note citations for auto-numbered notes include a hash sign # and the note's label in square brackets. The notelist tag is used to indicate textile where to place the notes, and this is followed by the list of notes.



Input (editable)

Browser
HTML

More about: Auto-numbered notes

When referencing or citing sources in body text you can employ footnotes. But these are explicitly numbered, and if you therefore alter the order of the references (by inserting one or deleting/moving others) you must manually renumber all the footnotes in the article.

Using auto-numbered notes you can label references in your body text, set up a definition for each of those labels, and then display the list of references at a suitable place in your body text. Crucially, the numbers will be automatically assigned when you save the article and recalculated if necessary as you alter the document.

Also:

  1. References from the main body may be hyperlinked to the note list section or not — either globally or on a note-by-note basis
  2. Notes listed in the note list section can optionally backlink to the place(s) they were used. Again, you can globally control whether backrefs are employed and, if so, whether the backref is just the first occurrence of the reference or all cited references. You may also override the backrefs on a note-by-note basis

Note Citations

Referencing or citing a note is similar to a footnote citation — except that this time you must use a hash character (#) and the note’s label in the citation. The note label can include any of these characters: alphabetic, numeric, underscore, dash, or colon, and looks like this:

scientists say[#label] the moon is ...

If you wish to refer to a note without linking to it, then add an exclamation mark after the label:

scientists say[#label!] the moon is ...

If needed, you can give a note citation a class:

scientists say[(class)#label] the moon is ...

You can cite the same note as many times as you wish.

notelist Tag

The notelist tag tells textile where to place the list of references in your document.

By default the list will show only the notes which are actually referenced in your document, though you can also tell the notelist to include the unreferenced notes too using the ‘+’ modifier. You can also control the way the notes in the list link back to their citations. By default, all backlinks will be shown.

List Setting Shows
notelist. Notes with backlinks to every citation made to them.
notelist+. Notes with backlinks to every citation made to them, followed by the unreferenced notes.
notelist^. Notes with one backlink to the first citation made to each note.
notelist^+. Notes with one backlink to the first citation made to each note, followed by unreferenced notes.
notelist!. Notes with no backlinks to the citations.
notelist!+. Notes with no backlinks to the citations, followed by unreferenced notes.

Backlink sequence characters

References in a note list can show links from the note back to the citation in the text. By default, the letter used in this backlink is ‘a’. For notes that have multiple backlinks, each link is given the next letter in the alphabet. If you wish to use a different initial backlink character you can define the starting character before the list’s link setting (if any) like this:

notelist:α^+.

In this example, the greek alpha (α) will be the text of the first backlink, followed by greek beta (β) and so on. Any backlink starting character must preceed the list backlink setting and the unreferenced setting.

Notes

Each note has to start on its own line. Note references can incude citations to other notes, or even to footnotes should you wish to mix-n-match the two.

You can override the list’s link settings by appending a link override character to the end of any note’s label. Like this:

Note Setting Shows
note#somelabel!. Note with no back links.
note#somelabel^. Note with only the first back link.
note#somelabel*. Note with all the back links.

Credits

The foregoing text has been adapted from the developer’s documentation.

Paste code into the box above.

Further reading: Auto-numbered notes




PHP Textile v3.5.5


Donate Textpattern developers.