DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:wikindx

wikindx plugin

Compatible with DokuWiki

  • 2020-07-29 "Hogfather" yes
  • 2018-04-22 "Greebo" unknown
  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown

plugin interact with a wikindx site

Last updated on
2021-11-10
Provides
Syntax
Repository
Source

Similar to refworks

Tagged with bibliography, quotes, references, wikindx

This plugin allows you to call a website made with WIKINDX to embed nice references, display quotes and provide the list of references accessed in this way.

Compatibility

This plugin is compliant with WIKINDX 6.5.1 and higher.

Usage

References

By putting things like {{wxcite>rid}} in your text (where rid is the resource id from the wikindx database), a reference to this work is displayed.

You can specify particular sections in that resource like this: {{wxcite>12345:place}}, where place can be a page number, a range of pages, a roman number, etc. just anything except for }} and ;.

You can specify several resources by separating them with a semicolon (';') like this:

{{wxcite>1234:1-4;5678:chapter 5}}

Which can give for example:

(1-4 Du Mesnil Du Buisson 1958, chapter 5 de La Hylais 1895–1990)

Bibliography

To create a list of all references used on this page, use the tag {{wxbib}} at the end of the page (i.e. after all the works that you want included have been cited).

Abstract, Notes

You can use {{wxnotes>rid}} and {{wxabstract>rid}} to display the notes and abstract fields of the resource with the id “rid”.

Quotes, Musings, Paraphrases

You can display quotes and such like this: {{wxquote>rid:number}}, {{wxmusing>rid:number}}, {{wxparaphs>rid:number}}. Here rid is the id a resource and number the index of a public quoted/paraphrased work again of that resource. It provides the possibility to select one of several quotes/musings.

Configuration

You have to use the Configuration Manager to set the base_url of your WIKINDX website and you preferred bibliography style.

If the main page of your personal WIKINDX website is https://mywikindx.fr/index.php you have to set the wikindx url parameter as https://mywikindx.fr/. That is, without the name of the index.php page, and keeping the “/” terminal.

Limitation

  • Depending on your installation, the rendering may be very slow or buggy (skipped formatting) if the web server of the WIKINDX site does not respond in time.
  • Only officials styles are supported.
  • The plugin is design for a single user WIKINDX / Dokuwiki installation.
  • Footnote styles are not rendering as footnotes in v1 of the plugin.
  • This plugin is still experimental.

License

This plugin is licensed under the terms of the GNU General Public License version 2.

Changes

  • 2021-10-12 – Finish v1 of the plugin for WIKINDX 6.5.1
  • 2013-01-21 – The wikindx4 developer has included some of the modifications suggested by this plugin into the development version. (Thanks a lot for this!) So instead of patching the released version, it is recommended to check out and use the svn version of wikindx4.
  • 2013-01-16 – Update for dokuwiki Release 2012-10-13 “Adora Belle” and wikindx v4.1. Also, there's new functionality: I have added the actions getAbstract, getNotes, getQuote, getParaphr, getMusing.

To Do

  • Provide switch to not insert a citation into the tracking array
  • Allow to put bibliography before all the citations?
plugin/wikindx.txt · Last modified: 2021-11-12 02:44 by LkpPo

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