Complete Help Docs

Laser Show Technology for Lighting Professionals

User Tools

Site Tools

You are here: The Pangolin Wiki » Pangolin Support, Education, and Development Process » Formatting Syntax
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 [2019/08/04 00:53]
Bob Varkevisser [Supported Services] 		wiki:syntax [2020/06/17 12:37] (current)
Line 67: Line 67:
   * 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.
 +
 +==== 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 ====
Line 186: Line 193:
  
 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 ===== ===== Lists =====
Line 399: Line 400:
   This is pretty much the same, but you could use it to show that you quoted a file.   This is pretty much the same, but you could use it to show that you quoted a file.
   </file>   </file>
- +
 ==== Syntax Highlighting ==== ==== Syntax Highlighting ====
  
Line 416: Line 417:
 </code> </code>
  
-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 c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d 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 q 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//+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 c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d 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 q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig 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 wolfram 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. 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 438: Line 438:
  
  
-===== Embedding HTML =====+===== Embedding HTML and PHP =====
  
-You can embed raw HTML code into your documents by using the ''%%<html>%%'' tags. (Use uppercase tags if you need to enclose block level elements.)+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: HTML example:
Line 460: Line 460:
 </HTML> </HTML>
  
- +PHP example:
-===== 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 | +
- +
- +
-====== Examples of Wrapping ====== +
- +
-===== Basic syntax ===== +
- +
-An uppercase **%%<WRAP>%%** (or alternatively **%%<block>%%** or **%%<div>%%**) creates a **''div''** and should be used for **"big"** containers, **surrounding** paragraphs, lists, tables, etc. +
- +
-  <WRAP classes width :language> +
-  "big" content +
-  </WRAP> +
-   +
-  or +
-  <block classes width :language> +
-  "big" content +
-  </block> +
-   +
-  or +
-  <div classes width :language> +
-  "big" content +
-  </div> +
- +
-A lowercase **%%<wrap>%%** (or alternatively **%%<inline>%%** or **%%<span>%%**) creates a **''span''** and should be used for **"small"** containers, **inside** paragraphs, lists, tables, etc. +
- +
-  <wrap classes width :language>"small" content</wrap> +
-   +
-  or +
-  <inline classes width :language>"small" content</inline> +
-   +
-  or +
-  <span classes width :language>"small" content</span> +
- +
-:!: Please note, some things **won't work with lowercase spans**: +
-  * **alignments** (including alignments generated by changing the text direction) +
-  * **multi-columns** +
-  * and **widths** +
-if the according wrap isn't floated as well. +
- +
- +
-===== Classes and Styles ===== +
- +
- +
-==== Columns and Floats ==== +
- +
-You can have columns easily by adding the class ''column'' and a width, e.g. +
-  <WRAP column 30%>...content...</WRAP> +
- +
-<WRAP column 30%> +
-//**__Emulated Big Headline__**// +
- +
-You can emulate a big headline with italic, bold and underlined text, e.g. +
-<code>//**__Emulated Big Headline__**//</code> +
- +
-//**Emulated Small Headline**// +
- +
-A smaller headline uses no underlining, e.g. +
-<code>//**Emulated Small Headline**//</code> +
- +
-If you need text that is bold and italic, simply use it the other way around: +
-<code>**//No Headline//**</code> +
-</WRAP> +
- +
-<WRAP column 30%> +
-//**__Different Floating Options__**// +
- +
-Normally you would only need the class ''column'', but for more sophisticated uses (not only for columns, but for any other classes, like [[#boxes and notes]] as well) you can have several kinds of "floats": +
- +
-  * **''column''** is the same as ''left'' in LTR languages and the same as ''right'' in RTL languages +
-  * **''left''** will let you float your wrap on the left +
-  * **''right''** will let the wrap float right +
-  * **''center''** will position the wrap in the horizontal center of the page +
- +
-</WRAP> +
- +
-<WRAP column 30%> +
-//**__Widths__**// +
- +
-You can set any valid widths (but only on divs): ''%, px, em, ex, pt, pc, cm, mm, in'', but most of the time you'd only want either +
- +
-^type^e.g.^note^ +
-^''%''|''30%''|makes sense in a liquid layout| +
-^''px''|''420px''|makes sense if your layout has a fixed pixel width or if your container contains images with a certain width| +
-^''em''|''20em''|makes sense if you like your wrap container to grow and shrink with the font size or if your layout is em-based| +
- +
-A **table** inside a column or box will always be **100% wide**. This makes positioning and sizing tables possible. +
- +
-</WRAP> +
- +
-<wrap em>After using any of the float classes, you might come across something like this, where the following text protrudes into the space where only the floating containers should be ...</wrap> +
- +
-<WRAP clear></WRAP> +
- +
-... to prevent that, you should simply add +
-  <WRAP clear></WRAP> +
-after your last column. +
- +
-You **can** use the same options with spans (as each element that floats is automatically a block level element), but it probably doesn't make too much sense. :!: Widths on spans normally do not work (by design), but can make sense, when it is floating. +
- +
-:!: Attention: Widths can cause problems and will often look different and break in some browsers. If you're not a web developer, you might not understand any problems regarding the [[http://en.wikipedia.org/wiki/Internet_Explorer_box_model_bug|box model]]. Just try to test your columns in all major browsers and make your widths smaller than you initially think they should be. +
- +
-All of those options will also work in the [[#boxes and notes]] wraps (see below). +
- +
-=== Multi-columns === +
- +
-<WRAP col3> +
-For modern browsers (Firefox, Chrome and Safari) you can use multi-columns. Just use **''%%col2%%''** for 2 columns, **''%%col3%%''** for 3 columns, **''%%col4%%''** for 4 columns and **''%%col5%%''** for 5 columns. +
- +
-:!: Note: Multi-columns don't make sense for spans. +
-</WRAP> +
- +
- +
-==== Alignments ==== +
- +
-You can use these different text alignments: +
- +
-  * ''leftalign'' +
-  * ''rightalign'' +
-  * ''centeralign'' +
-  * ''justify'' +
- +
-<WRAP centeralign> +
-Center aligned text ... +
-</WRAP> +
- +
-<WRAP rightalign> +
-... and right aligned. +
-</WRAP>+
  
 <code> <code>
-<WRAP centeralign> +<php> 
-Center aligned text ... +echo 'The PHP version: '; 
-</WRAP> +echo phpversion(); 
- +echo ' (generated inline HTML)'; 
-<WRAP rightalign> +</php> 
-... and right aligned. +<PHP> 
-</WRAP>+echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; 
 +echo '<td>'.phpversion().'</td>'; 
 +echo '</tr></table>'; 
 +</PHP>
 </code> </code>
  
-:!: You cannot add alignments to spans.+<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.
  
-==== Boxes and Notes ====+===== 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:
  
-<WRAP round box 570px center> +^ Parameter  ^ Description ^ 
-//**__round box 570px center__**//+| 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 | 
 +| 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). |
  
-  * ''box'' creates a box around the container and uses the colours from the template's ''style.ini'' as default colours (''%%__background_alt__%%'' and ''%%__text__%%'') +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.
-  * any of the classes ''info'', ''tip'', ''important'', ''alert'', ''help'', ''download'', ''todo'' will add a special note container with a corresponding icon +
-  * the classes ''danger'', ''warning'', ''caution'', ''notice'', ''safety'' use safety colours (and no icons) +
-  * ''round'' can be added to anything with a background colour or a border and will only work in modern browsers (no Internet Explorer) +
-</WRAP>+
  
 +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''.
  
-<WRAP info 220px left> +**Example:**
-//**Info**// +
-  <WRAP info></WRAP> +
-</WRAP>+
  
 +  {{rss>http://slashdot.org/index.rss 5 author date 1h }}
  
-<WRAP tip 220px left> +{{rss>http://slashdot.org/index.rss 5 author date 1h }}
-//**Tip**// +
-  <WRAP tip></WRAP> +
-</WRAP>+
  
  
-<WRAP important 220px left> +===== Control Macros =====
-//**Important**// +
-  <WRAP important></WRAP> +
-</WRAP>+
  
 +Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
  
-<WRAP alert 220px left> +^ Macro           ^ Description | 
-//**Alert**// +| %%~~NOTOC~~%%   | If this macro is found on the page, no table of contents will be created | 
-  <WRAP alert></WRAP> +| %%~~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 |
-</WRAP> +
- +
- +
-<WRAP round help 220px left> +
-//**Help**// +
-  <WRAP round help></WRAP> +
-</WRAP> +
- +
- +
-<WRAP download 220px left> +
-//**Download**// +
-  <WRAP download></WRAP> +
-</WRAP> +
- +
- +
-<WRAP todo 220px left> +
-//**Todo**// +
-  <WRAP todo></WRAP> +
-</WRAP> +
- +
- +
-<WRAP clear></WRAP> +
- +
- +
-**Safety Notes:** +
- +
-<WRAP danger 27% left> +
-//**Danger**// +
-  <WRAP danger></WRAP> +
-</WRAP> +
- +
-<WRAP warning 27% left> +
-//**Warning**// +
-  <WRAP warning></WRAP> +
-</WRAP> +
- +
-<WRAP caution 27% left> +
-//**Caution**// +
-  <WRAP caution></WRAP> +
-</WRAP> +
- +
-<WRAP round notice 27% left> +
-//**Notice**// +
-  <WRAP round notice></WRAP> +
-</WRAP> +
- +
-<WRAP round safety 27% left> +
-//**Safety**// +
-  <WRAP round safety></WRAP> +
-</WRAP> +
- +
-<WRAP clear></WRAP> +
- +
- +
-You can use notes and boxes also inside text with spans like this: +
-<wrap info>info</wrap>, <wrap help>help</wrap>, <wrap alert>alert</wrap>, <wrap important>important</wrap>, <wrap tip>tip</wrap>, <wrap download>download</wrap>, <wrap todo>todo</wrap> and <wrap round box>round box</wrap> and <wrap danger>danger</wrap>, <wrap warning>warning</wrap>, <wrap caution>caution</wrap>, <wrap notice>notice</wrap>, <wrap safety>safety</wrap>. +
-  <wrap info>info</wrap>, <wrap help>help</wrap>, ... +
- +
-==== Marks ==== +
- +
-You can mark text as <wrap hi>highlighted</wrap>, <wrap lo>less significant</wrap> and <wrap em>especially emphasised</wrap>. +
- +
-  You can mark text as <wrap hi>highlighted</wrap>, <wrap lo>less significant</wrap> and <wrap em>especially emphasised</wrap>. +
- +
-:!: This might look ugly in some templates and should be adjusted accordingly. +
- +
-==== Miscellaneous ==== +
- +
-=== Indent === +
- +
-<wrap indent>This text will appear indented.</wrap> +
- +
-  <wrap indent>This text will appear indented.</wrap> +
- +
-=== Outdent === +
- +
-<wrap outdent>This text will appear "outdented".</wrap> +
- +
-  <wrap outdent>This text will appear "outdented".</wrap> +
- +
-=== Prewrap === +
- +
-<WRAP prewrap 250px> +
-<code> +
-Inside this code block the words will wrap to a new line although they are all in one line. +
-</code> +
-</WRAP> +
- +
-  <WRAP prewrap 250px> +
-  <code> +
-  Inside this code block the words will wrap to a new line although they are all in one line. +
-  </code> +
-  </WRAP> +
- +
-=== Spoiler === +
- +
-Here follows a spoiler: <wrap spoiler>Darth Vader is Luke's father.</wrap> +
- +
-  Here follows a spoiler: <wrap spoiler>Darth Vader is Luke's father.</wrap> +
- +
-Just select the text in the spoiler box to be able to read its content. +
- +
-=== Hide === +
- +
-The following text is hidden: <wrap hide>John, please revise that sentence.</wrap> +
- +
-  The following text is hidden: <wrap hide>John, please revise that sentence.</wrap> +
- +
-:!: Warning: The text will still appear in the source code, in non-modern browsers and is searchable. Do not hide any security risky secrets with it! +
- +
-=== Pagebreak === +
- +
-The following will add a pagebreak: <WRAP pagebreak></WRAP> +
- +
-  The following will add a pagebreak: <WRAP pagebreak></WRAP> +
- +
-This has no effect on the browser screen. A [[http://reference.sitepoint.com/css/page-break-after|pagebreak]] will force a new page in printouts. +
- +
-=== Nopagebreak === +
- +
-The following will try to avoid a pagebreak: <WRAP nopagebreak>much content, belonging together (like a long table)</WRAP> +
- +
-  The following will try to avoid a pagebreak: <WRAP nopagebreak>much content, belonging together (like a long table)</WRAP> +
- +
-This also has no effect on the browser screen. It will try to [[http://reference.sitepoint.com/css/page-break-inside|avoid a page break]] in printouts. +
- +
-=== Noprint === +
- +
-<wrap noprint>This text appears on the screen, but not in print.</wrap> +
- +
-  <wrap noprint>This text appears on the screen, but not in print.</wrap> +
- +
-=== Onlyprint === +
- +
-<wrap onlyprint>This text does not appear on the screen, but only in print.</wrap> +
- +
-  <wrap onlyprint>This text does not appear on the screen, but only in print.</wrap> +
- +
-==== Typography ==== +
- +
-I advice against using the following typography classes. It's better to create semantic classes that reflect their meaning instead. +
- +
-  * font family: ''sansserif'', ''serif'', ''monospace'' +
-  * font size: ''bigger'', ''muchbigger'', ''smaller'' +
-  * font colour: ''fgred'', ''fggreen'', ''fgblue'', ''fgcyan'', ''fgviolet'', ''fgyellow'', ''fggrey'', ''fgwhite'', ''fgblack'' +
-  * background colour: ''bgred'', ''bggreen'', ''bgblue'', ''bgcyan'', ''bgviolet'', ''bgyellow'', ''bggrey'', ''bgwhite'', ''bgblack'' +
- +
- +
-==== Combining and Nesting ==== +
- +
-You can combine and nest all classes and types of boxes, e.g. +
- +
-<WRAP box bggreen fgblack 350px right :en> +
-//**__Outer green box floats right__**// +
- +
-<WRAP 165px left> +
-Inner nested box floats left and is partly <wrap em hi>__em__phasized and __hi__ghlighted with nested <wrap bigger>__bigger__ text</wrap> inside</wrap>. +
-</WRAP> +
- +
-Text inside outer right box, but beneath inner left box. +
- +
-<WRAP clear></WRAP> +
- +
-<WRAP round tip> +
-Round tip box underneath, after a ''clear''. +
-</WRAP> +
- +
-</WRAP> +
- +
- +
-<code> +
-<WRAP box bggreen fgblack 350px right :en> +
-//**__Outer green box floats right__**// +
- +
-<WRAP 165px left> +
-Inner nested box floats left and is partly <wrap em hi>__em__phasized and __hi__ghlighted with nested <wrap bigger>__bigger__ text</wrap> inside</wrap>. +
-</WRAP> +
- +
-Text inside outer right box, but beneath inner left box. +
- +
-<WRAP clear></WRAP> +
- +
-<WRAP round tip> +
-Round tip box underneath, after a ''clear''. +
-</WRAP> +
- +
-</WRAP> +
-</code> +
- +
- +
- +
- +
-===== Draft ===== +
- +
-Draft allows you to hide a page for everyone that is not signed in. +
- +
-=== Usage === +
- +
-  * To hide a page, simply add ''%%~~DRAFT~~%%'' anywhere in the text. +
-    * In case you are using German language, the code is ''%%~~ENTWURF~~%%''. +
-    * In case you are using Norwegian language, the code is ''%%~~KLADD~~%%''. +
-  * The plugin also adds a button to the far right of the editing buttons that looks like a //forbidden// sign. Clicking it will add the correct code. +
- +
-=== Effect ===+
  
-If you are an unregistered user, the page will not show up. If you are registered, you can see the page, as well as a red warning on the top of the page, which reminds you that the following page is a draft; hidden from the view of unregistered users.+===== 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.1564872820.txt · Last modified: 2020/06/11 19:21 (external edit)

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki