This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
wiki:syntax [2008/05/15 11:12] wkunert removed |
wiki:syntax [2011/09/12 15:01] andreasreiter created |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Formatting Syntax ====== | ====== Formatting Syntax ====== | ||
- | [[wiki:DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing the //Edit this page// button at the top or bottom of the page. If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku> | + | [[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 ===== | ===== Basic text formatting ===== | ||
Line 9: | Line 38: | ||
DokuWiki supports **bold**, //italic//, __underlined__ and '' | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
Of course you can **__//'' | 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 < | ||
Line 33: | Line 84: | ||
DokuWiki supports multiple ways of creating links. | DokuWiki supports multiple ways of creating links. | ||
+ | |||
+ | |||
==== External ==== | ==== External ==== | ||
- | External links are recognized automagically: | + | External links are recognized automagically: |
+ | |||
+ | External links are recognized automagically: | ||
+ | | ||
+ | | ||
- | DokuWiki supports multiple ways of creating links. External links are recognized | ||
- | automagically: | ||
- | Linknames, too: [[http:// | ||
- | addresses like this one: < | ||
==== Internal ==== | ==== Internal ==== | ||
- | Internal links are created by using square brackets. You can either just give a [[doku> | + | 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 | Internal links are created by using square brackets. You can either just give | ||
- | a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames | + | a [[usage:pagename]] or use an additional [[usage:pagename|Title Text]]. Wiki pagenames |
are converted to lowercase automatically, | are converted to lowercase automatically, | ||
- | You can use [[wiki: | + | You can use [[usage: |
- | You can use [[wiki: | + | You can use [[usage: |
- | 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 [[usage:syntax# |
- | 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#internal|this Section]]. | + | Links to [[usage:syntax|existing pages]] are shown in a different style from [[usage: |
- | Notes: | ||
- | * Links to [[wiki: | ||
- | * DokuWiki does not use [[wp> | ||
- | * When a section' | ||
- | ==== Interwiki ==== | ||
- | DokuWiki supports [[doku> | ||
- | DokuWiki supports [[doku> | ||
- | For example this is a link to Wikipedia' | ||
- | ==== Windows Shares ==== | ||
- | Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogenous 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 the config option [[http:// | ||
- | * See [[dokubug> | ||
==== Image Links ==== | ==== Image Links ==== | ||
Line 91: | Line 126: | ||
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:// |
- | [[http:// | + | [[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. | ||
- | |||
- | The whole [[# | ||
===== Footnotes ===== | ===== Footnotes ===== | ||
Line 120: | Line 153: | ||
---- | ---- | ||
+ | |||
===== Images and other files ===== | ===== Images and other files ===== | ||
- | You can include external and internal | + | You can include external and internal images with curly brackets. Optionally you can specify the size of them. |
- | Real size: {{wiki:dokuwiki-128.png}} | + | Real size: {{usage:gsi_logo.png}} |
- | Resize to given width: | + | Resize to given width: |
- | Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} | + | Resize to given width and height: {{usage:gsi_logo.png?400x50}} |
- | Resized external image: | + | Resized external image: |
- | Real size: {{wiki:dokuwiki-128.png}} | + | Real size: {{usage:gsi_logo.png}} |
- | Resize to given width: | + | Resize to given width: |
- | Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} | + | Resize to given width and height: {{usage:gsi_logo.png?400x50}} |
- | Resized external image: | + | Resized external image: |
By using left or right whitespaces you can choose the alignment. | By using left or right whitespaces you can choose the alignment. | ||
- | {{ wiki:dokuwiki-128.png}} | + | {{ usage:gsi_logo.png}} |
- | {{wiki:dokuwiki-128.png }} | + | {{usage:gsi_logo.png }} |
- | {{ wiki:dokuwiki-128.png }} | + | {{ usage:gsi_logo.png }} |
- | {{ wiki:dokuwiki-128.png}} | + | {{ usage:gsi_logo.png}} |
- | {{wiki:dokuwiki-128.png }} | + | {{usage:gsi_logo.png }} |
- | {{ wiki:dokuwiki-128.png }} | + | {{ usage:gsi_logo.png }} |
Of course, you can add a title (displayed as a tooltip by most browsers), too. | Of course, you can add a title (displayed as a tooltip by most browsers), too. | ||
- | {{ wiki:dokuwiki-128.png |This is the caption}} | + | {{ usage:gsi_logo.png |This is the caption.}} |
- | {{ wiki:dokuwiki-128.png |This is the caption}} | + | {{ usage:gsi_logo.png |This is the caption.}} |
If you specify a filename (external or internal) that is not an image ('' | If you specify a filename (external or internal) that is not an image ('' | ||
Line 211: | Line 245: | ||
* FIXME %% FIXME %% | * FIXME %% FIXME %% | ||
* DELETEME %% DELETEME %% | * DELETEME %% DELETEME %% | ||
+ | |||
+ | |||
===== Typography ===== | ===== Typography ===== | ||
- | [[DokuWiki]] | + | Dokuwiki |
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
Line 223: | Line 259: | ||
"He thought ' | "He thought ' | ||
</ | </ | ||
- | |||
- | Please note: These conversions can be turned off through a [[doku> | ||
===== Quoting ===== | ===== Quoting ===== | ||
Line 301: | Line 335: | ||
|left | | |left | | ||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | |||
===== Non-parsed Blocks ===== | ===== Non-parsed Blocks ===== | ||
Line 317: | Line 352: | ||
< | < | ||
- | This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, | + | This is some text which contains addresses like this: http://www.gsi.de and **formatting**, |
</ | </ | ||
See the source of this page to see how to use these blocks. | See the source of this page to see how to use these blocks. | ||
+ | |||
===== Syntax Highlighting ===== | ===== Syntax Highlighting ===== | ||
- | [[DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http:// | + | DokuWiki can highlight sourcecode, which makes it easier to read. It uses the [[http:// |
<code java> | <code java> | ||
Line 341: | Line 377: | ||
- | ===== RSS/ATOM Feed Aggregation | + | ===== Picture Gallery |
- | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | + | |
- | ^ Parameter | + | A basic gallery can be added by selecting a [[namespace]] like this: |
- | | 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. [[DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered. | + | {{gallery> |
- | **Example:** | + | All imagefiles in the selected namespace will be added to the image gallery. Note: those images need to be a valid [[pagename]], |
- | {{rss> | + | 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). |
- | {{rss>http://slashdot.org/ | + | |
+ | The created gallery can be aligned by using whitespace (defaults to centered): | ||
- | ===== Embedding HTML and PHP ===== | + | {{gallery> |
+ | {{gallery> | ||
+ | {{gallery> | ||
- | You can embed raw HTML or PHP code into your documents by using the '' | + | You can define |
- | < | + | |
- | < | + | |
- | This is some <span style=" | + | |
- | </ | + | |
- | < | + | |
- | <p style=" | + | |
- | </ | + | |
- | </ | + | |
- | < | + | {{gallery>namespace? |
- | This is some <span style=" | + | |
- | </ | + | |
- | < | + | |
- | <p style=" | + | |
- | </HTML> | + | |
- | < | + | The default is a dimension of 120x120 pixels. |
- | <php> | + | |
- | echo 'A logo generated by PHP:'; | + | You can define the number of columns as well: |
- | echo '<img src="' | + | |
- | echo '(generated inline HTML)'; | + | {{gallery>namespace? |
- | </ | + | |
- | <PHP> | + | 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. |
- | echo '<table class=" | + | |
- | echo '< | + | To have the filename displayed below the thumbnails add the '' |
- | echo '</ | + | |
- | </PHP> | + | {{gallery>namespace? |
- | </code> | + | |
+ | If you want the files sorted in the reverse order use the '' | ||
+ | |||
+ | | ||
+ | |||
+ | If you don't want to link to the image detail pages but directly to the image itself use the '' | ||
+ | |||
+ | {{gallery>namespace? | ||
+ | |||
+ | 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 ^ | ||
+ | | ''->'' or '' | ||
+ | | ''<-'' or '' | ||
+ | | '' | ||
+ | |||
+ | The Lightbox feature will also be used for all images embedded using the standard DokuWiki image syntax and having set the '' | ||
+ | |||
+ | More info at :[[http:// | ||
+ | |||
+ | Note: The feature does not use [[http:// | ||
- | <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. | ||
- | ===== 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 %%< | ||
- | ===== Syntax Plugins ===== | ||
- | DokuWiki' | ||
- | ~~INFO: | ||