1# bibtex4dw Plugin for DokuWiki 2 3Handling references stored in BibTeX (text) databases in DokuWiki. 4 5 6## What and why? 7 8**DokuWiki is an excellent tool for knowledge management** and has been successfully used in academic context for long time. However, **academics tend to use references to the literature** when managing their knowledge, and DokuWiki is missing appropriate tools here. 9 10Being familiar with using BibTeX both, as a bibliographic (text) database format and as an engine to format references in documents written using LaTeX, a plugin for DokuWiki understanding the BibTeX format and allowing to reference literature from within wiki pages seems an obvious choice. 11 12 13### Intended use cases 14 15* Literature references in an academic context 16* Reuse existing BibTeX databases 17 18 19### Core criteria 20 21* Works with larg(er) bibliographic databases (several thousand entries) 22* Allows to use string replacements (concrete example: abbreviated and full journal names) 23* Access to PDF files of the reference, as long as available locally and accessible by the currently logged-in unser (obeying ACLs) 24 25 26### Philosophy 27 28* Resilience: plain text files, no external dependencies, no database as permanent storage (only temporary, the "truth" is in the text files) 29* Unix philosophy (sort of): 30 * Write programs that do one thing and do it well. 31 * Write programs to work together. 32 * Write programs that handle text streams, because that is a universal interface. 33 34 35## Installation 36 37If you install this plugin manually, make sure it is installed in 38lib/plugins/bibtex/ - if the folder is called different it 39will not work! 40 41Please refer to http://www.dokuwiki.org/plugins for additional info 42on how to install plugins in DokuWiki. 43 44 45## Documentation 46 47All documentation for this plugin can (for the time being and in German) be found at: 48 49* https://till-biskup.de/de/software/dokuwiki/bibtex 50 51Eventually, the "official" documentation will live at https://www.dokuwiki.org/: 52 53* https://www.dokuwiki.org/plugin:bibtex4dw 54 55 56## Contributing 57 58Development of the plugin takes place primarily on GitHub: 59 60* https://github.com/tillbiskup/dokuwiki-bibtex 61 62Feel free to fork the repository, change it and submit pull requests. 63 64If you find some problems, open an issue on GitHub, and ideally provide a pull request with a possible solution. 65 66 67## Copyright and license 68 69Copyright (c) Till Biskup 70 71This program is free software; you can redistribute it and/or modify 72it under the terms of the GNU General Public License as published by 73the Free Software Foundation; version 2 of the License 74 75This program is distributed in the hope that it will be useful, 76but WITHOUT ANY WARRANTY; without even the implied warranty of 77MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 78GNU General Public License for more details. 79 80See the COPYING file in your DokuWiki folder for details 81