DokuWiki

It's better when it's simple

User Tools

Site Tools

Trace:
devel:ideas:dokutexit

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
devel:ideas:dokutexit [2012-02-20 21:05] – [Mentors] HåkanSdevel:ideas:dokutexit [2012-03-09 00:22] (current) – Restructured the page Michitux
Line 1: Line 1:
 ====== DokuTeXit plugin ====== ====== DokuTeXit plugin ======
  
-There is a [[plugin:dokutexit|LaTeX export plugin]] that hasn't been updated for 4 years and seems to be unmaintained. It would be nice to clean it up and make it fully work with the current DokuWiki version. Further steps could include adding support for BibTeX (or one of the existing BibTeX plugins) so DokuWiki could be used for scientific publishing, note taking etc. (and a LaTeX export is also nice for printing and creating all kinds of good-looking documents). I ([[user>michitux]]) have created a [[https://github.com/michitux/dokuwiki-plugin-dokutexit|repository at GitHub]] for DokuTeXit with some tiny improvements, feel free to use it as starting point if you want to.+There is a [[plugin:dokutexit|LaTeX export plugin]] that hasn't been updated for some years. It would be nice to clean it up and make it fully work with the current DokuWiki version. Further steps could include adding support for BibTeX (or one of the existing BibTeX plugins) so DokuWiki could be used for scientific publishing, note taking etc. (and a LaTeX export is also nice for printing and creating all kinds of good-looking documents). [[user>michitux|Michael Hamann]] has created a [[https://github.com/michitux/dokuwiki-plugin-dokutexit|repository at GitHub]] for DokuTeXit with some tiny improvements, feel free to use it as starting point if you want to.
  
 The idea for this project was born after watching a screencast about [[http://vimeo.com/25295002|researchr]], so watching it might give you an idea of the background. There are some things shown there that can't be integrated into DokuWiki, but there are some parts like the citation management that can. The idea for this project was born after watching a screencast about [[http://vimeo.com/25295002|researchr]], so watching it might give you an idea of the background. There are some things shown there that can't be integrated into DokuWiki, but there are some parts like the citation management that can.
  
-===== Discussion of this idea =====+===== Details =====
  
-  * Panel Administration: +Some ideas for features:
-    * Define header of document (packages, new commands, etc) +
-    * Define footer +
-    * For scientific publications choose ACM or IEEE template +
-  * All stuffs about Latex: +
-    * Add new buttons to toolbar (to add some math function or something very specific of Latex but not of DW) +
-      * There are already existing math plugins, some of them use LaTeX syntax and render it using JavaScript. My suggestion would be to add LaTeX export support to one or more of these plugins in order to not to require external dependencies on the server  --- [[user>Michitux|Michael Hamann]] //2012/02/05 15:47// +
-    * Export to latex files or PDF (I like much more the PDF option) +
-      * What is the best way to do that, convert DW files into Latex files and compile to generate PDF? +
-      * How can user see the log if happens a error during compilation? +
-      * My suggestion would be to concentrate on LaTeX (by using a LaTeX renderer that can be taken and extended from dokutexit) and generate the PDF only optionally and offer instead a zip download that contains everything that's needed for generating the PDF (i.e. all referenced images, BibTeX files, ...) and as optional option add the possibility to generate a PDF using pdflatex. The log could be displayed in some kind of popup, e.g. using a jQuery ui dialog. --- [[user>Michitux|Michael Hamann]] //2012/02/05 15:47// +
-    * Bibtex page (example if we write a paper at namespace X bibtex page can be locate at X:bib) but if we write a paper which depend some other pages located in other namespace? +
-      * There are already various BibTeX plugins. I searched for them some months ago and made a small list of them  (--- [[user>Michitux|Michael Hamann]] //2012/02/05 15:47//): +
-        * https://github.com/ip1981/dokuwiki-plugin-papers - reads (existing) BiBTeX files and displays data from them or renders BiBTeX code in a page - look pretty simple and clean +
-        * [[plugin:publist]] Reads and searches in existing BiBTeX files, a wrapper around [[http://lmazy.verrech.net/bib2tpl/|bib2tpl]] +
-        * [[plugin:refnotes]] Adds advanced syntax for references inside wiki pages and also a reference database that is built from simple tables inside a certain namespace using a simple (serialized PHP) database. It does not support BiBTeX yet, but it is planned. +
-        * [[http://hodique.info/projects/bibtex_plugin|BiBTeX plugin]] - reads BiBTeX data that is stored in wiki pages, displays them either as list or displays one single reference from the data, uses a simple template page to display the data for a reference. +
-        * [[plugin:datatemplate]] - "Only" a plugin for templates for displaying data that is stored using the data plugin, but look at the [[plugin:datatemplate#Demonstration]] - it shows mostly what I imagine +
-      * My ([[user>michitux|Michael Hamann]]) ideas concerning BibTeX support: +
-        * For each reference there is one page it is defined on using BibTeX syntax, the data is stored in some kind of database or also the DokuWiki metadata index +
-        * A toolbar button allows to quickly insert references, these references link to the page where they are defined on +
-        * A syntax displaying information about individual citations or for displaying lists of citations +
-        * There should be a bookmarklet for easily new reference pages for websites or BibTeX snippets from journal pages, wikipedia pages, ... +
-        * The LaTeX export should be supported by generating a BibTeX file containing all references on a page or all references or references that match a certain criteria and for the LaTeX export, these links to reference pages should be replaced by LaTeX citations.+
  
-  * Compile in cloud +  * Support different kinds of headers (packages, new commands, etc) and footers for different kinds of documents that can be defined in the admin backend or using wiki pages 
-    * Might be an interesting option for offering a quick PDF download that doesn't depend on any external dependencies on the server itself  --- [[user>Michitux|Michael Hamann]] //2012/02/05 16:42//+  * Define templates for scientific publications 
 +  * A way to either directly enter LaTeX code that will be just used for the LaTeX document or also displayed in the normal page e.g. for math formulas, there are also existing DokuWiki plugins that use JavaScript for rendering LaTeX formulas, maybe one could add LaTeX export support to one of them 
 +  * Export formats. Maybe something like a ZIP file with everything ready for running LaTeX in it or an option to run LaTeX on the server and directly download the PDF. Maybe a cloud service could be used/created for rendering LaTeX documents so no LaTeX installation on the server will be needed. 
 +  * Error handling. There should be an easy way to see errors that occur while generating a PDF. 
 +  * BibTeX support: 
 +    * One page for each reference (or optionally more than one reference on a page?) 
 +    * Citations are managed in some database or the DokuWiki metadata index 
 +    * Syntax for displaying a link with a tooltip for a citation (in LaTeX export a LaTeX citation) 
 +    * Syntax for displaying individual citation information or a list of resources matched by some criteria 
 +    * A toolbar button for quickly inserting this syntax. 
 +    * Export citations in BibTeX format, also bundled with the LaTeX document all citations used in it 
 +    * Bookmarklet that allows to easily create pages for new citations 
 + 
 + 
 +For the BibTeX support there are also existing plugins: 
 +    * https://github.com/ip1981/dokuwiki-plugin-papers - reads (existing) BibTeX files and displays data from them or renders BiBTeX code in a page - look pretty simple and clean 
 +    * [[plugin:publist]] Reads and searches in existing BibTeX files, a wrapper around [[http://lmazy.verrech.net/bib2tpl/|bib2tpl]] 
 +    * [[plugin:refnotes]] Adds advanced syntax for references inside wiki pages and also a reference database that is built from simple tables inside a certain namespace using a simple (serialized PHP) database. It does not support BibTeX yet, but it is planned. 
 +    * [[http://hodique.info/projects/bibtex_plugin|BiBTeX plugin]] - reads BibTeX data that is stored in wiki pages, displays them either as list or displays one single reference from the data, uses a simple template page to display the data for a reference. 
 +    * [[plugin:datatemplate]] - "Only" a plugin for templates for displaying data that is stored using the data plugin, but look at the [[plugin:datatemplate#Demonstration]] - that's mostly the idea here.
  
 ===== Requirements ===== ===== Requirements =====
Line 41: Line 37:
 ===== Difficulty ===== ===== Difficulty =====
  
-FIXME+**Medium**: The individual things might be easy but the complete system most probably requires some effort in order to make it both easy to use and maintain.
  
 ===== Similar services ===== ===== Similar services =====
Line 53: Line 49:
   * [[user>andi|Andreas Gohr]]   * [[user>andi|Andreas Gohr]]
   * [[user>hakans|Håkan Sandell]]   * [[user>hakans|Håkan Sandell]]
- +  * [[user>adrianlang|Adrian Lang]] 
 +  * [[user>michitux|Michael Hamann]]
devel/ideas/dokutexit.1329768329.txt.gz · Last modified: 2012-02-20 21:05 by HåkanS
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