Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
| wiki:syntax [2007/06/20 10:00] – ggmei | wiki:syntax [2026/08/25 09:49] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== | + | ====== |
| - | La pagina del Wiki è interamente in testo. Alcune combinazioni particolari di caratteri permettono di creare le formattazioni: | + | [[doku> |
| - | Le istruzioni riportate di seguito sono tutto quello che c'è da sapere nella normalità dei casi. Le istruzioni complete (in inglese) sono qui: [[Sintassi avanzata]]. | + | ===== Basic Text Formatting ===== |
| + | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
| - | ===== Formattazione base del testo ===== | + | DokuWiki supports **bold**, //italic//, __underlined__ and '' |
| + | Of course you can **__//'' | ||
| - | Il wiki supporta **grassetto**, | + | Note that the formatting markers have to directly enclose the text, so '' |
| - | Il wiki supporta **grassetto**, | + | You can use < |
| - | Ovviamente si possono **__//'' | + | |
| - | Il testo si può anche marcare come <del>cancellato</del>. | + | You can use <sub>subscript</sub> and < |
| - | Il testo si può anche marcare come <del>cancellato</ | + | You can mark something as <del>deleted</ |
| - | I **paragrafi** sono creati dalle linee vuote. | + | You can mark something as < |
| - | Questo è del testo con alcuni accapo\\ Nota che i | + | **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes |
| - | due backslashes | + | |
| - | o seguiti da\\ uno spazio \\qui non c'è. | + | |
| - | Questo è del testo con alcuni accapo\\ Nota che i | + | This is some text with some linebreaks\\ Note that the |
| - | | + | two backslashes |
| - | o seguiti da\\ uno spazio | + | or followed by\\ a whitespace |
| - | Accapo forzati dovrebbero essere usati solo se davvero necessari. | + | This is some text with some linebreaks\\ Note that the |
| + | two backslashes are only recognized at the end of a line\\ | ||
| + | or followed by\\ a whitespace \\this happens without it. | ||
| + | You should use forced newlines only if really needed. | ||
| ===== Links ===== | ===== Links ===== | ||
| - | Ci sono diversi modi di creare i link: | + | DokuWiki supports multiple ways of creating links. |
| - | ==== Esterni | + | ==== External |
| - | I link esterni vengono riconosciuti automagicamente: http:// | + | External links are recognized automagically: http:// |
| - | | + | |
| - | www.google.com | + | automagically: http:// |
| + | | ||
| + | addresses like this one: < | ||
| ==== Internal ==== | ==== Internal ==== | ||
| - | Internal links are created by using square brackets. You can either just give a [[doku> | + | 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 | Internal links are created by using square brackets. You can either just give | ||
| - | a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames | + | a [[pagename]] or use an additional [[pagename|link text]]. |
| - | are converted to lowercase automatically, | + | |
| - | You can use [[wiki: | + | [[doku> |
| - | | + | You can use [[some: |
| - | For details about namespaces see [[doku>wiki:namespaces]]. | + | You can use [[some: |
| + | |||
| + | For details about namespaces see [[doku> | ||
| Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax# | Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax# | ||
| Line 61: | Line 66: | ||
| Notes: | Notes: | ||
| - | * Links to [[wiki:syntax|existing pages]] are shown in a different style from [[wiki:nonexisting]] ones. | + | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. |
| - | * DokuWiki does not use [[wp> | + | * DokuWiki does not use [[wp> |
| * When a section' | * When a section' | ||
| + | ==== Interwiki ==== | ||
| + | |||
| + | DokuWiki supports [[doku> | ||
| + | |||
| + | DokuWiki supports [[doku> | ||
| + | For example this is a link to Wikipedia' | ||
| + | |||
| + | ==== Windows Shares ==== | ||
| + | |||
| + | Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp> | ||
| + | |||
| + | Windows Shares like [[\\server\share|this]] are recognized, too. | ||
| + | |||
| + | Notes: | ||
| + | |||
| + | * 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:// | ||
| + | <?php | ||
| + | /** | ||
| + | * Customization of the english language file | ||
| + | * Copy only the strings that needs to be modified | ||
| + | */ | ||
| + | $lang[' | ||
| + | </ | ||
| + | |||
| + | ==== Image Links ==== | ||
| + | |||
| + | You can also use an image to link to another internal or external page by combining the syntax for links and [[# | ||
| + | |||
| + | [[http:// | ||
| + | |||
| + | [[http:// | ||
| + | |||
| + | Please note: The image formatting is the only formatting syntax accepted in link names. | ||
| + | |||
| + | The whole [[# | ||
| + | |||
| + | ===== Footnotes ===== | ||
| + | |||
| + | You can add footnotes ((This is a footnote)) by using double parentheses. | ||
| + | |||
| + | You can add footnotes ((This is a footnote)) by using double parentheses. | ||
| ===== Sectioning ===== | ===== Sectioning ===== | ||
| You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string ''< | You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string ''< | ||
| - | |||
| ==== Headline Level 3 ==== | ==== Headline Level 3 ==== | ||
| Line 83: | Line 129: | ||
| ---- | ---- | ||
| + | ===== Media Files ===== | ||
| + | You can include external and internal [[doku> | ||
| + | Real size: {{wiki: | ||
| - | ===== Immagini e files allegati ===== | + | Resize to given width: |
| - | Si possono includere immagini e files sia interni che esterni tra parentesi graffe, e opzionalmente se ne può indicare la dimensione. Se il file non è un'immagine ne viene visualizzata l' | + | 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: |
| - | Dimensioni reali: | + | Resized external image: {{https://www.php.net/images/php.gif?200x50}} |
| - | Ridimensionato in larghezza: {{http://server.cone.it/logo_cone.gif?120}} | + | Real size: {{wiki: |
| + | Resize to given width: | ||
| + | Resize to given width and height: {{wiki: | ||
| + | Resized external image: {{https://www.php.net/images/php.gif?200x50}} | ||
| - | Ridimensionato completamente: | ||
| - | Dimensioni reali: | + | By using left or right whitespaces you can choose the alignment. |
| - | Ridimensionato in larghezza: | + | |
| - | Ridimensionato completamente: | + | |
| - | Con spazi a destra e sinistra si può scegliere l' | + | {{ wiki: |
| - | {{http://server.cone.it/ | + | {{wiki:dokuwiki-128.png }} |
| - | {{http://server.cone.it/ | + | {{ wiki:dokuwiki-128.png }} |
| - | {{ http://server.cone.it/ | + | |
| + | {{wiki: | ||
| + | {{ wiki: | ||
| - | | + | You can also set the alignment explicitly with a ''? |
| - | {{http://server.cone.it/ | + | |
| - | {{ http://server.cone.it/ | + | {{wiki:dokuwiki-128.png? |
| + | |||
| + | {{wiki: | ||
| + | |||
| + | Of course, you can add a title (displayed as a tooltip by most browsers), too. | ||
| + | |||
| + | {{ wiki: | ||
| + | |||
| + | {{ wiki:dokuwiki-128.png |This is the caption}} | ||
| + | |||
| + | For linking an image to another page see [[#Image Links]] above. | ||
| + | |||
| + | ==== Supported Media Formats ==== | ||
| + | |||
| + | DokuWiki can embed the following media formats directly. | ||
| + | |||
| + | | Image | '' | ||
| + | | Video | '' | ||
| + | | Audio | '' | ||
| + | | Flash | '' | ||
| + | |||
| + | If you specify a filename that is not a supported media format, then it will be displayed as a link instead. | ||
| + | |||
| + | By adding ''? | ||
| + | |||
| + | {{wiki: | ||
| + | |||
| + | {{wiki:dokuwiki-128.png? | ||
| + | |||
| + | ==== 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 '' | ||
| + | |||
| + | Additionally DokuWiki supports a " | ||
| ===== Lists ===== | ===== Lists ===== | ||
| Line 138: | Line 228: | ||
| </ | </ | ||
| - | ==== Image Links ==== | + | Also take a look at the [[doku> |
| - | You can also use an image to link to another internal or external page by combining the syntax for links and [[# | + | ===== Text Conversions ===== |
| - | [[http:// | + | DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML. |
| - | [[http:// | + | The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, |
| - | Please note: The image formatting is the only formatting syntax accepted in link names. | + | ==== Text to Image Conversions ==== |
| - | The whole [[# | + | DokuWiki converts commonly used [[wp> |
| + | |||
| + | * 8-) %% 8-) %% | ||
| + | * 8-O %% 8-O %% | ||
| + | * :-( %% :-( %% | ||
| + | * :-) %% :-) %% | ||
| + | * =) %% =) %% | ||
| + | * :-/ %% :-/ %% | ||
| + | * :-\ %% :-\ %% | ||
| + | * :-? %% :-? %% | ||
| + | * :-D %% :-D %% | ||
| + | * :-P %% :-P %% | ||
| + | * :-O %% :-O %% | ||
| + | * :-X %% :-X %% | ||
| + | * :-| %% :-| %% | ||
| + | * ;-) %% ;-) %% | ||
| + | * ^_^ %% ^_^ %% | ||
| + | * m( %% m( %% | ||
| + | * :?: %% :?: %% | ||
| + | * :!: %% :!: %% | ||
| + | * LOL %% LOL %% | ||
| + | * FIXME %% FIXME %% | ||
| + | * DELETEME %% DELETEME %% | ||
| + | |||
| + | ==== Text to HTML Conversions ==== | ||
| + | |||
| + | Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | ||
| + | |||
| + | -> <- <-> => <= <=> >> << -- --- 640x480 | ||
| + | "He thought ' | ||
| + | |||
| + | < | ||
| + | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
| + | "He thought ' | ||
| + | </ | ||
| + | |||
| + | The same can be done to produce any kind of HTML, it just needs to be added to the [[doku> | ||
| + | |||
| + | There are three exceptions which do not come from that pattern file: multiplication entity (640x480), ' | ||
| + | |||
| + | ===== Quoting ===== | ||
| + | |||
| + | 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 | ||
| + | |||
| + | > No we shouldn' | ||
| + | |||
| + | >> Well, I say we should | ||
| + | |||
| + | > Really? | ||
| + | |||
| + | >> Yes! | ||
| + | |||
| + | >>> | ||
| + | </ | ||
| + | |||
| + | I think we should do it | ||
| + | |||
| + | > No we shouldn' | ||
| + | |||
| + | >> Well, I say we should | ||
| + | |||
| + | > Really? | ||
| + | |||
| + | >> Yes! | ||
| + | |||
| + | >>> | ||
| - | ===== Tabelle | + | ===== Tables |
| - | DokuWiki supports a simple syntax to create tables. | + | DokuWiki supports a simple syntax to create tables. |
| ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
| | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
| | Row 2 Col 1 | some colspan (note the double pipe) || | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
| - | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | | + | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | |
| Table rows have to start and end with a '' | Table rows have to start and end with a '' | ||
| Line 164: | Line 322: | ||
| | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
| | Row 2 Col 1 | some colspan (note the double pipe) || | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
| - | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | | + | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | |
| To connect cells horizontally, | To connect cells horizontally, | ||
| Line 182: | Line 340: | ||
| ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
| - | Note: Vertical | + | You can have rowspans (vertically connected cells) by adding '' |
| + | |||
| + | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
| + | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | ||
| + | | Row 2 Col 1 | ::: | Row 2 Col 3 | | ||
| + | | Row 3 Col 1 | ::: | Row 2 Col 3 | | ||
| + | |||
| + | Apart from the rowspan | ||
| + | |||
| + | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
| + | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | ||
| + | | Row 2 Col 1 | ::: | Row 2 Col 3 | | ||
| + | | Row 3 Col 1 | ::: | Row 2 Col 3 | | ||
| You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. | You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. | ||
| Line 198: | Line 368: | ||
| | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
| + | Note: Vertical alignment is not supported. | ||
| + | ===== No Formatting ===== | ||
| - | ===== Footnotes ===== | + | If you need to display text exactly like it is typed (without any formatting), |
| - | You can add footnotes ((This is a footnote)) by using double parentheses. | + | < |
| + | This is some text which contains addresses like this: http:// | ||
| + | </ | ||
| + | The same is true for %%// | ||
| - | | + | |
| + | | ||
| + | </ | ||
| + | The same is true for %%// | ||
| - | ===== Icone ===== | + | ===== 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 '' |
| - | * :!: %% : | + | |
| - | * FIXME %% FIXME %% | + | |
| - | * DELETEME %% DELETEME | + | |
| + | This is text is indented by two spaces. | ||
| - | ===== Segni tipografici ===== | + | < |
| + | This is preformatted code all spaces are preserved: like <-this | ||
| + | </ | ||
| - | Il wiki converte alcuni caratteri di testo nell' | + | < |
| + | This is pretty much the same, but you could use it to show that you quoted a file. | ||
| + | </ | ||
| - | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | + | Those blocks were created by this source: |
| - | "He thought | + | |
| + | This is text is indented by two spaces. | ||
| + | |||
| + | <code> | ||
| + | This is preformatted code all spaces are preserved: like | ||
| + | | ||
| + | |||
| + | <file> | ||
| + | This is pretty much the same, but you could use it to show that you quoted a file. | ||
| + | | ||
| + | |||
| + | ==== Syntax Highlighting ==== | ||
| + | |||
| + | [[wiki: | ||
| + | |||
| + | <code java> | ||
| + | /** | ||
| + | * The HelloWorldApp class implements an application that | ||
| + | * simply displays "Hello World!" | ||
| + | */ | ||
| + | class HelloWorldApp { | ||
| + | public static void main(String[] args) { | ||
| + | System.out.println(" | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | 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> | ||
| + | |||
| + | ==== Downloadable Code Blocks ==== | ||
| + | |||
| + | When you use the '' | ||
| < | < | ||
| - | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | + | <file php myexample.php> |
| - | "He thought ' | + | <?php echo "hello world!"; ?> |
| + | </ | ||
| </ | </ | ||
| + | <file php myexample.php> | ||
| + | <?php echo "hello world!"; | ||
| + | </ | ||
| + | |||
| + | If you don't want any highlighting but want a downloadable file, specify a dash ('' | ||
| + | |||
| + | ===== RSS/ATOM Feed Aggregation ===== | ||
| + | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | ||
| + | |||
| + | ^ Parameter | ||
| + | | any number | will be used as maximum number items to show, defaults to 8 | | ||
| + | | reverse | ||
| + | | author | ||
| + | | date | show item dates | | ||
| + | | description| show the item description. All HTML tags will be stripped | | ||
| + | | nosort | ||
| + | | //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: | ||
| + | |||
| + | By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the '' | ||
| + | |||
| + | **Example: | ||
| + | |||
| + | {{rss> | ||
| + | |||
| + | {{rss> | ||
| + | |||
| + | |||
| + | ===== 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~~%% | ||
| + | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%< | ||
| + | |||
| + | ===== Syntax Plugins ===== | ||
| + | |||
| + | DokuWiki' | ||
| + | ~~INFO: | ||