Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
wiki:syntax [2012/01/04 13:42] – [Syntax Plugins] nick | wiki:syntax [2019/11/11 09:18] (current) – [Footnotes] kevinbowen | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Formatting Syntax ====== | ====== Formatting Syntax ====== | ||
- | |||
[[doku> | [[doku> | ||
+ | |||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | * **[[syntax# | ||
+ | |||
+ | ---- | ||
+ | |||
===== Basic Text Formatting ===== | ===== Basic Text Formatting ===== | ||
Line 29: | Line 48: | ||
You should use forced newlines only if really needed. | You should use forced newlines only if really needed. | ||
+ | |||
+ | ---- | ||
===== Links ===== | ===== Links ===== | ||
Line 99: | Line 120: | ||
The whole [[# | The whole [[# | ||
+ | |||
+ | [[|Back To Top]] | ||
+ | ---- | ||
===== Footnotes ===== | ===== Footnotes ===== | ||
Line 106: | Line 130: | ||
You can add footnotes ((This is a footnote)) by using double parentheses. | You can add footnotes ((This is a footnote)) by using double parentheses. | ||
+ | ---- | ||
===== Sectioning ===== | ===== Sectioning ===== | ||
Line 132: | Line 157: | ||
Resize to given width and height((when the aspect ratio of the given width and height doesn' | Resize to given width and height((when the aspect ratio of the given width and height doesn' | ||
- | Resized external image: | + | Resized external image: |
Real size: {{wiki: | Real size: {{wiki: | ||
Resize to given width: | Resize to given width: | ||
Resize to given width and height: {{wiki: | Resize to given width and height: {{wiki: | ||
- | Resized external image: | + | Resized external image: |
Line 161: | Line 186: | ||
For linking an image to another page see [[#Image Links]] above. | For linking an image to another page see [[#Image Links]] above. | ||
+ | |||
+ | [[|Back To Top]] | ||
+ | ---- | ||
===== Lists ===== | ===== Lists ===== | ||
Line 189: | Line 217: | ||
Also take a look at the [[doku> | Also take a look at the [[doku> | ||
+ | |||
+ | ---- | ||
===== Text Conversions ===== | ===== Text Conversions ===== | ||
Line 236: | Line 266: | ||
There are three exceptions which do not come from that pattern file: multiplication entity (640x480), ' | There are three exceptions which do not come from that pattern file: multiplication entity (640x480), ' | ||
+ | |||
+ | [[|Back To Top]] | ||
+ | ---- | ||
===== Quoting ===== | ===== Quoting ===== | ||
Line 264: | Line 297: | ||
>>> | >>> | ||
+ | |||
+ | ---- | ||
===== Tables ===== | ===== Tables ===== | ||
Line 326: | Line 361: | ||
Note: Vertical alignment is not supported. | Note: Vertical alignment is not supported. | ||
+ | |||
+ | [[|Back To Top]] | ||
+ | ---- | ||
===== No Formatting ===== | ===== No Formatting ===== | ||
Line 340: | Line 378: | ||
</ | </ | ||
The same is true for %%// | The same is true for %%// | ||
+ | |||
+ | ---- | ||
===== Code Blocks ===== | ===== Code Blocks ===== | ||
Line 367: | Line 407: | ||
</ | </ | ||
- | ==== Syntax Highlighting ==== | ||
- | |||
- | [[wiki: | ||
- | |||
- | <code java> | ||
- | /** | ||
- | * The HelloWorldApp class implements an application that | ||
- | * simply displays "Hello World!" | ||
- | */ | ||
- | class HelloWorldApp { | ||
- | public static void main(String[] args) { | ||
- | System.out.println(" | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | The following language strings are currently recognized: //4cs, abap, actionscript-french, | ||
==== Downloadable Code Blocks ==== | ==== Downloadable Code Blocks ==== | ||
Line 401: | Line 424: | ||
If you don't want any highlighting but want a downloadable file, specify a dash ('' | If you don't want any highlighting but want a downloadable file, specify a dash ('' | ||
+ | [[|Back To Top]] | ||
+ | ---- | ||
- | ===== Embedding HTML and PHP ===== | + | ===== Notes ===== |
- | You can embed raw HTML or PHP code into your documents by using the '' | + | Different types of notes are supported in the wiki. Using the following format: |
- | HTML example: | + | <note $type> |
- | < | + | $type can be 4 values: important, classic (same as using nothing), tip and warning. |
- | < | + | |
- | This is some <span style=" | + | |
- | </ | + | |
- | < | + | |
- | <p style=" | + | |
- | </ | + | |
- | </ | + | |
- | <html> | + | <note important>A note using **important**.</note> |
- | This is some <span style=" | + | |
- | </ | + | |
- | < | + | |
- | <p style=" | + | |
- | </HTML> | + | |
- | PHP example: | + | <note classic> |
- | <code> | + | <note tip>A note using **tip**.</note> |
- | < | + | |
- | echo 'A logo generated by PHP:'; | + | |
- | echo '< | + | |
- | echo ' | + | |
- | </ | + | |
- | < | + | |
- | echo '< | + | |
- | echo '< | + | |
- | echo '</ | + | |
- | </ | + | |
- | </code> | + | |
- | <php> | + | <note warning>A note using **warning**.</note> |
- | echo 'A logo generated by PHP:'; | + | |
- | echo '< | + | |
- | echo ' | + | |
- | </ | + | |
- | < | + | |
- | echo '< | + | |
- | echo '< | + | |
- | echo '</ | + | |
- | </PHP> | + | |
- | **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. | + | ---- |
- | ===== RSS/ATOM Feed Aggregation | + | ===== GUI Sequences |
- | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | + | |
- | ^ Parameter | + | Because of the documentation and manual target, there is a special syntax for GUI sequences or labels on the interface. The same for key combinations. |
- | | any number | will be used as maximum number items to show, defaults to 8 | | + | |
- | | reverse | + | |
- | | author | + | |
- | | date | show item dates | | + | |
- | | description| show the item description. If [[doku> | + | |
- | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | + | |
- | The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki: | + | You can open the preferences using {gui> |
+ | | ||
+ | {gui> | ||
+ | |||
+ | You can open the preferences using {gui> | ||
- | **Example: | + | ---- |
- | {{rss> | + | ===== Figures ===== |
+ | To give images a description and make then distinct from the rest of the text, you can use the figure tag. | ||
- | ===== Control Macros ===== | + | <figure " |
+ | {{: | ||
+ | </ | ||
- | Some syntax influences how DokuWiki renders | + | This will place the contents between the tags in a table with the string between the brackets as a table comment. |
- | ^ Macro ^ Description | | + | <figure " |
- | | %%~~NOTOC~~%% | + | {{: |
- | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call | | + | </figure> |
+ | ---- | ||
+ | ===== Definition Lists ===== | ||
+ | |||
+ | Common to describe dialogs are definition lists. The syntax to write those is as follows: | ||
+ | |||
+ | ? Term 1 | ||
+ | ! This is the definition of the first term. | ||
+ | ? Term 2 | ||
+ | ! This is the definition of the second term. | ||
+ | ? Term 3 | ||
+ | ! Maybe the 3rd term has three possible values: | ||
+ | ? Term 3.1 | ||
+ | ! This is the definition of the first subterm. | ||
+ | ? Term 3.2 | ||
+ | ! This is the definition of the second irst subterm. | ||
+ | ? Term 3.3 | ||
+ | ! This is the definition of the third subterm. | ||
+ | |||
+ | ? Term 1 | ||
+ | ! This is the definition of the first term. | ||
+ | ? Term 2 | ||
+ | ! This is the definition of the second term. | ||
+ | ? Term 3 | ||
+ | ! Maybe the 3rd term has three possible values: | ||
+ | ? Term 3.1 | ||
+ | ! This is the definition of the first subterm. | ||
+ | ? Term 3.2 | ||
+ | ! This is the definition of the second irst subterm. | ||
+ | ? Term 3.3 | ||
+ | ! This is the definition of the third subterm. | ||
+ | | ||
+ | ---- | ||
+ | [[|Back To Top]] |