| Obě strany předchozí revize Předchozí verze Následující verze | Předchozí verze |
| wiki:syntax [11.July 2013 09:10] – [Další přidané pluginy] drakmrak | wiki:syntax [26.April 2024 23:44] (aktuální) – upraveno mimo DokuWiki 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://www.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://www.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 ===== |
| * ;-) %% ;-) %% | * ;-) %% ;-) %% |
| * ^_^ %% ^_^ %% | * ^_^ %% ^_^ %% |
| | * m( %% m( %% |
| * :?: %% :?: %% | * :?: %% :?: %% |
| * :!: %% :!: %% | * :!: %% :!: %% |
| 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 ==== |
| |
| If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''. | 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 ===== | ===== RSS/ATOM Feed Aggregation ===== |
| | author | show item authors names | | | author | show item authors names | |
| | 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. All HTML 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:** |
| | %%~~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 | |
| | %%~~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 | |
| |
| ===== Rozšířené formátování ===== | |
| Tady budou věci přidané do tohoto wiki navíc aby se zjednodušila tvorba stránek | |
| ==== nspages ==== | |
| === Description === | |
| This plugin nicely displays a table of content of the pages -and optionally the subnamespaces- of a given (sub)namespace. | |
| |
| Using this plugin is easy: just write | |
| <nspages> | |
| and see the result. (You may also use the button {{http://img190.imageshack.us/img190/6845/tbnspages.png?nolinking}} from the toolbar.) | |
| |
| The general syntax is | |
| <nspages path_to_a_namespace -option1 -option2 ...> | |
| where: | |
| *path_to_a_namespace represents the path to the wanted namespace. It can be an absolute (ex: namespace1:subnamespace) or a relative path (ex: .:subnamespace). If no path is specified, the current namespace is selected. | |
| *-option may be one of the following (it is possible to specify several options): | |
| |
| ^ Common options ^^ | |
| | -subns |displays the subnamespaces of the selected namespace (and provide links to their main page) | | |
| | -nopages |do not list the pages of the selected namespace (of course this option is useful only if you use -subns) | | |
| | -exclude:nameOfPage |won't include the page nameOfPage. This option may be use several times in order to exclude several pages | | |
| | -exclude:subNs: |won't include the subnamespace subNs. This option may also be used more than once | | |
| | -exclude |won't include the current page | | |
| | -h1 |will display the first h1 title found. If a page doesn't contain such a title, the name of the page is used instead | | |
| | -textPages="some text" |//some text// will be displayed instead of the default text, to introduce the pages list | | |
| | -textNS="some text" |//some text// will be displayed instead of the default text, to introduce the namespaces list | | |
| | -title | alias of -h1 | | |
| | -simpleList | display the list on a single column | | |
| | -simpleLine | display the list on a single line (incompatible with -simpleList) | | |
| | -nbCol=3 | Change the number of columns to use (default is 3) | | |
| | -sortId | Sort the pages according to their id, even if -title is used | | |
| |
| ^ Less common options ^^ | |
| | -reverse | Sort the pages in reverse order | | |
| | -pagesInNs | The pages will appear among the namespaces | | |
| | -r | recurse : display elements of the subnamespaces. You may use just "-r" to check every subnamespace, or e.g. "-r=3" to have a depth limit to 3 levels | | |
| | -exclude:[page1 subNs: page2] |an easier syntax to exclude several pages/subnamespaces| | |
| | -pregPagesOn\\ -pregPagesOff\\ -pregNSOn \\ -pregNSOff | Enable the use of regex to select the documents that should be displayed. Eg: -pregPagesOn="/doku/i" will display only pages which contains "doku" in their id.\\ Several options may be used, and each of them may be used several times. | | |
| | -anchorName=myName | Add anchors on each title-letters, to let link directly to them. Anchors will look like, e.g. for the letter A: nspages_myName_A | | |
| |
| |
| <code>ex: <nspages path_to_a_namespace -exclude> or <nspages -subns -nopages> will work.</code> | |
| |
| ==== pagelist ==== | |
| === Description === | |
| |
| The Pagelist Plugin takes a list of wiki pages and provides a nicely formatted table with information about them. The plug-in has a number of flags that can be used to control the information and format of the page list. The user can provide a list of specific page references as can some popular helper plugins such the **Blog**, **Discussion**, **Editor**, **Tag**, **Task** and **Dir** plugins. | |
| |
| === Syntax === | |
| |
| Just wrap a regular unordered list of internal links with the ''%%<pagelist>%%'' tag. You may provide specific internal page references or have plug-ins supply them as in the example below: | |
| |
| <code> <pagelist&[flags]> | |
| * [[..:blog:|Blog Plugin]] | |
| * [[..:discussion:|Discussion Plugin]] | |
| * [[..:editor:|Editor Plugin]] | |
| * [[..:tag:|Tag Plugin]] | |
| * [[..:wrap|Wrap Plugin|This is shown in the description cell]] | |
| </pagelist></code> | |
| |
| ^ [flags] | flags can be used to alter the appearance of the pagelist, see [[#flags]] | optional | | |
| |
| === Flags === | |
| |
| ^ Setting ^ Default ^^ Alternative ^^ | |
| | ''style'' ^ ''default'' | table with horizontal lines ^ ''table'', ''list'' or ''simplelist'' | standard DokuWiki table or list style | | |
| | ''showheader'' ^ ''noheader'' | hide the heading row of the pagelist table ^ ''header'' | show the header | | |
| | ''showdate'' ^ ''date'' | show the creation or last modification date ^ ''nodate'' | hide the date | | |
| | ''showuser'' ^ ''user'' | show creator or contributors ^ ''nouser'' | hide the user | | |
| | ''showdesc'' ^ ''nodesc'' | hide the description ^ ''desc'' | show the description (from metadata) | | |
| | ''showcomments'' ^ ''nocomments'' | hide the number of comments ^ ''comments'' | show the number of comments (if **Discussion Plugin** is installed) | | |
| | ''showtags'' ^ ''notags'' | hide the tags ^ ''tags'' | show the tags (if **Tag Plugin** is installed) | | |
| | ''showfirsthl'' ^ ''firsthl'' | show the first headline ^ ''nofirsthl'' | show the page name | | |
| | ''rsort/sort'' ^ ''nosort'' | no sortation of pages ^ ''rsort/sort'' | sorts the pages (reverse) alphabetically by pagename | | |
| |
| === Example === | |
| |
| <code> <pagelist&header&comments> | |
| //an unordered list of pages to display// | |
| </pagelist></code> | |
| |
| In the example above, pagelist will display information about the provided pages in a table with a header line and a comments column (if the **Discussion Plugin** is installed). The user (or a plugin) must supply the specific pages to display in the list. | |
| |
| === Configuration === | |
| The plugin can be configured using the DokuWiki configuration manager available in the admin menu. The settings also apply to plugins which use the helper component of the pagelist plugin, like for example the archive component of the **blog** plugin. | |
| |
| ^ ''style'' | List style (default, list, table) | | |
| ^ ''showheader'' | Show table header | | |
| ^ ''showdate'' | Shows/hides the date column (hide, creation date, modification date) | | |
| ^ ''showuser'' | Shows/hides the user column (hide, creator, contributors) | | |
| ^ ''showdesc'' | Shows/hides a short description taken from the first paragraph of a page (hide, max. 160 characters, max. 500 characters) | | |
| ^ ''showcomments'' | Shows/hides comments of a page (requires the **discussion** plugin) | | |
| ^ ''showlinkbacks'' | Shows/hides linkbacks of a page (requires the [[http://foosel.org/snippets/dokuwiki/linkback|linkback]] plugin) | | |
| ^ ''showtags'' | Shows/hides tags of a page (requires the **tag** plugin) | | |
| ^ ''sort'' | Sorts the pages alphabetically by pagename | | |
| |
| ===== Syntax Plugins ===== | ===== Syntax Plugins ===== |