DokuWiki

It's better when it's simple

User Tools

Site Tools

Trace:
plugin:refnotes

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
plugin:refnotes [2014-12-11 09:07] – [Bibtex, reference to template] Folplugin:refnotes [2024-03-18 12:06] (current) – Wirbel78
Line 4: Line 4:
 description: Extended syntax for footnotes and references description: Extended syntax for footnotes and references
 author     : Mykola Ostrovskyy author     : Mykola Ostrovskyy
-email      : spambox03@mail.ru+email      : dwpforge@gmail.com
 type       : syntax type       : syntax
-lastupdate : 2012-07-15 +lastupdate : 2024-02-12 
-compatible : 2009-12-25c, 2010-11-07, rincewind, angua, Weatherwax,Ponder Stibbons+compatible : Hrun, Detritus, Greebo, Hogfather, Igor, Jack Jackrum, Kaos
 depends    :  depends    : 
-conflicts  : +conflicts  : OpenLayersMap
 similar    :  similar    : 
 tags       : footnotes, references, formatting, bibtex tags       : footnotes, references, formatting, bibtex
-downloadurl: http://dwp-forge.googlecode.com/files/refnotes-2012-07-15.zip +downloadurl: https://github.com/dwp-forge/refnotes/archive/v.2024-02-12.zip 
-bugtracker : http://code.google.com/p/dwp-forge/issues/list +bugtracker : https://github.com/dwp-forge/refnotes/issues 
-sourcerepo : http://code.google.com/p/dwp-forge/source/browse/+sourcerepo : https://github.com/dwp-forge/refnotes
 donationurl: donationurl:
- 
 ---- ----
  
-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:+The RefNotes plugin is an extension for build-in DokuWiki [[wiki:syntax#footnotes|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).   * Multiple independent note classes on the same page (e.g. citations, footnotes, etc).
   * Customizable look of the references and notes.   * Customizable look of the references and notes.
   * Render the notes at any place on the page, not only at the very bottom.   * 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.   * Often used notes (e.g. book references) can be shared between different pages.
 +  * Bibliographical elements stored in separate namespace(s) that can be referenced by name ([[plugin:refnotes:structured|Structured References]]).
  
  
 ===== Download and Installation ===== ===== Download and Installation =====
  
-Download and install the plugin using the [[plugin:plugin|Plugin Manager]] using the following URL. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
-  * [[http://dwp-forge.googlecode.com/files/refnotes-2012-07-15.zip|refnotes-2012-07-15]]+  * [[https://github.com/dwp-forge/refnotes/archive/v.2024-02-12.zip|refnotes-2024-02-12]]
  
  
 ===== Syntax ===== ===== Syntax =====
  
-{{ http://img223.imageshack.us/img223/8338/refnotes.png?300}}+{{ https://images2.imgbox.com/28/28/l6HgxXv0_o.png?300}}
  
 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: 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:
Line 65: Line 65:
 ===== Configuration ===== ===== 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 [[plugin:refnotes:syntax#Inline notes|inline notes]]). The predefined namespaces and notes are available on any wiki page without explicit declaration.+The RefNotes plugin has a complex configuration that is not embedded into the dokuwiki configuration page. It has its own configuration interface which is made available by a separate link named "RefNotes Configuration" on the main administration page. 
 + 
 +This interface allows to control some general settings, predefine commonly used namespace styles and notes (it's the only place to define [[plugin:refnotes:syntax#Inline notes|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. The configuration page heavily uses JavaScript, so it must be enabled or the page will be completely useless.
Line 71: Line 73:
  
 ===== Version History ===== ===== Version History =====
 +
 +==== 2024-02-12 ====
 +
 +  * Fixed compatibility with DokuWiki 2024-02-06 "Kaos".
 +
 +
 +==== 2023-12-30 ====
 +
 +  * Improved support for referencing electronic publications (''format'' and ''accessed'' fields).
 +  * Long author lists are automatically shortened in Harvard-style references.
 +  * Added third option for ''note-font-size''.
 +  * Improved compatibility with [[plugin:include|Include plugin]].
 +  * Minor fixes.
 +
 +
 +==== 2021-05-23 ====
 +
 +  * Fixed compatibility with PHP8.
 +  * Fixed merging of root namespace.
 +  * Updated admin page JavaScript (requires ES6 support).
 +
 +
 +==== 2020-08-10 ====
 +
 +  * Fixed compatibility with DokuWiki "Hogfather". The fixes are not backward compatible, so with DokuWiki "Greebo" use the [[https://github.com/dwp-forge/refnotes/tags|previous version]].
 +
 +
 +==== 2019-02-09 ====
 +
 +  * Added new style for custom formatting of [[:plugin:refnotes:style#Reference grouping (reference-group)|reference groups]].
 +  * Added support for starting extended note names with a digit.
 +  * Sorting of note blocks is based on order of referencing.
 +  * Updated configuration interface.
 +  * Fixed rendering of references at the start of a paragraph.
 +  * Fixed handling of ref-authors in BibTeX note definitions.
 +
 +
 +==== 2018-05-01 ====
 +
 +  * Fixed compatibility with DokuWiki "Greebo".
 +
 +
 +==== 2017-02-28 ====
 +
 +  * Added support for booktitle field in [[:plugin:refnotes:structured|structured references]]. (rwduzhao)
 +  * Show author names in "Last, First Middle" form as "First Middle Last". (rwduzhao)
 +  * Added basic ODT export for references. (Veelz)
 +  * Use standard DokuWiki directories for storing database cache and configuration files.
 +
 +
 +==== 2016-08-12 ====
 +
 +  * Fixed BibTeX note name handling.
 +
 +
 +==== 2016-02-27 ====
 +
 +  * Fixed PHP 7 compatibility.
  
  
Line 114: Line 174:
  
  
-===== Bugs / Feature Requests =====+===== Bugs and Feature Requests =====
  
-Please report bugs or feature requests at the [[http://code.google.com/p/dwp-forge/issues/list|bug tracker]].+Please report bugs or feature requests at the [[https://github.com/dwp-forge/refnotes/issues|bug tracker]].
  
  
-===== Discussion ===== +===== See Also =====
- +
-See older topics on the [[plugin:refnotes:discussion|discussion archive]] page. +
- +
-==== Eliminating multiple references? ==== +
- +
-I use RefNotes to add references to a bibliography.  It works //great// but for one thing: if I have multiple occurrences of %%[(xxx)]%% in a page, then I get multiple occurrences of it in the bibliography (REFNOTES) section. +
- +
-I've read the documentation several times, but cannot figure out how to eliminate it. +
- +
-Can anyone help? +
- +
---- //[[salustri@ryerson.ca|Fil Salustri]] 2013/07/28 20:45// +
- +
----------------------------------------------------------------------------------------------------- +
- +
-It heavily depends on what "xxx" stands for. If it is literally "xxx" then I would suggest to use [[plugin:refnotes:syntax#named_notes|named notes]]: first reference is %%[(x3>xxx)]%% and all subsequent ones %%[(x3)]%%. +
- +
---- [[user>pan One|Mykola Ostrovskyy]] //2013/08/02 21:14// +
- +
----------------------------------------------------------------------------------------------------- +
- +
-An actual example: I changed the first occurrence of %%[(Eek00)]%% to %%[(eekels>Eek00)]%%.  I left all other occurrences unchanged.  You can see what I get at the bottom of  http://deseng.ryerson.ca/dokuwiki/research:design_science. +
- +
-I wish I could understand what I was doing wrong. +
- +
---- //[[salustri@ryerson.ca|Fil Salustri]] 2013/08/05 19:53// +
- +
----------------------------------------------------------------------------------------------------- +
- +
-Change it back :-) +
- +
-In plugin terminology, those things that are repeated in the notes block are called back-references. Your problem seems to be that you use ''back-ref-format: note'' (the default). Try to play with [[plugin:refnotes:style#back_reference_formatting_back-ref-format|other styles]] that are available for ''back-ref-format''. For example, ''back-ref-format: a; back-ref-base: sup; note-id-font-weight: bold'' might look better.  +
- +
---- [[user>pan One|Mykola Ostrovskyy]] //2013/08/06 22:09// +
- +
---------- +
- +
-Ah-hah!  I get it now.  Thanks for your patience.  Problem resolved. +
- +
---- //[[salustri@ryerson.ca|Fil Salustri]] 2013/08/06 18:52// +
- +
- +
-==== Alternative note database lookup ==== +
- +
-I had difficulties making the plugin work, so I fixed it to work on my system, see [[https://github.com/eroux/dokuwiki-plugin-refnotes/|here]]  --- [[user>eroux|Elie Roux]] //2013/10/10 18:20// +
- +
- +
-==== Structured references ==== +
- +
-why i cant get it work like this [[plugin:refnotes:structured]]? i want a box with references info like on wikipedia people and books   --- [[user>mona|Mona Texy]] //2014/04/05 11:20// +
- +
----------------------------------------------------------------------------------------------------- +
- +
-You have to be more specific if you want to get some help. What are you doing? What do you expect to get? What do you get instead?  --- [[user>pan One|Mykola Ostrovskyy]] //2014-05-23 08:42// +
- +
----------------------------------------------------------------------------------------------------- +
- +
-I have problems rendering structured text. I have used some of the examples, just to test: +
- +
-<code> +
-<refnotes> +
-refnote-id       : 1 +
-reference-base   : text +
-reference-format : [] +
-note-id-format   : [] +
-note-id-base     : text +
-</refnotes> +
- +
-[(HarvRefSys>> +
-note-text : Harvard System of Referencing Guide +
-url       : http://libweb.anglia.ac.uk/referencing/harvard.htm +
-)] +
- +
-[(KnuthAoP2>> +
-author     : Donald Knuth +
-title      : Arts of Programming, Volume 2: Seminumerical Algorithms +
-edition    : Third Edition +
-published  : 1997 +
-publisher  : Addison-Wesley +
-note-pages : xiv + 762 pp. +
-isbn       : 0-201-89684-2 +
-url        : http://en.wikipedia.org/wiki/The_Art_of_Computer_Programming +
-)] +
- +
-The subject of random number generation and has been extensively studied in computer science [(HarvRefSys)] and [(KnuthAoP2)]. +
-</code> +
- +
- +
-What I get is  +
- +
-###### +
- +
-The subject of random number generation and has been extensively studied in computer science [1] and [2]. +
- +
-[1] > note-text : Harvard System of Referencing Guide url : http://libweb.anglia.ac.uk/referencing/harvard.htm +
- +
-[2] > author : Donald Knuth title : Arts of Programming, Volume 2: Seminumerical Algorithms edition : Third Edition published : 1997 publisher : Addison-Wesley note-pages : xiv + 762 pp. isbn : 0-201-89684-2 url : http://en.wikipedia.org/wiki/The_Art_of_Computer_Programming +
- +
-###### +
- +
-The citations in the text are ok, but the text in the references is not what I'm expecting. +
- +
-What am I doing wrong? +
- +
---- Miguel //2014/05/16 13:49// +
- +
----------------------------------------------------------------------------------------------------- +
- +
-It looks like you are using an old version of the plugin. Just tried fresh install of DokuWiki 2014-05-05 with RefNotes 2012-07-15 -- looks okay. --- [[user>pan One|Mykola Ostrovskyy]] //2014-06-17 08:07// +
- +
- +
-==== Bibtex, reference to template ==== +
- +
-I really love your plugin, it could be exactly what I need. I'm trying to get it work with bibtex references. I have created a file in //wiki/data/pages/refnotes/biblio// containing a Bibtex reference inside "code Bitex" snipets. : +
- +
-<code> +
-<code bibtex> +
-@Article{Bezivin2004, +
-  Title                    = {In Search of a Basic Principle for Model Driven Engineering}, +
-  Author                   = {Jean Bézivin}, +
-  Year                     = {2004}, +
- +
-  Abstract                 = {In November...} +
-} +
-</code > +
-</code> +
- +
-I tried to get a reference to that with something like <code>[(:refnotes:biblio:Bezivin2004)] +
-</code>, but whithout any success... Any ideas ? +
- --- [[user>fol|Nils B.]] //2014/12/08 22:30// +
- +
----------------------------------------------------------------------------------------------------- +
- +
-First make sure that reference database is enabled in the plugin [[plugin:refnotes#configuration|configuration]] and its namespace is set to '':refnotes:''. Then read [[plugin:refnotes:refdb|reference database documentation]] page, namely where it says: +
- +
-> Do not confuse this namespace (part of DokuWiki page name) with namespaces of notes (RefNotes formatting) defined on the page --- they are completely independent. For example, on '':refnotes:programming'' page you can define a note called '':ref:Knuth68''. In order to reference this note from some other page you should refer to '':ref:Knuth68''. +
- +
-Since you didn't specify any namespace for ''Bezivin2004'' note, it falls into the root namespace. If you even consider using BibTeX, I guess, that wasn't the intention. Again, read the [[plugin:refnotes:refdb#bibtex|documentation]]: +
- +
-> The namespace can be either specified as part of the entry key or in a separate comment. The namespace specified in the comment is used for all following entries within the current code block that do not have namespace specified explicitly. +
- +
-So I would recommend to start your BibTeX page with +
- +
-<code bibtex> +
-@Comment{refnotes, +
-  namespace = "biblio" +
-} +
-</code> +
- +
-and use ''[(:biblio:Bezivin2004)]'' to add references to the note. --- [[user>pan One|Mykola Ostrovskyy]] //2014-12-10 23:44// +
----- +
-It was a namespace problem indeed, adding the "@Comment{...}" had it working. +
- +
-Thanks for your time! (and I should definitely learn to read...) --- [[user>fol|Nils B.]] /2014-12-10 09:07// +
-===== See also =====+
  
   * [[plugin:refnotes:syntax|Syntax]]   * [[plugin:refnotes:syntax|Syntax]]
plugin/refnotes.1418285270.txt.gz · Last modified: 2014-12-11 09:07 by Fol
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

Global DokuWiki Links