DokuWiki

It's better when it's simple

User Tools

Site Tools

Trace:
plugin:odt

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
plugin:odt [2017-03-04 18:40] – [Configuration]: added missing option 'apply_fs_to_non_css' LarsDW223plugin:odt [2024-03-06 12:22] (current) – [Configuration] documentation of 'firsttemplatedefinitionwins' config option thomas-schaefer-nh
Line 1: Line 1:
-====== OpenOffice.org/LibreOffice.org Export ======+====== LibreOffice / OpenOffice Export ======
  
 ---- plugin ---- ---- plugin ----
-description: Exports a page to the Open Document format used by OpenOffice.org and other word processors+description: Exports a page to the Open Document Format (ODF) used by LibreOffice and other word processors
 author     : Andreas Gohr, Aurélien Bompard, Florian Lamml, Lars (LarsDW223) author     : Andreas Gohr, Aurélien Bompard, Florian Lamml, Lars (LarsDW223)
 email      : andi@splitbrain.org, aurelien@bompard.org, info@florian-lamml.de email      : andi@splitbrain.org, aurelien@bompard.org, info@florian-lamml.de
 type       : render, syntax type       : render, syntax
-lastupdate : 2017-02-18 +lastupdate : 2023-03-03 
-compatible : Detritus, 2016-06-26 "Elenor Of Tsort", 2017-02-19a "Frusterick Manners"+compatible : Detritus, 2016-06-26 "Elenor Of Tsort", 2017-02-19a "Frusterick Manners", "Greebo", Hogfather, "Jack Jackrum"
 depends    :  depends    : 
-conflicts  : header2+conflicts   : header2
 similar    :  similar    : 
 tags       : export, odt, pdf tags       : export, odt, pdf
  
-downloadurl: https://github.com/LarsGit223/dokuwiki-plugin-odt/archive/2017-02-18.zip+downloadurl: https://github.com/lpaulsen93/dokuwiki-plugin-odt/archive/refs/tags/2023-03-03.zip
 sourcerepo : https://github.com/LarsGit223/dokuwiki-plugin-odt sourcerepo : https://github.com/LarsGit223/dokuwiki-plugin-odt
 bugtracker : https://github.com/LarsGit223/dokuwiki-plugin-odt/issues bugtracker : https://github.com/LarsGit223/dokuwiki-plugin-odt/issues
Line 20: Line 20:
 ---- ----
  
-This plugin allows you to export a page to the [[wp>OpenDocument]] format used by [[http://www.openoffice.org/|OpenOffice.org]], [[http://www.libreoffice.org/|LibreOffice.org]] and other word processors. This is especially useful when you need to print or to give a single page to a customer (Hint: OpenOffice.org can also export to PDF). Since release version 2016-04-23 a page can also directly be exported to and downloaded as PDF. See section [[#PDF conversion]] for details.+This plugin allows you to export a page to the [[wp>OpenDocument]] format used by [[http://www.libreoffice.org/|LibreOffice]], [[http://www.openoffice.org/|OpenOffice]] and other word processors. This is especially useful when you need to print or to give a single page to a customer (Hint: LibreOffice can also export to PDF). Since release version 2016-04-23 a page can also directly be exported to and downloaded as PDF. See section [[#PDF conversion]] for details.
  
-This plugin was initialized by [[andi@splitbrain.org|Andreas Gohr]], and was then further developed and maintained by [[http://aurelien.bompard.org/|Aurelien Bompard]].  +This plugin was initialized by [[andi@splitbrain.org|Andreas Gohr]], and was then further developed and maintained by [[http://aurelien.bompard.org/|Aurelien Bompard]]. The older version of ODT plugin with default template support is from [[http://www.florian-lamml.de/|Florian Lamml]]. Currently, the ODT plugin is maintained by [[https://github.com/LarsGit223/dokuwiki-plugin-odt|LarsDW223]].
- +
-The older version of ODT-plugin with default template support is from [[http://www.florian-lamml.de/|Florian Lamml]]. +
- +
-Currently, ODT is maintained by [[https://github.com/LarsGit223/dokuwiki-plugin-odt|LarsDW223]].+
  
 ===== Requirements ===== ===== Requirements =====
Line 39: Line 35:
  
 The current release of this plugin is backwards compatible up to/including DokuWiki release 2015-08-10 "Detritus". The current release of this plugin is backwards compatible up to/including DokuWiki release 2015-08-10 "Detritus".
-:!: All releases starting with 2016-09-10 and older are **incompatible** with the next DokuWiki release "Frusterick Manners" (file **inc/ZipLib.class.php** is missing). :!:+ 
 +:!: All releases starting with 2016-09-10 and older are **incompatible** with the next DokuWiki release "Frusterick Manners" (file **inc/ZipLib.class.php** is missing).
  
 ==== Plugins ==== ==== Plugins ====
Line 118: Line 115:
 ^  Config option name              ^  Function                                                                                                                                                                                                                                                                                                                                                                                                                     ^ ^  Config option name              ^  Function                                                                                                                                                                                                                                                                                                                                                                                                                     ^
 | tpl_dir                          | Sub-directory for the templates in the media manager. Upload your ODT template files to this directory.                                                                                                                                                                                                                                                                                                                       | | tpl_dir                          | Sub-directory for the templates in the media manager. Upload your ODT template files to this directory.                                                                                                                                                                                                                                                                                                                       |
 +| firsttemplatedefinitionwins      | In case of multiple definitions of template, templatepage, css_template, or odt_template, the first will be used. (The value false will apply the last definition, instead.) Needs the [[plugin:usecounter|usecounter]] plugin!                                                                                                                                                                                                                                                                                                                       |
 | odt_template                     | ODT file which shall be used as a template. Per default this field is empty. In that case default styles are used.\\ \\ Since version 2016-02-13 the template can also be a CSS file. Make sure to use the correct file extensions (.odt or .css) so that the plugin can differ between the file types. See section [[#Templates support]] for details.                                                                       | | odt_template                     | ODT file which shall be used as a template. Per default this field is empty. In that case default styles are used.\\ \\ Since version 2016-02-13 the template can also be a CSS file. Make sure to use the correct file extensions (.odt or .css) so that the plugin can differ between the file types. See section [[#Templates support]] for details.                                                                       |
 | showexportbutton                 | Display the ODT Export Button?                                                                                                                                                                                                                                                                                                                                                                                                | | showexportbutton                 | Display the ODT Export Button?                                                                                                                                                                                                                                                                                                                                                                                                |
Line 126: Line 124:
 | css_template                     | The DokuWiki template to use for CSS import. This only affects the CSS content given to plugins. It does not affect the look of the DokuWiki basic syntax.                                                                                                                                                                                                                                                                    | | css_template                     | The DokuWiki template to use for CSS import. This only affects the CSS content given to plugins. It does not affect the look of the DokuWiki basic syntax.                                                                                                                                                                                                                                                                    |
 | apply_fs_to_non_css              | If set to true then the ''css_font_size'' will also be applied if an ODT template is used or if no template is used at all (no CSS and no ODT template [default]).                      | | apply_fs_to_non_css              | If set to true then the ''css_font_size'' will also be applied if an ODT template is used or if no template is used at all (no CSS and no ODT template [default]).                      |
-| usestyles                        | You can give a comma separated list of plugins of which the ''style.css'' or ''screen.css'' should be used for ODT generation. By default only ''print.css'' and ''odt.css'' are used.                                                                                                                                                                                                                                        |+| usestyles                        | You can give a comma separated list of plugins of which the ''style.css'' or ''screen.css'' should be used for ODT generation. By default only ''print.css'' and ''odt.css'' are used. This setting is missing since release 2017-02-11. From that release on the ODT plugin always imports screen and print CSS from each plugin.                                                                                                                                                                                                                                        |
 | twips_per_pixel_x                | Twips per pixel on the X axis.                                                                                                                                                                                                                                                                                                                                                                                                | | twips_per_pixel_x                | Twips per pixel on the X axis.                                                                                                                                                                                                                                                                                                                                                                                                |
 | twips_per_pixel_y                | Twips per pixel on the Y axis.                                                                                                                                                                                                                                                                                                                                                                                                | | twips_per_pixel_y                | Twips per pixel on the Y axis.                                                                                                                                                                                                                                                                                                                                                                                                |
Line 140: Line 138:
 | index_in_browser                 | If set to **hide** then the syntax tag **toc** and **chapter-index** will create no visible output in the browser. If it is set to **display placeholder** then a little placeholder paragraph will be shown in the browser showing the user that the syntax tag is there and a table of contents or chapter-index will be inserted on export to ODT.                                                                         | | index_in_browser                 | If set to **hide** then the syntax tag **toc** and **chapter-index** will create no visible output in the browser. If it is set to **display placeholder** then a little placeholder paragraph will be shown in the browser showing the user that the syntax tag is there and a table of contents or chapter-index will be inserted on export to ODT.                                                                         |
 | outline_list_style               | If set to **Normal** then headings will have no list style after export.\\ \\ If it is set to **Numbers** then all headings will be numbered after exporting to ODT.\\ \\ Please notice: the numbers of the headings will only appear in the table of contents or chapter index after updating them (which is required anyway).                                                                                               | | outline_list_style               | If set to **Normal** then headings will have no list style after export.\\ \\ If it is set to **Numbers** then all headings will be numbered after exporting to ODT.\\ \\ Please notice: the numbers of the headings will only appear in the table of contents or chapter index after updating them (which is required anyway).                                                                                               |
 +| olist_label_align                | The setting specifies how to align the numbers in front of list items in an ordered list (left, center, right [default]).                                                               |
 +| convert_to_pdf                   | The command line to execute for ODT to PDF conversion. The default specifies the command line for PDF conversion using LibreOffice. For details see section [[#PDF conversion]].             |
  
 ===== Additional syntax tags ===== ===== Additional syntax tags =====
Line 149: Line 149:
 A manual pagebreak can be inserted by adding the syntax tag ''<pagebreak>'' in the wiki page. This feature requires the [[plugin:pagebreak|Pagebreak Plugin]]. A manual pagebreak can be inserted by adding the syntax tag ''<pagebreak>'' in the wiki page. This feature requires the [[plugin:pagebreak|Pagebreak Plugin]].
  
 +> [[;plugin:pagebreak | The PageBreak plugin]] isn't maintained, and [[https://github.com/micgro42/dokuwiki-plugin-pagebreak/issues | bugs]] are ignored since 2018!  Tag   ''<br style=\"page-break-after:always;\">''   is broken,  ''<div></div>''  may be better?  ''$renderer->doc .= "<div style=\"page-break-after:always;\"></div>";''.  This seems simple enough that it may be good to add it in dokuwiki core as ''~~pagebreak~~'' or similar?  Andreas G,, can you quickly look at it please? 
 ==== page ==== ==== page ====
  
Line 261: Line 262:
  
 Latest Release: Latest Release:
-{{rss>https://github.com/LarsGit223/dokuwiki-plugin-odt/commits//2017-02-18.atom}}+{{rss>https://github.com/LarsGit223/dokuwiki-plugin-odt/commits//2019-07-27.atom}}
  
 Development master branch: Development master branch:
Line 269: Line 270:
 Release 20101030 with Default Template Support: [[https://github.com/LarsGit223/dokuwiki-plugin-odt/archive/2014-02-10.zip|dokuwiki-odt-20140210]].\\ Release 20101030 with Default Template Support: [[https://github.com/LarsGit223/dokuwiki-plugin-odt/archive/2014-02-10.zip|dokuwiki-odt-20140210]].\\
 More older releases are available [[http://aurelien.bompard.org/projects/files/dokuwiki-odt/|on this webpage]]. More older releases are available [[http://aurelien.bompard.org/projects/files/dokuwiki-odt/|on this webpage]].
- 
-This plugin works with DokuWiki 2007-06-26 and later. 
  
 If you are a developer which is interested in implementing ODT support for a plugin the following pages might be interesting for you: If you are a developer which is interested in implementing ODT support for a plugin the following pages might be interesting for you:
Line 334: Line 333:
 Since release version 2016-04-23 there is support for optional PDF conversion. The exported ODT file can be converted to PDF by using ''do=export_odt_pdf'' instead of ''do=export_odt''. The feature requires installation of an external program to do the conversion e.g. LibreOffice. The command line executed for conversion can be configured. An error page is send to the user if conversion fails. Since release version 2016-04-23 there is support for optional PDF conversion. The exported ODT file can be converted to PDF by using ''do=export_odt_pdf'' instead of ''do=export_odt''. The feature requires installation of an external program to do the conversion e.g. LibreOffice. The command line executed for conversion can be configured. An error page is send to the user if conversion fails.
  
 +Since release 2017-02-11 there is a button for PDF conversion which is labelled with **ODT=>PDF export**. It is only visible if the config option ''showpdfexportbutton'' is on.
 ==== Installation hints for LibreOffice ==== ==== Installation hints for LibreOffice ====
  
Line 365: Line 365:
 To report bugs or suggest features, **please** use [[https://github.com/LarsGit223/dokuwiki-plugin-odt/issues|GitHub Issues]]. The author does not monitor this page. To report bugs or suggest features, **please** use [[https://github.com/LarsGit223/dokuwiki-plugin-odt/issues|GitHub Issues]]. The author does not monitor this page.
  
 +===== Tutorials/more Documentation =====
  
 +For some more detailed examples and documentation have a look at the following pages: 
 +  * [[plugin:odt:tutorials:toc|Table of Contents Tutorial]] 
 +  * [[plugin:odt:tutorials:odttemplate:create|Create an ODT template file Tutorial]] 
 +  * [[plugin:odt:tutorials:odttemplate:stylingnormaltext|ODT template: styling normal text Tutorial]] 
 +  * [[plugin:odt:tutorials:odttemplate:stylingheadlines|ODT template: styling headlines Tutorial]] 
 +  * [[plugin:odt:tutorials:odttemplate:stylingtextextended|ODT template: extended text styling Tutorial]] 
 +  * [[plugin:odt:tutorials:odttemplate:stylinglists|ODT template: list styling Tutorial]] 
 +  * [[plugin:odt:styleimportgeneral|A general description of ODT style import]] 
 +  * [[plugin:odt:cssimportparagraphstyle|A description of CSS import for paragraph styles]] 
 +  * [[plugin:odt:cssimportcharacterstyle|A description of CSS import for character styles]]
  
  
plugin/odt.1488649247.txt.gz · Last modified: 2017-03-04 18:40 by LarsDW223
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