meta data for this page
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| wiki:syntax [2023/01/08 10:28] – 1 45.227.255.148 | wiki:syntax [2024/03/08 00:34] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Formatting Syntax ====== | ====== Formatting Syntax ====== | ||
| - | [[doku& | + | [[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 & | + | DokuWiki supports **bold**, //italic//, __underlined__ and '' |
| - | Of course you can **__//& | + | Of course you can **__//'' |
| - | You can use & | + | You can use <sub>subscript</sub> and <sup>superscript</sup>, too. |
| - | You can use & | + | You can use <sub>subscript</sub> and <sup>superscript</sup>, too. |
| - | You can mark something as & | + | You can mark something as <del>deleted</del> as well. |
| - | You can mark something as & | + | You can mark something as <del>deleted</del> as well. |
| **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 36: | 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 | DokuWiki supports multiple ways of creating links. External links are recognized | ||
| automagically: | automagically: | ||
| link text as well: [[http:// | link text as well: [[http:// | ||
| - | addresses like this one: & | + | addresses like this one: <andi@splitbrain.org> are recognized, too. |
| ==== Internal ==== | ==== Internal ==== | ||
| Line 50: | Line 50: | ||
| a [[pagename]] or use an additional [[pagename|link text]]. | a [[pagename]] or use an additional [[pagename|link text]]. | ||
| - | [[doku& | + | [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, |
| You can use [[some: | You can use [[some: | ||
| Line 56: | Line 56: | ||
| You can use [[some: | You can use [[some: | ||
| - | For details about namespaces see [[doku& | + | For details about namespaces see [[doku>namespaces]]. |
| 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# | 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# | ||
| Line 65: | Line 65: | ||
| * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | ||
| - | * DokuWiki does not use [[wp& | + | * DokuWiki does not use [[wp>CamelCase]] to automatically create links by default, but this behavior can be enabled in the [[doku>config]] file. Hint: If DokuWiki is a link, then it's enabled. |
| - | * When a section& | + | * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much. |
| ==== Interwiki ==== | ==== Interwiki ==== | ||
| - | DokuWiki supports [[doku& | + | DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. |
| - | DokuWiki supports [[doku& | + | DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. |
| - | For example this is a link to Wikipedia& | + | For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. |
| ==== Windows Shares ==== | ==== 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. Please note that these only make sense in a homogeneous user group like a corporate [[wp>Intranet]]. |
| Windows Shares like [[\\server\share|this]] are recognized, too. | Windows Shares like [[\\server\share|this]] are recognized, too. | ||
| Line 83: | Line 83: | ||
| Notes: | Notes: | ||
| - | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the & | + | * 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:// | + | * For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http:// |
| - | & | + | <?php |
| /** | /** | ||
| * Customization of the english language file | * Customization of the english language file | ||
| * Copy only the strings that needs to be modified | * Copy only the strings that needs to be modified | ||
| */ | */ | ||
| - | $lang[& | + | $lang['js']['nosmblinks'] = '' |
| - | & | + | </code> |
| ==== Image Links ==== | ==== Image Links ==== | ||
| Line 113: | Line 113: | ||
| ===== Sectioning ===== | ===== Sectioning ===== | ||
| - | You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string | + | You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string |
| ==== Headline Level 3 ==== | ==== Headline Level 3 ==== | ||
| Line 129: | Line 129: | ||
| ===== Media Files ===== | ===== Media Files ===== | ||
| - | You can include external and internal [[doku& | + | You can include external and internal [[doku>images|images, |
| Real size: {{wiki: | Real size: {{wiki: | ||
| Line 135: | Line 135: | ||
| Resize to given width: | Resize to given width: | ||
| - | 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't match that of the image, it will be cropped to the new ratio before resizing)): {{wiki: |
| - | Resized external image: {{https://secure.php.net/ | + | Resized external image: {{https://www.php.net/ |
| 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: {{https://secure.php.net/ | + | Resized external image: {{https://www.php.net/ |
| Line 169: | Line 169: | ||
| DokuWiki can embed the following media formats directly. | DokuWiki can embed the following media formats directly. | ||
| - | | Image | & | + | | Image | '' |
| - | | Video | & | + | | Video | '' |
| - | | Audio | & | + | | Audio | '' |
| - | | Flash | & | + | | Flash | '' |
| If you specify a filename that is not a supported media format, then it will be displayed as a link instead. | If you specify a filename that is not a supported media format, then it will be displayed as a link instead. | ||
| - | By adding | + | By adding |
| {{wiki: | {{wiki: | ||
| Line 190: | Line 190: | ||
| {{video.mp4|A funny video}} | {{video.mp4|A funny video}} | ||
| - | When you upload a & | + | When you upload a '' |
| - | Additionally DokuWiki supports a & | + | Additionally DokuWiki supports a "poster" |
| ===== Lists ===== | ===== Lists ===== | ||
| - | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a & | + | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a '' |
| * This is a list | * This is a list | ||
| Line 206: | Line 206: | ||
| - Another item | - Another item | ||
| - Just use indention for deeper levels | - Just use indention for deeper levels | ||
| - | - That& | + | - That's it |
| - | & | + | <code> |
| * This is a list | * This is a list | ||
| * The second item | * The second item | ||
| Line 217: | Line 217: | ||
| - Another item | - Another item | ||
| - Just use indention for deeper levels | - Just use indention for deeper levels | ||
| - | - That& | + | - That's it |
| - | & | + | </code> |
| - | Also take a look at the [[doku& | + | Also take a look at the [[doku>faq: |
| ===== Text Conversions ===== | ===== Text Conversions ===== | ||
| Line 230: | Line 230: | ||
| ==== Text to Image Conversions ==== | ==== Text to Image Conversions ==== | ||
| - | DokuWiki converts commonly used [[wp& | + | DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. Those [[doku>Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki: |
| * 8-) %% 8-) %% | * 8-) %% 8-) %% | ||
| Line 258: | Line 258: | ||
| Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | ||
| - | -& | + | -> <- <-> => <= <=> >> << |
| - | & | + | "He thought |
| - | & | + | <code> |
| - | -& | + | -> <- <-> => <= <=> >> << |
| - | & | + | "He thought |
| - | & | + | </code> |
| - | The same can be done to produce any kind of HTML, it just needs to be added to the [[doku& | + | 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), | + | There are three exceptions which do not come from that pattern file: multiplication entity (640x480), |
| ===== Quoting ===== | ===== Quoting ===== | ||
| - | Some times you want to mark some text to show it& | + | Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: |
| - | & | + | <code> |
| I think we should do it | I think we should do it | ||
| - | & | + | > No we shouldn't |
| - | & | + | >> |
| - | & | + | > Really? |
| - | & | + | >> |
| - | & | + | >>> |
| - | & | + | </code> |
| I think we should do it | I think we should do it | ||
| - | & | + | > No we shouldn't |
| - | & | + | >> |
| - | & | + | > Really? |
| - | & | + | >> |
| - | & | + | >>> |
| ===== Tables ===== | ===== Tables ===== | ||
| Line 309: | Line 309: | ||
| | Row 3 Col 1 | Row 3 Col 2 | Row 3 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 ^ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
| Line 325: | Line 325: | ||
| ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
| - | As you can see, it& | + | As you can see, it's the cell separator before a cell which decides about the formatting: |
| | ^ Heading 1 ^ Heading 2 ^ | | ^ Heading 1 ^ Heading 2 ^ | ||
| Line 332: | Line 332: | ||
| ^ 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 | + | You can have rowspans (vertically connected cells) by adding |
| ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
| Line 364: | Line 364: | ||
| ===== No Formatting ===== | ===== No Formatting ===== | ||
| - | If you need to display text exactly like it is typed (without any formatting), | + | If you need to display text exactly like it is typed (without any formatting), |
| - | & | + | <nowiki> |
| This is some text which contains addresses like this: http:// | This is some text which contains addresses like this: http:// | ||
| - | & | + | </nowiki> |
| The same is true for %%// | The same is true for %%// | ||
| - | | + | |
| This is some text which contains addresses like this: http:// | This is some text which contains addresses like this: http:// | ||
| - | | + | |
| The same is true for %%// | The same is true for %%// | ||
| ===== Code Blocks ===== | ===== Code Blocks ===== | ||
| - | You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags & | + | You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags '' |
| This is text is indented by two spaces. | This is text is indented by two spaces. | ||
| - | & | + | <code> |
| - | This is preformatted code all spaces are preserved: like | + | This is preformatted code all spaces are preserved: like |
| - | & | + | </code> |
| - | & | + | <file> |
| 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. | ||
| - | & | + | </file> |
| Those blocks were created by this source: | Those blocks were created by this source: | ||
| Line 394: | Line 394: | ||
| This is text is indented by two spaces. | This is text is indented by two spaces. | ||
| - | | + | |
| - | This is preformatted code all spaces are preserved: like | + | This is preformatted code all spaces are preserved: like |
| - | | + | |
| - | | + | |
| 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. | ||
| - | | + | |
| ==== Syntax Highlighting ==== | ==== Syntax Highlighting ==== | ||
| - | [[wiki: | + | [[wiki: |
| - | & | + | <code java> |
| /** | /** | ||
| * The HelloWorldApp class implements an application that | * The HelloWorldApp class implements an application that | ||
| - | * simply displays | + | * simply displays |
| */ | */ | ||
| class HelloWorldApp { | class HelloWorldApp { | ||
| public static void main(String[] args) { | public static void main(String[] args) { | ||
| - | System.out.println(& | + | System.out.println("Hello World!"); //Display the string. |
| } | } | ||
| } | } | ||
| - | & | + | </code> |
| 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// | 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& | + | There are additional [[doku>syntax_highlighting|advanced options]] available for syntax highlighting, |
| ==== Downloadable Code Blocks ==== | ==== Downloadable Code Blocks ==== | ||
| - | When you use the & | + | When you use the '' |
| - | & | + | <code> |
| - | & | + | <file php myexample.php> |
| - | & | + | <?php echo "hello world!"; ?> |
| - | & | + | </file> |
| - | & | + | </code> |
| - | & | + | <file php myexample.php> |
| - | & | + | <?php echo "hello world!"; ?> |
| - | & | + | </file> |
| - | If you don& | + | If you don't want any highlighting but want a downloadable file, specify a dash ('' |
| - | + | ||
| - | + | ||
| - | ===== Embedding HTML and PHP ===== | + | |
| - | + | ||
| - | You can embed raw HTML or PHP code into your documents by using the & | + | |
| - | + | ||
| - | HTML example: | + | |
| - | + | ||
| - | & | + | |
| - | & | + | |
| - | This is some & | + | |
| - | & | + | |
| - | & | + | |
| - | & | + | |
| - | & | + | |
| - | & | + | |
| - | + | ||
| - | & | + | |
| - | This is some & | + | |
| - | & | + | |
| - | & | + | |
| - | & | + | |
| - | & | + | |
| - | + | ||
| - | PHP example: | + | |
| - | + | ||
| - | & | + | |
| - | & | + | |
| - | echo & | + | |
| - | echo phpversion(); | + | |
| - | echo & | + | |
| - | & | + | |
| - | & | + | |
| - | echo & | + | |
| - | echo & | + | |
| - | echo & | + | |
| - | & | + | |
| - | & | + | |
| - | + | ||
| - | & | + | |
| - | echo & | + | |
| - | echo phpversion(); | + | |
| - | echo & | + | |
| - | & | + | |
| - | & | + | |
| - | echo & | + | |
| - | echo & | + | |
| - | echo & | + | |
| - | & | + | |
| - | + | ||
| - | **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 ===== | ===== RSS/ATOM Feed Aggregation ===== | ||
| Line 497: | Line 446: | ||
| | author | | author | ||
| | date | show item dates | | | date | show item dates | | ||
| - | | description| show the item description. | + | | description| show the item description. |
| | nosort | | nosort | ||
| | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | ||
| Line 503: | Line 452: | ||
| The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki: | 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 & | + | By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the '' |
| **Example: | **Example: | ||
| - | {{rss& | + | {{rss>http:// |
| - | {{rss& | + | {{rss>http:// |
| Line 518: | Line 467: | ||
| ^ Macro ^ Description | | ^ Macro ^ Description | | ||
| | %%~~NOTOC~~%% | | %%~~NOTOC~~%% | ||
| - | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%& | + | | %%~~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 | |
| ===== Syntax Plugins ===== | ===== Syntax Plugins ===== | ||
| - | DokuWiki& | + | DokuWiki's syntax can be extended by [[doku>plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation: |
| ~~INFO: | ~~INFO: | ||
| - | 1 | + | |
| - | 1 | + | |