Differences

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

Link to this comparison view

wiki:syntax [2016/02/07 18:13]
vedavrata [Tables]
wiki:syntax [2019/04/01 18:57]
Line 1: Line 1:
- 
- 
- 
- 
- 
- 
- 
- 
-===== Text Conversions ===== 
- 
-DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML. 
- 
-The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements,​ but can be configured to use other HTML as well. 
- 
- 
- 
- 
- 
-===== No Formatting ===== 
- 
-If you need to display text exactly like it is typed (without any formatting),​ enclose the area either with ''​%%<​nowiki>​%%''​ tags or even simpler, with double percent signs ''<​nowiki>​%%</​nowiki>''​. 
- 
-<​nowiki>​ 
-This is some text which contains addresses like this: http://​www.splitbrain.org and **formatting**,​ but nothing is done with it. 
-</​nowiki>​ 
-The same is true for %%//​__this__ text// with a smiley ;-)%%. 
- 
-  <​nowiki>​ 
-  This is some text which contains addresses like this: http://​www.splitbrain.org and **formatting**,​ but nothing is done with it. 
-  </​nowiki>​ 
-  The same is true for %%//​__this__ text// with a smiley ;-)%%. 
- 
-===== Code Blocks ===== 
- 
-You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags ''​%%<​code>​%%''​ or ''​%%<​file>​%%''​. 
- 
-  This is text is indented by two spaces. 
- 
-<​code>​ 
-This is preformatted code all spaces are preserved: like              <-this 
-</​code>​ 
- 
-<​file>​ 
-This is pretty much the same, but you could use it to show that you quoted a file. 
-</​file>​ 
- 
-Those blocks were created by this source: 
- 
-    This is text is indented by two spaces. 
- 
-  <​code>​ 
-  This is preformatted code all spaces are preserved: like              <-this 
-  </​code>​ 
- 
-  <​file>​ 
-  This is pretty much the same, but you could use it to show that you quoted a 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 'The PHP version: '; 
-echo phpversion();​ 
-echo ' (generated inline HTML)';​ 
-</​php>​ 
-<PHP> 
-echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​ 
-echo '<​td>'​.phpversion().'</​td>';​ 
-echo '</​tr></​table>';​ 
-</​PHP>​ 
-</​code>​ 
- 
-<php> 
-echo 'The PHP version: '; 
-echo phpversion();​ 
-echo ' (inline HTML)';​ 
-</​php>​ 
-<PHP> 
-echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​ 
-echo '<​td>'​.phpversion().'</​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 }} 
- 
- 
-===== 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~~%% ​  | If this macro is found on the page, no table of contents 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 | 
- 
-===== 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: 2019/04/01 18:57 (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