This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | |||
wiki:syntax [2019/08/04 00:53] Bob Varkevisser [Supported Services] |
wiki:syntax [2020/01/22 14:10] Bob Varkevisser |
||
---|---|---|---|
Line 67: | Line 67: | ||
* DokuWiki does not use [[wp> | * 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 ==== | ||
Line 77: | Line 84: | ||
* For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone" | * 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 | + | |
- | /** | + | LANG.nosmblinks = ''; |
- | * Customization of the english language file | + | |
- | * Copy only the strings that needs to be modified | + | |
- | */ | + | |
- | $lang[' | + | |
- | </ | + | |
==== Image Links ==== | ==== Image Links ==== | ||
Line 90: | Line 92: | ||
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:// | + | [[http://www.php.net|{{wiki: |
- | [[http:// | + | [[http://www.php.net|{{wiki: |
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 120: | Line 122: | ||
---- | ---- | ||
- | ===== Media Files ===== | + | ===== Images and Other Files ===== |
- | You can include external and internal [[doku> | + | You can include external and internal [[doku> |
Real size: {{wiki: | Real size: {{wiki: | ||
Line 130: | Line 132: | ||
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 155: | Line 157: | ||
{{ wiki: | {{ wiki: | ||
+ | |||
+ | If you specify a filename (external or internal) that is not an image ('' | ||
For linking an image to another page see [[#Image Links]] above. | 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}} | ||
- | |||
- | When you upload a '' | ||
- | |||
- | Additionally DokuWiki supports a " | ||
- | |||
- | |||
- | ---- | ||
- | |||
- | |||
- | |||
===== Lists ===== | ===== Lists ===== | ||
Line 272: | Line 241: | ||
Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: | Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: | ||
- | < | + | |
- | 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! | + | |
- | + | >>> | |
- | >>> | + | |
- | </ | + | |
I think we should do it | I think we should do it | ||
Line 330: | Line 297: | ||
^ 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 399: | Line 366: | ||
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 ==== | ||
Line 416: | Line 383: | ||
</ | </ | ||
- | The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 | + | The following language strings are currently recognized: //4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, |
- | + | ||
- | There are additional [[doku> | + | |
==== Downloadable Code Blocks ==== | ==== Downloadable Code Blocks ==== | ||
Line 438: | Line 402: | ||
- | ===== Embedding HTML ===== | + | ===== Embedding HTML and PHP ===== |
- | You can embed raw HTML code into your documents by using the '' | + | You can embed raw HTML or PHP code into your documents by using the '' |
HTML example: | HTML example: | ||
Line 460: | Line 424: | ||
</ | </ | ||
- | + | PHP example: | |
- | ===== 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 %%< | + | |
- | + | ||
- | + | ||
- | ====== Examples of Wrapping ====== | + | |
- | + | ||
- | ===== Basic syntax ===== | + | |
- | + | ||
- | An uppercase **%%< | + | |
- | + | ||
- | <WRAP classes width : | + | |
- | " | + | |
- | </ | + | |
- | + | ||
- | or | + | |
- | <block classes width : | + | |
- | " | + | |
- | </ | + | |
- | + | ||
- | or | + | |
- | <div classes width : | + | |
- | " | + | |
- | </ | + | |
- | + | ||
- | A lowercase **%%< | + | |
- | + | ||
- | <wrap classes width : | + | |
- | + | ||
- | or | + | |
- | <inline classes width : | + | |
- | + | ||
- | or | + | |
- | <span classes width : | + | |
- | + | ||
- | :!: Please note, some things **won' | + | |
- | * **alignments** (including alignments generated by changing the text direction) | + | |
- | * **multi-columns** | + | |
- | * and **widths** | + | |
- | if the according wrap isn't floated as well. | + | |
- | + | ||
- | + | ||
- | ===== Classes and Styles ===== | + | |
- | + | ||
- | + | ||
- | ==== Columns and Floats ==== | + | |
- | + | ||
- | You can have columns easily by adding the class '' | + | |
- | <WRAP column 30%> | + | |
- | + | ||
- | <WRAP column 30%> | + | |
- | // | + | |
- | + | ||
- | You can emulate a big headline with italic, bold and underlined text, e.g. | + | |
- | < | + | |
- | + | ||
- | // | + | |
- | + | ||
- | A smaller headline uses no underlining, | + | |
- | < | + | |
- | + | ||
- | If you need text that is bold and italic, simply use it the other way around: | + | |
- | < | + | |
- | </ | + | |
- | + | ||
- | <WRAP column 30%> | + | |
- | // | + | |
- | + | ||
- | Normally you would only need the class '' | + | |
- | + | ||
- | * **'' | + | |
- | * **'' | + | |
- | * **'' | + | |
- | * **'' | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | <WRAP column 30%> | + | |
- | // | + | |
- | + | ||
- | You can set any valid widths (but only on divs): '' | + | |
- | + | ||
- | ^type^e.g.^note^ | + | |
- | ^'' | + | |
- | ^'' | + | |
- | ^'' | + | |
- | + | ||
- | A **table** inside a column or box will always be **100% wide**. This makes positioning and sizing tables possible. | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | <wrap em>After using any of the float classes, you might come across something like this, where the following text protrudes into the space where only the floating containers should be ...</ | + | |
- | + | ||
- | <WRAP clear></ | + | |
- | + | ||
- | ... to prevent that, you should simply add | + | |
- | <WRAP clear></ | + | |
- | after your last column. | + | |
- | + | ||
- | You **can** use the same options with spans (as each element that floats is automatically a block level element), but it probably doesn' | + | |
- | + | ||
- | :!: Attention: Widths can cause problems and will often look different and break in some browsers. If you're not a web developer, you might not understand any problems regarding the [[http:// | + | |
- | + | ||
- | All of those options will also work in the [[#boxes and notes]] wraps (see below). | + | |
- | + | ||
- | === Multi-columns === | + | |
- | + | ||
- | <WRAP col3> | + | |
- | For modern browsers (Firefox, Chrome and Safari) you can use multi-columns. Just use **'' | + | |
- | + | ||
- | :!: Note: Multi-columns don't make sense for spans. | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | ==== Alignments ==== | + | |
- | + | ||
- | You can use these different text alignments: | + | |
- | + | ||
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | + | ||
- | <WRAP centeralign> | + | |
- | Center aligned text ... | + | |
- | </ | + | |
- | + | ||
- | <WRAP rightalign> | + | |
- | ... and right aligned. | + | |
- | </ | + | |
< | < | ||
- | <WRAP centeralign> | + | <php> |
- | Center aligned text ... | + | echo 'A logo generated by PHP:'; |
- | </WRAP> | + | echo '< |
- | + | echo ' | |
- | <WRAP rightalign> | + | </php> |
- | ... and right aligned. | + | <PHP> |
- | </WRAP> | + | echo '<table class=" |
+ | echo '< | ||
+ | echo '</ | ||
+ | </PHP> | ||
</ | </ | ||
- | :!: You cannot add alignments to spans. | + | < |
+ | echo 'A logo generated by PHP:'; | ||
+ | echo '< | ||
+ | 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. | ||
- | ==== Boxes and Notes ==== | + | ===== RSS/ATOM Feed Aggregation |
+ | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | ||
- | <WRAP round box 570px center> | + | ^ Parameter |
- | //**__round box 570px center__**// | + | | 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>config: | ||
+ | | //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 |
- | * any of the classes '' | + | |
- | * the classes '' | + | |
- | * '' | + | |
- | </WRAP> | + | |
+ | **Example: | ||
- | <WRAP info 220px left> | + | {{rss>http://slashdot.org/index.rss 5 author date 1h }} |
- | //**Info**// | + | |
- | <WRAP info></ | + | |
- | </ | + | |
+ | {{rss> | ||
- | <WRAP tip 220px left> | ||
- | //**Tip**// | ||
- | <WRAP tip></ | ||
- | </ | ||
+ | ===== Control Macros ===== | ||
- | <WRAP important 220px left> | + | Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: |
- | // | + | |
- | <WRAP important></ | + | |
- | </ | + | |
+ | ^ Macro ^ Description | | ||
+ | | %%~~NOTOC~~%% | ||
+ | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%< | ||
- | <WRAP alert 220px left> | + | ===== Syntax Plugins |
- | // | + | |
- | <WRAP alert></ | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | <WRAP round help 220px left> | + | |
- | // | + | |
- | <WRAP round help></ | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | <WRAP download 220px left> | + | |
- | // | + | |
- | <WRAP download></ | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | <WRAP todo 220px left> | + | |
- | // | + | |
- | <WRAP todo></ | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | <WRAP clear></ | + | |
- | + | ||
- | + | ||
- | **Safety Notes:** | + | |
- | + | ||
- | <WRAP danger 27% left> | + | |
- | // | + | |
- | <WRAP danger></ | + | |
- | </ | + | |
- | + | ||
- | <WRAP warning 27% left> | + | |
- | // | + | |
- | <WRAP warning></ | + | |
- | </ | + | |
- | + | ||
- | <WRAP caution 27% left> | + | |
- | // | + | |
- | <WRAP caution></ | + | |
- | </ | + | |
- | + | ||
- | <WRAP round notice 27% left> | + | |
- | // | + | |
- | <WRAP round notice></ | + | |
- | </ | + | |
- | + | ||
- | <WRAP round safety 27% left> | + | |
- | // | + | |
- | <WRAP round safety></ | + | |
- | </ | + | |
- | + | ||
- | <WRAP clear></ | + | |
- | + | ||
- | + | ||
- | You can use notes and boxes also inside text with spans like this: | + | |
- | <wrap info> | + | |
- | <wrap info> | + | |
- | + | ||
- | ==== Marks ==== | + | |
- | + | ||
- | You can mark text as <wrap hi> | + | |
- | + | ||
- | You can mark text as <wrap hi> | + | |
- | + | ||
- | :!: This might look ugly in some templates and should be adjusted accordingly. | + | |
- | + | ||
- | ==== Miscellaneous ==== | + | |
- | + | ||
- | === Indent === | + | |
- | + | ||
- | <wrap indent> | + | |
- | + | ||
- | <wrap indent> | + | |
- | + | ||
- | === Outdent === | + | |
- | + | ||
- | <wrap outdent> | + | |
- | + | ||
- | <wrap outdent> | + | |
- | + | ||
- | === Prewrap === | + | |
- | + | ||
- | <WRAP prewrap 250px> | + | |
- | < | + | |
- | Inside this code block the words will wrap to a new line although they are all in one line. | + | |
- | </ | + | |
- | </ | + | |
- | + | ||
- | <WRAP prewrap 250px> | + | |
- | < | + | |
- | Inside this code block the words will wrap to a new line although they are all in one line. | + | |
- | </ | + | |
- | </ | + | |
- | + | ||
- | === Spoiler === | + | |
- | + | ||
- | Here follows a spoiler: <wrap spoiler> | + | |
- | + | ||
- | Here follows a spoiler: <wrap spoiler> | + | |
- | + | ||
- | Just select the text in the spoiler box to be able to read its content. | + | |
- | + | ||
- | === Hide === | + | |
- | + | ||
- | The following text is hidden: <wrap hide> | + | |
- | + | ||
- | The following text is hidden: <wrap hide> | + | |
- | + | ||
- | :!: Warning: The text will still appear in the source code, in non-modern browsers and is searchable. Do not hide any security risky secrets with it! | + | |
- | + | ||
- | === Pagebreak === | + | |
- | + | ||
- | The following will add a pagebreak: <WRAP pagebreak></ | + | |
- | + | ||
- | The following will add a pagebreak: <WRAP pagebreak></ | + | |
- | + | ||
- | This has no effect on the browser screen. A [[http:// | + | |
- | + | ||
- | === Nopagebreak === | + | |
- | + | ||
- | The following will try to avoid a pagebreak: <WRAP nopagebreak> | + | |
- | + | ||
- | The following will try to avoid a pagebreak: <WRAP nopagebreak> | + | |
- | + | ||
- | This also has no effect on the browser screen. It will try to [[http:// | + | |
- | + | ||
- | === Noprint === | + | |
- | + | ||
- | <wrap noprint> | + | |
- | + | ||
- | <wrap noprint> | + | |
- | + | ||
- | === Onlyprint === | + | |
- | + | ||
- | <wrap onlyprint> | + | |
- | + | ||
- | <wrap onlyprint> | + | |
- | + | ||
- | ==== Typography ==== | + | |
- | + | ||
- | I advice against using the following typography classes. It's better to create semantic classes that reflect their meaning instead. | + | |
- | + | ||
- | * font family: '' | + | |
- | * font size: '' | + | |
- | * font colour: '' | + | |
- | * background colour: '' | + | |
- | + | ||
- | + | ||
- | ==== Combining and Nesting ==== | + | |
- | + | ||
- | You can combine and nest all classes and types of boxes, e.g. | + | |
- | + | ||
- | <WRAP box bggreen fgblack 350px right :en> | + | |
- | //**__Outer green box floats right__**// | + | |
- | + | ||
- | <WRAP 165px left> | + | |
- | Inner nested box floats left and is partly <wrap em hi> | + | |
- | </ | + | |
- | + | ||
- | Text inside outer right box, but beneath inner left box. | + | |
- | + | ||
- | <WRAP clear></ | + | |
- | + | ||
- | <WRAP round tip> | + | |
- | Round tip box underneath, after a '' | + | |
- | </ | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | + | ||
- | < | + | |
- | <WRAP box bggreen fgblack 350px right :en> | + | |
- | //**__Outer green box floats right__**// | + | |
- | + | ||
- | <WRAP 165px left> | + | |
- | Inner nested box floats left and is partly <wrap em hi> | + | |
- | </ | + | |
- | + | ||
- | Text inside outer right box, but beneath inner left box. | + | |
- | + | ||
- | <WRAP clear></ | + | |
- | + | ||
- | <WRAP round tip> | + | |
- | Round tip box underneath, after a '' | + | |
- | </ | + | |
- | + | ||
- | </ | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | ===== Draft ===== | + | |
- | + | ||
- | Draft allows you to hide a page for everyone that is not signed in. | + | |
- | + | ||
- | === Usage === | + | |
- | + | ||
- | * To hide a page, simply add '' | + | |
- | * In case you are using German language, the code is '' | + | |
- | * In case you are using Norwegian language, the code is '' | + | |
- | * The plugin also adds a button to the far right of the editing buttons that looks like a // | + | |
- | + | ||
- | === Effect === | + | |
- | + | ||
- | If you are an unregistered user, the page will not show up. If you are registered, you can see the page, as well as a red warning on the top of the page, which reminds you that the following page is a draft; hidden from the view of unregistered users. | + | |
+ | DokuWiki' | ||
+ | ~~INFO: | ||