Compatible with DokuWiki
Exportiert eine Seite ins Open Document format welches von OpenOffice.org und anderen Textbearbeitungen verwendet wird
This extension is not in the 'plugin' or 'template' namespace and is therefore ignored.
Similar to bookcreator, mellelexport, odp
Needed for bookcreator, odtsupport, symbols4odt
Dieses Plugin ermöglicht es Ihnen eine Seite in das OpenDocument Format zu exportieren welches von OpenOffice.org, LibreOffice.org und anderen Textbearbeitungen verwendet wird. Dies ist besonders nützlich wenn Sie eine einzelne Seite für einen Kunden drucken oder an ihn geben müssen. (Tip: OpenOffice.org kann auch nach PDF exportieren). Seit Release-Version 2016-04-23 kann eine Seite auch direkt nach PDF exportiert und heruntergeladen werden. Siehe Abschnitt PDF-Konvertierung für weitere Details.
Dieses Plugin wurde angelegt von Andreas Gohr, und wurde dann weiterentwickelt und verwaltet von Aurelien Bompard.
Die ältere Version vom ODT-Plugin mit Default-Template Unterstützung war von Florian Lamml.
Aktuell wird das ODT Plugin von LarsDW223 weiter verwaltet.
PHP 5.5 (für PHP 5.3.3+ und PHP 5.4.X, siehe dieser Workaround)
Es gibt keine generellen Voraussetzungen aber manche Funktionen haben Voraussetzungen:
Benutzer von PHP 7 sollten in Erwägung ziehen auf Release 2016-04-23 (aktuelles Release) zu gehen um zu verhindern das ihre Logdateien voll laufen mit überflüssigen Fehlern (PHP 7 signature errors).
Fügen Sie das folgende Makro zu einer Seite hinzu, um eine einzelne Seite exportierbar zu machen:
~~ODT~~
Eine bessere Möglichkeit ist die Integration einer Export-Schaltfläche in Ihr template.
Wenn sie das Default Template von Dokuwiki benutzen können Sie den Export Button einfach im Konfigurationsmenü aktivieren.
Ansonsten gehen Sie folgendermaßen vor, um eine Schaltfläche in die obere oder untere Zeile des Templates hinzuzufügen: 1)
<form class="button" method="get" action="<?php wl($ID)?>"> <div class="no"> <input type="submit" value="Export nach ODT" class="button" /> <input type="hidden" name="do" value="export_odt" /> <input type="hidden" name="id" value="<?php echo $ID?>" /> </div> </form>
Oder benutzen Sie dieses einfache 16×16 Icon irgendwo in Ihrem Template:
<a href="<?php echo exportlink($ID, 'odt')?>"><img src="<?php echo DOKU_BASE?>lib/images/fileicons/odt.png" alt="ODT Export" /></a>
Sie können die beiden vorherigen Methoden mischen, und erhalten eine Schaltfläche mit einem Bild darin, mittels des folgenden Codes:
<form class="button" method="get" action="<?php wl($ID)?>"> <div class="no"> <button type="submit" class="button"> <img src="<?php echo DOKU_BASE?>lib/images/fileicons/odt.png" alt="ODT Export" /> Export nach ODT </button> <input type="hidden" name="do" value="export_odt" /> <input type="hidden" name="rev" value="<?php global $REV; echo $REV?>" /> <input type="hidden" name="id" value="<?php echo $ID?>" /> </div> </form>
Die meisten Einstellungen oder Konfigurationsoptionen im ODT-Plugin können vorgenommen werden in der ODT-Plugin Konfiguration, durch übergeben der Einstellung als einen Parameter im URL-Request oder durch Verwendung eines Syntax-Tags.
Die Priorität ist folgende (der erste Eintrag hat die höchste Priorität, der Letzte die Niedrigste):
Es folgt ein Beispiel um die Einstellung Orientierung (orientation) als URL-Request Parameter zu übergeben:
https://www.dokuwiki.org/plugin:odt?orientation=landscape&do=export_odt
Das Gleiche funktioniert für Syntax-Tags. Die Syntax-Tags für Einstellungen haben immer das gleiche Format:
{{odt>Parameter:Wert}}
Hier wieder das Beispiel für die Einstellung Orientierung (orientation):
{{odt>orientation:landscape}}
Das aktuelle Release hat folgende Konfigurationsoptionen:
| Name der Konfigurationsoption | Funktion |
|---|---|
| tpl_dir | Unterverzeichnis für Templates im Media-Manager. Laden Sie ihre ODT-Template-Dateien in dieses Verzeichnis hoch. |
| odt_template | ODT-Datei die als Template verwendet werden soll. In der Standardeinstellung ist diese Feld leer. In diesem Fall werden vordefinierte Styles verwendet. Seit Version 2016-02-13 kann das Template auch eine CSS-Datei sein. Stellen Sie sicher, dass Sie korrekte Dateinamenserweiterungen verwenden (.odt oder .css) damit das Plugin zwischen den Dateitypen unterscheiden kann. Siehe Abschnitt Template Unterstützung für weitere Details. |
| showexportbutton | Soll die ODT Export Schaltfläche angezeigt werden? |
| media_sel | Welcher @media selector soll verwenndet werden um CSS properties abzufragen? Zum Beispiel 'print' oder 'screen'. Zur Zeit hat dies nur Einfluss auf den ODT-Export von Plugins, z.B. dem Wrap Plugin. |
| css_template | Das DokuWiki-Template welches für den CSS-Import verwendet werden soll. Es beeinflusst nur den CSS-Inhalt der an Plugins übergeben wird. Es beeinflusst nicht das Aussehen der DokuWiki-Basis-Syntax. |
| usestyles | Sie können eine mit Komma getrennte Liste von Plugins angeben für die style.css oder screen.css zur ODT-Generierung verwendet werden sollen. Standardmäßig werden nur print.css und odt.css verwendet. |
| twips_per_pixel_x | Twips pro Pixel auf der X-Achse. |
| twips_per_pixel_y | Twips pro Pixel auf der Y-Achse. |
| format | Das Seitenformat des exportierten Dokuments. Zur Zeit werden folgende Formate unterstützt: A6, A5, A4, A3, B6 (ISO), B5 (ISO), B4 (ISO), Letter, Legal, Long Bond, Tabloid, B6 (JIS), B5 (JIS), B4 (JIS), 16 Kai, 32 Kai, Big 32 Kai, DL Envelope, C6 Envelope, C6/5 Envelope, C5 Envelope, C4 Envelope, #6 3/4 Envelope, #7 3/4 (Monarch) Envelope, #9 Envelope, #10 Envelope, #11 Envelope, #12 Envelope, Japanese Postcard. |
| orientation | Orientierung des exportierten Dokuments. Erlaubt sind die Werte 'portrait' (Hochformat) oder 'landscape' (Querformat). |
| margin Top, Right, Bottom, Left | Die Seitenränder des exportierten Dokuments in Zentimetern. |
| disable_links | Wenn auf 'Yes' gesetzt, dann werden Links nicht als Links kodiert sondern als einfacher Text. |
| toc_maxlevel | Maximale Tiefe des Inhaltsverzeichnisses. Falls es leer ist, wird der Wert der globalen DokuWiki-Option ‘maxtoclevel’ verwendet. |
| toc_leader_sign | Das Füllzeichen für das Inhaltsverzeichnis. |
| toc_indents | Die Einrückung für das Inhaltsverzeichnis pro Ebene. Die Werte sind absolute Werte in Zentimetern, nicht relativ zur vorherigen Ebene. Z.B. führt die Einstellung '0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5' zu einer Einrückung von 0.5 Zentimetern pro Ebene. Dagegen sorgt die Einstellung '0, 1, 1, 1, 1, 1, 1, 1, 1, 1' dafür, dass Ebene 1 nicht eingerückt wird und alle anderen Ebenen eine Einrückung von 1 Zentimeter haben. |
| toc_pagebreak | Soll nach dem Inhaltsverzeichnis ein Seitenumbruch eingefügt werden? |
| toc_style | Style für das Inhaltsverzeichnis im CSS-Format, z.B.: 'color:red;'. Standardmäßig verwendet jede Ebene den selben Style. Sie können jedoch spezifische Styles pro Ebene mit Hilfe des Syntax-Tags angeben. |
| index_in_browser | Falls auf hide (verstecke) gesetzt, dann generieren die Tags toc und chapter-index keine sichtbare Ausgabe im Browser. Falls es auf display placeholder (zeige Platzhalter) gesetzt wird, dann wird ein kleiner Platzhalter-Absatz im Browser eingefügt welcher dem Anwender zeigt, das das Syntax-Tag vorhanden ist und ein Inhaltsverzeichnis oder Kapitelverzeichnis beim Export nach ODT eingefügt werden wird. |
| outline_list_style | Falls auf Normal gesetzt, werden Überschriften nach dem Export nicht als Liste dargestellt. Falls die Option auf Numbers gestellt wird, dann werden alle Überschriften beim Export nach ODT nummeriert. Bitte beachten Sie folgendes: die Nummern der Überschriften werden erst nach einer Aktualisierung des Inhaltsverzeichnis oder Kapitelverzeichnis in selbigem angezeigt (eine Aktualisierung muss sowieso immer durchgeführt werden). |
Es gibt einige zusätzliche Syntax-Tags für Zusatz-Funktionen die nicht in der Konfiguration alleine gesetzt werden können, da z.B. die Position wichtig ist oder mehr Flexibilität gegeben werden soll. Diese Tags werden in diesem Abschnitt beschrieben.
Ein manueller Seitenumbruch kann durch hinzufügen des Syntax-Tags <pagebreak> in der Wiki-Seite eingefügt werden. Diese Funktion benötigt das Pagebreak Plugin.
Das Syntax-Tag page kann verwendet werden um das Seitenformat, die Orientierung und die Seitenränder mit einem Befehl einzustellen. Das Format ist folgendes:
{{odt>page:format,orientation,margin_top,margin_right,margin_bottom,margin_left}}
Das folgende Beispiel setzt das Seitenformat A3, die Orientierung landscape (Querformat) und alle Seitenränder werden auf 1 Zentimeter gesetzt.
{{odt>page:A3,landscape,1,1,1,1}}
Sie können auch Einstellungen welche Sie nicht ändern wollen weglassen, z.B.:
{{odt>page:A3,landscape}}
Das ändert das Seitenformat und die Orientierung aber nicht die Seitenränder.
Wenn Sie nur eine einzelne der Seiteneinstellungen verändern möchten, dann können Sie die Tags für das Seitenformat, die Orientierung und die Seitenränder alleine verwenden. Hier ein paar Beispiele:
{{odt>format:A3}}
{{odt>format:A4}}
{{odt>orientation:portrait}}
{{odt>orientation:landscape}}
{{odt>margin_top:1}}
{{odt>margin_right:2}}
{{odt>margin_left:3}}
{{odt>margin_bottom:4}}
Eine Änderung des Seitenformats beendet die aktuelle Seite, fügt einen Seitenumbruch ein und die nächste Seite verwendet dann das neu gesetzte Seitenformat.
Das toc Syntax-Tag wird verwendet um ein Inhaltsverzeichnis an der Position des Tags einzufügen. Wenn kein toc Syntax-Tag eingefügt wird, wird auch überhaupt kein Inhaltsverzeichnis angelegt. Die minimale Ausführung ist:
{{odt>toc}}
Dies legt ein Inhaltsverzeichnis an, bei dem alle relevanten Einstellungen aus der Plugin-Konfiguration geholt werden. Der Titel wird 'Inhaltsverzeichnis' sein (in Abhängigkeit der eingestellten Sprache)
Es gibt folgende Optionen für das Syntax-Tag toc:
Sie haben alle die gleiche Bedeutung wie die entsprechende Konfigurationseinstellung. Die einzige Ausnahme ist styleL1 … styleLN. Die Konfigurationsoption toc_style setzt den Style für das gesamte Inhaltsverzeichnis. styleL1 setzt nur den Style für Ebene 1, styleL2 setzt nur den Style für Ebene 2…
Die Option syntaxH arbeitet genau so wie die styleL Option oben allerdings setzt sie den Style für den Titel bzw. die Überschrift des Inhaltsverzeichnisses.
All diese Optionen sind optional. Wenn Sie eine weglassen wird die entsprechende Einstellung aus der Konfiguration (oder aus dem URL-Request-Parameter) verwendet. Jede Option muss mit einem ; abgeschlossen werden.
Es folgen ein paar Beispiele (alles eine Zeile):
{{odt>toc:title=Content;leader_sign=.;indents=0,0.5,1;pagebreak=true;
styleL1="font-weight:bold;";styleL2="font-style:italic;";
styleL3="font-style:normal;";}}
{{odt>toc:title=Content;leader_sign=_;indents=0,2,2;pagebreak=false;
styleL1="font-weight:bold;";styleL2="font-style:normal;";
styleL3="font-style:normal;";}}
Das chapter-index Syntax-Tag wird verwendet um ein Kapitelverzeichnis an der Position des Tags einzufügen. Wenn kein chapter-index Syntax-Tag eingefügt wird, wird auch überhaupt kein Kapitelverzeichnis angelegt. Die minimale Ausführung ist:
{{odt>chapter-index}}
Dies legt ein Kapitelverzeichnis an, bei dem alle relevanten Einstellungen aus der Plugin-Konfiguration geholt werden und zwar aus den Einstellungen für das Inhaltsverzeichnis. Standardmäßig hat das Kapitelverzeichnis keinen Titel.
Die Optionen für das chapter-index Syntax-Tag sind die selben wie die des toc Syntax-Tags.
Diese Tags aktivieren oder deaktivieren die Link-Generierung genau so wie die zugehörige Konfigurationseinstellung. Es folgt die Syntax:
{{odt>disablelinks}}
{{odt>enablelinks}}
Diese Tag wird verwendet um eine Wiki-Seite als CSS-Template anzugeben. Das bedeutet, dass der Inhalt der Seite als CSS-Code importiert wird. Ein Beispiel:
{{odt>templatepage:mycsspage}}
Es ist vollkommen in Ordnung wenn der CSS-Code der Templatepage von <code css>…</code> Tags umgeben ist um die Lesbarkeit zu verbessern.
Diese Funktion gibt dem Anwender die Möglichkeit ein CSS-Template zu verwenden ohne ein Datei hochladen zu müssen. ACHTUNG: die Verwendung einer Templatepage kann bereits importierte Style-Einstellungen aus einer ODT- oder CSS-Template-Datei überschreiben.
Diese Tags fügen den Inhalt zwischen ihnen in einem ODT-Frame (Rahmen) ein wenn die Seite nach ODT exportiert wird. Die HTML-Ansicht bleibt unverändert. Es folgt die Syntax:
{{odt>frame-open:...options...}}
{{odt>frame-close}}
Inhalt in einen Frame/Rahmen zu setzen kann z.B. verwendet werden um den Inhalt an einer festen Position auf der Seite einzufügen. Dies kann z.B. nützlich sein um Briefe zu schreiben.
Siehe Details zur Anwendung von ODT-Frames für weitere Informationen.
: Seite anlegen, Anwendung von Frames im Detail beschreiben
Änderungen:
Aktuellstes Release:
Entwicklungs- master branch:
Release 20101030 mit Default-Template Unterstützung: dokuwiki-odt-20140210. Ältere Releases sind verfügbar auf dieser Webseite.
Dieses Plugin funktioniert mit DokuWiki 2007-06-26 und neueren Versionen.
Wenn Sie Entwickler sind und sich für die Realsierung von ODT-Unterstützung in einem Plugin interessieren, dann könnten Sie folgende Seiten interessieren:
Um Informationen zum aktuellen Entwicklung-Releases/master-Branch zu bekommen, werfen Sie einen Blick auf die development preview-Seite.
Es gibt drei Methoden um das Aussehen der Ausgabe anzupassen:
Sie können Templates verwenden um Ihr Dokument zu exportieren. Eine Template ist eine reguläre ODT-Datei, so, wie Sie mit OpenOffice erstellt wurde. (Als ein Beispiel, nicht getestet mit anderen Applikationen die ODT unterstützen).
Fügen Sie folgenden Code zu Ihrer Wiki-Seite hinzu:
{{odt>template:ihr template dateiname.odt}}
und laden Sie ihr Template in das Wiki hoch mit Hilfe des Media-Managers. Laut Voreinstellung, muss das Template in einem :odt Namensraum abgelegt werden (Dies bedeutet ein “odt” Verzeichnis direkt unter der Wurzel des Wikis). Der Verzeichnisname kann auf der Admin-Seite konfiguriert werden.
Die exportierte Seite wird hinter dem Inhalt Ihres Templates angehängt werden. Wenn Sie die Zeichenkette DOKUWIKI-ODT-INSERT in Ihrem Dokument einbauen, wird die Wikiseite genau an der Stelle eingefügt (als Ersatz für die Zeichenkette).
Warnung : die DOKUWIKI-ODT-INSERT Zeichenkette DARF NICHT in irgendeiner Weise formatiert werden. Um dies zu garantieren, selektieren Sie die Zeile mit der Zeichenkette, gehen in das Format-Menü, und klicken auf die “Direkte Formatierung löschen” (der Oberste Eintrag).
Es gibt zwei weitere Tags die Sie in Ihrem Template verwenden können: DOKUWIKI-ODT-CUT-START und DOKUWIKI-ODT-CUT-STOP. Der gesammte Text zwischen diesen beiden Tags wird beim Export gelöscht. Es gibt einen guten Grund für diese Funkion: in einer ODT-Datei werden nur die Styles gespeichert, die auch auf einem Inhalt im Dokument angewendet wurden, d.h. alle nicht verwendeten Styles werden gelöscht. Wenn Sie ein leeres ODT-Dokument für dieses Plugin anlegen möchten und trotzdem Styles definieren möchten, die auf den Wiki-Inhalt angewendet werden sollen, müssen Sie einen Dummy-Text bzw. Blindtext schreiben, die Styles auf diesen Text anwenden und den Text mit den Tags
DOKUWIKI-ODT-CUT-START und DOKUWIKI-ODT-CUT-STOP einschliessen. Auf diese Art bleiben die Styles in der ODT-Datei enthalten aber der Blindtext wird beim Export entfernt.
Sie können Templates verwenden um Ihr Dokument zu exportieren. Ein CSS-Template ist eine reguläre CSS-Textdatei. Fügen Sie folgenden Code auf Ihrer Wiki-Seite ein:
{{odt>template:your template file name.css}}
und laden Sie Ihr Template mit Hilfe des Media-Managers hoch. Dies erfordert normalerweise die Konfiguration der Mime-Types welche beim Hochladen von Dateien erlaubt werden, siehe mime. Standardmäßig müssen Sie ein :odt Namespace anlegen (Also ein Unterverzeichnis “odt” direkt unter dem Hauptverzeichis ihres Wikis). Der Verzeichnisname kann konfiguriert werden.
Anders als bei einem ODT-Template erzeugt ein CSS-Template keinen Inhalt im exportierten Dokument. Es steuert nur die Styles/das Aussehen für die DokuWiki-Basic-Syntax.
Werfen Sie einen Blick auf die Datei example.css im ODT-Plugin-Verzeichnis um einen Überblick über die aktuell unterstützten Optionen zu bekommen, die angewendet werden können um das Aussehen des exportierten ODT-Dokumentes zu verändern.
Seit Release-Version 2016-04-23 kann ein CSS-Template auch aus einer Wiki-Seite bestehen. Siehe Abschnitt templatepage für Details.
Seit Release-Version 2016-04-23 wird optional eine PDF-Konvertierung unterstützt. Die exportierte ODT-Datei kann nach PDF konvertiert werden indem do=export_odt_pdf statt do=export_odt verwendet wird. Die Funktion benötigt die Installation eines externen Programms welches die Konvertierung durchführt, z.B. LibreOffice. Die Befehlszeile zum Durchführen der Konvertierung kann konfiguriert werden. Ein Fehlerbericht wird angezeigt, falls die Konvertierung fehlschlägt.
Wenn LibreOffice für die PDF-Konvertierung verwendet wird, kann es zu folgender Fehlermeldung kommen wenn versucht wird ein ODT-Dokument im PDF-Format herunterzuladen:
[Java framework] Error in function createSettingsDocument (elements.cxx). javaldx failed! Warning: failed to read path from javaldx
In diesem Fall versagt LibreOffice weil es kein Konfigurationsverzeichnis hat welches zum webserver/PHP user gehört oder nicht von selbigem lesen kann.
Auf meinem Ubuntu-PC wurde der Webserver-User www-data verwendet, das home Verzeichnis war /var/www und das Konfigurationsverzeichis für LibreOffice war .config/libreoffice. Also musste ich das Verzeichnis /var/www/.config/libreoffice anlegen und den Besitzen auf www-data setzen um es ans Laufen zu bekommen.
Wenn Sie andere Syntax-Plugins verwenden, kann es vorkommen das ihre Ausgabe nicht im exportierten ODT-Dokument erscheint: diese Plugins müssen erst modifiziert werden um das ODT-Ausgabeformat zu unterstützen. Einige Plugins unterstützen es bereits.
Die Seite ODT render support zeigt eine Liste der Plugins die bereits den Export ins ODT-Format unterstützen. Auf der Seite können Sie auch Plugins hinzufügen für die Sie sich ODT-Unterstützung wünschen würden.
Das Plugin wurde übersetzt in Englisch, Deutsch, Dänisch, Französisch, Koreanisch, Holländisch und Japanisch. Vielen Dank an die Übersetzer, neue Sprachen sind herzlich willkommen!
Bitte das Translation Tool verwenden.
Um Bugs zu melden oder Funktionen vorzuschlagen, verwenden Sie bitte GitHub Issues. Der Autor überwacht diese Seite nicht.
Um Bugs zu melden oder Funktionen vorzuschlagen, verwenden Sie bitte GitHub Issues. Der Autor überwacht diese Seite nicht.
/lib/tpl/default/main.php, sind zwei divs die mehrere Schaltflächen enthalten: <div class=“bar” id=“bar__top”> und <div class=“bar” id=“bar__bottom”>. Fügen Sie einfach den HTML-Code in eine der beiden divs ein (links oder rechts)