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 [2016/02/07 18:12]
vedavrata [Lists]
wiki:syntax [2019/04/01 18:57] (current)
Line 1: Line 1:
 +====== 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 "Edit this page". If you want to try something, just use the [[playground:​playground|playground]] page. The simpler markup is easily accessible via [[doku>​toolbar|quickbuttons]],​ too.
  
 +===== Basic Text Formatting =====
  
 +DokuWiki supports **bold**, //italic//, __underlined__ and ''​monospaced''​ texts. Of course you can **__//''​combine''//​__** all these.
  
 +  DokuWiki supports **bold**, //italic//, __underlined__ and ''​monospaced''​ texts.
 +  Of course you can **__//''​combine''//​__** all these.
  
 +You can use <​sub>​subscript</​sub>​ and <​sup>​superscript</​sup>,​ too.
 +
 +  You can use <​sub>​subscript</​sub>​ and <​sup>​superscript</​sup>,​ too.
 +
 +You can mark something as <​del>​deleted</​del>​ as well.
 +
 +  You can mark something as <​del>​deleted</​del>​ as well.
 +
 +**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:​ 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: <​andi@splitbrain.org>​ 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: <​andi@splitbrain.org>​ are recognized, too.
 +
 +==== 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>​pagename|Wiki pagenames]] are converted to lowercase automatically,​ special characters are not allowed.
 +
 +You can use [[some:​namespaces]] by using a colon in the pagename.
 +
 +  You can use [[some:​namespaces]] by using a colon in the pagename.
 +
 +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]].
 +
 +  This links to [[syntax#​internal|this Section]].
 +
 +Notes:
 +
 +  * Links to [[syntax|existing pages]] are shown in a different style from [[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.
 +  * When a section'​s heading is changed, its bookmark changes, too. So don't rely on section linking too much.
 +
 +==== Interwiki ====
 +
 +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]].
 +
 +==== 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>​Intranet]].
 +
 +  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://​kb.mozillazine.org/​Links_to_local_pages_do_not_work|Mozilla Knowledge Base]]. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in ''​conf/​lang/​en/​lang.php''​ (more details at [[doku>​localization#​changing_some_localized_texts_and_strings_in_your_installation|localization]]):​ <code - conf/​lang/​en/​lang.php>​
 +<?php
 +/**
 + * Customization of the english language file
 + * Copy only the strings that needs to be modified
 + */
 +$lang['​js'​]['​nosmblinks'​] = '';​
 +</​code>​
 +
 +==== 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:
 +
 +  [[http://​php.net|{{wiki:​dokuwiki-128.png}}]]
 +
 +[[http://​php.net|{{wiki:​dokuwiki-128.png}}]]
 +
 +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).
  
 ===== Footnotes ===== ===== Footnotes =====
Line 11: Line 111:
   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 ''<​nowiki>​~~NOTOC~~</​nowiki>''​ in the document.
  
 +==== 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:
 +
 +----
 +
 +===== Media Files =====
 +
 +You can include external and internal [[doku>​images|images,​ videos and audio files]] with curly brackets. Optionally you can specify the size of them.
 +
 +Real size:                        {{wiki:​dokuwiki-128.png}}
 +
 +Resize to given width: ​           {{wiki:​dokuwiki-128.png?​50}}
 +
 +Resize to given width and height((when the aspect ratio of the given width and height doesn'​t match that of the image, it will be cropped to the new ratio before resizing)): {{wiki:​dokuwiki-128.png?​200x50}}
 +
 +Resized external image: ​          ​{{http://​php.net/​images/​php.gif?​200x50}}
 +
 +  Real size:                        {{wiki:​dokuwiki-128.png}}
 +  Resize to given width: ​           {{wiki:​dokuwiki-128.png?​50}}
 +  Resize to given width and height: {{wiki:​dokuwiki-128.png?​200x50}}
 +  Resized external image: ​          ​{{http://​php.net/​images/​php.gif?​200x50}}
 +
 +
 +By using left or right whitespaces you can choose the alignment.
 +
 +{{ wiki:​dokuwiki-128.png}}
 +
 +{{wiki:​dokuwiki-128.png }}
 +
 +{{ wiki:​dokuwiki-128.png }}
 +
 +  {{ wiki:​dokuwiki-128.png}}
 +  {{wiki:​dokuwiki-128.png }}
 +  {{ wiki:​dokuwiki-128.png }}
 +
 +Of course, you can add a title (displayed as a tooltip by most browsers), too.
 +
 +{{ wiki:​dokuwiki-128.png |This is the caption}}
 +
 +  {{ wiki:​dokuwiki-128.png |This is the caption}}
 +
 +For linking an image to another page see [[#Image Links]] above.
  
 ==== Supported Media Formats ==== ==== Supported Media Formats ====
Line 24: Line 175:
  
 If you specify a filename that is not a supported media format, then it will be displayed as a link instead. If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
 +
 +By adding ''?​linkonly''​ you provide a link to the media without displaying it inline
 +
 +  {{wiki:​dokuwiki-128.png?​linkonly}}
 +
 +{{wiki:​dokuwiki-128.png?​linkonly}} This is just a link to the image.
  
 ==== Fallback Formats ==== ==== Fallback Formats ====
Line 37: Line 194:
 Additionally DokuWiki supports a "​poster"​ image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''​video.jpg''​ file would work. Additionally DokuWiki supports a "​poster"​ image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''​video.jpg''​ file would work.
  
 +===== Lists =====
 +
 +Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''​*''​ for unordered lists or a ''​-''​ for ordered ones.
 +
 +  * 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
 +
 +<​code>​
 +  * 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
 +</​code>​
 +
 +Also take a look at the [[doku>​faq:​lists|FAQ on list items]].
  
 ===== Text Conversions ===== ===== Text Conversions =====
Line 89: Line 273:
 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 +<​code>​ 
-   +I think we should do it 
-  > No we shouldn'​t + 
-   +> No we shouldn'​t 
-  >> Well, I say we should + 
-   +>> Well, I say we should 
-  > Really? + 
-   +> Really? 
-  >> Yes! + 
-   +>> Yes! 
-  >>>​ Then lets do it!+ 
 +>>>​ Then lets do it! 
 +</​code>​
  
 I think we should do it I think we should do it
Line 145: Line 331:
   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
  
-You can have rowspans (vertically connected cells) by adding '':::''​ into the cells below the one to which they should connect.+You can have rowspans (vertically connected cells) by adding ''​%%:::%%''​ into the cells below the one to which they should connect.
  
 ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
Line 231: Line 417:
 </​code>​ </​code>​
  
-The following language strings are currently recognized: //4cs6502acme6502kickass6502tasm68000devpacabapactionscript-french, actionscript,​ actionscript3, ​adaalgol68apacheapplescriptasmaspautoconfautohotkeyautoitavisynthawkbascomavrbashbasic4glbfbibtexblitzbasicbnfboo, c, c_loadrunner,​ c_mac, ​caddclcadlispcfdgcfmchaiscriptcilclojurecmakecobolcoffeescriptcppcpp-qtcsharpcsscuesheet, d, dcsdelphidiffdivdosdot, e, epc, ecmascripteiffelemailerlangeuphoriaf1falconfofortranfreebasicfsharpgambasgenerogenie, gdb, glslgmlgnuplotgogroovy, gettext, ​gwbasichaskellhicesthq9plushtmlhtml5iconidliniinnointercalio, j, java5javajavascriptjquerykixtartklonecklonecpplatexlblispllvmlocobasiclogtalklolcodelotusformulaslotusscriptlscriptlsl2luam68kmagiksfmakemapbasicmatlabmircmodula2modula3, mmix, mpasmmxmlmysqlnewlispnsisoberon2objcobjeckocaml-briefocamloobasoracle8, oracle11, ​oxygeneozpascalpcreperl, perl6, ​perpfphp-briefphppike, pic16, ​pixelbenderpliplsqlpostgresqlpovraypowerbuilderpowershellproftpdprogressprologpropertiesprovidexpurebasicpyconpythonq, qbasic, ​railsrebolregrobotsrpmspecrsplusrubysasscalaschemescilabsdlbasicsmalltalksmartysqlsystemverilogtclteratermtextthinbasictsqltyposcriptuniconuscriptvalavbnetvbverilogvhdlvimvisualfoxprovisualprologwhitespacewinbatch, whois, ​xbasicxmlxorg_confxppyamlz80zxbasic//+The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 ​actionscript ada aimms algol68 apache applescript ​apt_sources arm asm asp asymptote ​autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl ​batch bf biblatex ​bibtex blitzbasic bnf boo caddcl cadlisp ​ceylon ​cfdg cfm chaiscript ​chapel ​cil c_loadrunner ​clojure ​c_mac cmake cobol coffeescript ​cpp cpp-qt ​cpp-winapi ​csharp css cuesheet ​c_winapi dart dcl dcpu16 ​dcs delphi diff div dos dot ecmascript eiffel email epc e erlang euphoria ​ezt f1 falcon fo fortran freebasic ​freeswitch ​fsharp gambas ​gdb genero genie gettext ​glsl gml gnuplot go groovy gwbasic haskell ​haxe hicest hq9plus html html4strict ​html5 icon idl ini inno intercal io ispfpanel ​java5 java javascript ​jcl j jquery ​julia kixtart klonec klonecpp ​kotlin ​latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic ​mathematica ​matlab ​mercury metapost ​mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx ​newlisp ​nginx nimrod ​nsis oberon2 objc objeck ocaml-brief ocaml octave ​oobas oorexx oracle11 ​oracle8 oxygene oz parasail parigp ​pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql ​postscript ​povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python ​qbasic qml racket ​rails rbs rebol reg rexx robots rpmspec rsplus ruby rust sas sass scala scheme scilab ​scl sdlbasic smalltalk smarty ​spark sparql ​sql standardml stonescript swift systemverilog ​tclegg ​tcl teraterm ​texgraph ​text thinbasic tsql twig typoscript unicon ​upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace ​whois winbatch xbasic xml xojo xorg_conf xpp yaml z80 zxbasic// 
 + 
 +There are additional [[doku>​syntax_highlighting|advanced options]] available for syntax highlighting,​ such as highlighting lines or adding line numbers.
  
 ==== Downloadable Code Blocks ==== ==== Downloadable Code Blocks ====
Line 309: Line 497:
 | date       | show item dates | | date       | show item dates |
 | description| show the item description. If [[doku>​config:​htmlok|HTML]] is disabled all tags will be stripped | | description| show the item description. If [[doku>​config:​htmlok|HTML]] is disabled all tags will be stripped |
 +| nosort ​    | do not sort the items in the feed |
 | //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.
 +
 +By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''​reverse''​ parameter, or display the feed as is with ''​nosort''​.
  
 **Example:​** **Example:​**
wiki/syntax.1454868730.txt.gz · Last modified: 2019/02/08 12:23 (external edit)
GNU Free Documentation License 1.3
Powered by PHP Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0 Valid HTML5