| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| howto:syntax [2019/08/11 16:27] – ↷ Page moved from wiki:syntax to howto:syntax ve7hzf | howto:syntax [2020/08/09 16:51] (current) – va7fi |
|---|
| ====== Editing Mode ====== | ====== Editing Mode ====== |
| * In order to edit this site, you must first sign in | {{ howto:edit1.png}} |
| * Next, you can edit the entire page using the pen icon | * In order to edit this site, you must first ''Log In'' (top right corner). |
| {{:wiki:edit1.png }}{{:wiki:edit2.png }} | * After that, the "pen icon" will appear on the right, which allows you to edit the entire page. |
| | * Alternatively, each section will have an <key>Edit</key> button that allows you to edit only that section. |
| | \\ |
| | \\ |
| | \\ |
| | |
| | ====== News Item ====== |
| | To post a news item: |
| | - Make sure you are logged in. |
| | - Click on the ''Create a News Item'' button on the front page. \\ {{howto:newsfeed.png}} |
| | - Enter a **short** title. |
| | - Write the article below the title (make sure you leave the title between the 6 equal signs as is). |
| | - Before you save, select the "default" Blog option. |
| | - Write the year and month (first three letters) in the tags field. |
| | |
| | Here's a short video demonstration: |
| | |
| | {{ youtube>hbU6BHIUUM8 }} |
| |
| ====== Formatting Syntax ====== | ====== 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. | [[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 [[howto:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too. |
| |
| ===== Basic Text Formatting ===== | ===== Basic Text Formatting ===== |
| ==== External ==== | ==== 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. | External links are recognized automagically: https://www.google.com or simply www.google.com - You can set the link text as well: [[https://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 | DokuWiki supports multiple ways of creating links. External links are recognized |
| automagically: http://www.google.com or simply www.google.com - You can set | automagically: https://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 | link text as well: [[https://www.google.com|This Link points to google]]. Email |
| addresses like this one: <andi@splitbrain.org> are recognized, too. | addresses like this one: <andi@splitbrain.org> are recognized, too. |
| |
| ==== Internal ==== | ==== 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 [[wiki:pagename]] or use an additional [[wiki:pagename|link text]]. |
| |
| Internal links are created by using square brackets. You can either just give | Internal links are created by using square brackets. You can either just give |
| Notes: | Notes: |
| |
| * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | * Links to [[syntax|existing pages]] are shown in a different style from [[wiki: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. | * 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. |
| |
| * 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/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> | * For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[https://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 php> |
| <?php | <?php |
| /** | /** |
| 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://php.net|{{wiki:dokuwiki-128.png}}]] | [[https://php.net|{{wiki:dokuwiki-128.png}}]] |
| |
| [[http://php.net|{{wiki:dokuwiki-128.png}}]] | [[https://php.net|{{howto: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. |
| You can include external and internal [[doku>images|images, videos and audio files]] 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: {{howto:dokuwiki-128.png}} |
| |
| Resize to given width: {{wiki:dokuwiki-128.png?50}} | Resize to given width: {{howto: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}} | 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)): {{howto:dokuwiki-128.png?200x50}} |
| |
| Resized external image: {{http://php.net/images/php.gif?200x50}} | Resized external image: {{https://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://php.net/images/php.gif?200x50}} | Resized external image: {{https://php.net/images/php.gif?200x50}} |
| |
| |
| By using left or right whitespaces you can choose the alignment. | By using left or right whitespaces you can choose the alignment. |
| |
| {{ wiki:dokuwiki-128.png}} | {{ howto:dokuwiki-128.png}} |
| |
| {{wiki:dokuwiki-128.png }} | {{howto:dokuwiki-128.png }} |
| |
| {{ wiki:dokuwiki-128.png }} | {{ howto: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. | Of course, you can add a title (displayed as a tooltip by most browsers), too. |
| |
| {{ wiki:dokuwiki-128.png |This is the caption}} | {{ howto:dokuwiki-128.png |This is the caption}} |
| |
| {{ wiki:dokuwiki-128.png |This is the caption}} | {{ wiki:dokuwiki-128.png |This is the caption}} |
| {{wiki:dokuwiki-128.png?linkonly}} | {{wiki:dokuwiki-128.png?linkonly}} |
| |
| {{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image. | {{howto:dokuwiki-128.png?linkonly}} This is just a link to the image. |
| |
| ==== Fallback Formats ==== | ==== Fallback Formats ==== |
| ==== Text to HTML Conversions ==== | ==== Text to HTML Conversions ==== |
| |
| Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | Typography: [[wiki:dokuwiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. |
| |
| -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) |
| |
| <nowiki> | <nowiki> |
| This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. | This is some text which contains addresses like this: https://www.splitbrain.org and **formatting**, but nothing is done with it. |
| </nowiki> | </nowiki> |
| The same is true for %%//__this__ text// with a smiley ;-)%%. | The same is true for %%//__this__ text// with a smiley ;-)%%. |
| |
| <nowiki> | <nowiki> |
| This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. | This is some text which contains addresses like this: https://www.splitbrain.org and **formatting**, but nothing is done with it. |
| </nowiki> | </nowiki> |
| The same is true for %%//__this__ text// with a smiley ;-)%%. | The same is true for %%//__this__ text// with a smiley ;-)%%. |
| This is text is indented by two spaces. | This is text is indented by two spaces. |
| |
| <code> | <pcode> |
| This is preformatted code all spaces are preserved: like <-this | This is preformatted code all spaces are preserved: like <-this |
| </code> | </code> |
| ==== Syntax Highlighting ==== | ==== 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>''. | [[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[https://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> | <code java> |
| </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: |
| | <WRAP indent><WRAP box 100%> |
| | ''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'' |
| | </WRAP></WRAP> |
| |
| 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. |
| HTML example: | HTML example: |
| |
| <code> | <code html> |
| <html> | <html> |
| This is some <span style="color:red;font-size:150%;">inline HTML</span> | This is some <span style="color:red;font-size:150%;">inline HTML</span> |
| PHP example: | PHP example: |
| |
| <code> | <code php> |
| <php> | <php> |
| echo 'The PHP version: '; | echo 'The PHP version: '; |
| |
| ===== RSS/ATOM Feed Aggregation ===== | ===== 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: | [[wiki:dokuwiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[https://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 ^ | ^ Parameter ^ Description ^ |
| **Example:** | **Example:** |
| |
| {{rss>http://slashdot.org/index.rss 5 author date 1h }} | {{rss>https://slashdot.org/index.rss 5 author date 1h }} |
| |
| {{rss>http://slashdot.org/index.rss 5 author date 1h }} | {{rss>https://slashdot.org/index.rss 5 author date 1h }} |
| |
| |
