Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Last revision Both sides next revision
policies:syntax [2009-10-01 22:45:41]
ndcadmin Approved 		policies:syntax [2009-10-01 23:17:50]
ndcadmin Approved
Line 1: Line 1:
 ====== Formatting Syntax ====== ====== Formatting Syntax ======
  
-[[doku>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:test|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.+[[doku>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 [[sandbox:test|sandbox]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.
  
 ===== Basic text formatting ===== ===== Basic text formatting =====
Line 45: Line 45:
 ==== Internal ==== ==== 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 [[wiki:pagename]] or use an additional [[wiki:pagename|link text]].
  
   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|link text]].+  a [[wiki:pagename]] or use an additional [[wiki:pagename|link text]].
  
 [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.  [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed. 
Line 58: Line 58:
 For details about namespaces see [[doku>namespaces]]. For details about namespaces see [[doku>namespaces]].
  
-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#internal|this Section]].+Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[wiki:syntax#internal|this Section]].
  
-  This links to [[syntax#internal|this Section]].+  This links to [[wiki:syntax#internal|this Section]].
  
 Notes: Notes:
  
-  * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones.+  * Links to [[wiki:syntax|existing pages]] are shown in a different style from [[wiki:nonexisting]] ones.
   * DokuWiki does not use [[wp>CamelCase]] to automatically create links by default, but this behavior can be enabled in the [[doku>config]] file. Hint: If DokuWiki is a link, then it's enabled.   * DokuWiki does not use [[wp>CamelCase]] to automatically create links by default, but this behavior can be enabled in the [[doku>config]] file. Hint: If DokuWiki is a link, then it's enabled.
   * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.   * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.
Line 90: Line 90:
 ==== Image Links ==== ==== Image Links ====
  
-You can also use an image to link to another internal or external page by combining the syntax for links and [[#images_and_other_files|images]] (see below) like this:+You can also use an image to link to another internal or external page by combining the syntax for links and [[:wiki#images_and_other_files|images]] (see below) like this:
  
   [[http://www.php.net|{{wiki:dokuwiki-128.png}}]]   [[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
Line 98: Line 98:
 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 [[#images_and_other_files|image]] and [[#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).+The whole [[:wiki#images_and_other_files|image]] and [[:wiki#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
  
 ===== Footnotes ===== ===== Footnotes =====
Line 160: Line 160:
 If you specify a filename (external or internal) that is not an image (''gif, jpeg, png''), then it will be displayed as a link instead. If you specify a filename (external or internal) that is not an image (''gif, jpeg, png''), then it will be displayed as a link instead.
  
-For linking an image to another page see [[#Image Links]] above.+For linking an image to another page see [[:wiki#Image Links]] above.
  
 ===== Lists ===== ===== Lists =====
Line 216: Line 216:
 ===== Typography ===== ===== Typography =====
  
-[[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.+[[wiki:dokuwiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
  
 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
Line 326: Line 326:
 ===== Syntax Highlighting ===== ===== Syntax Highlighting =====
  
-[[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|GeSHi]] Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax is the same like in the code block in the previous section, but this time the name of the used language is inserted inside the tag. Eg. ''<nowiki><code java></nowiki>''.+[[wiki:dokuwiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|GeSHi]] Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax is the same like in the code block in the previous section, but this time the name of the used language is inserted inside the tag. Eg. ''<nowiki><code java></nowiki>''.
  
 <code java> <code java>
Line 344: Line 344:
  
 ===== RSS/ATOM Feed Aggregation ===== ===== RSS/ATOM Feed Aggregation =====
-[[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:+[[wiki:dokuwiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:
  
 ^ Parameter  ^ Description ^ ^ Parameter  ^ Description ^
Line 354: Line 354:
 | //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: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 [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered.+The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki: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 [[wiki:dokuwiki]] to re-render the page if it is more than //refresh period// since the page was last rendered.
  
 **Example:** **Example:**