Benutzer-Werkzeuge


Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
dokuwiki_manual [2023/09/13 14:16] – [4.1.12 Wrap Plugin] cbuehlerdokuwiki_manual [2023/09/15 12:04] (aktuell) – [4.1.12 Wrap Plugin] cbuehler
Zeile 5: Zeile 5:
 //Benutzer// schätzen DokuWiki insbesondere aufgrund der einprägsamen und leicht lesbaren [[de:wiki:Syntax]]. Diese gewährleistet, dass die Daten auch außerhalb des Wikis lesbar bleiben und vereinfacht die Erstellung strukturierter Texte. //Administratoren// favorisieren es aufgrund seiner einfachen Wartung, Sicherung, sowie Integration. Dank integrierter [[de:acl|Zugriffskontrolle]] ist es insbesondere auch für den Einsatz im Unternehmensumfeld geeignet. Die große Anzahl von Plugins, die von seiner lebendigen Community beigesteuert werden, ermöglicht eine breite Palette von Anwendungsfällen, die über ein traditionelles Wiki hinausgehen. //Benutzer// schätzen DokuWiki insbesondere aufgrund der einprägsamen und leicht lesbaren [[de:wiki:Syntax]]. Diese gewährleistet, dass die Daten auch außerhalb des Wikis lesbar bleiben und vereinfacht die Erstellung strukturierter Texte. //Administratoren// favorisieren es aufgrund seiner einfachen Wartung, Sicherung, sowie Integration. Dank integrierter [[de:acl|Zugriffskontrolle]] ist es insbesondere auch für den Einsatz im Unternehmensumfeld geeignet. Die große Anzahl von Plugins, die von seiner lebendigen Community beigesteuert werden, ermöglicht eine breite Palette von Anwendungsfällen, die über ein traditionelles Wiki hinausgehen.
  
-Loslegen: [[http://download.dokuwiki.org|{{:marketing:download-big.png|Download der aktuellen Version}}]]+Loslegen: [[http://download.dokuwiki.org|{{:download-big.png|Download der aktuellen Version}}]]
  
 ---- ----
Zeile 736: Zeile 736:
 {{wiki:dokuwiki-128.png?15&direct}} {{wiki:dokuwiki-128.png?15&direct}}
   {{wiki:dokuwiki-128.png?15&direct}}   {{wiki:dokuwiki-128.png?15&direct}}
 +  
 +=== 4.1.3.7 Videos im DokuWiki speichern ===
 +
 +== Syntax ==
 +
 +<code>
 +{{ :video_example_mp4_1280_10mg.mp4 |Video Beispiel}}
 +</code>
  
 +{{ :video_example_mp4_1280_10mg.mp4 |Video Beispiel}}
 ==== 4.1.4 Listen ==== ==== 4.1.4 Listen ====
  
Zeile 1001: Zeile 1010:
 === 4.1.11.1 Syntax === === 4.1.11.1 Syntax ===
  
-The width has to be specified at the start of a line before the tableThe first value is used as width of the tablethe rest is for columnsIf you want to omit some value use a dash insteadThe widths can be specified in any CSS units:+Die Breite muss am Anfang einer Zeile vor der Tabelle angegeben werdenDer erste Wert wird als Breite der Tabelle verwendetder Rest ist für die SpaltenWenn Sie einen Wert auslassen möchten, verwenden Sie stattdessen einen BindestrichDie Breiten können in beliebigen CSS-Einheiten angegeben werden:
  
 <code> <code>
Zeile 1009: Zeile 1018:
 </code> </code>
  
-The relative units (percentagefor the table width refer to the width of the pageand when used for columns they refer for the table wight. For examplethe width specification ''|< 50% 50% 50% >|'' makes the table half width of the page and two equal columns quarter of the page width each.+Die relativen Einheiten (in Prozentfür die Tabellenbreite beziehen sich auf die Breite der Seiteund wenn sie für Spalten verwendet werdenbeziehen sie sich auf die Tabellenbreite. Zum Beispiel macht die Breitenangabe ''|< 50% 50% 50% >|'' die Tabelle halb so breit wie die Seite und zwei gleiche Spalten jeweils ein Viertel der Seitenbreite.
  
-If there are more columns in the table than there are values in the width specificationthe width will be applied to the columns from left to right:+Wenn die Tabelle mehr Spalten enthält, als Werte in der Breitenangabe vorhanden sindwird die Breite auf die Spalten von links nach rechts angewendet:
  
 <code> <code>
 |< 50em 20% >| |< 50em 20% >|
 ^ 20%              ^ 80%                          ^ ^ 20%              ^ 80%                          ^
-Specified width  The rest of the table width  |+Festgelegte Breite  Die restliche Breite der Tabelle  |
 </code> </code>
  
 ==== 4.1.12 Wrap Plugin ==== ==== 4.1.12 Wrap Plugin ====
  
-Universal plugin which combines the functionality of many other pluginsWrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.+Universelles Plugin, das die Funktionalität vieler anderer Plugins kombiniertPacken Sie Wiki-Text in Container (divs oder spans) und geben Sie ihnen eine Klasse (wählen Sie aus einer Vielzahl von voreingestellten Klassen), eine Breite und/oder eine Sprache mit der dazugehörigen Textrichtung.
  
 === 4.1.12.1 One plugin to rule them all === === 4.1.12.1 One plugin to rule them all ===
  
-This plugin gives you the ability to wrap wiki text inside containers (divs or spans) and give them +Dieses Plugin gibt Ihnen die Möglichkeit, Wiki-Text in Containern (divs oder spans) zu packen und ihnen 
-  - a certain class (with loads of useful preset classes+  - eine bestimmte Klasse (mit vielen nützlichen voreingestellten Klassen
-  - a width +  - eine Breite 
-  - a language with its associated text direction+  - eine Sprache mit der dazugehörigen Textrichtung
  
-It potentially replaces a lot of other plugins and is IMHO the better alternative for many.+Es ersetzt potentiell eine Menge anderer Plugins und ist IMHO für viele die bessere Alternative.
  
-It fully replaces: [[class]], [[clearfloat]], [[div_span_shorthand]], [[divalign2]], [[divalign]], [[emphasis]], [[hide]], [[important_paragraf]], [[importanttext]], [[lang]], [[ltr]], [[noprint]], [[pagebreak]], [[side_note]], [[tip]], [[wpre]]+Es ersetzt vollständig: [[class]], [[clearfloat]], [[div_span_shorthand]], [[divalign2]], [[divalign]], [[emphasis]], [[hide]], [[important_paragraf]], [[importanttext]], [[lang]], [[ltr]], [[noprint]], [[pagebreak]], [[side_note]], [[tip]], [[wpre]]
  
-It partly replaces: [[box]], [[button]], [[color]], [[columns]], [[fontcolor]], [[fontfamily]], [[fontsize2]], [[fontsize]], [[highlight]], [[layout]], [[note]], [[styler]], [[tab]], [[tablewidth]], [[typography]]+Es ersetzt teilweise: [[box]], [[button]], [[color]], [[columns]], [[fontcolor]], [[fontfamily]], [[fontsize2]], [[fontsize]], [[highlight]], [[layout]], [[note]], [[styler]], [[tab]], [[tablewidth]], [[typography]]
  
 === 4.1.12.2 Syntax === === 4.1.12.2 Syntax ===
Zeile 1301: Zeile 1310:
 ''buildAttributes()'' expects the same string as above ("classes #id width :language") and an optional string for additional classes, in case your plugin has CSS classes of its own which it needs to reuse. It returns a string with all the attributes prepared for HTML. ''buildAttributes()'' expects the same string as above ("classes #id width :language") and an optional string for additional classes, in case your plugin has CSS classes of its own which it needs to reuse. It returns a string with all the attributes prepared for HTML.
  
-===== 5. Das Handbuch =====+==== 4.1.13 Extended Table Syntax 3 Plugin ==== 
 + 
 +---- plugin ---- 
 +description: Implement extended (MediaWiki-style) table syntax in DokuWiki 
 +author     : Satoshi Sahara 
 +email      : sahara.satoshi@gmail.com 
 +type       : syntax 
 +lastupdate : 2021-03-24 
 +compatible : "Elenor of Tsort", "Frusterick Manners", Greebo, Hogfather 
 +depends    :  
 +conflicts  :  
 +similar    : exttab2, exttab1 
 +tags       : tables, mediawiki 
 + 
 +downloadurl: https://github.com/ssahara/dw-plugin-exttable/archive/master.zip 
 +bugtracker : https://github.com/ssahara/dw-plugin-exttable/issues 
 +sourcerepo : https://github.com/ssahara/dw-plugin-exttable 
 +donationurl:  
 + 
 +screenshot_img :  
 +---- 
 + 
 +=== Description === 
 + 
 +The third trial to implement extended (MediaWiki-style) table syntax in DokuWiki.  
 + 
 +What's New / Difference from [[exttab2]]: 
 +  * The plugin now completely writes its own plugin calls (instruction list) in the //handle// processing stage before //render// stage. In contrast to earlier versions, this change ensures the plugin to work better with DokuWiki's own EOL & paragraph handling and serves to avoid potential invalid html rendering. 
 +  * Better handling of nested tables (tables inside tables), even though they should be avoided as much as possible. 
 +  * No need to add an extra blank line to the end of whole table to close extended table mode. 
 + 
 + 
 +=== Installation === 
 +Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually. 
 + 
 + 
 +=== Examples / Usage === 
 +The markup for the extended table is explained well at http://www.mediawiki.org/wiki/Help:Tables 
 + 
 +Here is an example usage of extended table syntax. 
 + 
 +|Wiki source<file> 
 +{| title="Extended Table Example" 
 +|+//Extended Table Example// 
 +! style="width: 12em;"| A1 Header 
 +! style="width: 10em;"| B1 Header 
 +|- style="background-color: MistyRose;" 
 +
 +{| title="nested table" 
 +|+ //nested table// 
 +
 +{{ wiki:dokuwiki-128.png?50&nolink}} 
 +**Lorem** ipsum dolor sit amet,  
 +//consetetur// sadipscing elitr,  
 +sed diam nonumy eirmod tempor invidunt 
 +ut labore et dolore magna aliquyam erat,  
 +sed diam voluptua. 
 +|} 
 +
 +List in Cell 
 +  * //italic// and **bold** 
 +  * ''monospace'' 
 +  * [[:start|page link]] 
 + 
 +> quoting 
 + 
 +**ATTENTION:**\\ 
 +Needs an extra empty line  
 +after lists and quoting syntax! 
 +|} 
 +</file>| html output (image)\\ \\ {{http://raw.githubusercontent.com/ssahara/dw-plugin-exttable/master/images/sample.png?nolink&290|Extended Table Example}} | 
 + 
 + 
 +=== Configuration === 
 + 
 +== CSS style tips == 
 +The class ''exttable'' is available as a part of selectors in your CSS file. The HTML of extended table is enclosed between ''%%<div class="exttable">%%'' and ''%%</div>%%''. The following CSS rule-set is defined in ''style.css'' of the plugin directory: 
 + 
 +  * reducing indent width of list block in cells:<file css> 
 +.exttable ol, .exttable ul { padding-left: 0em; } 
 +</file> 
 +  * reducing bottom and left margin of list block in cells:<file css> 
 +.exttable ol, .exttable ul { margin-bottom: 0.3em; margin-left: 1em; } 
 +</file> 
 +  * suppress extra line spacing after paragraph in cells:<file css> 
 +.exttable p { margin-bottom: 0; } 
 +</file> 
 + 
 +== exttab with vector template == 
 +When using [[template:vector|vector template for DokuWiki]], tables won't have borders around the cells. To add a border, use the default way of vector template customization by altering ''/dokuwiki/lib/tpl/vector/**user**/screen.css'' (**NOT** ''/dokuwiki/lib/tpl/vector/**styles**/screen.css''). Insert the following: 
 +<file css> 
 +.exttable td, 
 +.exttable th { 
 +   **border**: 1px solid __border__; 
 +
 +</file> 
 +=== Acknowledgement === 
 + 
 +This 3rd trial to implement exttab is based on  
 +  * the [[plugin:exttab2|2nd version (exttab2, 2010-08-28)]] (source: [[https://​github.com/​ssahara/​dw-plugin-exttable/​tree/​exttab2]]) by disorder change with XSS vulnerability fix by Ashish Myles.  
 +  * The [[plugin:exttab1|first version (exttab1, 2006-10-19)]] (source: [[https://github.com/wernerflamme/dwexttab1/]]) was released by Werner Flamme.  
 +Thanks for their earlier development and sharing source code.   
 + 
 + 
 +=== Development === 
 + 
 +== Change Log == 
 + 
 +{{rss>https://github.com/ssahara/dw-plugin-exttable/commits/master.atom date 10}} 
 + 
 + 
 +=== FAQ === 
 +This plugin is only a trial to implement MediaWiki-like extended table syntax, and table output (html) may differ from those of MediaWiki. 
 + 
 +=== Discussion === 
 + 
 +== Problem with bordering inserts by Include Plugin == 
 + 
 +If you use ''%%{{page>...}}%%'' syntax of Include Plugin in wikitables, it will crush borders in all cells after a table header. If you look at browser's console, it will show inserted code ''%%style="border: 0px none;"%%'' in TD tags. CSS files can't do this, and in both plugins there is no such code, so it's a problem of Doku core, maybe. 
 + 
 +You can fix it by adding ''%% !important%%'' mark to a both border instructions in ''%%lib/plugins/exttab3/style.css%%''. This decision works with more high priority, but doesn't make a pure code, whatever. 
 +== [fixed] vertical bar treated wrong == 
 +Links do not work if they contain an embedded vertical bar, like in ''%%[[path:to:page|Oh that page!]]%%''. - Daumling 
 + 
 +> changing line 70 of file ''syntax.php'' might also be a fix. 
 +<file php> 
 +        $attrs = '[^\n\{\|\!\[]+'; // match pattern for attributes 
 +</file> 
 + 
 +>> Thanks for this patch, merged into the plugin release 2014-11-20.   
 + 
 +== How to force a newline == 
 + 
 +<br/> to create line breaks within cells does not work. - Silverfire 
 +> please use ''%%\\ %%'' -- two backslashes followed by a whitespace or the end of line. 
 +>> It's an original syntax of Doku, but if somebody really want to use <br/>, than s/he can add this tag at ''conf/entities.conf'' file (or at update-protected ''conf/entities.local.conf'' file) as string ''%%<br>    <br />%%'' 
 + 
 +==== 4.1.14 FontFamily Plugin ==== 
 + 
 +Select the text that you would like to change, then click on the {{https://trello-attachments.s3.amazonaws.com/5af4815352fa15728c62aaae/604de5942d22aa21c6c1ac36/d89ac3dfa4ad7054f18a98afa0c86f57/toolbar_icon.png?recache|font family toolbar button}} and choose one of the predefined font samples in the emerged picker. 
 + 
 +The result is: 
 +  <ff fontfamily>Your own text</ff> 
 + 
 +Code based on the [[plugin:highlight|plugin highlight]] 
 + 
 +==== 4.1.15 nodisp Plugin ==== 
 + 
 +=== Examples/Usage === 
 + 
 +This plugin has two ways of concealing text from unauthorized users.   
 +  - In the first case, it conceals text from all viewers except users who are logged in and belong to either the admin or manager group.  The text is still on the page, but not displayed.  This means it can be viewed using the browser's view source facility. 
 +  - In the second case, an acl level is set and if the viewer does not have an acl level equal to or greater than the acl setting, the text is completely removed from the page.  It is not output from the server to the browser. The same is true if the site allows viewers to view the page source using Dokuwiki's view source action. 
 + 
 +=== Syntax === 
 + 
 +== The syntax for the first case == 
 + 
 +<code> 
 +<nodisp> your text here </nodisp> 
 + 
 +<nodisp> 
 +your text here 
 +etc 
 +</nodisp> 
 +</code> 
 + 
 +== The syntax for the second case == 
 + 
 +<code> 
 +<nodisp acl> your text here </nodisp> 
 + 
 +<nodisp acl> 
 +your text here 
 +etc 
 +</nodisp> 
 +</code> 
 + 
 +''acl'' is the numeric representation of the acl level which is required for the marked off text to be output to the browser.  In other words the viewer must be logged in and have ''acl'' rights for the page in order for the marked up text to be included in the page.  So, for example, with ''<nodisp 8>'' the viewer must have upload permission or greater for the namespace where the page appears; with ''<nodisp 2>'', the viewer must have edit permission or greater for the page, etc.  
 + 
 +It's possible to have several ''nodisp'' blocks on a page, each with a different ''acl'' level, so that the current user might have access to one section of text and not another. For example, the user might have write permission ((acl 2)) for a page but not create permission for its namespace.  ''<nodisp 2>'' would mark off a passage which this user could view, but ''<nodisp 4>'' would mark off one which this user does not have access to. A user with create permission for page's namespace ((acl 4)) would uhave access to both.   
 +The ACL levels are described in the [[:acl#background_info|acl documentation]].  
 + 
 +== Newline syntax == 
 +<code> 
 +{nodisp} your text here {/nodisp} 
 + 
 +{nodisp} 
 +your text here 
 +etc 
 +{/nodisp} 
 + 
 +{nodisp acl} your text here {/nodisp} 
 + 
 +{nodisp acl} 
 +your text here 
 +etc 
 +{/nodisp} 
 +</code> 
 +The ''<nodisp. . . >'' syntax sets off blocks of text. If you place two blocks, one after the other, there will be a paragraph break between the two.  The newline syntax treats the enclosed text as a single line unless an extra newline (CR/LF) or the DokuWiki newline markup is inserted. This conforms to the practice of the DokuWiki editor. If you place one newline entry above another, they will continue on the same line unless a newline is inserted. See https://github.com/turnermm/nodisp/issues/
 + 
 +If you are upgrading from an earlier version of nodisp, which does not support the newline syntax, you will have to remove the file syntax.php from the root directory of the plugin.  This is now replaced by a new file called basic.php in the syntax directory.  
 + 
 +== Group Syntax == 
 +It is also possible to limit access to the hidden material by group. The syntax is the same as for the other cases, except that ACL numbers are replaced by a group names.  
 + 
 +<code> 
 +<nodisp group> 
 +Restricted Data 
 +</nodisp> 
 + 
 +{nodisp group}Restricted Data{/nodisp}  
 +</code>  
 + 
 +**Notice:** The group name does not use the at-sign; it is ''group'', not ''@group''
 + 
 +==== 4.1.16 DW2PDF Plugin ==== 
 + 
 +=== 4.1.16.1 Configuration Settings for dw2pdf plugin === 
 + 
 +The plugin provides a few configuration settings that can be configured in the [[plugin:config|Configuration Manager]]. Some can be overridden via url-parameters. 
 + 
 +=== 4.1.16.2 Initiate export only via URL-parameters === 
 + 
 +Per way of export a list of URL-parameters: 
 + 
 +  * Export one page 
 +    * ''do=export_pdf'' -- (required) Export current wiki page 
 +    * ''book_title=<urlencode%20title>''\\ (optional) default using the title of the wiki article. 
 + 
 +  * Export an entire namespace\\ (See [[plugin:dw2pdf#syntax|Syntax for layouted link]]) 
 +    * ''do=export_pdfns'' -- (required) Export the requested namespace 
 +    * ''book_ns=<namespace>'' -- (required) Exported namespace  
 +    * ''book_title=<urlencode%20title>'' -- (required) 
 +    * ''book_nsdepth=<number>'' -- (optional) Down to which level the pages are collected for inclusion (default: all levels included) 
 +    * ''book_order=<order>'' -- (optional) Sort included pages by ''natural''(default) or ''date'' 
 +    * ''excludes[]=<ns:ns:page>'' -- (optional) Full page id with namespace to be excluded from export. Repeat the parameter to exclude multiple pages. 
 +    * ''excludesns[]=<ns:ns>'' -- (optional) Full namespace id (no '':'' before/after) to be excluded from export. Repeat the parameter to exclude multiple namespaces. 
 + 
 + 
 +  * Export selection of pages via [[plugin:Bookcreator]] Plugin 
 +    * Parameter ''selection'' is posted with a page list -- Export page selection from [[plugin:Bookcreator]] Plugin 
 +    * ''book_title=<urlencode%20title>'' -- (required) 
 +    * ''book_skipforbiddenpages=1'' -- (optional) Default it will not export if not-accessible pages are selected  
 + 
 +  * Export a selection saved by the [[plugin:Bookcreator]] Plugin (only possible if Bookcreator plugin is installed) \\ (See also [[plugin:bookcreator#Direct export a saved selection|Bookcreator syntax for layouted links]]) 
 +    * ''do=export_pdfbook'' -- (required) 
 +    * ''savedselection=<Page id>'' -- (required) Page name(default also title of saved selection) without the namespace 
 +    * ''book_title=<urlencode%20title>'' -- (optional) Replace default title of the saved selection. 
 +    * ''book_skipforbiddenpages=1'' -- (optional) Default it will not export if not-accessible pages are selected  
 + 
 +=== 4.1.16.3 via Configuration Manager, but override-able via URL-parameters === 
 + 
 +If a url-parameter is provided, that value is used, otherwise the plugin config setting from the Configuration Manager is used. 
 + 
 +== Pagesize == 
 + 
 +''pagesize=A4|letter|etc''\\ 
 +A page format as supported by mPDF. Usually ''A4'' or ''letter''. See the docs for other allowed values for the ''format'' parameter of [[https://mpdf.github.io/reference/mpdf-functions/construct.html|\Mpdf\Mpdf(['format' => '...']);]] constructor. 
 + 
 +== Orientation == 
 + 
 +''orientation=portrait|landscape''\\ 
 +Page orientation of the whole document, you can select ''Portrait'' or ''Landscape''
 + 
 +Also you can change the orientation of only some pages. Adding the syntax will change the orientation, until you change it with the other orientation syntax. 
 + 
 +  ~~PDF:LANDSCAPE~~ 
 +  ~~PDF:PORTRAIT~~ 
 + 
 +== Double-sided document == 
 + 
 +''doublesided=0|1''\\ 
 +By default a double-sided PDF document is outputted. The first page is an odd page (left hand-side page) and further even-odd page pairs are added. Disabling this will output a single-sided document with only odd pages. The single-sided document doesn't add additional blank pages if a Table of Contents or cover page is included (and you can still send it to the printer as double-sided, but it won't have odd-even formatting). 
 + 
 +== Table of Contents == 
 + 
 +''toc=0|1''\\ 
 +and ''toclevels=<top>-<max>''\\ 
 +An auto-generated Table of Contents can be included by enabling the setting 'toc' (values: 0 or 1). By default, the same headings are added to the PDF Table of Contents as in the TOC for a wiki article (as set with [[config:toptoclevel]] and [[config:maxtoclevel]]). The range of headings can be overridden by setting 'toclevels' e.g. ''1-3''. Where the values correspond to ''<toptoclevel>-<maxtoclevel>''
 +Correct sample: ''?do=export_pdf&toc=1&toclevels=top'' 
 + 
 +== Bookmarks == 
 + 
 +''%%maxbookmarks=0|1|2|3|4|5%%''\\ 
 +By default the plugin generates PDF bookmarks for each headline in the source page. You can lower the number here to include only higher level headlines in the bookmarks. Set it ''0'' to disable bookmarks all together. 
 + 
 +== Template == 
 + 
 +''tpl=<foldername>''\\  
 +Choose which [[plugin:dw2pdf:pdftemplate|PDF template]] should be used by default. The template can be overridden with the ''tpl'' request variable e.g. add ''&tpl=yourtemplate'' to the export url. 
 + 
 +=== 4.1.16.4 Only via URL-parameter === 
 + 
 +== Watermark == 
 +''%%watermark=<urlencode%20text>%%''\\ 
 +Adding this parameter to the url adds a water mark to your document e.g. ''&watermark=DRAFT''
 + 
 +=== 4.1.16.5 Only via configuration manager === 
 + 
 +== Output Control == 
 + 
 +The ''output'' option controls if PDF should be opened within the Browser (when a PDF plugin is installed and the browser is configured correctly) or should always be downloaded. 
 + 
 +== Caching == 
 + 
 +By default, generated PDFs are cached. This includes embedded images. This means the ACLs for embedded images will not be rechecked when a user requests a cached PDF. If this is a problem, you should disable caching. 
 + 
 +== Plugin Styles == 
 + 
 +The plugin automatically uses ''print.css'' and ''pdf.css'' files of installed 3rd party plugins to style plugin content. Often plugins do not provide such styles or you may actually prefer their screen styles. In that case list the names of these plugins here. 
 + 
 +== QR code == 
 + 
 +Via a placeholder a QR code can be added in the pdf-templates, which is generated with the size given in the configuration. The plugin uses the [[https://github.com/mpdf/qrcode|QR-code library of mPDF]] ([[https://mpdf.github.io/what-else-can-i-do/barcodes.html|docs]]). Setting the size to zero will disable this feature. 
 + 
 +== Show export button == 
 + 
 +Lets you show or hide the export button in the pagetools. 
 + 
 +=== 4.1.16.6 PDF Templates === 
 +PDF Templates define the design of the created PDF files and are a good way to easily customize them to your Corporate Identity.  
 + 
 +The default PDF template which is shipped with the dw2pdf plugin is shown below. It has simple headers, footers and citation box. 
 + 
 +{{ :pdfexport_with_default_tpl.png?direct&200|The default shipped PDF template}} 
 +To create a new template, just create a new folder within the plugin's ''lib/plugins/dw2pdf/tpl/'' folder and put your header, footers, cover page, and style definitions in it. See ''lib/plugins/dw2pdf/tpl/default'' for an example. Do //**not modify**// the template ''default'', this template will be overwritten on updates, so you will lose your changes.  
 + 
 +After creation, you set in the [[plugin:config|Configuration Manager]] that your template should be used for exports. Eventually, if you like to change template incidentally, you can use the URL parameter ''&tpl=<foldername>''
 + 
 +Default the css is included for the print view (which replaces parts of the screen view to make it leaner - see also Print preview of your browser) of the wiki-[[:template]] and the active [[:plugins]]. The PDF-templates can override these styles. 
 + 
 +=== Headers and Footers === 
 + 
 +The following files can be created and will be used to set headers and footers on odd or even pages. Special headers/footers can be used on the first page of a document. If a file does not exist the next more generic one will be tried. E.g. if you don't differ between even and odd pages, just the ''header.html'' is used. 
 + 
 +  * ''header.html'' -- Header for all pages 
 +  * ''header_odd.html'' -- Header for odd pages 
 +  * ''header_even.html'' -- Header for even pages 
 +  * ''header_first.html'' -- Header for the first page 
 + 
 +  * ''footer.html'' -- Footer for all pages 
 +  * ''footer_odd.html'' -- Footer for odd pages 
 +  * ''footer_even.html'' -- Footer for even pages 
 +  * ''footer_first.html'' -- Footer for the first page 
 + 
 +  * ''citation.html'' -- Citationbox to be printed after each article 
 + 
 +  * ''cover.html'' -- If exists, added once before first page 
 +  * ''back.html'' -- If exists, added once after last page 
 + 
 +You can use all HTML that is understood by mPDF (See [[https://mpdf.github.io/|mpdf.github.io]]) 
 + 
 +If you reference image files from your pdf-template file, be sure to prefix them with the ''@TPLBASE@'' (or for some cases ''@TPLINC@'') parameter (See [[#Replacements]] below). 
 + 
 +=== Replacements === 
 + 
 +The following replacement patterns can be used within the header and 
 +footer files. 
 + 
 +  * ''@PAGE@'' -- current page number in the PDF 
 +  * ''@PAGES@'' -- number of all pages in the PDF (excluded a ToC) 
 +  * ''@TITLE@'' -- the article's title 
 +  * ''@WIKI@'' -- the wiki's title 
 +  * ''@WIKIURL@'' -- URL to the wiki 
 +  * ''@DATE@'' -- time when the PDF was created (might be in the past if cached) 
 +  * ''@BASE@'' -- the wiki base directory 
 +  * ''@TPLBASE@'' -- the URL base of PDF-template directory (use to reference images) (e.g. ''/[wikiURLbase]/lib/plugins/dw2pdf/tpl/<yourtplfolder>/''
 +  * ''@TPLINC@'' -- the absolute path to the PDF template directory on the filesystem (e.g. ''/var/www/dokuwiki/lib/plugins/dw2pdf/tpl/<yourtplfolder>/''
 +  * ''@INC@'' -- the absolute wiki install directory on the filesystem 
 +  * ''@DATE(<date>[, <format>])@'' -- formats the given date with [[config:dformat]] or with the given format such as ''%Y-%m-%e'', e.g. this would give just the current year ''@DATE(@DATE@,%Y)@'' 
 +  * ''@USERNAME@'' -- name of the user who creates the PDF 
 + 
 +//Remark about Bookcreator//: 
 +The next page dependent replacements are only for ''citation.html'' updated for every page. 
 +In the headers and footers the ID of the bookmanager page of the Bookcreator is applied. 
 +  * ''@ID@'' -- The article's pageID 
 +  * ''@PAGEURL@'' -- URL to the article 
 +  * ''@UPDATE@'' -- Time of the last update of the article 
 +  * ''@QRCODE@'' -- QR code image pointing to the original page url 
 +=== Styles === 
 + 
 +Custom stylings can be provided in the following file of your pdf-template folder: 
 + 
 +  * ''[wikibase]/lib/plugins/dw2pdf/tpl/<yourpdftplfolder>/style.css'' 
 + 
 +You can use all the CSS that is understood by mPDF \\ (See https://mpdf.github.io/css-stylesheets/supported-css.html) 
 + 
 + 
 +== Style sheets loaded by dw2pdf == 
 + 
 +Some background about css file loading. The dw2pdf loads the print style sheets of the wiki including these of plugins to get a leaner appearance of the article. A first impression can be gotten by looking in the print preview of your browser. Note that due to limitations of the mPDF-library, the final pdf can look different.  
 + 
 +During the generation of the pdf the following files are tried to load in the given order: 
 +  * ''lib/styles/screen.css'' 
 +  * ''lib/styles/print.css'' 
 +  * per plugin: 
 +    * only if requested in config setting ''plugin»dw2pdf»usestyles'': 
 +      * ''lib/plugins/<plugin>/screen.css'' and ''screen.less'' 
 +      * ''lib/plugins/<plugin>/style.css'' and ''style.less'' 
 +    * ''lib/plugins/<plugin>/all.css'' and ''all.less'' 
 +    * if exists:\\ ''lib/plugins/<plugin>/pdf.css'' and ''pdf.less'' 
 +    * if pdf.css/pdf.less not exists:\\ ''lib/plugins/<plugin>/print.css'' and ''print.less'' 
 +  * for the active [[:template]]: 
 +    * ''lib/tpl/<template>/pdf.css'' and ''pdf.less'' 
 +    * ''lib/tpl/<template>/css/pdf.css'' and ''pdf.less'' 
 +    * ''lib/tpl/<template>/styles/pdf.css'' and ''pdf.less'' 
 +  * ''lib/plugins/dw2pdf/conf/style.css'' (overwritten on each plugin update) 
 +  * ''lib/plugins/dw2pdf/tpl/<pdf-template>/style.css'' (note that the supplied example pdf-template "default" is overwritten on each plugin update, so rename/copy that pdf-template folder before making changes) 
 +  * ''lib/plugins/dw2pdf/conf/style.local.css'' (not overwritten on plugin updates) 
 +====== 5. Das Handbuch ======
  
   * [[doku>de:manual|Das Handbuch]] :!:   * [[doku>de:manual|Das Handbuch]] :!:
Zeile 1323: Zeile 1742:
   * [[doku>thanks|Demütige Danksagungen (en)]]   * [[doku>thanks|Demütige Danksagungen (en)]]
  
-===== 6. Urheberrecht =====+======6. Urheberrecht =====
  
 2004-2023 (c) Andreas Gohr <andi@splitbrain.org>((Bitte nicht für Hilfe und Unterstützung kontaktieren -- stattdessen die [[doku>mailinglist|Mailingliste]] oder das [[http://forum.dokuwiki.org|Forum]] benutzen)) und die DokuWiki Community 2004-2023 (c) Andreas Gohr <andi@splitbrain.org>((Bitte nicht für Hilfe und Unterstützung kontaktieren -- stattdessen die [[doku>mailinglist|Mailingliste]] oder das [[http://forum.dokuwiki.org|Forum]] benutzen)) und die DokuWiki Community