Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
wiki:syntax [21.09.2015 12:18] – Michael Wegener | wiki:syntax [16.07.2025 11:54] (aktuell) – Updated syntax reference with optimized structure and comprehensive plugin coverage Jane Alesi | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | <todo @mw> | + | ====== |
- | ====== Syntax ====== | + | |
- | [[DokuWiki]] zeichnet sich u. a. durch einfache Textformatierungen aus. Dadurch bleiben die Dateien, die den Inhalt enthalten, gut lesbar. | + | **System: |
- | In den nachfolgenden Abschnitten sind die möglichen Formatierungsarten aufgelistet, | + | |
- | Ein erstes Beispiel, wie der Aufbau einer Seite aussehen kann, findest du, wenn du dir diese Seite im Quelltext-Modus anzeigen lässt. Klicke dazu auf den Button " | + | |
- | Zum Ausprobieren oder Üben kann die [[playground: | + | ---- |
+ | ===== 1. Text Formatting ===== | ||
- | ====== 1 Texte ====== | + | ==== Basic Markup |
- | ===== 1.1 Formatierungen ===== | + | ``` |
+ | **bold** //italic// __underline__ '' | ||
+ | < | ||
+ | **__//'' | ||
+ | ``` | ||
- | DokuWiki unterstützt **fetten**, // | + | ==== Line Breaks ==== |
+ | ``` | ||
+ | Line 1\\ | ||
+ | Line 2 with forced break\\ | ||
+ | End of paragraph | ||
- | DokuWiki unterstützt **fetten**, // | + | New paragraph starts here |
- | | + | ``` |
- | Ebenso gibt es < | + | ---- |
- | Ebenso gibt es < | + | ===== 2. Headers & Structure ===== |
- | Text kann als < | + | ==== Header Levels ==== |
+ | ``` | ||
+ | ====== H1 (Main Title) ====== | ||
+ | ===== H2 (Section) ===== | ||
+ | ==== H3 (Subsection) ==== | ||
+ | === H4 (Sub-subsection) === | ||
+ | == H5 (Paragraph) == | ||
+ | ``` | ||
- | Text kann als < | + | ==== Control Macros ==== |
+ | ``` | ||
+ | ---- | ||
+ | ~~NOTOC~~ | ||
+ | ~~NOCACHE~~ | ||
+ | ``` | ||
- | ===== 1.2 Absätze ===== | + | ---- |
- | Ein Absatz wird durch eine leere Zeile erzeugt. Eine neue Zeile (Zeilenumbruch) kann durch zwei " | + | ===== 3. Links ===== |
- | Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.\\ Beachte: Die zwei umgekehrten Schrägstriche | + | ==== External Links ==== |
- | werden nur erkannt, wenn sie am Zeilenende stehen\\ | + | ``` |
- | oder wenn ihnen ein\\ Leerzeichen folgt.\\ So\\sieht es ohne Leerzeichen aus. | + | http:// |
+ | [[http:// | ||
+ | [[http:// | ||
+ | < | ||
+ | ``` | ||
- | Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.\\ Beachte: Die zwei umgekehrten Schrägstriche | + | ==== Internal Links ==== |
- | | + | ``` |
- | oder wenn ihnen ein\\ Leerzeichen folgt.\\ So\\sieht es ohne Leerzeichen aus. | + | [[pagename]] |
+ | [[pagename|Display text]] | ||
+ | [[namespace:page]] | ||
+ | [[# | ||
+ | [[syntax# | ||
+ | ``` | ||
- | Zeilenumbrüche durch zwei " | + | ==== Special Links ==== |
+ | ``` | ||
+ | [[doku> | ||
+ | [[\\server\share]] | ||
+ | ``` | ||
- | ===== 1.3 Überschriften ===== | + | ---- |
- | Mit fünf unterschiedlichen Ebenen, getrennt durch Überschriften, | + | |
- | Die Überschriften werden mit maximal sechs " | + | |
- | Es ist __sinnvoll__, | + | ===== 4. Media & Images ===== |
- | Wenn in einer Seite mehr als drei Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet. | + | ==== Basic Image Syntax ==== |
- | Soll dieses Inhaltsverzeichnis nicht erstellt werden, muss der Befehl: ''< | + | ``` |
+ | {{image.png}} // original size | ||
+ | {{image.png? | ||
+ | {{image.png? | ||
+ | {{https:// | ||
+ | ``` | ||
- | | + | ==== Image Alignment |
- | ===== Überschrift Ebene 2 ===== | + | ``` |
- | ==== Überschrift Ebene 3 ==== | + | {{ image.png }} // centered |
- | === Überschrift Ebene 4 === | + | {{image.png }} // left aligned |
- | == Überschrift Ebene 5 == | + | {{ image.png}} |
+ | {{image.png|Caption text}} | ||
+ | ``` | ||
- | Innerhalb von Überschriften können standardmäßig keine weiteren Formatierungen vorgenommen werden! (s. [[faq:headerlinks|FAQ | + | ==== Supported Formats ==== |
+ | - **Images:** gif, jpg, png, svg | ||
+ | - **Video:** webm, ogv, mp4 | ||
+ | - **Audio:** ogg, mp3, wav | ||
- | ===== 1.4 unformatierte Abschnitte ===== | + | ---- |
- | Um Text so anzuzeigen, wie er geschrieben wurde, egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält, kann man jede | + | ===== 5. Lists ===== |
- | Zeile mit zwei Leerzeichen beginnen (so wie es in dieser Seite angewendet wurde) oder einen der Bezeichner " | + | |
- | < | + | ==== Unordered Lists ==== |
- | Mit " | + | ``` |
- | </ | + | * First item |
+ | * Second item | ||
+ | * Nested item | ||
+ | * Another nested | ||
+ | * Back to first level | ||
+ | ``` | ||
+ | ==== Ordered Lists ==== | ||
+ | ``` | ||
+ | - First numbered | ||
+ | - Second numbered | ||
+ | - Nested numbered | ||
+ | - Another nested | ||
+ | - Back to first level | ||
+ | ``` | ||
- | <file plain Beispiel.txt> | + | ==== Mixed Lists ==== |
- | Mit dem Bezeichner " | + | ``` |
- | | + | |
- | | + | - Ordered nested |
+ | - Another ordered | ||
+ | | ||
+ | ``` | ||
- | Innerhalb von " | + | ---- |
- | <file perl HelloWorld.pl> | + | ===== 6. Tables ===== |
- | # | + | |
- | print "Hello World!\n"; | + | |
- | </ | + | |
- | <file perl HelloWorld.pl> | + | ==== Basic Table ==== |
- | # | + | ``` |
- | print "Hello World!\n"; | + | ^ Header 1 ^ Header 2 ^ Header 3 ^ |
- | </ | + | | Cell 1 | Cell 2 | Cell 3 | |
+ | | Row 2 | Data | More | | ||
+ | ``` | ||
- | Um jegliche Umwandlung durch DokuWiki abzustellen, | + | ==== Advanced Features ==== |
+ | ``` | ||
+ | ^ Header 1 ^ Header 2 ^ Header 3 ^ | ||
+ | | Cell 1 | Colspan | ||
+ | | Rowspan | ||
+ | | ::: | Cell 2 | Cell 3 | | ||
+ | ``` | ||
- | < | + | ==== Alignment ==== |
- | Dieser Text enthält links wie: http:// | + | ``` |
- | </ | + | ^ |
+ | | right| | ||
+ | ``` | ||
+ | **Rules:** 2+ spaces: left→right, | ||
- | %%Dieser Text ist nun mit %%''< | + | ---- |
- | " | + | ===== 7. Code & Formatting ===== |
- | Einfach den Quelltext dieser Seite anschauen (den Knopf " | + | ==== Inline Code ==== |
+ | ``` | ||
+ | Use '' | ||
+ | ``` | ||
- | ===== 1.5 Syntax-Hervorhebung ===== | + | ==== Code Blocks |
- | + | ``` | |
- | [[DokuWiki]] kennt Syntax-Highlighting für Quellcode, um dessen Lesbarkeit zu erhöhen. Dafür wird [[http:// | + | <code> |
- | Es wird der gleiche Bezeichner wie im vorherigen Abschnitt benutzt, nur dass er nun auch den Namen der Sprache enthält: | + | Plain code block |
- | '' | + | preserves |
+ | </ | ||
<code java> | <code java> | ||
- | /** | + | // Syntax highlighted Java |
- | * The HelloWorldApp | + | public |
- | * simply displays "Hello World!" | + | |
- | */ | + | |
- | class HelloWorldApp | + | |
public static void main(String[] args) { | public static void main(String[] args) { | ||
- | System.out.println(" | + | System.out.println(" |
} | } | ||
} | } | ||
</ | </ | ||
+ | ``` | ||
- | Es werden folgende Sprachen unterstützt: | + | ==== File Blocks ==== |
+ | ``` | ||
+ | < | ||
+ | <?php | ||
+ | echo " | ||
+ | ?> | ||
+ | </file> | ||
+ | ``` | ||
- | ===== 1.6 Zitat / Kommentar ===== | + | ==== No Formatting |
- | Um einen Text als Zitat oder Kommentar zu kennzeichnen, | + | ``` |
+ | < | ||
+ | %%**No formatting** //applied here//%% | ||
+ | ``` | ||
- | Ich denke wir sollten es tun. | + | ==== Supported Languages ==== |
- | + | **Popular: | |
- | > Nein, sollten wir nicht. | + | |
- | + | ||
- | >> Doch! | + | |
- | + | ||
- | > Wirklich? | + | |
- | + | ||
- | >> Ja! | + | |
- | + | ||
- | >>> | + | |
- | + | ||
- | >>> | + | |
- | Ich denke wir sollten es tun | + | **Complete list:** 200+ languages including assembly, fortran, cobol, ada, pascal, delphi, vb, powershell, batch, nginx, apache, docker, terraform, etc. |
- | > Nein, sollten wir nicht. | + | ---- |
- | >> Doch! | + | ===== 8. Special Elements ===== |
- | > Wirklich? | + | ==== Quotes ==== |
+ | ``` | ||
+ | > First level quote | ||
+ | >> Second level quote | ||
+ | >>> | ||
+ | ``` | ||
- | >> Ja! | + | ==== Footnotes ==== |
+ | ``` | ||
+ | Text with footnote((This is the footnote content)) | ||
+ | ``` | ||
- | >>> | + | ==== Emoticons & Symbols ==== |
+ | ``` | ||
+ | 8-) 8-O :-( :-) =) :-/ :-\ :-? :-D :-P :-O :-X :-| ;-) ^_^ | ||
+ | :?: :!: LOL FIXME DELETEME | ||
+ | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
+ | ``` | ||
- | >>> | + | ---- |
- | + | ||
- | ===== 1.7 Escapezeichen ===== | + | |
- | Will man verhindern, dass DokuWiki irgendwelche Formatierungen am bzw. Umwandlungen im Text vornimmt so kann man die Prozentzeichen benutzen | + | |
- | < | + | |
- | Die Ausgabe würde dann folgendermaßen aussehen %%[[wiki: | + | |
- | ===== 1.8 Fußnoten | + | ===== 9. RSS/ |
- | Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote)). Der Text zwischen den Klammern wird an das Ende der Seite geschrieben. Die Reihenfolge und somit die Nummerierung übernimmt DokuWiki. | + | ``` |
+ | {{rss> | ||
+ | ``` | ||
- | Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote)) | + | **Parameters: |
+ | - Number: max items to display | ||
+ | - **author:** show author names | ||
+ | - **date:** show publication dates | ||
+ | - **reverse: | ||
+ | - **1h/ | ||
- | ====== 2 Links ====== | + | ---- |
- | Mit DokuWiki können fünf unterschiedliche Arten von Links benutzt werden: | + | ===== 10. Plugin Extensions ===== |
- | ===== 2.1 Extern ===== | + | ==== Color Plugin |
+ | ``` | ||
+ | <color red>Red text</ | ||
+ | <color blue/ | ||
+ | <color # | ||
+ | ``` | ||
- | Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.com. | + | ==== Icons Plugin ==== |
- | Verweise können auch hinter eigenen Begriffen versteckt werden: [[http://www.google.com|hier ist google]]. | + | ``` |
- | E-Mail Adressen werden in spitze Klammern gesetzt: < | + | {{icon> |
+ | {{fa> | ||
+ | {{fa> | ||
+ | {{glyphicon>star? | ||
+ | ``` | ||
- | Externe Links werden automatisch erkannt: http:// | + | ==== Forms Plugin ==== |
- | | + | ``` |
- | | + | <form> |
+ | Action mail admin@example.com | ||
+ | Thanks "Thank you for your submission" | ||
- | ===== 2.2 Intern ===== | + | Fieldset " |
+ | Textbox " | ||
+ | email " | ||
+ | textarea " | ||
- | Interne Links, also Verweise auf Seiten innerhalb von DokuWiki, werden in doppelten eckigen Klammern gesetzt ("Alt Gr+8" | + | submit |
- | [[doku>pagename]] | + | </form> |
+ | ``` | ||
- | Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden: | + | ==== Tag Plugin ==== |
- | [[pagename|Beschreibung für einen Link]]. | + | ``` |
+ | {{tag> | ||
+ | {{topic> | ||
+ | {{count> | ||
+ | ``` | ||
- | Interne Links werden in doppelten eckigen Klammern gesetzt: | + | ==== ToDo Plugin ==== |
- | | + | ``` |
- | + | < | |
- | Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden: | + | <todo #> |
- | | + | <todo @user> |
+ | <todo !>High priority task</ | ||
+ | ``` | ||
- | Dateinamen für neue Seiten im Wiki werden automatisch in Kleinbuchstaben umgewandelt! | + | ==== Struct Plugin ==== |
- | Umlaute sind genauso wie Sonderzeichen nicht erlaubt! | + | ``` |
+ | ---- struct data ---- | ||
+ | schema: person | ||
+ | name: John Doe | ||
+ | email: john@example.com | ||
+ | department: IT | ||
+ | ---- | ||
+ | ``` | ||
- | Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst: [[de: | + | ==== DataTables Plugin ==== |
+ | ``` | ||
+ | < | ||
+ | ^ Name ^ Position ^ Salary ^ | ||
+ | | John | Developer | $75,000 | | ||
+ | | Jane | Designer | $65,000 | | ||
+ | | Bob | Manager | $85,000 | | ||
+ | </ | ||
+ | ``` | ||
- | Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst: | + | ==== VShare Plugin ==== |
+ | ``` | ||
+ | {{youtube> | ||
+ | {{youtube> | ||
+ | {{vimeo> | ||
+ | {{dailymotion> | ||
+ | ``` | ||
- | Weitere Informationen zu Namensbereichen: | + | ==== Wrap Plugin ==== |
+ | ``` | ||
+ | <WRAP center round info 60%> | ||
+ | **Information Box** | ||
+ | Centered, rounded info box with 60% width | ||
+ | </WRAP> | ||
- | Die Verlinkung zu einem speziellen Abschnitt innerhalb des Dokuments (Anker) ist auch möglich. Der Abschnittsnamen wird getrennt durch ein Doppelkreuz (#) an den Seitennamen gehängt. | + | <wrap em> |
+ | ``` | ||
- | Dieses Beispiel verlinkt zu [[de: | + | ---- |
- | Dieses Beispiel verlinkt zu [[de: | + | ===== 11. Reveal.js Presentations ===== |
+ | ==== Basic Setup ==== | ||
+ | ``` | ||
+ | ~~REVEAL theme~~ | ||
- | Anmerkungen: | + | ====== Main Slide ====== |
+ | Slide content here | ||
- | * Links zu [[syntax|existierenden Seiten]] werden anders angezeigt als Links zu [[nicht-existierenden]] Seiten. | + | ===== Horizontal Slide ===== |
- | * DokuWiki verwendet standardmäßig keine [[wpde> | + | Next slide content |
- | * Ändert sich eine Überschrift im Zieldokument, | + | |
- | * Anker werden klein geschrieben, | + | |
- | ===== 2.3 Interwiki ===== | + | ==== Vertical Slide ==== |
+ | Nested slide content | ||
+ | ``` | ||
- | DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku> | + | ==== Advanced Features ==== |
- | Ein Link zur Wikipedia Seite über Wikis: | + | ``` |
+ | ~~REVEAL theme=sky& | ||
- | DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku>de: | + | {{background>lightblue}} |
- | Ein Link zur Wikipedia Seite über Wikis: | + | ===== Slide with Background ===== |
- | ===== 2.4 Windows-Freigaben ===== | + | < |
+ | < | ||
+ | < | ||
- | DokuWiki kennt auch Links auf Windows-Freigaben: [[\\server\freigabe|freigegebener-Ordner]]. | + | < |
- | Dies ist allerdings nur in einer homogenen Benutzergruppe sinnvoll (siehe [[wpde>Intranet]]). | + | Speaker notes here |
+ | - Point 1 | ||
+ | - Point 2 | ||
+ | </notes> | ||
+ | ``` | ||
- | [[\\server\freigabe|this]]. | + | **Available Themes:** white, black, sky, beige, blood, league, moon, night, serif, simple, solarized, dokuwiki |
- | Hinweis: | + | ---- |
- | * Aus Sicherheitsgründen funktioniert direktes Navigieren durch die Freigaben standardmäßig nur mit dem Internet Explorer (und das nur in der " | + | |
- | * Für Mozilla und Firefox kann es durch die Option [[http:// | + | |
- | * Opera ignoriert als Sicherheitsfeature seit [[http:// | + | |
- | * Für weitere Informationen siehe: [[bug> | + | |
- | ===== 2.5 Bilder als Links ===== | + | ===== 12. Mermaid Diagrams |
- | Bilder können für einen Link auf eine interne oder externe Datei verwendet werden. Dazu wird die Syntax zur Anzeige von Links einfach mit der zur Anzeige von Bildern (siehe unten) kombiniert: | + | ==== Flowcharts ==== |
+ | ``` | ||
+ | < | ||
+ | graph TD | ||
+ | A[Start] --> B{Decision} | ||
+ | B -->|Yes| C[Action 1] | ||
+ | B -->|No| D[Action 2] | ||
+ | C --> E[End] | ||
+ | D --> E | ||
+ | </ | ||
+ | ``` | ||
- | [[http:// | + | ==== Sequence Diagrams ==== |
+ | ``` | ||
+ | < | ||
+ | sequenceDiagram | ||
+ | participant User | ||
+ | participant System | ||
+ | participant Database | ||
+ | |||
+ | User->> | ||
+ | System->> | ||
+ | Database-->> | ||
+ | System-->> | ||
+ | </ | ||
+ | ``` | ||
- | [[http:// | + | ==== Gantt Charts ==== |
+ | ``` | ||
+ | < | ||
+ | gantt | ||
+ | title Project Timeline | ||
+ | dateFormat YYYY-MM-DD | ||
+ | section Planning | ||
+ | Requirements | ||
+ | Design | ||
+ | section Development | ||
+ | Coding | ||
+ | Testing | ||
+ | </ | ||
+ | ``` | ||
- | Bitte beachte: Bildformatierungen sind die einzigen Formatierungen, die in Linknamen benutzt werden können! | + | **Supported Types:** flowchart, sequence, gantt, class, git, pie, journey, er, timeline, quadrant |
- | ====== 3 Bilder und andere Dateien ====== | + | ---- |
- | ===== 3.1 Bilder im DokuWiki speichern | + | ===== 13. System Configuration |
- | Um Bilder im DokuWiki | + | ==== Current Installation ==== |
+ | - **DokuWiki:** 2024-02-06b | ||
+ | - **Template: | ||
+ | - **PHP:** 7.4-8.1 compatible | ||
+ | - **Plugins:** 25+ active extensions | ||
- | ===== 3.2 Größe von Bildern | + | ==== Cache Management |
- | Mit geschweiften Klammern können sowohl externe als auch interne [[doku> | + | ``` |
+ | ~~NOCACHE~~ | ||
+ | ``` | ||
- | Originalgröße: | + | ==== Performance Tips ==== |
+ | - Optimize images before upload | ||
+ | - Use namespaces for organization | ||
+ | - Avoid excessive plugin usage | ||
+ | - Regular maintenance and updates | ||
- | Eine Breite vorgeben: | + | ---- |
- | Breite und Höhe vorgeben: | + | ===== 14. Troubleshooting ===== |
- | Größe für externe Bilder vorgeben: | + | ==== Common Issues ==== |
+ | | **Problem** | **Solution** | | ||
+ | | Page not updating | Use `~~NOCACHE~~` or Ctrl+F5 | | ||
+ | | Images not displaying | Check file path and permissions | | ||
+ | | Syntax not working | Verify plugin activation | | ||
+ | | PHP errors | Check PHP version compatibility | | ||
+ | | Plugin conflicts | Disable plugins individually | | ||
- | Originalgröße: | + | ==== Browser Compatibility ==== |
- | Eine Breite vorgeben: | + | - **Modern browsers:** Full support |
- | | + | - **Mobile devices:** Responsive design |
- | Größe für externe Bilder vorgeben: | + | - **Accessibility:** Screen reader compatible |
+ | - **Performance:** Optimized for speed | ||
- | ===== 3.3 Ausrichten von Bildern ===== | + | ==== Debug Strategies |
- | Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden (Links, Zentriert, Rechts). | + | 1. Check browser console for errors |
+ | 2. Verify plugin compatibility | ||
+ | 3. Test with minimal content | ||
+ | 4. Use DokuWiki debug mode | ||
+ | 5. Check server logs | ||
- | {{ wiki: | + | ---- |
- | {{wiki: | + | ===== 15. Best Practices ===== |
- | {{ wiki: | + | ==== Content Organization ==== |
+ | - Use logical heading hierarchy | ||
+ | - Implement consistent naming conventions | ||
+ | - Organize media in folders | ||
+ | - Regular content reviews | ||
- | | + | ==== Accessibility ==== |
- | | + | - Provide alt-text for images |
- | {{ wiki: | + | - Use descriptive link text |
- | {{ wiki: | + | - Maintain proper heading structure |
+ | - Test with screen readers | ||
- | Bei Ausrichtung und der Verwendung eines Titels sollte man drauf achten dass der Titel nach dem Leerzeichen kommt: | + | ==== Security |
- | + | - Keep DokuWiki updated | |
- | {{wiki: | + | - Use strong authentication |
- | {{ wiki: | + | - Review ACL settings regularly |
- | {{ wiki: | + | - Monitor for suspicious activity |
- | ===== 3.4 Tooltips ===== | + | |
- | Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden. | + | |
- | {{ wiki: | + | ==== Performance ==== |
+ | - Optimize images and media | ||
+ | - Use caching effectively | ||
+ | - Minimize plugin usage | ||
+ | - Regular maintenance | ||
- | {{ wiki: | + | ---- |
- | ===== 3.5 Dateidownload | + | ===== 16. Advanced Features |
- | Wenn eine Datei angegeben wird, die kein Bild ('' | + | ==== Namespaces ==== |
+ | ``` | ||
+ | [[namespace: | ||
+ | [[sub: | ||
+ | ``` | ||
- | {{ wiki: | + | ==== Anchors ==== |
- | < | + | ``` |
+ | [[page# | ||
+ | ``` | ||
- | ===== 3.6 Automatische Verlinkung ===== | + | ==== Interwiki Links ==== |
+ | ``` | ||
+ | [[doku> | ||
+ | [[wp> | ||
+ | [[google> | ||
+ | ``` | ||
- | Bilder werden automatisch mit einer Verlinkung zur Ihren [[wpde>Metadaten]] erstellt - Bsp.: {{wiki: | + | ==== Include Pages ==== |
+ | ``` | ||
+ | {{page>namespace:page}} | ||
+ | {{section> | ||
+ | ``` | ||
- | Dieses Verhalten kann über die Option ? | + | ---- |
- | {{wiki: | + | ===== 17. Quick Reference ===== |
- | {{wiki: | + | |
- | Außerdem kann mit ?direct das Bild, z.Bsp. als Vollansicht, | + | ==== Essential Shortcuts ==== |
+ | | **Element** | **Syntax** | **Result** | | ||
+ | | Bold | `**text**` | **text** | | ||
+ | | Italic | `//text//` | //text// | | ||
+ | | Link | `[[page|text]]` | [[page|text]] | | ||
+ | | Image | `{{image.png}}` | Image display | | ||
+ | | Code | `'' | ||
+ | | Header | `===== H2 =====` | Section header | | ||
+ | | List | ` * item` | • item | | ||
+ | | Table | `^ head ^ head ^` | Table header | | ||
- | {{wiki: | + | ==== Plugin Shortcuts ==== |
- | {{wiki: | + | | **Plugin** | **Syntax** | **Function** | |
+ | | Color | `<color red> | ||
+ | | Icon | `{{fa>home}}` | Font Awesome icon | | ||
+ | | Tag | `{{tag>tag1 tag2}}` | Page tags | | ||
+ | | Todo | `< | ||
+ | | Mermaid | `< | ||
- | ====== 4 Listen ====== | ||
- | |||
- | DokuWiki kennt unsortierte und nummerierte Listen. Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit zwei Leerzeichen. Diesen Leerzeichen folgt dann ein " | ||
- | |||
- | * 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 | ||
- | </ | ||
- | |||
- | ====== 5 Tabellen ====== | ||
- | |||
- | ===== 5.1 Grundlegender Aufbau ===== | ||
- | |||
- | Mit DokuWiki können Tabellen ganz einfach erstellt werden: | ||
- | |||
- | ^ hervorgehoben | ||
- | | 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 | | ||
- | |||
- | Felder einer Tabelle starten mit " | ||
- | |||
- | ^ hervorgehoben | ||
- | | 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 | | ||
- | |||
- | ===== 5.2 Formatierung/ | ||
- | |||
- | === Leerzellen === | ||
- | |||
- | Zellen über mehrere Spalten werden erzeugt wenn man, wie oben gezeigt, am Ende einer solchen Spalte so viele " | ||
- | Kurz gesagt: Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern " | ||
- | |||
- | 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 (" | ||
- | |||
- | | ^ 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 '':::'' | ||
- | |||
- | ^ 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 '' | ||
- | |||
- | ^ 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 | | ||
- | |||
- | 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 horizontal verbunden | ||
- | | Zeile 2 Spalte 1 | Zeile 2 Spalte 2 | ||
- | | 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| | ||
- | |Links | ||
- | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | |||
- | So sieht die Formatierung aus: | ||
- | |||
- | ^ Tabelle mit Ausrichtung | ||
- | | Rechts| | ||
- | |Links | ||
- | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | |||
- | |Hinweis zu dem senkrechten Balken-Zeichen: | ||
- | |||
- | ====== 6 sonstige Formatierungen ====== | ||
- | |||
- | ===== 6.1 horizontale Linie ===== | ||
- | Mit vier aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden: | ||
---- | ---- | ||
- | < | ||
+ | **Complete DokuWiki syntax reference for wiki.satware.com** | ||
+ | **Version: | ||
- | ===== 6.2 Smileys ===== | + | {{tag>wiki syntax dokuwiki reference guide}} |
- | + | ||
- | DokuWiki verwandelt oft genutzte [[wpde>Emoticon]]s zu kleinen Smiley-Grafiken. | + | |
- | Weitere Smiley-Grafiken können im Ordner " | + | |
- | Hier ist nun eine Übersicht der standardmäßig in DokuWiki enthaltenen Smileys: | + | |
- | + | ||
- | ^ 8-) ^ 8-O ^ :-( ^ :-) ^ =) ^ :-/ ^ :-\ ^ :-? ^ :-D ^ :-P ^ :-O ^ :-X ^ :-| ^ ;-) ^ :?: ^ :!: ^ '' | + | |
- | | %% 8-) %% | %% 8-O %% | %% :-( %% | %% :-) %% | %% =) | + | |
- | + | ||
- | ===== 6.3 Typografie ===== | + | |
- | + | ||
- | [[DokuWiki]] kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln. | + | |
- | Hier eine Liste aller Zeichen, die DokuWiki kennt: | + | |
- | + | ||
- | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | + | |
- | "He thought ' | + | |
- | + | ||
- | < | + | |
- | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | + | |
- | "He thought ' | + | |
- | </ | + | |
- | + | ||
- | Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden | + | |
- | + | ||
- | ===== 6.4 HTML und PHP einbinden ===== | + | |
- | + | ||
- | In einer Seite kann sowohl HTML als auch PHP direkt benutzt werden. | + | |
- | + | ||
- | < | + | |
- | This is some <font color=" | + | |
- | </ | + | |
- | + | ||
- | < | + | |
- | < | + | |
- | This is some <font color=" | + | |
- | </ | + | |
- | </ | + | |
- | + | ||
- | < | + | |
- | echo 'A logo generated by PHP:'; | + | |
- | echo '< | + | |
- | </ | + | |
- | + | ||
- | < | + | |
- | < | + | |
- | echo 'A logo generated by PHP:'; | + | |
- | echo '< | + | |
- | </ | + | |
- | </ | + | |
- | + | ||
- | **Achtung**: | + | |
- | + | ||
- | **Achtung**: | + | |
- | + | ||
- | ====== 7 Kontroll-Makros ====== | + | |
- | + | ||
- | Einige Syntax-Befehle beeinflussen wie Dokuwiki eine Seite beim Aufruf ausgibt. Die folgenden Kontroll-Makros sind verfügbar: | + | |
- | + | ||
- | ^ Makro ^ Beschreibung ^ | + | |
- | | %%~~NOTOC~~%% | + | |
- | | %%~~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. | | + | |
- | + | ||
- | ---- | + | |
- | ====== 8 Syntax-Plugins ====== | + | |
- | Die Syntax von DokuWiki kann durch [[doku> | + | |
- | + | ||
- | ~~INFO: | + |