====== LaTeXit Plugin ======
---- plugin ----
description: This plugin allows you to export single or multiple DokuWiki pages into one LaTeX file. It will export all media in a ZIP archive. It also supports exporting syntax from plugins imagereference, mathjax and zotero.
author : Adam Kucera
email : adam.kucera@wrent.cz
type : render, syntax, action
lastupdate : 2014-11-14
compatible : Ponder Stibbons, Binky, Hrun
depends :
conflicts :
similar : dokutexit
tags : export, latex, pdf
downloadurl: https://github.com/Wrent/dokuwiki-plugin-latexit/archive/master.zip
bugtracker : https://github.com/Wrent/dokuwiki-plugin-latexit/issues
sourcerepo : https://github.com/Wrent/dokuwiki-plugin-latexit
donationurl:
screenshot_img :
----
===== Installation =====
Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
===== Examples/Usage =====
If you are using basic DokuWiki template, you should have a new export button by the pagetool buttons. It can be switched off in configuration. To export a page, put ''&do=export_latexit'' at the end of the demanded URL.
===== Syntax =====
The plugin allows you to export multiple DokuWiki pages in a single LaTeX file.
===1st Insert syntax===
If you want to insert a page as a subsection, put the following just before the link to the demanded page:
~~~~~~RECURSIVE~~~~~~
[[link]]
''~'' works exactly the same as ''='' in headers. Number of ''~'' will determine the level of the first header of inserted page.
===2nd Insert syntax===
:!: [[devel:develonly]] only in outstanding pull request
A replacement of the recursion syntax is the insertwikipage syntax. The functionality is similar, but the caching should be improved. ''\insertwikipage[//headinglevel//]{//pageid//|//Title//}''
* ''//headinglevel//'': Let heading start at ''1'' = biggest heading to ''5'' = smallest heading.\\ Sets size of the starting heading in the inserted page. (Example: using ''2'' displays ''====== Head ======'' as ''===== Head====='')
* ''//pageid//'': absolute or relative pageid
* ''//Title//'' (Optional) : Title for the url when it is shown in the wiki.
\insertwikipage{page}
\insertwikipage[1]{ns:page}
\insertwikipage[5]{ns:page|Title}
====Additional syntaxes====
Some supported syntaxes and their replacement in LaTeX.
Wiki syntax LaTeX syntax
FIXME[UserName](description of issue) \hl{FIXME[UserName](description of issue)}
DELETEME \hl{DELETEME}
===== Configuration and Settings =====
In the [[plugin:config|Configuration Manager]] you can set global settings. The most config settings can be set as parameters for the exported document as well.
A parameter in a page can be set with:
{{latexit> keyname yourvalue}}
{{latexit: document_class report}}
^ Key name ^ Description (with defaults)^
| document_class | LaTeX document clas (article, report, book, memoir) |
| font_size | Font size of the document |
| paper_size | Paper size of the document (a4paper, letterpaper, b5paper, executivepaper, legalpaper)|
| output_format | Oneside / twoside document (oneside, twoside) |
| landscape | Landscape document (0, 1) |
| draft | Draft document (0, 1) |
| document_header | Your own header parameters |
| document_footer | Your own footer parameters |
| document_lang | Language of the ''babel'' package |
| header_chapter | Usage of ''\chapter'' level headers (0, 1) |
| header_part | Usage of ''\part'' level headers (0, 1) |
| title | Your own title of the document |
| author | Author of the document |
| date | Date of creation of the document (0, 1) |
| table_of_content | Include a Table of Content (0, 1) |
| media_folder | Default media export folder |
| image_params | Default parameters for images |
| bibliography_style | Preferred style of bibliography |
| bibliography_name | Name of bibliography .bib file |
| default_table_align | Default cell align in tables (l, c, r) |
Settings only changeable via the Configuration manager:
* ''link_insertion_message'' -- For XHTML view of the document, you can modify the text of the header you will see before recursively inserted subpages.
* ''showexportbutton'' -- You can switch on/off the export button.
=== Change Log ===
* **2015-01-22**
* Version 1.0.5
* Added configuration entry allowing having \title as the top level.
* **2014-11-14**
* Version 1.0.4
* Added missing helper.php to release ZIP file.
* **2014-11-13**
* Version 1.0.3
* Added pull requests from other devolopers. Improved code.
* **2014-06-30**
* Version 1.0.2
* Mathjax now should be exported correctly.
* **2014-05-13**
* Version 1.0.1
* Fixed bug when there was a link to non-existing media.
* **2014-05-09**
* Version 1.0
* Minor bug fixes.
* Implementation of Unit tests.
* Release now contains only required files, test files only on github.
* **2014-05-01**
* Version 0.4.1 RC
* Fixed the bug with zotero plugin. Its installation is no longer required for the plugin to work.
* **2014-04-20**
* Version 0.4 RC
* Fixed the bug with infinite recursion loop.
* Few minor bug fixes.
* Added the export button.
* **2014-03-29**
* Version 0.3.
* Added support for bibliography (Zotero plugin has to be used).
* **2014-03-29**
* Version 0.2.
* Added Configuration.
* **2014-03-17**
* Beta release 0.1 with support of all major DW functions except RSS.
* **2014-03-05**
* Initial release (0.09) with support of all major DW functions except media and RSS.
=== Known Bugs and Issues ===
* There is a problem with quotes in czech language.
=== ToDo/Wish List ===
* Direct inclusion of LaTeX commands.
* In-file configuration.
* Smoother tables exporting.
===== Other Plugins =====
Latexit plugin supports cooperation with other useful plugins.
* [[plugin:mathjax]]
* [[plugin:imagereference]]
* [[plugin:zotero]]
===== FAQ =====
===== Discussion =====