| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung |
| dokuwiki_manual [2023/09/13 14:30] – [4.1.12 Wrap Plugin] cbuehler | dokuwiki_manual [2023/09/15 12:04] (aktuell) – [4.1.12 Wrap Plugin] cbuehler |
|---|
| //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}}]] |
| |
| ---- | ---- |
| {{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 ==== |
| |
| === 4.1.11.1 Syntax === | === 4.1.11.1 Syntax === |
| |
| The width has to be specified at the start of a line before the table. The first value is used as width of the table, the rest is for columns. If you want to omit some value use a dash instead. The widths can be specified in any CSS units: | Die Breite muss am Anfang einer Zeile vor der Tabelle angegeben werden. Der erste Wert wird als Breite der Tabelle verwendet, der Rest ist für die Spalten. Wenn Sie einen Wert auslassen möchten, verwenden Sie stattdessen einen Bindestrich. Die Breiten können in beliebigen CSS-Einheiten angegeben werden: |
| |
| <code> | <code> |
| </code> | </code> |
| |
| The relative units (percentage) for the table width refer to the width of the page, and when used for columns they refer for the table wight. For example, the 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 Prozent) für die Tabellenbreite beziehen sich auf die Breite der Seite, und wenn sie für Spalten verwendet werden, beziehen 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 specification, the width will be applied to the columns from left to right: | Wenn die Tabelle mehr Spalten enthält, als Werte in der Breitenangabe vorhanden sind, wird 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 plugins. Wrap 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 kombiniert. Packen 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 === |
| ''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. |
| |
| ==== 4.1.13 Extended Table Syntax 3 ==== | ==== 4.1.13 Extended Table Syntax 3 Plugin ==== |
| |
| ---- plugin ---- | ---- plugin ---- |
| >> 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 />%%'' | >> 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 ==== | ==== 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. | 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. |
| Code based on the [[plugin:highlight|plugin highlight]] | Code based on the [[plugin:highlight|plugin highlight]] |
| |
| ==== 4.1.15 nodisp ==== | ==== 4.1.15 nodisp Plugin ==== |
| |
| === Examples/Usage === | === Examples/Usage === |
| **Notice:** The group name does not use the at-sign; it is ''group'', not ''@group''. | **Notice:** The group name does not use the at-sign; it is ''group'', not ''@group''. |
| |
| ==== 4.1.16 Table Width ==== | ==== 4.1.16 DW2PDF Plugin ==== |
| |
| The width has to be specified at the start of a line before the table. The first value is used as width of the table, the rest is for columns. If you want to omit some value use a dash instead. The widths can be specified in any CSS units: | === 4.1.16.1 Configuration Settings for dw2pdf plugin === |
| |
| <code> | The plugin provides a few configuration settings that can be configured in the [[plugin:config|Configuration Manager]]. Some can be overridden via url-parameters. |
| |< 100% 50px - 5em 10em 10% >| | |
| ^ A ^ B ^ C ^ D ^ E ^ | |
| | 1 | 2 | 3 | 4 | 5 | | |
| </code> | |
| |
| The relative units (percentage) for the table width refer to the width of the page, and when used for columns they refer for the table width. For example, the width specification ''|< 50% 50% 50% >|'' makes the table half width of the page and two equal columns quarter of the page width each. | === 4.1.16.2 Initiate export only via URL-parameters === |
| |
| If there are more columns in the table than there are values in the width specification, the width will be applied to the columns from left to right: | Per way of export a list of URL-parameters: |
| |
| <code> | * Export one page |
| |< 50em 20% >| | * ''do=export_pdf'' -- (required) Export current wiki page |
| ^ 20% ^ 80% ^ | * ''book_title=<urlencode%20title>''\\ (optional) default using the title of the wiki article. |
| | Specified width | The rest of the table width | | |
| </code> | * 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 ====== | ====== 5. Das Handbuch ====== |
| |
