User Tools

Site Tools


wiki:syntax

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
wiki:syntax [2012/11/13 11:19]
legatum
wiki:syntax [2012/11/13 12:54]
legatum removed
Line 9: Line 9:
 Most buttons have access keys assigned to them -- just press Alt button and a corresponding access key (see the table below). Most buttons have access keys assigned to them -- just press Alt button and a corresponding access key (see the table below).
  
-:!: If quickbuttons ​do not work with ALT, please refer to the [[doku>​accesskeys|access keys page]] or to your browser manual to see how to use access keys.+:!: If these do not work with ALT, please refer to the [[doku>​accesskeys|access keys page]] or to your browser manual to see how to use access keys.
  
 ^ Button ​ ^ Key  ^ Function ​ ^ ^ Button ​ ^ Key  ^ Function ​ ^
Line 31: Line 31:
 |  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​ul.png?​nolink}} ​         |  ''​**.**'' ​ | Unordered list item | |  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​ul.png?​nolink}} ​         |  ''​**.**'' ​ | Unordered list item |
 |  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​hr.png?​nolink}} ​         |             | Horizontal rule | |  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​hr.png?​nolink}} ​         |             | Horizontal rule |
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​image.png?​nolink}} ​      ​| ​            | [[media manager|Media Selection, includes file/​attachment uploader]] |+|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​image.png?​nolink}} ​      ​| ​            | Media Selection, includes file/​attachment uploader |
 |  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​smiley.png?​nolink}} ​     |             | Smiley picker | |  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​smiley.png?​nolink}} ​     |             | Smiley picker |
 |  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​chars.png?​nolink}} ​      ​| ​            | Character picker | |  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​chars.png?​nolink}} ​      ​| ​            | Character picker |
Line 63: Line 63:
 You should use forced newlines only if really needed. You should use forced newlines only if really needed.
  
 +Instead of a **hyphen** (-), please use a **dash** -- either [[wp>​Dash#​En_dash_versus_em_dash|en dash]] (--) or em dash (---) -- where appropriate (spaced or unspaced).
 +
 +  Instead of a **hyphen** (-), please use a **dash** -- either [[wp>​Dash#​En_dash_versus_em_dash|en dash]] (--) or em dash (---) -- where appropriate (spaced or unspaced).
 ===== Links ===== ===== Links =====
  
 DokuWiki supports multiple ways of creating links. DokuWiki supports multiple ways of creating links.
- 
-==== External ==== 
- 
-External links are recognized automagically:​ http://​www.google.com or simply www.google.com - You can set the link text as well: [[http://​www.google.com|This Link points to google]]. Email addresses like this one: <​info@legatum.sk>​ are recognized, too. 
- 
-  DokuWiki supports multiple ways of creating links. External links are recognized 
-  automagically:​ http://​www.google.com or simply www.google.com - You can set 
-  link text as well: [[http://​www.google.com|This Link points to google]]. Email 
-  addresses like this one: <​info@legatum.sk>​ are recognized, too. 
  
 ==== 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 page name -- such as [[en:​ahr:​lippe-ad-importance-of-a-single-symptom-158-10559]] -- or use an additional ​link text -- such as [[en:​ahr:​lippe-ad-importance-of-a-single-symptom-158-10559|Lippe: Importance of a Single Symptom]].
  
-  ​Internal links are created by using square brackets. ​You can either just give +  You can either just give a page name -- such as [[en:​ahr:​lippe-ad-importance-of-a-single-symptom-158-10559]] --  
-  ​a [[pagename]] or use an additional [[pagename|link text]].+  ​or use an additional ​link text -- such as [[en:​ahr:​lippe-ad-importance-of-a-single-symptom-158-10559|Lippe: Importance of a Single Symptom]].
  
 [[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 94: Line 88:
  
   This links to [[syntax#​internal|this Section]].   This links to [[syntax#​internal|this Section]].
 +  ​
 +=== Linking to a specific sentence ===
 +
 +Most articles in [[en:​resources|resources]] are sentence disambiguated (by an algorithm). In practice, this means each sentence has a unique anchor you can directly link to. This is a useful feature for linking directly to specific proving symptoms or any sentence or part of an article you would like to direct our attention to.
 +
 +The syntax is the same as in section linking, you just need to find the anchor number in the source of the article (click the Edit button) -- in order to know where to link to.
 +
 +For example, if you wish to link to a sentence where [[en:​ahr:​lippe-ad-the-homoeopathician-158-10568#​s24|Dr. Lippe explains us how to properly relate a successful cure]], you will do this as follows
 +  ​
 +  [[en:​ahr:​lippe-ad-the-homoeopathician-158-10568#​s24|Dr. Lippe explains us how to properly relate a successful cure]]
  
 Notes: Notes:
  
   * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones.   * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones.
-  * 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 -- use anchor linking, if possible. 
 +==== External ==== 
 + 
 +External links are recognized automagically:​ http://​www.google.com or simply www.google.com - You can set the link text as well: [[http://​www.google.com|This Link points to google]]. Email addresses like this one: <​info@legatum.sk>​ are recognized, too. 
 + 
 +  DokuWiki supports multiple ways of creating links. External links are recognized 
 +  automagically:​ http://​www.google.com or simply www.google.com - You can set 
 +  link text as well: [[http://​www.google.com|This Link points to google]]. Email 
 +  addresses like this one: <​info@legatum.sk>​ are recognized, too. 
 + 
 +DokuWiki supports [[doku>​Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia'​s page about Wikis: [[wp>​Wiki]].
  
 +  DokuWiki supports [[doku>​Interwiki]] links. These are quick links to other Wikis.
 +  For example this is a link to Wikipedia'​s page about Wikis: [[wp>​Wiki]].
 ==== Image Links ==== ==== Image Links ====
  
Line 253: Line 269:
 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+  I think we should do it.
   ​   ​
-  > No we shouldn'​t+  > Nowe shouldn'​t.
   ​   ​
-  >> Well, I say we should+  >> Well, I say we should.
   ​   ​
   > Really?   > Really?
Line 263: Line 279:
   >> Yes!   >> Yes!
   ​   ​
-  >>>​ Then lets do it!+  >>>​ Then let'​s ​do it!
  
-I think we should do it+I think we should do it.
  
-> No we shouldn'​t+> Nowe shouldn'​t.
  
->> Well, I say we should+>> Well, I say we should.
  
 > Really? > Really?
Line 275: Line 291:
 >> Yes! >> Yes!
  
->>>​ Then lets do it!+>>>​ Then let'​s ​do it!
  
 ===== Tables ===== ===== Tables =====
Line 379: Line 395:
   </​file>​   </​file>​
  
-==== 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 uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<​nowiki><​code java></​nowiki>''​ or ''<​nowiki><​file java></​nowiki>''​. 
- 
-<code java> 
-/** 
- * The HelloWorldApp class implements an application that 
- * simply displays "Hello World!"​ to the standard output. 
- */ 
-class HelloWorldApp { 
-    public static void main(String[] args) { 
-        System.out.println("​Hello World!"​);​ //Display the string. 
-    } 
-} 
-</​code>​ 
- 
-The following language strings are currently recognized: //4cs, 6502acme, 6502kickass,​ 6502tasm, 68000devpac,​ abap, actionscript-french,​ actionscript,​ actionscript3,​ ada, algol68, apache, applescript,​ asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner,​ c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript,​ cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas,​ lotusscript,​ lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml-brief,​ ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender,​ pli, plsql, postgresql, povray, powerbuilder,​ powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog,​ tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro,​ visualprolog,​ whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic// 
- 
-==== Downloadable Code Blocks ==== 
- 
-When you use the ''​%%<​code>​%%''​ or ''​%%<​file>​%%''​ syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this: 
- 
-<​code>​ 
-<file php myexample.php>​ 
-<?php echo "hello world!";​ ?> 
-</​file>​ 
-</​code>​ 
- 
-<file php myexample.php>​ 
-<?php echo "hello world!";​ ?> 
-</​file>​ 
- 
-If you don't want any highlighting but want a downloadable file, specify a dash (''​-''​) as the language code: ''​%%<​code - myfile.foo>​%%''​. 
- 
- 
-===== Embedding HTML and PHP ===== 
- 
-You can embed raw HTML or PHP code into your documents by using the ''​%%<​html>​%%''​ or ''​%%<​php>​%%''​ tags. (Use uppercase tags if you need to enclose block level elements.) 
- 
-HTML example: 
- 
-<​code>​ 
-<​html>​ 
-This is some <span style="​color:​red;​font-size:​150%;">​inline HTML</​span>​ 
-</​html>​ 
-<​HTML>​ 
-<p style="​border:​2px dashed red;">​And this is some block HTML</​p>​ 
-</​HTML>​ 
-</​code>​ 
- 
-<​html>​ 
-This is some <span style="​color:​red;​font-size:​150%;">​inline HTML</​span>​ 
-</​html>​ 
-<​HTML>​ 
-<p style="​border:​2px dashed red;">​And this is some block HTML</​p>​ 
-</​HTML>​ 
- 
-PHP example: 
- 
-<​code>​ 
-<php> 
-echo 'A logo generated by PHP:'; 
-echo '<​img src="'​ . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '"​ alt="​PHP Logo !" />';​ 
-echo '​(generated inline HTML)';​ 
-</​php>​ 
-<PHP> 
-echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​ 
-echo '<​td><​img src="'​ . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '"​ alt="​PHP Logo !" /></​td>';​ 
-echo '</​tr></​table>';​ 
-</​PHP>​ 
-</​code>​ 
- 
-<php> 
-echo 'A logo generated by PHP:'; 
-echo '<​img src="'​ . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '"​ alt="​PHP Logo !" />';​ 
-echo '​(inline HTML)';​ 
-</​php>​ 
-<PHP> 
-echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​ 
-echo '<​td><​img src="'​ . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '"​ alt="​PHP Logo !" /></​td>';​ 
-echo '</​tr></​table>';​ 
-</​PHP>​ 
- 
-**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://​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 ^ 
-| any number | will be used as maximum number items to show, defaults to 8 | 
-| reverse ​   | display the last items in the feed first | 
-| author ​    | show item authors names | 
-| date       | show item dates | 
-| description| show the item description. If [[doku>​config:​htmlok|HTML]] is disabled all tags will be stripped | 
-| //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. 
- 
-**Example:​** 
- 
-  {{rss>​http://​slashdot.org/​index.rss 5 author date 1h }} 
- 
-{{rss>​http://​slashdot.org/​index.rss 5 author date 1h }} 
  
  
Line 490: Line 403:
 ^ Macro           ^ Description | ^ Macro           ^ Description |
 | %%~~NOTOC~~%% ​  | If this macro is found on the page, no table of contents will be created | | %%~~NOTOC~~%% ​  | If this macro is found on the page, no table of contents will be created |
 +| %%~~DISCUSSION:​off~~%% ​  | If this macro is found on the page, no discussion at the end of the page will be created |
 | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<​php>​%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<​php>​%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call |
  
-===== Syntax Plugins ===== 
- 
-DokuWiki'​s syntax can be extended by [[doku>​plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:​ 
- 
-~~INFO:​syntaxplugins~~ 
wiki/syntax.txt · Last modified: 2015/06/23 07:27 (external edit)