This shows you the differences between two versions of the page.
wiki:syntax [2012/11/20 19:35] claes [Timeline2] |
wiki:syntax [2021/08/14 04:21] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Formatting Syntax ====== | ||
- | |||
- | [[doku> | ||
- | |||
- | |||
- | ===== Basic Text Formatting ===== | ||
- | |||
- | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
- | |||
- | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
- | Of course you can **__//'' | ||
- | |||
- | You can use < | ||
- | |||
- | You can use < | ||
- | |||
- | 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. | ||
- | |||
- | This is some text with some linebreaks\\ Note that the | ||
- | two backslashes are only recognized at the end of a line\\ | ||
- | 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\\ | ||
- | or followed by\\ a whitespace \\this happens without it. | ||
- | |||
- | You should use forced newlines only if really needed. | ||
- | ==== Font Color ==== | ||
- | <fc # | ||
- | <fc # | ||
- | <fc # | ||
- | <fc # | ||
- | <fc # | ||
- | <fc # | ||
- | |||
- | ===== Links ===== | ||
- | |||
- | DokuWiki supports multiple ways of creating links. | ||
- | |||
- | ==== External ==== | ||
- | |||
- | External links are recognized automagically: | ||
- | |||
- | DokuWiki supports multiple ways of creating links. External links are recognized | ||
- | automagically: | ||
- | link text as well: [[http:// | ||
- | addresses like this one: < | ||
- | |||
- | ==== Internal ==== | ||
- | |||
- | 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]]. | ||
- | |||
- | [[doku> | ||
- | |||
- | You can use [[some: | ||
- | |||
- | You can use [[some: | ||
- | |||
- | 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# | ||
- | |||
- | Notes: | ||
- | |||
- | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | ||
- | * DokuWiki does not use [[wp> | ||
- | * When a section' | ||
- | |||
- | ==== Interwiki ==== | ||
- | |||
- | DokuWiki supports [[doku> | ||
- | |||
- | DokuWiki supports [[doku> | ||
- | For example this is a link to Wikipedia' | ||
- | |||
- | Examples of the 2 most used interwiki links | ||
- | [[mobot> | ||
- | [[frobo> | ||
- | | ||
- | [[mobot> | ||
- | |||
- | [[frobo> | ||
- | ==== 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:// | ||
- | |||
- | $lang[' | ||
- | |||
- | ==== Image Links ==== | ||
- | |||
- | You can also use an image to link to another internal or external page by combining the syntax for links and [[# | ||
- | |||
- | [[http:// | ||
- | |||
- | [[http:// | ||
- | |||
- | Please note: The image formatting is the only formatting syntax accepted in link names. | ||
- | |||
- | The whole [[# | ||
- | |||
- | ===== Footnotes ===== | ||
- | |||
- | 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 ===== | ||
- | |||
- | 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 4 === | ||
- | == Headline Level 5 == | ||
- | |||
- | ==== Headline Level 3 ==== | ||
- | === Headline Level 4 === | ||
- | == Headline Level 5 == | ||
- | |||
- | By using four or more dashes, you can make a horizontal line: | ||
- | |||
- | ---- | ||
- | |||
- | ===== Images and Other Files ===== | ||
- | |||
- | You can include external and internal [[doku> | ||
- | |||
- | Real size: {{wiki: | ||
- | |||
- | Resize to given width: | ||
- | |||
- | Resize to given width and height((when the aspect ratio of the given width and height doesn' | ||
- | |||
- | Resized external image: | ||
- | |||
- | Real size: {{wiki: | ||
- | Resize to given width: | ||
- | Resize to given width and height: {{wiki: | ||
- | Resized external image: | ||
- | |||
- | |||
- | By using left or right whitespaces you can choose the alignment. | ||
- | |||
- | {{ wiki: | ||
- | |||
- | {{wiki: | ||
- | |||
- | {{ wiki: | ||
- | |||
- | {{ wiki: | ||
- | {{wiki: | ||
- | {{ wiki: | ||
- | |||
- | Of course, you can add a title (displayed as a tooltip by most browsers), too. | ||
- | |||
- | {{ 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. | ||
- | |||
- | ===== Lists ===== | ||
- | |||
- | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a '' | ||
- | |||
- | * This is a list | ||
- | * The second item | ||
- | * You may have different levels | ||
- | * Another item | ||
- | |||
- | - The same list but ordered | ||
- | - Another item | ||
- | - Just use indention for deeper levels | ||
- | - That's it | ||
- | |||
- | < | ||
- | * This is a list | ||
- | * The second item | ||
- | * You may have different levels | ||
- | * Another item | ||
- | |||
- | - The same list but ordered | ||
- | - Another item | ||
- | - Just use indention for deeper levels | ||
- | - That's it | ||
- | </ | ||
- | |||
- | Also take a look at the [[doku> | ||
- | |||
- | ===== 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-O %% 8-O %% | ||
- | * :-( %% :-( %% | ||
- | * :-) %% :-) %% | ||
- | * =) %% =) %% | ||
- | * :-/ %% :-/ %% | ||
- | * :-\ %% :-\ %% | ||
- | * :-? %% :-? %% | ||
- | * :-D %% :-D %% | ||
- | * :-P %% :-P %% | ||
- | * :-O %% :-O %% | ||
- | * :-X %% :-X %% | ||
- | * :-| %% :-| %% | ||
- | * ;-) %% ;-) %% | ||
- | * ^_^ %% ^_^ %% | ||
- | * :?: %% :?: %% | ||
- | * :!: %% :!: %% | ||
- | * LOL %% LOL %% | ||
- | * FIXME %% FIXME %% | ||
- | * DELETEME %% DELETEME %% | ||
- | |||
- | ==== Text to HTML Conversions ==== | ||
- | |||
- | Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | ||
- | |||
- | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
- | "He thought ' | ||
- | |||
- | < | ||
- | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
- | "He thought ' | ||
- | </ | ||
- | |||
- | The same can be done to produce any kind of HTML, it just needs to be added to the [[doku> | ||
- | |||
- | There are three exceptions which do not come from that pattern file: multiplication entity (640x480), ' | ||
- | |||
- | ===== Quoting ===== | ||
- | |||
- | 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' | ||
- | | ||
- | >> Well, I say we should | ||
- | | ||
- | > Really? | ||
- | | ||
- | >> Yes! | ||
- | | ||
- | >>> | ||
- | |||
- | I think we should do it | ||
- | |||
- | > No we shouldn' | ||
- | |||
- | >> Well, I say we should | ||
- | |||
- | > Really? | ||
- | |||
- | >> Yes! | ||
- | |||
- | >>> | ||
- | ===== Blockquote ===== | ||
- | The following code | ||
- | < | ||
- | < | ||
- | Test with loads of markup... | ||
- | |||
- | Another paragraph with a little [[http:// | ||
- | |||
- | * item 1 | ||
- | * item 1.1 | ||
- | * item 1.2 | ||
- | * item 2 | ||
- | - ordered item 2.1 | ||
- | - ordered item 2.2 | ||
- | - ordered item 2.2.1 | ||
- | * item 3 | ||
- | |||
- | Works :-) | ||
- | </ | ||
- | </ | ||
- | results in | ||
- | < | ||
- | Test with loads of markup... | ||
- | |||
- | Another paragraph with a little [[http:// | ||
- | |||
- | * item 1 | ||
- | * item 1.1 | ||
- | * item 1.2 | ||
- | * item 2 | ||
- | - ordered item 2.1 | ||
- | - ordered item 2.2 | ||
- | - ordered item 2.2.1 | ||
- | * item 3 | ||
- | |||
- | Works :-) | ||
- | </ | ||
- | ==== Cite attribute ==== | ||
- | The following code | ||
- | < | ||
- | results in | ||
- | < | ||
- | |||
- | ==== Cite command ==== | ||
- | The following code | ||
- | < | ||
- | results in | ||
- | < | ||
- | |||
- | ===== Tables ===== | ||
- | |||
- | DokuWiki supports a simple syntax to create tables. | ||
- | |||
- | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
- | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
- | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
- | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | | ||
- | |||
- | 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 2 Col 1 | some colspan (note the double pipe) || | ||
- | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | | ||
- | |||
- | To connect cells horizontally, | ||
- | |||
- | Vertical tableheaders are possible, too. | ||
- | |||
- | | ^ Heading 1 ^ Heading 2 ^ | ||
- | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | | ||
- | ^ Heading 4 | no colspan this time | | | ||
- | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
- | |||
- | 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 4 | no colspan this time | | | ||
- | ^ 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. | ||
- | |||
- | ^ 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. | ||
- | |||
- | ^ Table with alignment | ||
- | | | ||
- | |left | | ||
- | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | |||
- | This is how it looks in the source: | ||
- | |||
- | ^ Table with alignment | ||
- | | | ||
- | |left | | ||
- | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | |||
- | Note: Vertical alignment is not supported. | ||
- | |||
- | ===== 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 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 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. | ||
- | </ | ||
- | |||
- | Those blocks were created by this source: | ||
- | |||
- | This is text is indented by two spaces. | ||
- | |||
- | < | ||
- | 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, abap, actionscript-french, | ||
- | |||
- | ==== 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 ('' | ||
- | |||
- | |||
- | ===== 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 'A logo generated by PHP:'; | ||
- | echo '< | ||
- | echo ' | ||
- | </ | ||
- | <PHP> | ||
- | echo '< | ||
- | echo '< | ||
- | echo '</ | ||
- | </ | ||
- | </ | ||
- | |||
- | <php> | ||
- | echo 'A logo generated by PHP:'; | ||
- | echo '< | ||
- | echo ' | ||
- | </ | ||
- | <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 ===== | ||
- | [[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. If [[doku> | ||
- | | //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: | ||
- | |||
- | **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 %%< | ||
- | ===== 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 [[http:// | ||
- | |||
- | 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 = " | ||
- | } | ||
- | </ | ||
- | |||
- | [[wp> | ||
- | ===== vshare ===== | ||
- | The basic syntax looks like this: '' | ||
- | |||
- | A toolbar button pops up a prompt where you can simply paste the full URL to the page of the video you want to embed. The plugin will then try to figure out the video ID by itself. | ||
- | |||
- | ==== Examples ==== | ||
- | |||
- | Display a YouTube Video: | ||
- | |||
- | {{youtube> | ||
- | |||
- | Show a larger player: | ||
- | |||
- | {{youtube> | ||
- | |||
- | Right-align the player : | ||
- | |||
- | {{ youtube> | ||
- | |||
- | Show a small, centered player: | ||
- | |||
- | {{ youtube> | ||
- | |||
- | Show a small, centered player with a title: | ||
- | |||
- | {{ youtube> | ||
- | |||
- | ==== Supported Services ==== | ||
- | |||
- | ^ Identifier | ||
- | | 12seconds | ||
- | | 5min | [[http:// | ||
- | | bambuser | ||
- | | bliptv | ||
- | | blogtv | ||
- | | break | [[http:// | ||
- | | clipfish | ||
- | | current | ||
- | | dailymotion | [[http:// | ||
- | | googlevideo | [[http:// | ||
- | | gtrailers | ||
- | | justintv | ||
- | | metacafe | ||
- | | myspacetv | ||
- | | rcmovie | ||
- | | revver | ||
- | | scivee | ||
- | | sevenload | ||
- | | slideshare | ||
- | | stickam | ||
- | | ustream | ||
- | | veoh | [[http:// | ||
- | | viddler | ||
- | | vimeo | [[http:// | ||
- | | youtube | ||
- | |||
- | Additional sites can be added to the '' | ||
- | |||
- | ===== Slideshow ===== | ||
- | See [[playground: | ||
- | ===== Columns ===== | ||
- | Following a number of requests, the plugin is re-designed to support headings and vertical alignment of the columns content. In order to support the new features syntax of the plugin is extended with extra attributes that should be specified in front of the column width: | ||
- | |||
- | < | ||
- | <columns 100% first column attributes 50% second column attributes -> | ||
- | |||
- | Content of the first column. | ||
- | |||
- | < | ||
- | |||
- | Content of the second column. | ||
- | |||
- | </ | ||
- | </ | ||
- | |||
- | With this extra attributes the columns declaration gets more and more cluttered. To prevent that you can specify column attributes in the '' | ||
- | |||
- | < | ||
- | <columns 100% first column attributes 50%> | ||
- | |||
- | Content of the first column. | ||
- | |||
- | < | ||
- | |||
- | Content of the second column. | ||
- | |||
- | </ | ||
- | </ | ||
- | |||
- | |||
- | === Headings === | ||
- | |||
- | The headings are specified the using the standard DokuWiki syntax: | ||
- | |||
- | < | ||
- | <columns 100% 50% -> | ||
- | |||
- | ===== Heading ===== | ||
- | |||
- | Content of the first column. | ||
- | |||
- | < | ||
- | |||
- | Content of the second column. | ||
- | |||
- | </ | ||
- | </ | ||
- | |||
- | By default plugin puts the content within a column without explicitly specifying the section level. This works fine when the entire columns block belongs to a single section but can produce unexpected results when the headings are used within the block: | ||
- | |||
- | < | ||
- | ====== Level 1 Heading ====== | ||
- | |||
- | <columns 100% 50% -> | ||
- | |||
- | Implicit level 1 content. | ||
- | |||
- | ===== Level 2 Headline 1 ===== | ||
- | |||
- | Level 2 content. | ||
- | |||
- | < | ||
- | |||
- | Implicit level 1 content that should be in level 2 section. | ||
- | |||
- | ===== Level 2 Headline 2 ===== | ||
- | |||
- | Level 2 content. | ||
- | |||
- | </ | ||
- | </ | ||
- | |||
- | You can force the beginning of the second column to be in level 2 by specifying "'' | ||
- | |||
- | < | ||
- | ====== Level 1 Heading ====== | ||
- | |||
- | <columns 100% 50% -> | ||
- | |||
- | Implicit level 1 content. | ||
- | |||
- | ===== Level 2 Headline 1 ===== | ||
- | |||
- | Level 2 content. | ||
- | |||
- | < | ||
- | |||
- | Level 2 content. | ||
- | |||
- | ===== Level 2 Headline 2 ===== | ||
- | |||
- | Level 2 content. | ||
- | |||
- | </ | ||
- | </ | ||
- | |||
- | |||
- | |||
- | === Alignment === | ||
- | |||
- | The vertical alignment is specified with new alignment attributes. There are four horizontal alignment attributes ('' | ||
- | |||
- | < | ||
- | <columns 100% left 50% right bottom -> | ||
- | |||
- | Aligned on the left side. | ||
- | |||
- | < | ||
- | |||
- | Aligned to the right-bottom corner. | ||
- | |||
- | </ | ||
- | </ | ||
- | |||
- | All attributes can be abbreviated to the first letter, the single letter attributes may be merged together: | ||
- | |||
- | < | ||
- | <columns 100% l 50%> | ||
- | |||
- | Aligned on the left side. | ||
- | |||
- | < | ||
- | |||
- | Aligned to the right-bottom corner. | ||
- | |||
- | < | ||
- | |||
- | The old alignment syntax is still supported. | ||
- | Content of this column is centered both ways. | ||
- | |||
- | </ | ||
- | </ | ||
- | |||
- | ===== AV Task Box ===== | ||
- | < | ||
- | < | ||
- | TITLE: A test task | ||
- | PRIORITY: High | ||
- | ESTIMATE: 4h | ||
- | PROGRESS: 10% | ||
- | ASSIGNED: Sherri | ||
- | DESCRIPTION: | ||
- | </ | ||
- | </ | ||
- | * The labels for each item are //not// case sensitive. I just make them all caps to make them visible. | ||
- | * Each item must take up only one line, except the description can be on multiple lines. | ||
- | * The description will maintain newlines. | ||
- | * The description must be the last item in the list before the </ | ||
- | * You can leave out any of the items(attributes), | ||
- | * The entire thing is wrapped in a span with the CSS class " | ||
- | |||
- | < | ||
- | TITLE: A test task | ||
- | PRIORITY: High | ||
- | ESTIMATE: 4h | ||
- | PROGRESS: 10% | ||
- | ASSIGNED: Sherri | ||
- | DESCRIPTION: | ||
- | </ | ||
- | ===== Timeline2 ===== | ||
- | |||
- | < | ||
- | highlight=01/ | ||
- | highlight=01/ | ||
- | highlight=15/ | ||
- | </ | ||
- | hmm | ||
- | |||
- | hmm | ||
- | < | ||
- | highlight=02/ | ||
- | </ | ||
- | < | ||
- | highlight=02/ | ||
- | highlight=05/ | ||
- | </ | ||
- | hmm | ||
- | |||
- | < | ||
- | < | ||
- | highlight=01/ | ||
- | highlight=01/ | ||
- | highlight=15/ | ||
- | </ | ||
- | hmm | ||
- | |||
- | hmm | ||
- | < | ||
- | highlight=02/ | ||
- | </ | ||
- | < | ||
- | highlight=02/ | ||
- | highlight=05/ | ||
- | </ | ||
- | hmm | ||
- | </ | ||
- | |||
- | < | ||
- | < | ||
- | highlite=dd/ | ||
- | ... | ||
- | </ | ||
- | </ | ||
- | |||
- | ===== Syntax Plugins ===== | ||
- | |||
- | DokuWiki' | ||
- | |||
- | ~~INFO: | ||