xbFootnoteTag Package
Intro Page Doc Page

This page demonstrates the various display modes for xbFootnoteTag

For each of the examples we show it both with article text "reference" selected when the shortcode is inserted and again when no text is selected and the insert point is between the last two words.

We start with simple footnotes using text (title and description) from a tag.

This is a reference[1] using sequential numbering on the page to link to the footnote. And [2] again.

This reference [Goldsmith, 1992] uses the title for the link rather than a number. And [Goldsmith, 1992] again.

Now using a popover to display instead of a footnote. Good for online reading but not so good for printing or seeing a list of references as in a footnote are

This reference displays as a popover. When no text is selected the title is inserted to provide the hover link like [Jennings, 1985] this.

The best of both worlds is to have both popover and footnote display

This is a reference[5] using sequential numbering on the page to link to the footnote and also as a popover on the selected text. With numbering linking to the footnote for the popover we have to insert the title again if no text is selected like [Tainter, 1988][6] this.

This reference [Diamond, 2005] uses the title for the footnote link. The selected text is used for the popover, but if there is no selected text then the title has to serve both functions like  [Diamond, 2005] this.

Note that when the title is used for the footnote link the sequence number still shows in the footnote list, it just doesn't provide the link in the article text. So there may be gaps in the numbers showing in the article - in this case there is no [3] [4] [7] [8]. In real life you should aim to be consistent across the site and always use either sequence numbering, or title, for all footnote references. It's a style choice with no right answer.

When using tag text for the reference[9] you can append a plain text note to the end of the tag description. This is useful to add a page number or a personal note to the reference in this[Goldsmith, 1992][10] article

Both tag titles and appended text and plain text descriptions can only use simple bold and italic html formatting and basic line breaks. Any other html is stripped out. Tag descriptions can include html links and images and other formatting elements - but use with caution, the description is going to appear inside a list item <li> element so some things will be invalid or will mess up the footnote display. Tag descriptions used in popovers are stripped back to bold and italic elements only.

xbFootnoteTag doesn't have to use a tag for the source. For a one-off entry it may be easier just to enter title and text on-the-fly rather than having to predefine a tag.

Here is a reference[11] using plain text and a sequence number, and this is one with no selected [Another Side of...][12] text.

Another plain text reference [More] with the title used for the link. And [Andmoreagain] again.

If an article references the same item twice or more in succession then it is conventional to use "ibid" and optionally a different page reference rather than writing out the full text again.

Achieve this by using a tag reference[15] for the first instance and then a plain text reference[16] for the second and subsequent successive references[17] .

Of course you can use xbFootnoteTag for any other content that you want to appear as a footnote. If it is going to appear more than once on the site, or you want to be able to index articles containing the footnote then create it as a tag, if it is a one-off for a footnote then use plain text. For one-off text in a popover with no footnote you are better off using xbTipPop because that inserts the correct bootstrap popover code directly in the article and doesn't rely on a content plugin to work.

Examples of other uses include definitions of words like OpCit and ibid, explanation of acronyms like PHP

Other important points to note.

  • when using tags they need to be created before you use the button to insert them when editing the article. 
  • you preselect what tags can be used for footnotes in the plugin options. It makes sense to make all of your references child tags of a tag called "References" to make it easy to select them. Have another parent tag for "Acronyms" and so on.
  • if you unpublish or delete a tag used by xbFootnoteTag the {xbref...} shortcode will remain in any article but it will no longer work. It will not appear in the front-end display.
  • if you uninstall xbFootnoteTag then currently it will automatically remove all {xbref...} shortcodes from all articles so they don't mess up front-end display. Use versioning to restore them if you wish.
References & Footnotes
  1. Diamond, 2005: Jared Diamond, Collapse, How Societies Choose to Fail or Survive, Allen Lane Penguin Press, 2005
  2. Diamond, 2005: Jared Diamond, Collapse, How Societies Choose to Fail or Survive, Allen Lane Penguin Press, 2005
  3. Goldsmith, 1992: Edward (Teddy) Goldsmith, The Way, An Ecological World View, 
  4. Goldsmith, 1992: Edward (Teddy) Goldsmith, The Way, An Ecological World View, 
  5. Tainter, 1988: Joseph A Tainter, The Collapse of Complex Societies, CUP 1988
  6. Tainter, 1988: Joseph A Tainter, The Collapse of Complex Societies, CUP 1988
  7. Diamond, 2005: Jared Diamond, Collapse, How Societies Choose to Fail or Survive, Allen Lane Penguin Press, 2005
  8. Diamond, 2005: Jared Diamond, Collapse, How Societies Choose to Fail or Survive, Allen Lane Penguin Press, 2005
  9. Goldsmith, 1992: Edward (Teddy) Goldsmith, The Way, An Ecological World View, this is text appended to the description from the tag.
  10. Goldsmith, 1992: Edward (Teddy) Goldsmith, The Way, An Ecological World View, the appended text can include bold and italic tags but no others.
  11. My Title: Some simple text description, can include only bold and italic formats.
  12. Another Side of...: These are useful if you want a one-off simple footnote. If it is going to be reused either in the same article or elsewhere then you are better off creating a tag for it. By the way surely you know who had Another Side
  13. More: You might know who made the soundtrack album of this name, but can you name the director or stars of the eponymous film - did you see it back in the day?
  14. Andmoreagain: so can you name the album and artist associated with this title?
  15. Goldsmith, 1992: Edward (Teddy) Goldsmith, The Way, An Ecological World View, - pages 123-125
  16. ibid: page 42
  17. ibid: pp37-39