This shows you the differences between two versions of the page.
wiki:syntax [2011/09/12 15:01] andreasreiter created |
wiki:syntax [2020/07/29 11:35] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Formatting Syntax ====== | ||
- | |||
- | [[http:// | ||
- | |||
- | ===== Quickbuttons ===== | ||
- | |||
- | The Editing-Toolbar is based upon the one from [[wpmeta> | ||
- | |||
- | Browsers without support to insert at the current cursor position will add the string to the end of the edit box. | ||
- | |||
- | Most buttons have accesskeys assigned to them, too. | ||
- | |||
- | ^ Button ^ Key ^ Function ^ | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | | {{http:// | ||
- | |||
- | |||
- | ===== Basic text formatting ===== | ||
- | |||
- | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
- | |||
- | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
- | Of course you can **__//'' | ||
- | |||
- | You can also <color orange> | ||
- | |||
- | You can also <color orange> | ||
- | | ||
- | Following colours are available: | ||
- | * <color black> | ||
- | * <color navy> | ||
- | * <color blue> | ||
- | * <color green> | ||
- | * <color teal> | ||
- | * <color lime> | ||
- | * <color maroon> | ||
- | * <color purple> | ||
- | * <color olive> | ||
- | * <color gray> | ||
- | * <color silver> | ||
- | * <color red> | ||
- | * <color fuchsia> | ||
- | * <color yellow> | ||
- | * <color white> | ||
- | * <color orange> | ||
- | |||
- | 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. | ||
- | |||
- | ===== Links ===== | ||
- | |||
- | DokuWiki supports multiple ways of creating links. | ||
- | |||
- | |||
- | |||
- | ==== External ==== | ||
- | |||
- | External links are recognized automagically: | ||
- | |||
- | External links are recognized automagically: | ||
- | You can set Linknames, too: [[http:// | ||
- | Email 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|Title Text]]. Wiki pagenames are converted to lowercase automatically, | ||
- | |||
- | Internal links are created by using square brackets. You can either just give | ||
- | a [[usage: | ||
- | are converted to lowercase automatically, | ||
- | |||
- | You can use [[usage: | ||
- | |||
- | You can use [[usage: | ||
- | |||
- | Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[usage: | ||
- | |||
- | This links to [[usage: | ||
- | |||
- | Links to [[usage: | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | ==== 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. | ||
- | |||
- | ===== 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 images with curly brackets. Optionally you can specify the size of them. | ||
- | |||
- | Real size: {{usage: | ||
- | |||
- | Resize to given width: | ||
- | |||
- | Resize to given width and height: {{usage: | ||
- | |||
- | Resized external image: | ||
- | |||
- | Real size: {{usage: | ||
- | Resize to given width: | ||
- | Resize to given width and height: {{usage: | ||
- | Resized external image: | ||
- | |||
- | |||
- | By using left or right whitespaces you can choose the alignment. | ||
- | |||
- | {{ usage: | ||
- | |||
- | {{usage: | ||
- | |||
- | {{ usage: | ||
- | |||
- | {{ usage: | ||
- | {{usage: | ||
- | {{ usage: | ||
- | |||
- | Of course, you can add a title (displayed as a tooltip by most browsers), too. | ||
- | |||
- | {{ usage: | ||
- | |||
- | {{ usage: | ||
- | |||
- | 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 | ||
- | </ | ||
- | |||
- | ===== Smileys ===== | ||
- | |||
- | 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 %% | ||
- | |||
- | |||
- | |||
- | ===== 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 ' | ||
- | </ | ||
- | |||
- | ===== 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! | ||
- | |||
- | >>> | ||
- | |||
- | ===== 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 2 Col 2 | Row 2 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 2 Col 2 | Row 2 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 | | ||
- | |||
- | Note: Vertical spans (rowspan) are not possible. | ||
- | |||
- | 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 | | ||
- | |||
- | |||
- | ===== Non-parsed Blocks ===== | ||
- | |||
- | You can include non-parsed 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 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. | ||
- | </ | ||
- | |||
- | To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with '' | ||
- | |||
- | < | ||
- | This is some text which contains addresses like this: http:// | ||
- | </ | ||
- | |||
- | See the source of this page to see how to use these blocks. | ||
- | |||
- | |||
- | ===== Syntax Highlighting ===== | ||
- | |||
- | DokuWiki can highlight sourcecode, which makes it easier to read. It uses the [[http:// | ||
- | |||
- | <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: //abap actionscript-french, | ||
- | |||
- | |||
- | ===== Picture Gallery ===== | ||
- | |||
- | A basic gallery can be added by selecting a [[namespace]] like this: | ||
- | |||
- | {{gallery> | ||
- | |||
- | All imagefiles in the selected namespace will be added to the image gallery. Note: those images need to be a valid [[pagename]], | ||
- | |||
- | 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 whitespace (defaults to centered): | ||
- | |||
- | {{gallery> | ||
- | {{gallery> | ||
- | {{gallery> | ||
- | |||
- | You can define the wanted thumbnail size by adding its dimension as parameter: | ||
- | |||
- | {{gallery> | ||
- | |||
- | The default is a dimension of 120x120 pixels. | ||
- | |||
- | You can define the number of columns as well: | ||
- | |||
- | {{gallery> | ||
- | |||
- | The default number of columns is 5 and can be configured in the config manager. If you specify a 0 no table is used instead all thumbnails are added in a sequence. | ||
- | |||
- | To have the filename displayed below the thumbnails add the '' | ||
- | |||
- | {{gallery> | ||
- | |||
- | If you want the files sorted in the reverse order use the '' | ||
- | |||
- | {{gallery> | ||
- | |||
- | If you don't want to link to the image detail pages but directly to the image itself use the '' | ||
- | |||
- | {{gallery> | ||
- | |||
- | For fancy JavaScript based inline browsing of the images use the '' | ||
- | |||
- | {{gallery> | ||
- | |||
- | All params can be combined: | ||
- | |||
- | {{gallery> | ||
- | |||
- | You can also specify the size of lightbox images. It is done the same way as with thumbnails, except using a capital ' | ||
- | |||
- | {{gallery> | ||
- | |||
- | |||
- | IMPORTANT: When you have added your pictures they may not show up in the gallery: add '& | ||
- | |||
- | === About the Lightbox mode === | ||
- | |||
- | This mode will open the clicked picture inside the current browser window without leaving the current page. You can close the picture view by clicking the little X in the upper right corner or anywhere in the picture. You can move to the next or previous image by using the arrow buttons in the lower corners. | ||
- | |||
- | 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 ^ | ||
- | | '' | ||
- | | ''< | ||
- | | '' | ||
- | |||
- | The Lightbox feature will also be used for all images embedded using the standard DokuWiki image syntax and having set the '' | ||
- | |||
- | More info at : | ||
- | |||
- | Note: The feature does not use [[http:// | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||