DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:refnotes

RefNotes Plugin

Compatible with DokuWiki

  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" yes
  • 2014-05-05 "Ponder Stibbons" yes

plugin Extended syntax for footnotes and references

Last updated on
2016-08-12
Provides
Syntax
Repository
Source

The RefNotes plugin is an extension for build-in DokuWiki footnotes syntax. In addition to the basic footnotes functionality it provides a number of extra features, most notably:

  • Multiple independent note classes on the same page (e.g. citations, footnotes, etc).
  • Customizable look of the references and notes.
  • Render the notes at any place on the page, not only at the very bottom.
  • Often used notes (e.g. book references) can be shared between different pages.

Download and Installation

Download and install the plugin using the Plugin Manager using the following URL. Refer to Plugins on how to install plugins manually.

Syntax

There are two major parts of the syntax: references and note blocks. The references are used in a text body to define a note and during rendering are replaced with a short link. The basic reference syntax is similar to the footnotes:

Here goes the reference[(This is a note.)].

Apart from the basic functionality provided by footnotes, the references have a number of extra features:

  • Better support for multiple references to the same note.
  • You can name a note and later refer to it by name from another reference. The named notes can be shared between different pages via the reference database.
  • The notes can be grouped into namespaces. For example, you can keep footnotes apart from bibliographical references.
  • References can be hidden from rendering and used only to define the note text. This can be convenient if you want to keep the notes apart from the main text body.

The note blocks indicate a page location where text of the notes will be rendered. They are optional and if there are no explicit note blocks on the page, all notes will be rendered at the end of the page. The minimal syntax for the note block is:

~~REFNOTES~~

Apart of specifying the notes location the note blocks can be used to:

  • Render notes from a certain namespace.
  • Render only part of the notes. For example, this can be used to render the notes in multiple columns.
  • Change formatting of the references and the note blocks.

For more details on the extended syntax see the complete syntax description.

Configuration

The RefNotes plugin has its own configuration interface that is available from the administration page. This interface allows to control some general settings, predefine commonly used namespace styles and notes (it's the only place to define inline notes). The predefined namespaces and notes are available on any wiki page without explicit declaration.

The configuration page heavily uses JavaScript, so it must be enabled or the page will be completely useless.

Version History

2016-08-12

  • Fixed BibTeX note name handling.

2016-02-27

  • Fixed PHP 7 compatibility.

2012-07-15

  • Added support for structured references.
  • Added BibTeX syntax support in the reference database.
  • Added Data plugin support in the reference database.
  • Added selection of rendering style for structured references and notes.
  • Added support for merging multiple namespaces into a single note block.
  • Improved handling of note names. The names are no longer limited to alpha-numeric characters.
  • Improved control over inline note formatting.
  • Fixed non-operational configuration UI on some webhost servers.
  • Fixed compatibility with DokuWiki Angua.
  • Fixed a couple of minor issues.

2010-04-05

  • Added support for structured note definition in the reference database.
  • Added note text alignment style.
  • Improved detection of hidden notes.
  • Fixed handling of references inside of list items.
  • A number of fixes in handling of database references.

2009-10-11

  • Fixed ignoring of the settings from General section.
  • Fixed a couple of minor issues.

2009-09-12

  • Fixed disabled configuration UI on DokuWiki installations that use URL rewriting.
  • Fixed a number of minor issues.

2009-08-01

  • First public release

Bugs and Feature Requests

Please report bugs or feature requests at the bug tracker.

See Also

plugin/refnotes.txt · Last modified: 2016-08-12 08:58 by pan One