Differences

This shows you the differences between two versions of the page.

--- plugin:pdftools [2020-12-28 12:42] – gero-gothe
+++ plugin:pdftools [2022-10-25 02:59] – [pdftools Plugin] 2406:5a00:9c03:5100:4216:7eff:feb4:fe2
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description: Add few simple features for dw2pdf (German language only)
+description: Additional features for dw2pdf
-author     : Gero Gothe
+author     : Gero Gothe.
 email      : gero.gothe@medizindoku.de
 type       : syntax
-lastupdate : 2020-11-16
+lastupdate : 2021-11-11
 compatible : Hogfather,Greebo
 depends    : dw2pdf, wrap
@@ Line 22: / Line 22: @@
 Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
-===== Examples/Usage =====
-Presently, this plugin is only offered in **German language.** This will be improved in coming versions.
+===== Features =====
-Momentan hat dieses Plugin zwei Funktionen, welches die Tätigkeit von einfachen Anwendern erleichtern soll:
+  * Optional and configurable slider button to chose a template for pdf-generation
+  * Configurable pdf-generate button which can be placed in a page
+  * A set of templates for different purposes which can be installed directly from the admin section
+  * Upload your own templates in the admin section and option to remove templates
+  * Additional wrap-containers and some additional syntax for formatting
+  * Additional replacements which can be used in the templates
-==== <etikett> ====
+===== Print Button =====
+Activate a print button (slider) which is shown at the bottom right of the screen. You can configure the templates which are the display and can be chosen in order to generate a PDF.
+----
+{{https://raw.githubusercontent.com/practical-solutions/dokuwiki-pdftools/master/img/screenshot2.png}}
+----
+{{https://raw.githubusercontent.com/practical-solutions/dokuwiki-pdftools/master/img/screenshot1.png}}
+----
+===== Inline PDF button =====
+Use the ''<pdf>''-Tag in a document to create an inline button. Pressing this button will generate a PDF with the defined template. Syntax:
+  <pdf template-name>
+  <pdf template-name quer>
+The option ''quer'' creates the PDF in landscape orientation (German word "quer" = horizontal)
+Standard parameters for the created PDF are
+  * toc = 0 (no table of content)
+  * tpl = ''template-name''
+  * orientation=landscape (if the keyword ''quer'' is used)
+===== etikett-Tag =====
   <etikett>
-Fügt ein Bild ein, welches die Größe eines durchschnittlichen Etiketts hat. Dies ist für Formulare gedacht, bei denen ein Adressaufkleber platziert werden soll
+Inserts an image which is meant for printed documents, where a sticker is to be pasted on.
+{{https://raw.githubusercontent.com/practical-solutions/dokuwiki-pdftools/master/img/etikett.png}}
-==== <pdf> ====
-  <pdf VORLAGENBEZEICHNUNG [quer]>
+===== Additional wrap containers =====
-Erzeugt einen Link, bei der eine Wiki-Seite mit der ausgewählten dw2pdf-Vorlage generiert wird. Wird "quer" als Option mit angegeben, wird die Seitenausrichtung auf quer gestellt.
+If you have the wrap-plugin installed, you can use these addition classes:
+  <WRAP maxtabelle>
+  Table ist set to 100% width = same as tablewidth-option
+  | Content | Another content |
+  </WRAP>
+  <WRAP formular>
+  Table without borders
+  | Example | Okay |
+  </WRAP>
+  <WRAP formular2>
+  Table with border only on the bottom of the lines
+  | Another example | Test |
+  </WRAP>
-==== Zusätzliche WRAP-Klassen ====
+  <WRAP platz>
+  Increases the padding of cells in a table
+  | Test |
+  | Test |
+  </WRAP>
-Ist das wrap-Plugin installiert, so können folgende zusätzliche WRAP-Klassen mit diesem Plugin verwendet werden
+  <wrap bigtext>Text scaled to 115%</wrap>
+  <wrap smalltext>Text scaled to 90%</wrap>
-| ''<WRAP maxtabelle>'' | Tabelle nimmt 100% der Seitenbreite ein |
+===== Create spaces in empty table cells =====
-| ''<WRAP formular>'' | Erzeugt eine Tabelle, bei der die Ränder nicht angezeigt werden. |
-| ''<WRAP formular2>'' | Erzeugt eine Tabelle, bei der nur die unteren Ränder der Zeilen angezeigt werden |
-| ''<wrap smalltext>'' | Skaliert den Text auf 90% |
-| ''<wrap bigtext>'' | Skaliert den Text auf 115% |
-| ''<wrap platz>'' | Zeilenabstände von Tabellen werden vergrößert |
+Vertical space
-==== Abstandshalter ====
+  | <abstand1> | Test |
+  | <abstand2> | Test |
+  | <abstand3> | Test |
-Insbesondere für Tabellen gedacht, die leere Zellen enthalten. Styling mittels CSS, welches kompatibel zu mPDF ist, gestaltet sich immer wieder schwierig, sodass dies eine einfache Lösung bietet
+Horizontal space
   | Test | <quer1> | <quer2> | <quer3> |
+===== Set of templates =====
+The pdftools-plugin contains a set of templates which can be installed in the admin section. These templates contain additional replacements:
-  | Test |
+  @AUTHOR@ - Name of the author
-  | <abstand1> |
+  @COMPANY@ - Name of the company which can be configured
-  | <abstand2> |
+  @APPROVER@ - Name of the approve (requires Approve- und ApprovePlus-Plugin)
-  | <abstand3> |
-==== Vorlagenpaket ====
+===== Upload pdf-templates =====
-Es ist nun ein dw2pdf-Vorlagenpaket integriert. Die Vorlagen lassen sich im admin-Bereich installieren. Zudem sind folgende Replacements für die Vorlagen hinzugefügt worden:
+Upload form for uploading your own pdf-templates.
-  @AUTHOR@ - Autor der Seite
+The template files must be placed in a directory, which must bei included in the zip-file. The files are extracted directly into the ''dw2pdf/tpl'' directory. This feature depends on the Linux ''unzip'' programme to work.
-  @COMPANY@ - Firmenname / Im Konfigurationsbereich einstellbar
-  @APPROVER@ - Verwendung nut mit Approve- und ApprovePlus-Plugin
-Das ApprovePlus-Plugin findet sich aktuell [[https://github.com/practical-solutions/dokuwiki-plugin-approveplus|hier]]
+===== Erase pdf-templates =====
-==== Druck-Button ====
+Button to delete templates from dw2pdf.
-Es wird ein Druckbutton unten rechts am Bildschirm angezeigt. Dieser kann in der Konfiguration angepasst oder auch ausgeblendet werden. Auf der (Haupt-)Startseite wird er nicht angezeigt.
+===== Ideas for coming versions =====
+  * online template editor
+  * configurable GET-Parameters for the ''<pdf>''-Tag and the slider
+===== Compatibility =====
+Tested with
+  * PHP **7.3**
+  * Dokuwiki / **Hogfather**
+  * [[https://www.dokuwiki.org/plugin:approve|Approve-Plugin]] / **2021-02-17**
+  * [[https://github.com/practical-solutions/dokuwiki-plugin-dw2pdf|dw2pdf / Modified Version]] / **2020-09-16**
+  * [[https://github.com/practical-solutions/dokuwiki-plugin-approveplus|ApprovePlus-Plugin]] / **2020-11-23**
+===== Development =====
+{{rss>https://github.com/practical-solutions/dokuwiki-pdftools/commits/master.atom date}}
@@ Line 83: / Line 151: @@
 I will be thankful for any approvement suggestions or translations in form of pull-requests.