| Both sides previous revisionPrevious revision | |
| wiki:syntax [2013/08/07 08:51] – Added Tag Plugin Description samuel | wiki:syntax [2020/07/29 09:35] (current) – external edit 127.0.0.1 |
|---|
| |
| * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone"). | * 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/userscript.js'': | * 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 |
| LANG.nosmblinks = ''; | /** |
| | * Customization of the english language file |
| | * Copy only the strings that needs to be modified |
| | */ |
| | $lang['js']['nosmblinks'] = ''; |
| | </code> |
| |
| ==== 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 [[#images_and_other_files|images]] (see below) like this: |
| |
| [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] | [[http://php.net|{{wiki:dokuwiki-128.png}}]] |
| |
| [[http://www.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. | Please note: The image formatting is the only formatting syntax accepted in link names. |
| ---- | ---- |
| |
| ===== Images and Other Files ===== | ===== Media Files ===== |
| |
| You can include external and internal [[doku>images]] with curly brackets. Optionally you can specify the size of them. | 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}} | Real size: {{wiki:dokuwiki-128.png}} |
| 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}} | 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://de3.php.net/images/php.gif?200x50}} | Resized external image: {{https://secure.php.net/images/php.gif?200x50}} |
| |
| Real size: {{wiki:dokuwiki-128.png}} | Real size: {{wiki:dokuwiki-128.png}} |
| Resize to given width: {{wiki:dokuwiki-128.png?50}} | Resize to given width: {{wiki:dokuwiki-128.png?50}} |
| Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} | Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} |
| Resized external image: {{http://de3.php.net/images/php.gif?200x50}} | Resized external image: {{https://secure.php.net/images/php.gif?200x50}} |
| |
| |
| |
| {{ wiki:dokuwiki-128.png |This is the caption}} | {{ wiki:dokuwiki-128.png |This is the caption}} |
| |
| 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 [[#Image Links]] above. |
| | |
| | ==== Supported Media Formats ==== |
| | |
| | DokuWiki can embed the following media formats directly. |
| | |
| | | Image | ''gif'', ''jpg'', ''png'' | |
| | | Video | ''webm'', ''ogv'', ''mp4'' | |
| | | Audio | ''ogg'', ''mp3'', ''wav'' | |
| | | Flash | ''swf'' | |
| | |
| | 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 ==== |
| | |
| | Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility. |
| | |
| | For example consider this embedded mp4 video: |
| | |
| | {{video.mp4|A funny video}} |
| | |
| | When you upload a ''video.webm'' and ''video.ogv'' next to the referenced ''video.mp4'', DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser. |
| | |
| | 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 ===== |
| 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 |
| ^ 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 ^ |
| </code> | </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// | 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. |
| |
| ==== Downloadable Code Blocks ==== | ==== Downloadable Code Blocks ==== |
| <code> | <code> |
| <php> | <php> |
| echo 'A logo generated by PHP:'; | echo 'The PHP version: '; |
| echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; | echo phpversion(); |
| echo '(generated inline HTML)'; | echo ' (generated inline HTML)'; |
| </php> | </php> |
| <PHP> | <PHP> |
| echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; | 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 '<td>'.phpversion().'</td>'; |
| echo '</tr></table>'; | echo '</tr></table>'; |
| </PHP> | </PHP> |
| |
| <php> | <php> |
| echo 'A logo generated by PHP:'; | echo 'The PHP version: '; |
| echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; | echo phpversion(); |
| echo '(inline HTML)'; | echo ' (inline HTML)'; |
| </php> | </php> |
| <PHP> | <PHP> |
| echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; | 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 '<td>'.phpversion().'</td>'; |
| echo '</tr></table>'; | echo '</tr></table>'; |
| </PHP> | </PHP> |
| | 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:** |
| |
| ~~INFO:syntaxplugins~~ | ~~INFO:syntaxplugins~~ |
| |
| ===== Tag Plugin ===== | |
| ==== Tag ==== | |
| |
| {{tag>[list of tags]}} | |
| |
| ^ [list of tags] | a space separated list of tags that describe the content of the current page | required | | |
| |
| Allows you to categorize your wiki pages. The resulting links either point to the corresponding page in the specified tag namespace (only if it exists). If you want a link to point to a page in another namespace, you have to indicate the namespace before the tag name. If this page doesn't exist, just the list of pages with the same tag is shown when you follow one of those links. | |
| |
| Examples: | |
| * ''%%{{tag>tag1 tag2 tag3}}%%'' | |
| * with namespaces: ''%%{{tag>:ns1:tag1 ns1:tag2 ns2:subns1:tag3}}%%'' | |
| ==== Topic ==== | |
| |
| {{topic>[tag]&[flags]}} | |
| |
| ^ [tag] | the category tag for which you want a list of pages | required | | |
| ^ [flags] | pagelist flags delimited by ''&'', see [[pagelist#flags]] | optional | | |
| |
| This displays a list of all pages that contain the given category tag. The list is sorted alphabetically by page ID. You can also prepend the modifiers ''+'' and ''-''. ''+'' creates an intersection between the list of pages created by the already defined tags and the pages matching the tag following the ''+'' (AND), ''-'' removes all pages tagged with the given tag from the list of already found pages. | |
| |
| Example: | |
| * ''%%{{topic>tag1 -tag2}}%%'' -- Lists all pages tagged with tag1 but not with tag2. | |
| * ''%%{{topic>tag1 +tag2}}%%'' -- Lists all pages tagged with tag1 and tag2. | |
| * ''%%{{topic>tag1 tag2}}%%'' -- Lists all pages tagged with either tag1 or tag2 or both. | |
| * ''%%{{topic>ns1?tag1 tag2}}%%'' -- List all pages inside namespace ns1 tagged with either tag1 or tag2 | |
| * ''%%{{topic>.?tag1 tag2}}%%'' -- List all pages inside the current namespace tagged with either tag1 or tag2 | |
| * ''%%{{topic>tag1 tag2 tag3&nodate&desc&sort}}%%'' (Adding [[:plugin:pagelist|pagelist]] options to change the design) | |
| |
| ==== Searchtags ==== | |
| |
| {{searchtags&[flags]}} | |
| |
| ^ [flags] | pagelist flags delimited by ''&'', see [[pagelist#flags]] | optional | | |
| |
| This displays a search form with the possibility to select a namespace and to select tags from a table of all tags that should either be in- or excluded with the option to choose if the tags should be associated with AND or OR. The results are displayed as in the topic component. | |
| |
| Example: | |
| * ''%%{{searchtags}}%%'' -- The basic syntax | |
| * ''%%{{searchtags&nodate&desc&sort}}%%'' -- with [[:plugin:pagelist|pagelist]] options to change the design | |
| |
| ==== Count ==== | |
| |
| {{count>[tag]}} | |
| |
| ^ [tag] | the category tag for which you want the list the occurrence | required | | |
| |
| This part allows you to display an overview of your current used tags. It prints the tag and the related occurrence (how often is the tag used?) in your wiki. Either you can specify a ''+'' as tag-name, which results in a list of all used tags or just specify some tags separated by spaces. | |
| |
| Example: | |
| * ''%%{{count>+}}%%'' -- List all tags with related occurrences. | |
| * ''%%{{count>tag1 tag2}}%%'' -- List the occurrence of tag1 and tag2. | |
| * ''%%{{count>tag1 tag2 tag3&. ns1 ns2}}%%'' -- List all occurrences for the given tags inside the namespaces (the dot specifies the root namespace) | |
| | |
| ==== Tagpage ==== | |
| |
| {{tagpage>[tag][&dynamic][|title]}} | |
| |
| This displays a link to the listing of all tags as it is done by the [[#Tag]] syntax but without tagging the page with that tag. With the optional ''dynamic'' flag the link becomes red when the listing of all pages with that tag is empty for the current user. The ''dynamic'' flag automatically disables the cache of the current page in order to ensure that the link color is always correct. Optionally a title can be specified that will be used as link name. | |
| |
| Example: | |
| * ''%%{{tagpage>test_foo}}%%'' -- The basic syntax | |
| * ''%%{{tagpage>test_foo&dynamic}}%%'' -- A link with dynamic link color | |
| * ''%%{{tagpage>test_foo|my title}}%%'' -- A link with custom title | |
| * ''%%{{tagpage>test_foo&dynamic|my | title}}%%'' -- A link with dynamic link color and custom title (that can also contain ''%%|%%'') | |
| |
| |
