This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
wiki:syntax [2011/12/16 16:38] claes |
wiki:syntax [2021/08/14 04:21] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Formatting Syntax ====== | ====== Formatting Syntax ====== | ||
- | [[doku> | + | [[doku> |
===== Basic Text Formatting ===== | ===== Basic Text Formatting ===== | ||
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[' | + | /** |
+ | * 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 122: | 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 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 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 241: | Line 273: | ||
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 297: | Line 331: | ||
^ 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 369: | Line 403: | ||
==== Syntax Highlighting ==== | ==== Syntax Highlighting ==== | ||
- | [[wiki: | + | [[wiki: |
<code java> | <code java> | ||
Line 383: | Line 417: | ||
</ | </ | ||
- | The following language strings are currently recognized: //4cs, abap, actionscript-french, actionscript, | + | The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac |
+ | |||
+ | There are additional [[doku> | ||
==== Downloadable Code Blocks ==== | ==== Downloadable Code Blocks ==== | ||
- | When you use the '' | + | When you use the '' |
< | < | ||
Line 428: | Line 464: | ||
< | < | ||
<php> | <php> | ||
- | echo 'A logo generated by PHP:'; | + | echo 'The PHP version: '; |
- | echo '< | + | echo phpversion(); |
- | echo ' | + | echo ' (generated inline HTML)'; |
</ | </ | ||
<PHP> | <PHP> | ||
echo '< | echo '< | ||
- | echo '< | + | echo '< |
echo '</ | echo '</ | ||
</ | </ | ||
Line 440: | Line 476: | ||
<php> | <php> | ||
- | echo 'A logo generated by PHP:'; | + | echo 'The PHP version: '; |
- | echo '< | + | echo phpversion(); |
- | echo ' | + | echo ' (inline HTML)'; |
</ | </ | ||
<PHP> | <PHP> | ||
echo '< | echo '< | ||
- | echo '< | + | echo '< |
echo '</ | echo '</ | ||
</ | </ | ||
Line 461: | Line 497: | ||
| date | show item dates | | | date | show item dates | | ||
| description| show the item description. If [[doku> | | description| show the item description. If [[doku> | ||
+ | | 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 479: | Line 518: | ||
| %%~~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 %%< | ||
- | ===== MathJax ===== | ||
- | ==== Examples/ | ||
- | |||
- | NOTE that the default configuration uses $ (dollar signs) to delimit TeX formulas. This may cause trouble if you have $ characters in any pages. The default configuration also lets you escape the dollar signs, however, by changing them to ' | ||
- | |||
- | Once the plugin is installed, you can write TeX formulas in your wiki with the following syntax (by default — all delimiters are configurable): | ||
- | |||
- | === Inline Math === | ||
- | Use dollar signs: | ||
- | |||
- | $a^2 + b^2 = c^2$ | ||
- | | ||
- | $a^2 + b^2 = c^2$ | ||
- | |||
- | or escaped parentheses: | ||
- | |||
- | \(1+2+\dots+n=\frac{n(n+1)}{2}\) | ||
- | |||
- | \(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)\, | ||
- | | ||
- | $$ \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] \] | ||
- | |||
- | \[ \sin A \cos B = \frac{1}{2}\left[ \sin(A-B)+\sin(A+B) \right] \] | ||
- | |||
- | ===== SyntaxHighlighter3 ===== | ||
- | ==== Syntax and Usage ==== | ||
- | |||
- | Client side syntax highlighter (with copy to clipboard functionality) based on SyntaxHighlighter Plugin by David Shin. Main differences: | ||
- | |||
- | === Usage === | ||
- | <sxh [brush alias][; options for SyntaxHighlighter]> | ||
- | ... code/text ... | ||
- | </ | ||
- | |||
- | brush alias - The brush alias (language) that SyntaxHighlighter should use. Defaults to “text” if none is provided. See SyntaxHighlighter Brushes for a complete list of available brushes. Add new brushes to the scripts directory (see plugin structure) and the alias(es) and brush file name to the available brushes string in Config Manager (example: ”…,bat cmd shBrushBat.js”). The brush file name is case sensitive. | ||
- | |||
- | options - Semicolon separated options for SyntaxHighlighter, | ||
- | |||
- | === Example === | ||
- | <sxh php; first-line: 70; highlight: [89,92]; title: New title attribute in action> | ||
- | public function render($mode, | ||
- | if($mode != ' | ||
- | if (count($data) == 3) { | ||
- | list($syntax, | ||
- | if ($syntax == ' | ||
- | // Check if there' | ||
- | if (preg_match("/ | ||
- | // Extract title(s) from attribute string. | ||
- | $attr_array = explode(";", | ||
- | $title_array = preg_grep("/ | ||
- | // Extract everything BUT title(s) from attribute string. | ||
- | $not_title_array = preg_grep("/ | ||
- | $attr = implode(";", | ||
- | // If there are several titles, use the last one. | ||
- | $title = array_pop($title_array); | ||
- | $title = preg_replace("/ | ||
- | // Add title as an attribute to the <pre /> tag. | ||
- | $renderer-> | ||
- | } else { | ||
- | // No title detected, pass all attributes as parameters to SyntaxHighlighter. | ||
- | $renderer-> | ||
- | } | ||
- | } else { | ||
- | $renderer-> | ||
- | } | ||
- | } | ||
- | return true; | ||
- | } | ||
- | </ | ||
- | |||
- | |||
- | <sxh php; first-line: 70; highlight: [89,92]; title: New title attribute in action> | ||
- | public function render($mode, | ||
- | |||
- | if($mode != ' | ||
- | |||
- | if (count($data) == 3) { | ||
- | list($syntax, | ||
- | if ($syntax == ' | ||
- | // Check if there' | ||
- | if (preg_match("/ | ||
- | // Extract title(s) from attribute string. | ||
- | $attr_array = explode(";", | ||
- | $title_array = preg_grep("/ | ||
- | // Extract everything BUT title(s) from attribute string. | ||
- | $not_title_array = preg_grep("/ | ||
- | $attr = implode(";", | ||
- | // If there are several titles, use the last one. | ||
- | $title = array_pop($title_array); | ||
- | $title = preg_replace("/ | ||
- | // Add title as an attribute to the <pre /> tag. | ||
- | $renderer-> | ||
- | } else { | ||
- | // No title detected, pass all attributes as parameters to SyntaxHighlighter. | ||
- | $renderer-> | ||
- | } | ||
- | } else { | ||
- | $renderer-> | ||
- | } | ||
- | } | ||
- | |||
- | return true; | ||
- | } | ||
- | </ | ||
- | |||
- | ===== Gallery ===== | ||
- | |||
- | A basic gallery can be added by selecting a [[: | ||
- | |||
- | {{gallery> | ||
- | |||
- | All image files in the selected namespace will be added to the image gallery. Don't forget the ":" | ||
- | |||
- | Instead of using a whole namespace of images, you can also specify a single image -- this makes most sense when combined with the lightbox mode (see below). | ||
- | |||
- | {{gallery> | ||
- | |||
- | The created gallery can be aligned by using white space (defaults to centered): | ||
- | |||
- | {{gallery> | ||
- | {{gallery> | ||
- | {{gallery> | ||
- | |||
- | Instead of a namespace, you can also give an HTTP(s) URL to any [[wp> | ||
- | |||
- | {{gallery> | ||
- | |||
- | Note: since the question mark is used to separate the parameters (see next section) the URL can not contain any question mark. To use such a feed URL with the gallery plugin, just use one of the many short URL services like [[http:// | ||
- | |||
- | E.g. instead of '' | ||
- | |||
- | Additionally, | ||
- | |||
- | ==== Parameters ==== | ||
- | |||
- | A number of parameters can be set by appending them with ''?'' | ||
- | |||
- | ^ Parameter | ||
- | | ''//< | ||
- | | ''//< | ||
- | | ''//< | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | anything containing a '' | ||
- | |||
- | __Example__: | ||
- | |||
- | {{gallery> | ||
- | |||
- | This displays all images beginning with '' | ||
- | |||
- | __Example__: | ||
- | |||
- | {{gallery>? | ||
- | |||
- | This displays all images in the current namespace using 2 parameters. Parameterlist begins with ''?'' | ||
- | |||
- | ==== About the Lightbox mode ==== | ||
- | |||
- | This mode will open the clicked picture inside the current browser window without leaving the current page((This feature is based on the [[http:// | ||
- | |||
- | The picture is downsized if necessary to fit into the current browser window. You can enlarge it with the arrow button in the top corner. | ||
- | |||
- | The following keys can be used to navigate: | ||
- | |||
- | ^ Key ^ Action ^ | ||
- | | '' | ||
- | | ''< | ||
- | | '' | ||
- | |||
- | |||
- | Note: The feature does not use [[http:// | ||
- | |||
- | ==== Known Limitations and Caveats ==== | ||
- | |||
- | === Uploading Images === | ||
- | |||
- | Uploading images is beyond the scope of this plugin. Do not request any features regarding this. | ||
- | |||
- | * Use the [[: | ||
- | * Use the [[plugin: | ||
- | * Use the Flash Uploader to upload multiple files | ||
- | * Upload the files manually via FTP to the '' | ||
- | |||
- | === Caching === | ||
- | |||
- | The gallery output is cached by default. When you add pictures later, they may not show up in the gallery: add ''& | ||
- | |||
- | Optionally use the '' | ||
- | |||
- | === EXIF Data Problems === | ||
- | |||
- | Problems with accessing [[: | ||
- | |||
- | === Lightbox Problems === | ||
- | |||
- | When the lightbox mode doesn' | ||
- | |||
- | === Images are not Resized === | ||
- | |||
- | There are different reasons why thumbnails are not created: | ||
- | * libGD extension is missing => Install the extension or configure DokuWiki to use [[config: | ||
- | * libGD extension is installed, but the source image size + overhead is larger than memory_limit set in php.ini => Lower the source image size or increase the memory_limit | ||
- | |||
- | === MediaRSS feed displays " | ||
- | |||
- | When no images from your feed are shown, be sure you don't have a question mark in your URL. Use an URL shortener as suggested above. Also be sure your feed URL (before shortening) starts with %%http://%% or %%https:// | ||
- | |||
- | === External Images are not Resized === | ||
- | |||
- | As written above, you need to increase the [[config: | ||
- | |||
- | ===== Cumulus ===== | ||
- | |||
- | < | ||
- | |||
- | * **flag** can be one or several (separated by & ) of: | ||
- | * // | ||
- | * //width// --- Width in pixels (500 or more is recommended) | ||
- | * // | ||
- | * // | ||
- | * // | ||
- | * // | ||
- | * // | ||
- | * // | ||
- | * // | ||
- | * // | ||
- | * // | ||
- | |||
- | **Example: | ||
- | |||
- | < | ||
- | |||
- | {{http:// | ||
- | |||
- | ==== Configuration ==== | ||
- | |||
- | All properties described above can also be set in the [[plugin: | ||
- | |||
- | **showtags** --- The plugin always includes all tags as standard HTML <a> links in a hidden <div> for SEO purposes but this setting decides if it should be visible as a " | ||
- | |||
- | ===== Comments ===== | ||
- | This tiny [[plugins|plugin]] allows you to leave notes to yourself (and other authors of your wiki) in the wiki source code that won't be shown on the wiki page. The syntax is like C and PHP: | ||
- | |||
- | **Example: | ||
- | < | ||
- | The text /* between the slash-asterisk and asterisk-slash */ is hidden | ||
- | </ | ||
- | **Becomes: | ||
- | The text is hidden | ||
- | \\ | ||
- | |||
- | You can also have multi-line comments: | ||
- | /** | ||
- | * @todo: rewrite this section to reflect changes made recently | ||
- | * | ||
- | * this is a longer note | ||
- | */ | ||
- | |||
- | But this single line example works too: | ||
- | |||
- | /********** added by Esther **********/ | ||
- | ===== note ===== | ||
- | < | ||
- | This is my note ! Remember it!! | ||
- | </ | ||
- | < | ||
- | This is my note ! Remember it!! | ||
- | </ | ||
- | |||
- | <note important> | ||
- | Warning ! You're about to lose your mind ;-) | ||
- | </ | ||
- | <note important> | ||
- | Warning ! You're about to lose your mind ;-) | ||
- | </ | ||
- | |||
- | <note tip> | ||
- | The clues are in the images. | ||
- | </ | ||
- | <note tip> | ||
- | The clues are in the images. | ||
- | </ | ||
- | |||
- | <note warning> | ||
- | Beware of the dog when you open the door !! | ||
- | </ | ||
- | <note warning> | ||
- | Beware of the dog when you open the door !! | ||
- | </ | ||
- | ===== Graphviz ===== | ||
- | Any Graphviz compatible graph definition can be given with graphviz tags. | ||
- | |||
- | The rendering engine can optionally be given as argument in the opening tag. Supported are dot, neato, twopi, circo and fdp with dot being the default. | ||
- | |||
- | You can also specify left, center or right to align the resulting image. | ||
- | |||
- | A parameter in the form of < | ||
- | |||
- | < | ||
- | < | ||
- | digraph finite_state_machine { | ||
- | rankdir=LR; | ||
- | size=" | ||
- | node [shape = doublecircle]; | ||
- | node [shape = circle]; | ||
- | LR_0 -> LR_2 [ label = " | ||
- | LR_0 -> LR_1 [ label = " | ||
- | LR_1 -> LR_3 [ label = " | ||
- | LR_2 -> LR_6 [ label = " | ||
- | LR_2 -> LR_5 [ label = " | ||
- | LR_2 -> LR_4 [ label = " | ||
- | LR_5 -> LR_7 [ label = " | ||
- | LR_5 -> LR_5 [ label = " | ||
- | LR_6 -> LR_6 [ label = " | ||
- | LR_6 -> LR_5 [ label = " | ||
- | LR_7 -> LR_8 [ label = " | ||
- | LR_7 -> LR_5 [ label = " | ||
- | LR_8 -> LR_6 [ label = " | ||
- | LR_8 -> LR_5 [ label = " | ||
- | } | ||
- | </ | ||
- | </ | ||
- | < | ||
- | digraph finite_state_machine { | ||
- | rankdir=LR; | ||
- | size=" | ||
- | node [shape = doublecircle]; | ||
- | node [shape = circle]; | ||
- | LR_0 -> LR_2 [ label = " | ||
- | LR_0 -> LR_1 [ label = " | ||
- | LR_1 -> LR_3 [ label = " | ||
- | LR_2 -> LR_6 [ label = " | ||
- | LR_2 -> LR_5 [ label = " | ||
- | LR_2 -> LR_4 [ label = " | ||
- | LR_5 -> LR_7 [ label = " | ||
- | LR_5 -> LR_5 [ label = " | ||
- | LR_6 -> LR_6 [ label = " | ||
- | LR_6 -> LR_5 [ label = " | ||
- | LR_7 -> LR_8 [ label = " | ||
- | LR_7 -> LR_5 [ label = " | ||
- | LR_8 -> LR_6 [ label = " | ||
- | LR_8 -> LR_5 [ label = " | ||
- | } | ||
- | </ | ||
- | |||
===== Syntax Plugins ===== | ===== Syntax Plugins ===== |