wiki:syntax
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
wiki:syntax [2007/05/10 20:32] – Ian the Admin | wiki:syntax [2023/04/04 12:21] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Formatting Syntax ====== | ====== Formatting Syntax ====== | ||
- | [[wiki:DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing | + | [[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing |
- | ===== Basic text formatting | + | ===== Basic Text Formatting |
DokuWiki supports **bold**, //italic//, __underlined__ and '' | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
- | < | + | |
- | DokuWiki supports **bold**, //italic//, __underlined__ and '' | + | Of course you can **__//'' |
- | Of course you can **__//'' | + | |
- | </ | + | |
You can use < | You can use < | ||
- | < | + | |
- | You can use < | + | |
- | </ | + | |
You can mark something as < | You can mark something as < | ||
- | < | + | |
- | You can mark something as < | + | |
- | </ | + | |
**Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line. | **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line. | ||
Line 30: | Line 24: | ||
or followed by\\ a whitespace \\this happens without it. | or followed by\\ a whitespace \\this happens without it. | ||
- | < | + | |
- | This is some text with some linebreaks\\ Note that the | + | two backslashes are only recognized at the end of a line\\ |
- | two backslashes are only recognized at the end of a line\\ | + | or followed by\\ a whitespace \\this happens without it. |
- | or followed by\\ a whitespace \\this happens without it. | + | |
- | </ | + | |
You should use forced newlines only if really needed. | You should use forced newlines only if really needed. | ||
Line 44: | Line 36: | ||
==== External ==== | ==== External ==== | ||
- | External links are recognized automagically: | + | External links are recognized automagically: |
- | < | + | |
- | DokuWiki supports multiple ways of creating links. External links are recognized | + | automagically: |
- | automagically: | + | link text as well: [[http:// |
- | Linknames, too: [[http:// | + | addresses like this one: < |
- | addresses like this one: < | + | |
- | </ | + | |
==== Internal ==== | ==== Internal ==== | ||
- | Internal links are created by using square brackets. You can either just give a [[doku> | + | Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]]. |
- | < | + | |
- | Internal links are created by using square brackets. You can either just give | + | a [[pagename]] or use an additional [[pagename|link text]]. |
- | a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames | + | |
- | are converted to lowercase automatically, | + | |
- | </ | + | |
- | You can use [[wiki: | + | [[doku> |
- | < | + | You can use [[some: |
- | You can use [[wiki: | + | |
- | </ | + | |
- | For details about namespaces see [[doku> | + | You can use [[some: |
- | Linking to a specific section is possible, too. Just add the sectionname behind a hash character as known from HTML. This links to [[syntax# | + | For details about namespaces see [[doku> |
- | < | + | Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax# |
- | This links to [[syntax# | + | |
- | </ | + | This links to [[syntax# |
Notes: | Notes: | ||
- | * Links to [[wiki:syntax|existing pages]] are shown in a different style from [[wiki:nonexisting]] ones. | + | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. |
+ | * DokuWiki does not use [[wp> | ||
* When a section' | * When a section' | ||
+ | ==== Interwiki ==== | ||
+ | DokuWiki supports [[doku> | ||
+ | |||
+ | DokuWiki supports [[doku> | ||
+ | For example this is a link to Wikipedia' | ||
+ | |||
+ | ==== Windows Shares ==== | ||
+ | |||
+ | Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp> | ||
+ | |||
+ | Windows Shares like [[\\server\share|this]] are recognized, too. | ||
+ | |||
+ | Notes: | ||
+ | |||
+ | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone" | ||
+ | * For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http:// | ||
+ | <?php | ||
+ | /** | ||
+ | * Customization of the english language file | ||
+ | * Copy only the strings that needs to be modified | ||
+ | */ | ||
+ | $lang[' | ||
+ | </ | ||
==== Image Links ==== | ==== Image Links ==== | ||
Line 88: | Line 97: | ||
You can also use an image to link to another internal or external page by combining the syntax for links and [[# | You can also use an image to link to another internal or external page by combining the syntax for links and [[# | ||
- | < | + | |
- | [[http://www.php.net|{{wiki: | + | |
- | </ | + | |
- | [[http://www.php.net|{{wiki: | + | [[http:// |
Please note: The image formatting is the only formatting syntax accepted in link names. | Please note: The image formatting is the only formatting syntax accepted in link names. | ||
Line 102: | Line 109: | ||
You can add footnotes ((This is a footnote)) by using double parentheses. | 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 114: | Line 119: | ||
== Headline Level 5 == | == Headline Level 5 == | ||
- | < | + | |
- | ==== Headline Level 3 ==== | + | === Headline Level 4 === |
- | === Headline Level 4 === | + | == Headline Level 5 == |
- | == Headline Level 5 == | + | |
- | </ | + | |
By using four or more dashes, you can make a horizontal line: | By using four or more dashes, you can make a horizontal line: | ||
Line 124: | Line 127: | ||
---- | ---- | ||
- | ===== Images and other files ===== | + | ===== Media Files ===== |
- | You can include external and internal [[doku> | + | You can include external and internal [[doku> |
Real size: {{wiki: | Real size: {{wiki: | ||
Line 132: | Line 135: | ||
Resize to given width: | Resize to given width: | ||
- | Resize to given width and height: {{wiki: | + | 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: | + | 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: | + | |
- | </ | + | |
- | By using left or right whitespaces you can choose the alignment | + | By using left or right whitespaces you can choose the alignment. |
{{ wiki: | {{ wiki: | ||
Line 152: | Line 153: | ||
{{ wiki: | {{ wiki: | ||
- | < | + | |
- | {{ wiki: | + | {{wiki: |
- | {{wiki: | + | {{ wiki: |
- | {{ wiki: | + | |
- | </ | + | |
Of course, you can add a title (displayed as a tooltip by most browsers), too. | Of course, you can add a title (displayed as a tooltip by most browsers), too. | ||
Line 162: | Line 161: | ||
{{ wiki: | {{ wiki: | ||
- | < | + | |
- | {{ wiki: | + | |
- | </ | + | For linking an image to another page see [[#Image Links]] above. |
+ | |||
+ | ==== Supported Media Formats ==== | ||
+ | |||
+ | DokuWiki can embed the following media formats directly. | ||
+ | |||
+ | | Image | '' | ||
+ | | Video | '' | ||
+ | | Audio | '' | ||
+ | | Flash | '' | ||
+ | |||
+ | If you specify a filename that is not a supported media format, then it will be displayed as a link instead. | ||
+ | |||
+ | By adding ''? | ||
+ | |||
+ | {{wiki: | ||
+ | |||
+ | {{wiki: | ||
+ | |||
+ | ==== Fallback Formats ==== | ||
+ | |||
+ | Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility. | ||
+ | |||
+ | For example consider this embedded mp4 video: | ||
+ | |||
+ | {{video.mp4|A funny video}} | ||
- | If you specify | + | When you upload |
- | For linking an image to another page see [[Image Links]] | + | Additionally DokuWiki supports a " |
===== Lists ===== | ===== Lists ===== | ||
Line 196: | Line 220: | ||
</ | </ | ||
- | ===== Smileys ===== | + | Also take a look at the [[doku> |
- | DokuWiki converts commonly used [[wp> | + | ===== Text Conversions ===== |
+ | |||
+ | DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML. | ||
+ | |||
+ | The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, | ||
+ | |||
+ | ==== Text to Image Conversions ==== | ||
+ | |||
+ | DokuWiki converts commonly used [[wp> | ||
* 8-) %% 8-) %% | * 8-) %% 8-) %% | ||
Line 215: | Line 247: | ||
* ;-) %% ;-) %% | * ;-) %% ;-) %% | ||
* ^_^ %% ^_^ %% | * ^_^ %% ^_^ %% | ||
+ | * m( %% m( %% | ||
* :?: %% :?: %% | * :?: %% :?: %% | ||
* :!: %% :!: %% | * :!: %% :!: %% | ||
Line 221: | Line 254: | ||
* DELETEME %% DELETEME %% | * DELETEME %% DELETEME %% | ||
- | ===== Typography ===== | + | ==== Text to HTML Conversions |
- | [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | + | Typography: |
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
Line 233: | Line 266: | ||
</ | </ | ||
- | Please note: These conversions | + | The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]]. |
+ | |||
+ | There are three exceptions which do not come from that pattern file: multiplication entity (640x480), ' | ||
===== Quoting ===== | ===== Quoting ===== | ||
Line 241: | Line 276: | ||
< | < | ||
I think we should do it | I think we should do it | ||
- | | + | |
> No we shouldn' | > No we shouldn' | ||
- | | + | |
>> Well, I say we should | >> Well, I say we should | ||
- | | + | |
> Really? | > Really? | ||
- | | + | |
>> Yes! | >> Yes! | ||
- | | + | |
>>> | >>> | ||
</ | </ | ||
Line 267: | Line 302: | ||
===== Tables ===== | ===== Tables ===== | ||
- | DokuWiki supports a simple syntax to create tables. | + | DokuWiki supports a simple syntax to create tables. |
^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
| Row 2 Col 1 | some colspan (note the double pipe) || | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
- | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | | + | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | |
Table rows have to start and end with a '' | Table rows have to start and end with a '' | ||
- | < | + | |
- | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | + | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | |
- | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | + | | Row 2 Col 1 | some colspan (note the double pipe) || |
- | | Row 2 Col 1 | some colspan (note the double pipe) || | + | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | |
- | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | | + | |
- | </ | + | |
To connect cells horizontally, | To connect cells horizontally, | ||
Line 294: | Line 327: | ||
As you can see, it's the cell separator before a cell which decides about the formatting: | As you can see, it's the cell separator before a cell which decides about the formatting: | ||
- | < | + | |
- | | ^ Heading 1 ^ Heading 2 ^ | + | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | |
- | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | | + | ^ Heading 4 | no colspan this time | | |
- | ^ Heading 4 | no colspan this time | | | + | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | |
- | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | + | |
- | </ | + | You can have rowspans (vertically connected cells) by adding '' |
+ | |||
+ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
+ | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | ||
+ | | Row 2 Col 1 | ::: | Row 2 Col 3 | | ||
+ | | Row 3 Col 1 | ::: | Row 2 Col 3 | | ||
+ | |||
+ | Apart from the rowspan syntax those cells should not contain anything else. | ||
- | Note: Vertical | + | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ |
+ | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | ||
+ | | Row 2 Col 1 | ::: | Row 2 Col 3 | | ||
+ | | Row 3 Col 1 | ::: | Row 2 Col 3 | | ||
You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. | You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. | ||
Line 312: | Line 355: | ||
This is how it looks in the source: | This is how it looks in the source: | ||
- | < | + | |
- | ^ Table with alignment | + | | |
- | | | + | |left | |
- | |left | | + | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | |
- | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | + | |
- | </ | + | |
- | ===== Nonparsed Blocks ===== | + | Note: Vertical alignment is not supported. |
- | You can include | + | ===== No Formatting ===== |
+ | |||
+ | If you need to display text exactly like it is typed (without any formatting), | ||
+ | |||
+ | < | ||
+ | This is some text which contains addresses like this: http:// | ||
+ | </ | ||
+ | The same is true for %%// | ||
+ | |||
+ | < | ||
+ | This is some text which contains addresses like this: http:// | ||
+ | </ | ||
+ | The same is true for %%// | ||
+ | |||
+ | ===== Code Blocks ===== | ||
+ | |||
+ | You can include | ||
+ | |||
+ | This is text is indented by two spaces. | ||
< | < | ||
Line 328: | Line 387: | ||
< | < | ||
- | This is pretty much the same, but you could use it to show that you quoted a file. | + | This is pretty much the same, but you could use it to show that you quoted a file. |
</ | </ | ||
- | To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with '' | + | Those blocks were created by this source: |
- | < | + | |
- | This is some text which contains addresses like this: http:// | + | |
- | </ | + | |
- | See the source of this page to see how to use these blocks. | + | < |
+ | This is preformatted code all spaces are preserved: like <-this | ||
+ | </ | ||
+ | < | ||
+ | This is pretty much the same, but you could use it to show that you quoted a file. | ||
+ | </ | ||
+ | ==== 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 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic// | ||
+ | |||
+ | There are additional [[doku> | ||
+ | |||
+ | ==== Downloadable Code Blocks ==== | ||
+ | |||
+ | When you use the '' | ||
+ | |||
+ | < | ||
+ | <file php myexample.php> | ||
+ | <?php echo "hello world!"; | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <file php myexample.php> | ||
+ | <?php echo "hello world!"; | ||
+ | </ | ||
+ | |||
+ | If you don't want any highlighting but want a downloadable file, specify a dash ('' | ||
+ | |||
+ | ===== RSS/ATOM Feed Aggregation ===== | ||
+ | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | ||
+ | |||
+ | ^ Parameter | ||
+ | | 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. All HTML tags will be stripped | | ||
+ | | nosort | ||
+ | | //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: | ||
+ | |||
+ | By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the '' | ||
+ | |||
+ | **Example: | ||
+ | |||
+ | {{rss> | ||
+ | |||
+ | {{rss> | ||
+ | |||
+ | |||
+ | ===== Control Macros ===== | ||
+ | |||
+ | Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: | ||
+ | |||
+ | ^ Macro ^ Description | | ||
+ | | %%~~NOTOC~~%% | ||
+ | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%< | ||
===== Syntax Plugins ===== | ===== Syntax Plugins ===== | ||
- | DokuWiki' | + | DokuWiki' |
~~INFO: | ~~INFO: | ||
+ |
wiki/syntax.1178843525.txt.gz · Last modified: 2019/03/29 15:17 (external edit)