plugin:refnotes
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:refnotes [2014-12-11 09:07] – [Bibtex, reference to template] Fol | plugin:refnotes [2024-03-18 12:06] (current) – Wirbel78 | ||
---|---|---|---|
Line 4: | Line 4: | ||
description: | description: | ||
author | author | ||
- | 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 |
similar | similar | ||
tags : footnotes, references, formatting, bibtex | tags : footnotes, references, formatting, bibtex | ||
- | downloadurl: | + | downloadurl: |
- | bugtracker : http://code.google.com/p/dwp-forge/issues/list | + | bugtracker : https://github.com/ |
- | sourcerepo : http://code.google.com/p/dwp-forge/source/ | + | sourcerepo : https://github.com/ |
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 |
* 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: | ||
===== Download and Installation ===== | ===== Download and Installation ===== | ||
- | Download | + | Search |
- | * [[http:// | + | * [[https://github.com/ |
===== 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 | + | The RefNotes plugin |
+ | |||
+ | This interface allows to control some general settings, predefine commonly used namespace styles and notes (it's the only place to define [[plugin: | ||
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 " | ||
+ | |||
+ | |||
+ | ==== 2023-12-30 ==== | ||
+ | |||
+ | * Improved support for referencing electronic publications ('' | ||
+ | * Long author lists are automatically shortened in Harvard-style references. | ||
+ | * Added third option for '' | ||
+ | * Improved compatibility with [[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 " | ||
+ | |||
+ | |||
+ | ==== 2019-02-09 ==== | ||
+ | |||
+ | * Added new style for custom formatting of [[: | ||
+ | * 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 " | ||
+ | |||
+ | |||
+ | ==== 2017-02-28 ==== | ||
+ | |||
+ | * Added support for booktitle field in [[: | ||
+ | * Show author names in "Last, First Middle" | ||
+ | * 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/ | + | Please report bugs or feature requests at the [[https://github.com/ |
- | ===== Discussion ===== | + | ===== See Also ===== |
- | + | ||
- | See older topics on the [[plugin: | + | |
- | + | ||
- | ==== Eliminating multiple references? ==== | + | |
- | + | ||
- | I use RefNotes to add references to a bibliography. | + | |
- | + | ||
- | I've read the documentation several times, but cannot figure out how to eliminate it. | + | |
- | + | ||
- | Can anyone help? | + | |
- | + | ||
- | --- // | + | |
- | + | ||
- | ---------------------------------------------------------------------------------------------------- | + | |
- | + | ||
- | It heavily depends on what " | + | |
- | + | ||
- | --- [[user> | + | |
- | + | ||
- | ---------------------------------------------------------------------------------------------------- | + | |
- | + | ||
- | An actual example: I changed the first occurrence of %%[(Eek00)]%% to %%[(eekels> | + | |
- | + | ||
- | I wish I could understand what I was doing wrong. | + | |
- | + | ||
- | --- // | + | |
- | + | ||
- | ---------------------------------------------------------------------------------------------------- | + | |
- | + | ||
- | Change it back :-) | + | |
- | + | ||
- | In plugin terminology, | + | |
- | + | ||
- | --- [[user> | + | |
- | + | ||
- | --------- | + | |
- | + | ||
- | Ah-hah! | + | |
- | + | ||
- | --- // | + | |
- | + | ||
- | + | ||
- | ==== Alternative note database lookup ==== | + | |
- | + | ||
- | I had difficulties making the plugin work, so I fixed it to work on my system, see [[https:// | + | |
- | + | ||
- | + | ||
- | ==== Structured references ==== | + | |
- | + | ||
- | why i cant get it work like this [[plugin: | + | |
- | + | ||
- | ---------------------------------------------------------------------------------------------------- | + | |
- | + | ||
- | 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? | + | |
- | + | ||
- | ---------------------------------------------------------------------------------------------------- | + | |
- | + | ||
- | I have problems rendering structured text. I have used some of the examples, just to test: | + | |
- | + | ||
- | < | + | |
- | < | + | |
- | refnote-id | + | |
- | reference-base | + | |
- | reference-format : [] | + | |
- | note-id-format | + | |
- | note-id-base | + | |
- | </ | + | |
- | + | ||
- | [(HarvRefSys>> | + | |
- | note-text : Harvard System of Referencing Guide | + | |
- | url : http:// | + | |
- | )] | + | |
- | + | ||
- | [(KnuthAoP2>> | + | |
- | author | + | |
- | title : Arts of Programming, | + | |
- | edition | + | |
- | published | + | |
- | publisher | + | |
- | note-pages : xiv + 762 pp. | + | |
- | isbn : 0-201-89684-2 | + | |
- | url : http:// | + | |
- | )] | + | |
- | + | ||
- | The subject of random number generation and has been extensively studied in computer science [(HarvRefSys)] and [(KnuthAoP2)]. | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | 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:// | + | |
- | + | ||
- | [2] > author : Donald Knuth title : Arts of 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 // | + | |
- | + | ||
- | ---------------------------------------------------------------------------------------------------- | + | |
- | + | ||
- | 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> | + | |
- | + | ||
- | + | ||
- | ==== 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 // | + | |
- | + | ||
- | < | + | |
- | <code bibtex> | + | |
- | @Article{Bezivin2004, | + | |
- | Title = {In Search of a Basic Principle for Model Driven Engineering}, | + | |
- | Author | + | |
- | Year = {2004}, | + | |
- | + | ||
- | Abstract | + | |
- | } | + | |
- | </code > | + | |
- | </ | + | |
- | + | ||
- | I tried to get a reference to that with something like < | + | |
- | </ | + | |
- | --- [[user> | + | |
- | + | ||
- | ---------------------------------------------------------------------------------------------------- | + | |
- | + | ||
- | First make sure that reference database is enabled in the plugin [[plugin: | + | |
- | + | ||
- | > 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 '': | + | |
- | + | ||
- | Since you didn't specify any namespace for '' | + | |
- | + | ||
- | > 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 = " | + | |
- | } | + | |
- | </ | + | |
- | + | ||
- | and use '' | + | |
- | ---- | + | |
- | It was a namespace problem indeed, adding the " | + | |
- | + | ||
- | Thanks for your time! (and I should definitely learn to read...) --- [[user> | + | |
- | ===== See also ===== | + | |
* [[plugin: | * [[plugin: |
plugin/refnotes.1418285270.txt.gz · Last modified: 2014-12-11 09:07 by Fol