{{ wiki:dokuwiki-128.txt |Beispiel}}
=== 4.1.3.6 Automatische Verlinkung ===
Bilder werden automatisch mit einer Verlinkung zur Ihren [[wpde>Metadaten]] erstellt - Bsp.: {{wiki:dokuwiki-128.png?15}}
Dieses Verhalten kann über die Option ?nolink((ggf. mit einem "&" mit anderen Optionen wie der Größenangabe kombinieren)) unterbunden werden((Standardmäßig lässt sich [[tips:image_nolink|dieses, oft unerwünschte, Verhalten]] momentan (13.03.2009) nicht für das komplette DokuWiki deaktivieren)):
{{wiki:dokuwiki-128.png?15&nolink}}
{{wiki:dokuwiki-128.png?15&nolink}}
Außerdem kann mit ?direct das Bild, z.Bsp. als Vollansicht, direkt verlinkt werden:
{{wiki:dokuwiki-128.png?15&direct}}
{{wiki:dokuwiki-128.png?15&direct}}
=== 4.1.3.7 Videos im DokuWiki speichern ===
== Syntax ==
{{ :video_example_mp4_1280_10mg.mp4 |Video Beispiel}}
{{ :video_example_mp4_1280_10mg.mp4 |Video Beispiel}}
==== 4.1.4 Listen ====
DokuWiki kennt unsortierte und nummerierte Listen. Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit zwei Leerzeichen. Diesen Leerzeichen folgt dann ein "*" für unsortierte oder ein "-" für nummerierte Listen.
* Dies ist ein Eintrag einer unsortierten Liste
* Ein zweiter Eintrag
* Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
* Noch ein Eintrag
- Dies ist ein Eintrag einer nummerierte Liste
- Ein zweiter Eintrag
- Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
- Noch ein Eintrag
* Dies ist ein Eintrag einer unsortierten Liste
* Ein zweiter Eintrag
* Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
* Noch ein Eintrag
- Dies ist ein Eintrag einer nummerierte Liste
- Ein zweiter Eintrag
- Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
- Noch ein Eintrag
==== 4.1.5 Tabellen ====
=== 4.1.5.1 Grundlegender Aufbau ===
Mit DokuWiki können Tabellen ganz einfach erstellt werden:
^ hervorgehoben ^ zum Beispiel für ^ eine Titelzeile ^
| Zeile 1 Spalte 1 | Zeile 1 Spalte 2 | Zeile 1 Spalte 3 |
| Zeile 2 Spalte 1 | doppelte Spaltenbreite (beachte den doppelten senkrechten Strich) ||
| Zeile 3 Spalte 1 | Zeile 2 Spalte 2 | Zeile 2 Spalte 3 |
| Zeile 4 Spalte 1 | | Zeile 4 Spalte 3 |
Felder einer Tabelle starten mit "|" für ein normales Feld oder mit einem "^" für hervorgehobenes Feld.
^ hervorgehoben ^ zum Beispiel für ^ eine Titelzeile ^
| Zeile 1 Spalte 1 | Zeile 1 Spalte 2 | Zeile 1 Spalte 3 |
| Zeile 2 Spalte 1 | doppelte Spaltenbreite (beachte den doppelten senkrechten Strich) ||
| Zeile 3 Spalte 1 | Zeile 2 Spalte 2 | Zeile 2 Spalte 3 |
=== 4.1.5.2 Formatierung/Ausrichtung ===
== Leerzellen ==
Zellen über mehrere Spalten werden erzeugt wenn man, wie oben gezeigt, am Ende einer solchen Spalte so viele "|" oder "^" ohne Leerzeichen dazwischen hintereinander setzt, wie Spalten überbrückt werden sollen.
Kurz gesagt: Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern "|" oder "^" haben.
Hervorgehobene Felder in Vertikaler Ausrichtung sind auch möglich.
| ^ hervorgehoben 1 ^ hervorgehoben 2 ^
^ hervorgehoben 3 | Zeile 1 Spalte 2 | Zeile 1 Spalte 3 |
^ hervorgehoben 4 | Zeile 2 Spalte 2 | |
^ hervorgehoben 5 | Zeile 3 Spalte 2 | Zeile 3 Spalte 3 |
Wie wir sehen, entscheidet der Feldtrenner ("|" oder "^") vor einer Zelle über ihr Aussehen:
| ^ hervorgehoben 1 ^ hervorgehoben 2 ^
^ hervorgehoben 3 | Zeile 1 Spalte 2 | Zeile 1 Spalte 3 |
^ hervorgehoben 4 | Zeile 2 Spalte 2 | |
^ hervorgehoben 5 | Zeile 3 Spalte 2 | Zeile 3 Spalte 3 |
== Zellen verbinden ==
Felder über mehrere Zeilen (**vertikal verbundene Zellen**) lassen sich durch hinzufügen von '':::'' in der zu verbindenden Zelle zusammenfügen.\\
:!: Zum Stand der //Release 2015-08-10a "Detritus"// können __Zellen der ersten Zeile nicht in vertikal verbundene Zellen einbezogen werden__.
^ Titelzeile 1 ^ Titelzeile 2 ^ Titelzeile 3 ^
| Zeile 1 Spalte 1 | Diese Zelle ist vertikal verbunden | Zeile 1 Spalte 3 |
| Zeile 2 Spalte 1 | ::: | Zeile 2 Spalte 3 |
| Zeile 3 Spalte 1 | ::: | Zeile 3 Spalte 3 |
Außer den drei Doppelpunkten darf die zu verbindende Zelle keine weiteren Inhalte haben.
^ Titelzeile 1 ^ Titelzeile 2 ^ Titelzeile 3 ^
| Zeile 1 Spalte 1 | Diese Zelle ist vertikal verbunden | Zeile 1 Spalte 3 |
| Zeile 2 Spalte 1 | ::: | Zeile 2 Spalte 3 |
| Zeile 3 Spalte 1 | ::: | Zeile 3 Spalte 3 |
Felder über mehrere Spalten (**horizontal verbundene Zellen**) lassen sich durch hinzufügen von ''^'' bzw. ''|'' in der zu verbindenden Zelle zusammenfügen.
^ Titelzeile 1 ^ Titelzeile 2 ^ Titelzeile 3 ^
| Zeile 1 Spalte 1 | Diese Zelle ist horizontal verbunden ||
| Zeile 2 Spalte 1 | Zeile 2 Spalte 2 | Zeile 2 Spalte 3 |
| Zeile 3 Spalte 1 | Zeile 3 Spalte 2 | Zeile 3 Spalte 3 |
^ Titelzeile 1 ^ Titelzeile 2 ^ Titelzeile 3 ^
| Zeile 1 Spalte 1 | Diese Zelle ist horizontal verbunden ||
| Zeile 2 Spalte 1 | Zeile 2 Spalte 2 | Zeile 2 Spalte 3 |
| Zeile 3 Spalte 1 | Zeile 3 Spalte 2 | Zeile 3 Spalte 3 |
== Textausrichtung ==
Der Inhalt einer Zelle kann horizontal innerhalb der Zelle ausgerichtet werden:
* Rechtsbündig - zwei Leerzeichen links vom Text
* Linksbündig - Leerzeichen rechts vom Text
* Zentriert - zwei Leerzeichen links und rechts vom Text
^ Tabelle mit Ausrichtung |||
| Rechts | Mitte | Links |
| Links | Rechts | Mitte |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
So sieht die Formatierung aus:
^ Tabelle mit Ausrichtung ^^^
| Rechts| Mitte |Links |
|Links | Rechts| Mitte |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
| Hinweis zu dem senkrechten Balken-Zeichen: dieses Zeichen ist auf einer PC-Tastatur erreichbar über die Taste "<" bei zusätzlich gedrückter "AltGr"-Taste. Ist dort auch aufgedruckt. Apple-Nutzer erreichen das Zeichen mit der Wahltaste ("Alt") und der "7". |
==== 4.1.6 sonstige Formatierungen ====
=== 4.1.6.1 horizontale Linie ===
Mit vier aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden:
----
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."
Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden
=== 4.1.6.4 HTML und PHP einbinden ===
In einer Seite kann sowohl HTML als auch PHP direkt benutzt werden.
This is some HTML-Code
This is some HTML-Code
echo 'A logo generated by PHP:';
echo ' . ')
';
echo 'A logo generated by PHP:';
echo '';
**Achtung**: Das Einbinden von HTML und PHP in einer Seite kann in der Konfigurationsdatei ausgeschaltet werden((Konfigurationsoptionen [[config:htmlok]] bzw. [[config:phpok]])). Ist diese Option aktiviert, wird der Quellcode dieser Abschnitte als Text angezeigt und nicht ausgeführt.
**Achtung**: Das Einbinden von HTML und PHP auf einer Seite im Internet ist gewöhnlich ein schweres Sicherheitsrisiko! Diese Funktion ist nur für das Intranet gedacht!
==== 4.1.7 Kontroll-Makros ====
Einige Syntax-Befehle beeinflussen wie Dokuwiki eine Seite beim Aufruf ausgibt. Die folgenden Kontroll-Makros sind verfügbar:
^ Makro ^ Beschreibung ^
| %%~~NOTOC~~%% | Wenn dieses Makro in eine Seite eingebunden ist, wird das [[:toc|Table of Content]] nicht erstellt.|
| %%~~NOCACHE~~%% | Alle Seiten werden aus Performancegründen zwischengespeichert. Unter bestimmten Umständen ist dieses Verhalten aber nicht gewollt. Beim Einfügen dieses Makros wird DokuWiki angewiesen, den Inhalt der Seite neu aufzubauen. |
----
==== 4.1.8 Syntax-Plugins ====
Die Syntax von DokuWiki kann durch [[doku>plugins|Plugins]] erweitert werden. Wie die einzelnen Plugins benutzt werden, steht auf den zugehörigen Beschreibungsseiten. Die folgenden Plugins sind auf dieser DokuWiki Installation verfügbar:
~~INFO:syntaxplugins~~
==== 4.1.9 Color Plugin ====
Platzieren Sie dieses Code-Beispiel auf Ihrer Testumgebung:
Text
Text
Text
Text
text
text
folgendes Ergebnis sollte dann zu sehen sein:
{{https://folk.ntnu.no/hanche/tmp/dokuwiki_color_plugin.png|Color Plugin in Aktion}}
Dieses Plugin unterstützt die [[wp>X11_color_names#Color_name_chart|X11 color names]],
Hex-Dreifache (wie #123 oder #123456 für RGB),
Hex-Vierfach (#1234 oder #12345678 für RGBA),
[[https://developer.mozilla.org/en-US/docs/Web/CSS/color_value|rgb, rgba, hsl und hsla]]
Farbspezifikationen.
Dieses Plugin kann keine Syntaxfehler in Ihren Farbspezifikationen erkennen.
Wenn Sie diese Spezifikationen falsch verwenden, werden Sie nicht funktionieren.
Beachten Sie, dass nicht alle Farbspezifikationen auf allen Browsern funktionieren.
Überprüfen Sie im Zweifelsfall [[https://caniuse.com/|Can I Use]].
==== 4.1.10 Zellen Hintergrund Plugin ====
=== 4.1.10.1 Syntax und Verwendung ===
Eine Hintergrundfarbe wird durch "@" eingeleitet und durch ":" beendet.
Sie können alle Namen und Farbcodes aus HTML verwenden.
Wenn Sie keine Farbe angeben, wird Gelb verwendet.
Siehe Beispiele unten:
=== 4.1.10.2 Beispiele ===
Dieser Code:
^ Header 1 ^ Header 2 ^ Header 3 ^
| @lightgreen:**Span** || |
| @#6495ed:Ligne 1 | Oui | Oui, à valider |
| Ligne 2 | Oui | @orange: Oui |
| @:Ligne 3 | Oui | @red:Non |
erzeugt folgendes: \\
^ Header 1 ^ Header 2 ^ Header 3 ^
| @lightgreen:**Span** || |
| @#6495ed:Ligne 1 | Oui | Oui, à valider |
| Ligne 2 | Oui | @orange: Oui |
| @:Ligne 3 | Oui | @red:Non |
Dieser Code:
| @palegreen:Validé | @orange:À valider | @red:Non fonctionnel |
dieses Ergebnis: \\
| @palegreen:Validé | @orange:À valider | @red:Non fonctionnel |
=== 4.1.10.3 Features ===
* Uses HTML color codes and names [[http://html-color-codes.info/|HTML Color Code Chart]]
* Works with other table formatting (alignment, bold, ...)
==== 4.1.11 Table Width Plugin ====
=== 4.1.11.1 Syntax ===
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:
|< 100% 50px - 5em 10em 10% >|
^ A ^ B ^ C ^ D ^ E ^
| 1 | 2 | 3 | 4 | 5 |
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.
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:
|< 50em 20% >|
^ 20% ^ 80% ^
| Festgelegte Breite | Die restliche Breite der Tabelle |
==== 4.1.12 Wrap Plugin ====
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 ===
Dieses Plugin gibt Ihnen die Möglichkeit, Wiki-Text in Containern (divs oder spans) zu packen und ihnen
- eine bestimmte Klasse (mit vielen nützlichen voreingestellten Klassen)
- eine Breite
- eine Sprache mit der dazugehörigen Textrichtung
Es ersetzt potentiell eine Menge anderer Plugins und ist IMHO für viele die bessere Alternative.
Es ersetzt vollständig: [[class]], [[clearfloat]], [[div_span_shorthand]], [[divalign2]], [[divalign]], [[emphasis]], [[hide]], [[important_paragraf]], [[importanttext]], [[lang]], [[ltr]], [[noprint]], [[pagebreak]], [[side_note]], [[tip]], [[wpre]]
Es ersetzt teilweise: [[box]], [[button]], [[color]], [[columns]], [[fontcolor]], [[fontfamily]], [[fontsize2]], [[fontsize]], [[highlight]], [[layout]], [[note]], [[styler]], [[tab]], [[tablewidth]], [[typography]]
=== 4.1.12.2 Syntax ===
Basic Syntax:
"big" content
An uppercase **%%%%**) creates a **''div''** and should be used for **"big"** containers, **surrounding** paragraphs, lists, tables, etc.
"small" content
or
"small" content
or
"small" content
A lowercase **%%%%** (or alternatively **%%%%** or **%%%%**) creates a **''span''** and should be used for **"small"** containers, **inside** paragraphs, lists, tables, etc.
Since version 2013-06-13 there is also a shorthand syntax (for wraps without content):
%%''s |
| **''tabs''** | if wrapped around a list of links, will show those as tabs |
| **''hide''** | hides the text per CSS (the text will still appear in the source code, in non-modern browsers and is searchable) |
| **''noprint''** | displays text on the screen, but not in print, similar to [[noprint]] |
| **''onlyprint''** | displays text only in print, but not on the screen |
| **''pagebreak''** | forces a new page in printouts (not visible on the screen), similar to [[pagebreak]] |
| **''nopagebreak''** | tries to avoid a pagebreak in printouts (not visible on the screen) |
| **''spoiler''** | shows white text on a white background, only to be revealed by highlighting it; similar to [[hide]] |
| **''button''** | when wrapped around a link, styles it like a button |
| **''tablewidth''** | sets widths of tables inside to whichever width the wrap gets, partly replaces [[tablewidth]] |
| **''indent''** | indents the text, could be used instead of [[tab]] |
| **''outdent''** | "outdents" the text, could partly be used instead of [[outdent]] |
| **''prewrap''** | wraps text inside pre-formatted code blocks, similar to [[wpre]] |
== 4.1.12.2.2.1 Known restrictions ==
* WRAPs export to ODT format but not everything works 100%
* Round corners only work in modern browsers (no IE8 and below).
* Multiple columns only work in modern browsers (no IE9 and below).
* Width classes are experimental and only work in modern browsers (no IE8 and below).
* Normal DokuWiki Headlines used to not work and a work-around was added. Now that headlines do work, the work-around is not needed anymore but kept for backwards-compatibility. It was deprecated in version 2018-04-22 and disabled by default. They can be enabled by using the ''emulatedHeadlines'' [[#configuration_options|config option]]. The following syntax would then produce two different kinds of emulated headlines inside any wrap:
* %%//**__Big Underlined Headline__**//%% (They will look a bit different in safety notes.)
* %%//**Small Headline**//%%
You might need to adjust a few of the classes to your template's needs, especially ''hi'', ''lo'' and ''em''. If you have a dark or otherwise heavily coloured theme, please use the ''darkTpl'' [[#configuration_options|config option]].
The classes are easily adjustable and extensible. Any wishes are welcome.
=== 4.1.12.2.3 Widths ===
You can set any valid widths on any uppercase %%%% container: ''%, px, em, rem, ex, ch, vw, vh, pt, pc, cm, mm, in''. Just set the width before or after or with the classes, e.g.
...
All except percentages will be reduced to have the maximum width available on smaller screens.
You can also use the width keywords ''half'', ''third'', ''twothirds'' and ''quarter''. To work correctly they need another wrap around them. E.g.
...
...
will result in two columns next to each other, which will wrap underneath each other on smaller screens and mobile devices.
=== 4.1.12.2.4 Languages and Text Directions ===
You can change the language and the direction of a container by simply adding a colon followed by the language code, like this:
This text is explicitly marked as English.
The text direction (''rtl'', right to left or ''ltr'', left to right) will get inserted automatically and is solely dependent on the language. The list of currently supported languages is taken from: http://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code
If you like to mark a text with a different text direction than the default one, you should use divs, i.e. uppercase ''%%%%''s. Otherwise the text alignment won't change as well.
This makes it a better replacement of [[ltr]] (and [[lang]]).
=== 4.1.12.3 Demo ===
You can see a demo of the plugin on [[http://demo.selfthinker.org/plugin:wrap|demo.selfthinker.org]].
[[https://yadi.sk/i/ycbENWFjWEduTA|“Examples” (demo) in Russian]] (for v2011-05-15). [[http://pastebin.com/C9xjaEH9|Source]].
=== 4.1.12.4 Configuration options ===
^ Option ^ Description ^ Default value ^
|''noPrefix'' | Which (comma separated) class names should be excluded from being prefixed with "wrap_" (* and ? wildcards allowed) | tabs, group |
|''restrictedClasses'' | Restrict usage of plugin to these (comma separated) classes (* and ? wildcards allowed) | //(empty)// |
|''restrictionType'' | Restriction type, specifies if classes above shall be included or excluded | 0 |
|''syntaxDiv'' | Which syntax should be used in the toolbar picker for block wraps? | WRAP (other choices: div, block) |
|''syntaxSpan'' | Which syntax should be used in the toolbar picker for inline wraps? | wrap (other choices: span, inline) |
|''darkTpl'' | Optimise colours for dark templates? | 0 |
|''emulatedHeadlines'' | Use emulated headings? (deprecated) | 0 |
=== 4.1.12.5 ODT Support ===
FIXME There have been more updates to the Wrap as well as the ODT plugin, so more stuff works. The below should be updated with what works and what doesn't.
Since version 2015-06-13 the Wrap plugin supports exporting most of its functionality/styling to ODT when using at least version 2015-06-29 of the [[odt|ODT Plugin]]. By default, Wrap syntax will be exported to ODT using 'print' CSS styles. This means the exported Wrap elements will look the same when printing a wiki page. If you want to have the ODT exported Wrap elements look like displayed in the browser (i.e. with 'screen' CSS styles), then use the following ODT plugin configuration settings:
* add wrap to the 'usestyles' config setting
* set the 'media_sel' setting to 'screen'
If you prefer a user defined CSS style for the Wrap ODT export, then simply place a file 'odt.css' into the Wrap plugin folder with your own CSS code (and set config setting 'media_sel' to 'print').
Here is what is currently **not** supported:
* columns: left/right/center/column is partly supported; they are positioned correctly, but content is not floating around them
* widths are not supported except % and half/third/quarter
* boxes and notes: hardly any formatting inside them is supported, therefore emulated headings also don't work
* tabs will just show a list of links
* noprint
* nopagebreak
* onlyprint only works on boxes
* languages are set correctly but do not seem to affect text alignment
* shorthand syntax
* Not supported because not relevant in ODT: clear, prewrap
=== 4.1.12.6 Toolbar picker ===
{{ :wrap_plugin_toolbar_picker.png?nolink}}
The wrap picker in the editing toolbar adds the most common wrap syntaxes.
* "columns" creates a set of half columns
* "simple centered box" creates a standard box (60% wide, centered)
* "info, tip, important, alert, help, download, todo box" creates specifically themed boxes (also 60% wide, centered)
* "clear floats" creates a ''%%%%'', you edit (or create if it doesn't exist) your ''conf/userstyle.css'' and add your ''.wrap_myclass{}'' with its style definitions to it. (If necessary, edit ''conf/userprint.css''(( ''conf/printstyle.css'' in Anteater)) for the print view, ''conf/userrtl.css''(( ''conf/rtlstyle.css'' in Anteater)) for RTL languages and ''conf/userall.css''(( ''conf/allstyle.css'' in Anteater)) for all styles as well.)
User permissions for every file used must be similar to original DokuWiki files.
Since version 2010-03-14 you have the possibility to exclude certain class names from being prefixed with "wrap_". Just add a comma separated list of class names into the config option "noPrefix" in the configuration manager.
== 4.1.12.7.1 Examples ==
in style.css
...
Here are some [[plugin:wrap:extensions|useful Wrap extensions]] created by users of this plugin.
== 4.1.12.7.2 Add former typography classes ==
The old typography classes were removed in version 2011-05-15. If you need something similar, use the [[Block]] plugin instead. Or you can use your own and copy them to your own user styles (see [[#Extend with custom styles|above]]).
=== 4.1.12.8 How to use the helper ===
From version 2011-05-15 on the plugin includes a helper plugin which you can use to add classes, width and lang/dir to any other plugin.
== 4.1.12.8.1 Example how to get just one kind of attribute ==
.dokuwiki div.wrap_note{ /* added */
background-color: #eee;
color: #000;
padding: .5em .5em .5em .5em;
margin-bottom: 1em;
overflow: hidden;
}
call in DW-page:
// get lang from wrap helper plugin
$lang = '';
if(!plugin_isdisabled('wrap')) {
$wrap = plugin_load('helper', 'wrap');
$attr = $wrap->getAttributes($data);
if($attr['dir']) $lang = ' lang="'.$attr['lang'].'" xml:lang="'.$attr['lang'].'" dir="'.$attr['dir'].'"';
}
// add lang to your plugin's output
$renderer->doc .= '';
''getAttributes()'' expects the string with "classes #id width :language". It returns an array with
* ''$attr['class']'': CSS class(es)
* ''$attr['id']'': CSS ID
* ''$attr['width']'': width
* ''$attr['lang']'' and ''$attr['dir']'': language and text direction
== 4.1.12.8.2 Example how to get all attributes ==
// get attributes from wrap helper plugin
$attr = '';
if(!plugin_isdisabled('wrap')) {
$wrap = plugin_load('helper', 'wrap');
$attr = $wrap->buildAttributes($data, 'additionalClass');
}
// add those attributes to your plugin's output
$renderer->doc .= '';
''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 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
{| 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!
|}
| 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 ''%%%%'' and ''%%%%''. The following CSS rule-set is defined in ''style.css'' of the plugin directory:
* reducing indent width of list block in cells:
.exttable ol, .exttable ul { padding-left: 0em; }
* reducing bottom and left margin of list block in cells:
.exttable ol, .exttable ul { margin-bottom: 0.3em; margin-left: 1em; }
* suppress extra line spacing after paragraph in cells:
.exttable p { margin-bottom: 0; }
== 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:
.exttable td,
.exttable th {
**border**: 1px solid __border__;
}
=== 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.
$attrs = '[^\n\{\|\!\[]+'; // match pattern for attributes
>> Thanks for this patch, merged into the plugin release 2014-11-20.
== How to force a newline ==
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
, than s/he can add this tag at ''conf/entities.conf'' file (or at update-protected ''conf/entities.local.conf'' file) as string ''%%
%%''
==== 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:
Your own text
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 ==
your text here
your text here
etc
== The syntax for the second case ==
your text here
your text here
etc
''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 '''' the viewer must have upload permission or greater for the namespace where the page appears; with '''', 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. '''' would mark off a passage which this user could view, but '''' 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 ==
{nodisp} your text here {/nodisp}
{nodisp}
your text here
etc
{/nodisp}
{nodisp acl} your text here {/nodisp}
{nodisp acl}
your text here
etc
{/nodisp}
The '''' 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/3
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.
Restricted Data
{nodisp group}Restricted Data{/nodisp}
**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=''\\ (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='' -- (required) Exported namespace
* ''book_title='' -- (required)
* ''book_nsdepth='' -- (optional) Down to which level the pages are collected for inclusion (default: all levels included)
* ''book_order='' -- (optional) Sort included pages by ''natural''(default) or ''date''
* ''excludes[]='' -- (optional) Full page id with namespace to be excluded from export. Repeat the parameter to exclude multiple pages.
* ''excludesns[]='' -- (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='' -- (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='' -- (required) Page name(default also title of saved selection) without the namespace
* ''book_title='' -- (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=-''\\
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 ''-''.
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=''\\
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=%%''\\
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=''.
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//'' )
* ''@TPLINC@'' -- the absolute path to the PDF template directory on the filesystem (e.g. ''/var/www/dokuwiki/lib/plugins/dw2pdf/tpl//'')
* ''@INC@'' -- the absolute wiki install directory on the filesystem
* ''@DATE([, ])@'' -- 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//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//screen.css'' and ''screen.less''
* ''lib/plugins//style.css'' and ''style.less''
* ''lib/plugins//all.css'' and ''all.less''
* if exists:\\ ''lib/plugins//pdf.css'' and ''pdf.less''
* if pdf.css/pdf.less not exists:\\ ''lib/plugins//print.css'' and ''print.less''
* for the active [[:template]]:
* ''lib/tpl//pdf.css'' and ''pdf.less''
* ''lib/tpl//css/pdf.css'' and ''pdf.less''
* ''lib/tpl//styles/pdf.css'' and ''pdf.less''
* ''lib/plugins/dw2pdf/conf/style.css'' (overwritten on each plugin update)
* ''lib/plugins/dw2pdf/tpl//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:FAQ|Häufig gestellte Fragen (FAQ)]]
* [[doku>glossary|Glossar (en)]]
**DokuWiki personalisieren**
* [[doku>de:tips|Tipps und Tricks]]
* [[doku>de:template|Templates erstellen und verwenden]]
* [[doku>de:plugins|Plugins installieren]]
* [[doku>development|Entwicklungsressourcen (en)]]
**DokuWiki Feedback und Community**
* [[doku>mailinglist|Der Mailing-Liste beitreten (en)]] :!:
* [[doku>de:forum|Diskutiere mit anderen Benutzern im Forum]]
* [[doku>de:irc|Rede mit anderen Anwendern im IRC-Kanal]]
* [[https://github.com/dokuwiki/dokuwiki/issues|Bugs und gewünschte Funktionen mitteilen (en)]]
* [[http://www.wikimatrix.org/forum/viewforum.php?id=10|Teile deine Erfahrungen im WikiMatrix-Forum mit (en)]]
* [[doku>thanks|Demütige Danksagungen (en)]]
======6. Urheberrecht ======
2004-2023 (c) Andreas Gohr ((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
Die //DokuWiki-Software// (= Programmlogik) ist unter der [[http://www.gnu.org/licenses/gpl.html|GNU General Public License]] Version 2 veröffentlicht. Wenn Sie DokuWiki in Ihrem Unternehmen einsetzen, bedenken Sie den Entwickler mit einer kleinen Spende via [[https://www.paypal.com/xclick/business=andi%40splitbrain.org&item_name=DokuWiki+Donation&no_shipping=1&no_note=1&tax=0¤cy_code=EUR&lc=US|PayPal]] ;-).
Die //Inhalte im DokuWiki// auf https://www.dokuwiki.org/dokuwiki/ stehen unter der [[http://creativecommons.org/licenses/by-nc-sa/2.0/|Creative Commons Attribution-NonCommercial-ShareAlike License]] Version 2.0.
Eine Ausnahme bildet der Inhalt, der mit im Archiv heruntergeladen wird((Dateien innerhalb des ''data'' Verzeichnisses -- z. B.: ''dokuwiki.txt'', ''syntax.txt'', ''dokuwiki-128.png'')), die aus Kompatibilitätsgründen ebenfalls unter der GNU General Public License Version 2 stehen.
Sie sind nicht sicher, was das bedeutet? Siehe [[doku>de:faq:license|FAQ zur Lizenzierung]].