wiki:syntax
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| wiki:syntax [2015/10/09 09:20] – add docs for colored table cells rhaas | wiki:syntax [2024/08/05 06:28] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 84: | 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 92: | 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:// |
| - | [[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 132: | Line 137: | ||
| 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 157: | Line 162: | ||
| {{ wiki: | {{ wiki: | ||
| - | |||
| - | If you would like the title to show up as a caption as well, just surround the image by square brackets | ||
| - | |||
| - | [{{ wiki: | ||
| - | |||
| - | [{{ wiki: | ||
| For linking an image to another page see [[#Image Links]] above. | For linking an image to another page see [[#Image Links]] above. | ||
| - | ==== Directly embedding external images | + | ==== Supported Media Formats |
| - | Sometimes it is useful to directly embedd external images since the normal | + | DokuWiki |
| - | dokuwiki method requires that the dokuwiki server | + | |
| - | resource. Use direct html tags to link to the image: | + | |
| - | < | + | | Image | '' |
| - | src=" | + | | Video | '' |
| - | width=" | + | | Audio | '' |
| + | | Flash | '' | ||
| - | ==== Supported Media Formats ==== | + | If you specify a filename that is not a supported media format, then it will be displayed as a link instead. |
| - | DokuWiki can embed the following | + | By adding ''? |
| - | | Image | '' | + | {{wiki: |
| - | | Video | '' | + | |
| - | | Audio | '' | + | |
| - | | Flash | '' | + | |
| - | If you specify a filename that is not a supported media format, then it will be displayed as a link instead. | + | {{wiki: |
| ==== Fallback Formats ==== | ==== Fallback Formats ==== | ||
| Line 199: | Line 194: | ||
| Additionally DokuWiki supports a " | Additionally DokuWiki supports a " | ||
| - | ==== Image numbering ==== | ||
| - | Simple captions can be displayed by just surrounding the image tag by square | ||
| - | brackets '' | ||
| - | [{{ wiki: | ||
| - | |||
| - | [{{ wiki: | ||
| - | |||
| - | You can use the [[http:// | ||
| - | |||
| - | * ''< | ||
| - | * ''< | ||
| - | |||
| - | Concerning this ''< | ||
| - | one of the first two environments. | ||
| - | |||
| - | Captions are automatically numbered and labelled with " | ||
| - | Figures can be gives labels so that they can be referenced later on: | ||
| - | <figure label> | ||
| - | {{ wiki: | ||
| - | < | ||
| - | </ | ||
| - | Figure {{ref> | ||
| - | |||
| - | < | ||
| - | <figure label> | ||
| - | {{ wiki: | ||
| - | < | ||
| - | </ | ||
| - | Figure {{ref> | ||
| - | </ | ||
| - | and analogously for tables. | ||
| ===== Lists ===== | ===== Lists ===== | ||
| Line 257: | Line 221: | ||
| Also take a look at the [[doku> | Also take a look at the [[doku> | ||
| - | |||
| - | ===== Collapsible sections ===== | ||
| - | |||
| - | If you want to make additional information available that is hidden by default, you have two options with this plugin: | ||
| - | |||
| - | ==== Inline ==== | ||
| - | |||
| - | This is example ++text | with some of it only shown when you unfold it++. And after that | ||
| - | the text just continues to flow in the same paragraph. | ||
| - | | ||
| - | This is example ++text | with some of it only shown when you unfold it++. And after that | ||
| - | the text just continues to flow in the same paragraph. | ||
| - | |||
| - | ==== Block ==== | ||
| - | |||
| - | < | ||
| - | This is example text. | ||
| - | |||
| - | ++++ Title | | ||
| - | |||
| - | | This table | is only shown | when you unfold the block | | ||
| - | |||
| - | ++++ | ||
| - | </ | ||
| - | |||
| - | This is example text. | ||
| - | |||
| - | ++++ Title | | ||
| - | |||
| - | | This table | is only shown | when you unfold the block | | ||
| - | |||
| - | ++++ | ||
| - | |||
| - | ==== Block allowing nesting: method 1==== | ||
| - | |||
| - | < | ||
| - | This is example text. | ||
| - | |||
| - | <hidden Title> | ||
| - | |||
| - | | This table | is only shown | when you unfold the block | | ||
| - | |||
| - | <hidden Nested> | ||
| - | Some more hidden text. | ||
| - | </ | ||
| - | |||
| - | </ | ||
| - | </ | ||
| - | |||
| - | This is example text. | ||
| - | |||
| - | <hidden Title> | ||
| - | |||
| - | | This table | is only shown | when you unfold the block | | ||
| - | |||
| - | <hidden Nested> | ||
| - | Some more hidden text. | ||
| - | </ | ||
| - | |||
| - | </ | ||
| - | |||
| - | ==== Block allowing nesting: method 2==== | ||
| - | |||
| - | < | ||
| - | This is example text. | ||
| - | |||
| - | --> | ||
| - | |||
| - | Postfix Title text by %%#%% to suppress a preview, postfix Title text by %%^%% to create a section that is initially visible. | ||
| - | |||
| - | | This table | is only shown | when you unfold the block | | ||
| - | |||
| - | --> | ||
| - | Some more hidden text. | ||
| - | |||
| - | <-- | ||
| - | |||
| - | <-- | ||
| - | </ | ||
| - | |||
| - | This is example text. | ||
| - | |||
| - | --> | ||
| - | |||
| - | Postfix Title text by %%#%% to suppress a preview, postfix Title text by %%^%% to create a section that is initially visible. | ||
| - | |||
| - | | This table | is only shown | when you unfold the block | | ||
| - | |||
| - | --> | ||
| - | Some more hidden text. | ||
| - | <-- | ||
| - | |||
| - | <-- | ||
| - | |||
| - | See https:// | ||
| ===== Text Conversions ===== | ===== Text Conversions ===== | ||
| Line 378: | Line 247: | ||
| * ;-) %% ;-) %% | * ;-) %% ;-) %% | ||
| * ^_^ %% ^_^ %% | * ^_^ %% ^_^ %% | ||
| + | * m( %% m( %% | ||
| * :?: %% :?: %% | * :?: %% :?: %% | ||
| * :!: %% :!: %% | * :!: %% :!: %% | ||
| Line 404: | Line 274: | ||
| 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 | + | <code> |
| - | + | ||
| - | | + | |
| - | + | ||
| - | >> Well, I say we should | + | |
| - | + | ||
| - | > Really? | + | |
| - | + | ||
| - | >> Yes! | + | |
| - | + | ||
| - | >>> | + | |
| I think we should do it | I think we should do it | ||
| Line 427: | Line 286: | ||
| >>> | >>> | ||
| + | </ | ||
| - | ===== Citing text ===== | + | I think we should do it |
| - | The '' | + | > No we shouldn't |
| - | * '' | + | >> |
| - | * '' | + | |
| - | * '' | + | |
| - | ==== Examples ==== | + | > Really? |
| - | <code> | + | >> |
| - | < | + | |
| - | There is nothing either good or bad, but thinking makes it so. | + | |
| - | <cite>William Shakespeare, | + | >>> |
| - | </ | + | |
| - | </ | + | |
| - | < | + | |
| - | There is nothing either good or bad, but thinking makes it so. | + | |
| - | + | ||
| - | < | + | |
| - | </ | + | |
| - | + | ||
| - | < | + | |
| - | He said < | + | |
| - | </ | + | |
| - | He said < | + | |
| ===== Tables ===== | ===== Tables ===== | ||
| Line 488: | 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 518: | Line 362: | ||
| Note: Vertical alignment is not supported. | Note: Vertical alignment is not supported. | ||
| - | A background color is introduced by @ and ended by :. | ||
| - | You can use all names and color codes from HTML. | ||
| - | If you don't specify a color, yellow is used. | ||
| - | |||
| - | ^ Header 1 | ||
| - | | @lightgreen: | ||
| - | | @# | ||
| - | | Ligne 2 | Oui | ||
| - | | @:Ligne 3 | Oui | @red: | ||
| - | |||
| - | This is how it looks in the source: | ||
| - | < | ||
| - | | @lightgreen: | ||
| - | | @# | ||
| - | | Ligne 2 | Oui | ||
| - | | @:Ligne 3 | Oui | @red: | ||
| - | </ | ||
| ===== No Formatting ===== | ===== No Formatting ===== | ||
| Line 591: | Line 418: | ||
| </ | </ | ||
| - | The following language strings are currently recognized: //4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, | + | The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 |
| + | |||
| + | There are additional [[doku> | ||
| ==== Downloadable Code Blocks ==== | ==== Downloadable Code Blocks ==== | ||
| Line 608: | Line 437: | ||
| 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 ('' | ||
| - | |||
| - | |||
| - | ===== Embedding HTML and PHP ===== | ||
| - | |||
| - | You can embed raw HTML or PHP code into your documents by using the '' | ||
| - | |||
| - | HTML example: | ||
| - | |||
| - | < | ||
| - | < | ||
| - | This is some <span style=" | ||
| - | </ | ||
| - | < | ||
| - | <p style=" | ||
| - | </ | ||
| - | </ | ||
| - | |||
| - | < | ||
| - | This is some <span style=" | ||
| - | </ | ||
| - | < | ||
| - | <p style=" | ||
| - | </ | ||
| - | |||
| - | PHP example: | ||
| - | |||
| - | < | ||
| - | <php> | ||
| - | echo 'The PHP version: '; | ||
| - | echo phpversion(); | ||
| - | echo ' (generated inline HTML)'; | ||
| - | </ | ||
| - | <PHP> | ||
| - | echo '< | ||
| - | echo '< | ||
| - | echo '</ | ||
| - | </ | ||
| - | </ | ||
| - | |||
| - | <php> | ||
| - | echo 'The PHP version: '; | ||
| - | echo phpversion(); | ||
| - | echo ' (inline HTML)'; | ||
| - | </ | ||
| - | <PHP> | ||
| - | 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 668: | Line 446: | ||
| | author | | author | ||
| | date | show item dates | | | date | show item dates | | ||
| - | | description| show the item description. | + | | description| show the item description. |
| + | | 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). | | ||
| 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 '' | ||
| **Example: | **Example: | ||
| Line 693: | Line 474: | ||
| ~~INFO: | ~~INFO: | ||
| - | |||
| - | ===== MathJax ===== | ||
| - | |||
| - | This plugin adds MathJax to your wiki pages to let you easily write mathematical formulas that will be typeset and displayed cleanly. It is written to be as simple as possible; it loads and configures the script, protects TeX math expressions from other parsing, and no more. | ||
| - | |||
| - | The default configuration uses \$ (dollar signs) to delimit TeX formulas. | ||
| - | |||
| - | You can write TeX formulas in your wiki with the following [[http:// | ||
| - | |||
| - | ===Inline Math=== | ||
| - | |||
| - | Use dollar signs: | ||
| - | |||
| - | $a^2 + b^2 = c^2$ | ||
| - | |||
| - | or escaped parentheses: | ||
| - | |||
| - | \(1+2+\dots+n=\frac{n(n+1)}{2}\) | ||
| - | |||
| - | |||
| - | ===Display Math=== | ||
| - | |||
| - | To display math on its own line, use double dollar signs: | ||
| - | |||
| - | $$ \frac{d}{dx}\left( \int_{0}^{x} f(u)\, | ||
| - | |||
| - | or escaped square brackets: | ||
| - | |||
| - | \[ \sin A \cos B = \frac{1}{2}\left[ \sin(A-B)+\sin(A+B) \right] \] | ||
| - | |||
| - | A wide range of math environments will work as well: | ||
| - | |||
| - | \begin{align*} | ||
| - | e^x & = 1 + x + \frac{x^2}{2} + \frac{x^3}{6} + \cdots \\ | ||
| - | & = \sum_{n\geq 0} \frac{x^n}{n!} | ||
| - | \end{align*} | ||
wiki/syntax.1444382406.txt.gz · Last modified: 2020/07/08 17:39 (external edit)