computing:wikisyntax
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revisionNext revisionBoth sides next revision | ||
| computing:wikisyntax [2019/08/09 06:53] – created oemb1905 | computing:wikisyntax [2024/02/17 16:45] – oemb1905 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | < | + | [[https://www.dokuwiki.org/wiki: |
| - | {{PD Help Page}} | + | |
| - | < | + | |
| - | < | + | |
| - | You can format your text by using wiki markup. This consists of normal characters like asterisks, apostrophes or equal signs which have a special function in the wiki, sometimes depending on their position. For example, to format a word in '' | + | |
| - | == Text formatting markup | + | ====== |
| - | </ | + | |
| - | {| class=" | + | |
| - | ! < | + | |
| - | ! width=40% | < | + | |
| - | ! width=40% | < | + | |
| - | |- | + | |
| - | ! colspan=" | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | ''< | + | |
| - | </ | + | |
| - | | | + | |
| - | ''< | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | '''< | + | |
| - | </ | + | |
| - | | | + | |
| - | '''< | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | '''''< | + | |
| - | </ | + | |
| - | | | + | |
| - | '''''< | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | & | + | |
| - | </ | + | |
| - | | | + | |
| - | < | + | |
| - | |- | + | |
| - | ! colspan=" | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | == Level 2 == < | + | |
| - | === Level 3 === <!--T:27--> | + | [[doku> |
| - | ==== Level 4 ==== < | + | ===== Basic Text Formatting ===== |
| - | ===== Level 5 ===== < | + | DokuWiki supports **bold**, //italic//, __underlined__ and '' |
| - | ====== Level 6 ====== < | + | DokuWiki supports **bold**, |
| - | </translate> | + | Of course you can **__//'' |
| - | </pre> | + | |
| - | ---- | + | |
| - | {{note|1=< | + | |
| - | * < | + | |
| - | * < | + | |
| - | * < | + | |
| - | }} | + | |
| - | | | + | |
| - | <!-- using HTML markup to avoid creating new sections --> | + | |
| - | < | + | |
| - | < | + | |
| - | < | + | |
| - | <!--T:36--> | + | You can use <sub>subscript</sub> and <sup>superscript</sup>, too. |
| - | <h3>Level 3</h3> | + | |
| - | <!--T:37--> | + | You can use <sub>subscript</sub> and <sup>superscript</sup>, too. |
| - | <h4>Level 4</h4> | + | |
| - | <!--T:38--> | + | You can mark something as <del>deleted</del> as well. |
| - | < | + | |
| - | <!--T:39--> | + | You can mark something as <del>deleted</del> as well. |
| - | <h6>Level 6</ | + | |
| - | </ | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | ---- | + | |
| - | < | + | |
| - | </ | + | |
| - | | | + | |
| - | < | + | |
| - | ---- | + | |
| - | < | + | |
| - | |- | + | |
| - | | < | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | < | + | |
| - | * Start each line | + | |
| - | * with an [[Wikipedia: | + | |
| - | ** More asterisks give deeper | + | |
| - | *** and deeper levels. | + | |
| - | * Line breaks < | + | |
| - | *** But jumping levels creates empty space. | + | |
| - | Any other start ends the list. | + | |
| - | < | + | **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line. |
| - | * combine bullet list | + | |
| - | ** with definition | + | |
| - | ::- definition | + | |
| - | ** creates empty space | + | |
| - | < | + | This is some text with some linebreaks\\ Note that the |
| - | * combine bullet list | + | two backslashes are only recognized at the end of a line\\ |
| - | ** with definition | + | or followed by\\ a whitespace \\this happens |
| - | *:- definition | + | |
| - | ** without | + | |
| - | < | + | This is some text with some linebreaks\\ Note that the |
| - | *bullet list | + | two backslashes are only recognized at the end of a line\\ |
| - | :- definition | + | or followed by\\ a whitespace \\this happens without it. |
| - | :* sublist | + | |
| - | :* spaces after definition | + | |
| - | </ | + | |
| - | </ | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | * Start each line | + | |
| - | * with an [[Wikipedia: | + | |
| - | ** More asterisks give deeper | + | |
| - | *** and deeper levels. | + | |
| - | * Line breaks <br /> | + | |
| - | *** But jumping levels creates empty space. | + | |
| - | Any other start ends the list. | + | |
| - | < | + | You should use forced newlines only if really needed. |
| - | * combine bullet list | + | |
| - | ** with definition | + | |
| - | ::- definition | + | |
| - | ** creates empty space | + | |
| - | < | + | ===== Links ===== |
| - | * combine bullet list | + | |
| - | ** with definition | + | |
| - | *:- definition | + | |
| - | ** without empty spaces | + | |
| - | < | + | DokuWiki supports multiple ways of creating links. |
| - | *bullet list | + | |
| - | :- definition | + | |
| - | :* sublist that doesn' | + | |
| - | :* spaces after definition | + | |
| - | </ | + | |
| - | |- | + | |
| - | | < | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | < | + | |
| - | # Start each line | + | |
| - | # with a [[Wikipedia: | + | |
| - | ## More number signs give deeper | + | |
| - | ### and deeper | + | |
| - | ### levels. | + | |
| - | # Line breaks <br /> | + | |
| - | ### But jumping levels creates empty space. | + | |
| - | # Blank lines | + | |
| - | < | + | ==== External ==== |
| - | # end the list and start another. | + | |
| - | Any other start also | + | |
| - | ends the list. | + | |
| - | </ | + | |
| - | </ | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | # Start each line | + | |
| - | # with a [[Wikipedia: | + | |
| - | ## More number signs give deeper | + | |
| - | ### and deeper | + | |
| - | ### levels. | + | |
| - | # Line breaks <br /> | + | |
| - | ### But jumping levels creates empty space. | + | |
| - | # Blank lines | + | |
| - | <!--T:52--> | + | External links are recognized automagically: http://www.google.com or simply www.google.com |
| - | # end the list and start another. | + | |
| - | Any other start also | + | |
| - | ends the list. | + | |
| - | </ | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | < | + | |
| - | ;item 1 | + | |
| - | : definition 1 | + | |
| - | ;item 2 | + | |
| - | : definition 2-1 | + | |
| - | : definition 2-2 | + | |
| - | </translate> | + | |
| - | </ | + | |
| - | | | + | |
| - | < | + | |
| - | <!--T: | + | |
| - | ;item 1 | + | |
| - | : definition 1 | + | |
| - | ;item 2 | + | |
| - | : definition 2-1 | + | |
| - | : definition 2-2 | + | |
| - | </ | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | <!--T:57--> | + | |
| - | : Single indent | + | |
| - | :: Double indent | + | |
| - | ::::: Multiple indent | + | |
| - | </translate> | + | |
| - | </pre> | + | |
| - | ---- | + | |
| - | {{Note|1=< | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | : Single indent | + | |
| - | :: Double indent | + | |
| - | ::::: Multiple indent | + | |
| - | </ | + | |
| - | |- | + | |
| - | | < | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | < | + | |
| - | # one | + | |
| - | # two | + | |
| - | #* two point one | + | |
| - | #* two point two | + | |
| - | # three | + | |
| - | #; three item one | + | |
| - | #: three def one | + | |
| - | # four | + | |
| - | #: four def one | + | |
| - | #: this looks like a continuation | + | |
| - | #: and is often used | + | |
| - | #: instead <br />of & | + | |
| - | # five | + | |
| - | ## five sub 1 | + | |
| - | ### five sub 1 sub 1 | + | |
| - | ## five sub 2 | + | |
| - | </ | + | |
| - | </ | + | |
| - | ---- | + | |
| - | {{note|1=< | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | # one | + | |
| - | # two | + | |
| - | #* two point one | + | |
| - | #* two point two | + | |
| - | # three | + | |
| - | #; three item one | + | |
| - | #: three def one | + | |
| - | # four | + | |
| - | #: four def one | + | |
| - | #: this looks like a continuation | + | |
| - | #: and is often used | + | |
| - | #: instead | + | |
| - | # five | + | |
| - | ## five sub 1 | + | |
| - | ### five sub 1 sub 1 | + | |
| - | ## five sub 2 | + | |
| - | </ | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | < | + | |
| - | Start each line with a space. | + | |
| - | Text is ''' | + | |
| - | '' | + | |
| - | </ | + | |
| - | </ | + | |
| - | ---- | + | |
| - | {{note|1=< | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | Start each line with a space. | + | |
| - | Text is ''' | + | |
| - | '' | + | |
| - | </ | + | |
| - | |- | + | |
| - | | < | + | |
| - | | <pre> & | + | |
| - | Start with a space in the first column, | + | |
| - | (before the < | + | |
| - | <!--T:70--> | + | DokuWiki supports multiple ways of creating links. External links are recognized |
| - | Then your block format will be | + | automagically: http:// |
| - | | + | link text as well: [[http:// |
| + | | ||
| - | < | + | ==== Internal ==== |
| - | This is good for copying in code blocks: | + | |
| - | </ | + | |
| - | def function(): | + | Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]]. |
| - | """< | + | |
| - | if True: | + | Internal links are created by using square brackets. You can either just give |
| - | print True | + | a [[pagename]] or use an additional [[pagename|link text]]. |
| - | else: | + | |
| - | print False& | + | |
| - | </ | + | |
| - | | | + | |
| - | | + | |
| - | Start with a space in the first column, | + | |
| - | (before the & | + | |
| - | < | + | [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, |
| - | Then your block format will be | + | |
| - | maintained. | + | |
| - | <!--T:75--> | + | You can use [[some:namespaces]] by using a colon in the pagename. |
| - | This is good for copying | + | |
| - | </ | + | |
| - | def function(): | + | You can use [[some:namespaces]] by using a colon in the pagename. |
| - | """< | + | |
| - | if True: | + | For details about namespaces see [[doku>namespaces]]. |
| - | print True | + | |
| - | else: | + | |
| - | print False | + | |
| - | }} | + | |
| - | |} | + | |
| - | < | + | |
| - | == Paragraphs == < | + | 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# |
| - | < | + | This links to [[syntax# |
| - | MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tag < | + | |
| - | == HTML tags == <!--T:80--> | + | Notes: |
| - | < | + | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. |
| - | Some [[wikipedia: | + | * 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' |
| - | {| class=" | + | |
| - | ! < | + | |
| - | ! width=40% | < | + | |
| - | ! width=40% | < | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | < | + | ==== Interwiki ==== |
| - | <u>< | + | DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia' |
| - | </ | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. |
| + | 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>Intranet]]. |
| - | < | + | 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[' | ||
| + | </code> | ||
| - | < | + | ==== Image Links ==== |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | < | + | You can also use an image to link to another internal |
| - | < | + | [[http://php.net|{{wiki:dokuwiki-128.png}}]] |
| - | </ | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | [[http:// |
| - | < | + | Please note: The image formatting |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | < | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | {{Note|1=The q element ''' | + | |
| - | | < | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | <!-- This is a comment --> | + | |
| - | Comments are visible | + | |
| - | in the edit zone. | + | |
| - | </ | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | <!-- This is a comment --> | + | |
| - | Comments are visible only | + | |
| - | in the edit zone. | + | |
| - | </ | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | < | + | |
| - | Text is ''' | + | |
| - | '' | + | |
| - | </ | + | |
| - | ---- | + | |
| - | {{note|1=< | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | Text is ''' | + | |
| - | '' | + | |
| - | </ | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | <pre style=" | + | |
| - | < | + | |
| - | Text is ''' | + | |
| - | with a style and | + | |
| - | '' | + | |
| - | & | + | |
| - | </ | + | |
| - | ---- | + | |
| - | {{note|1=< | + | |
| - | | | + | |
| - | <pre style=" | + | |
| - | < | + | |
| - | Text is ''' | + | |
| - | with a style and | + | |
| - | '' | + | |
| - | </ | + | |
| - | |} | + | |
| - | < | + | |
| - | < | + | |
| - | continued:</ | + | |
| - | {| class=" | + | |
| - | ! < | + | |
| - | ! width=40% | < | + | |
| - | ! width=40% | < | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | < | + | |
| - | < | + | |
| - | & | + | |
| - | </ | + | |
| - | | | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | |- | + | |
| - | | < | + | |
| - | | < | + | |
| - | <pre style=" | + | |
| - | < | + | |
| - | & | + | |
| - | </ | + | |
| - | | | + | |
| - | <pre style=" | + | |
| - | < | + | |
| - | </ | + | |
| - | |} | + | |
| - | < | + | |
| - | == Inserting symbols == < | + | The whole [[# |
| - | < | + | ===== Footnotes ===== |
| - | Symbols and other special characters not available on your keyboard | + | |
| + | 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 ===== | ||
| + | |||
| + | You can use up to five different levels of headlines | ||
| + | |||
| + | ==== Headline Level 3 ==== | ||
| + | === Headline Level 4 === | ||
| + | == Headline Level 5 == | ||
| + | |||
| + | ==== Headline Level 3 ==== | ||
| + | === Headline Level 4 === | ||
| + | == Headline Level 5 == | ||
| + | |||
| + | By using four or more dashes, you can make a horizontal line: | ||
| - | < | ||
| - | As a last resort, you can use a special sequence of characters. Those sequences are called HTML entities. For example, the following sequence (entity) '''& | ||
| ---- | ---- | ||
| - | {{note|1=< | ||
| - | {| class=" | + | ===== Media Files ===== |
| - | ! colspan=32 | HTML symbol entities | + | |
| - | |- align=center | + | 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: |
| - | | '''< | + | |
| - | | '''< | + | Resize to given width: |
| - | | '''< | + | |
| - | | '''< | + | 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: |
| - | | '''< | + | |
| - | | '''< | + | Resized external image: {{https://www.php.net/images/php.gif? |
| - | | '''< | + | |
| - | | '''< | + | Real size: {{wiki: |
| - | | '''< | + | |
| - | | '''< | + | |
| - | | '''< | + | |
| - | | '''< | + | |
| - | | '''< | + | |
| - | | '''< | + | By using left or right whitespaces you can choose the alignment. |
| - | | '''< | + | |
| - | | '''< | + | {{ wiki: |
| - | | '''< | + | |
| - | | '''< | + | {{wiki: |
| - | | '''< | + | |
| - | | '''< | + | {{ wiki: |
| - | | '''< | + | |
| - | | '''< | + | {{ wiki: |
| - | | '''< | + | |
| - | | '''< | + | {{ wiki: |
| - | | '''< | + | |
| - | | '''< | + | Of course, you can add a title (displayed as a tooltip by most browsers), too. |
| - | | '''< | + | |
| - | | '''< | + | {{ wiki: |
| - | | '''< | + | |
| - | | '''< | + | {{ wiki: |
| - | |- align=center | + | |
| - | | '''< | + | 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: |
| - | | '''< | + | |
| - | | '''< | + | ==== 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 "poster" |
| - | | '''< | + | |
| - | | '' | + | ===== Lists ===== |
| - | |- align=center | + | |
| - | | '''< | + | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a '' |
| - | | '''< | + | |
| - | | '''< | + | * This is a list |
| - | | '''< | + | * The second item |
| - | | '''< | + | * You may have different levels |
| - | | '''< | + | * Another item |
| - | | '''< | + | |
| - | | '''< | + | - The same list but ordered |
| - | | '''< | + | - Another item |
| - | | '''< | + | - Just use indention for deeper levels |
| - | | '''< | + | - That's it |
| - | | '''< | + | |
| - | | '''< | + | <code> |
| - | | ''' | + | * This is a list |
| - | | ''' | + | * The second item |
| - | | '''< | + | * You may have different levels |
| - | | '''< | + | * Another item |
| - | | '''< | + | |
| - | | ''' | + | - The same list but ordered |
| - | | '''< | + | - Another item |
| - | | '' | + | - Just use indention for deeper levels |
| - | | '''< | + | - That's it |
| - | | '''< | + | </code> |
| - | | '''< | + | |
| - | | '''< | + | Also take a look at the [[doku>faq:lists|FAQ on list items]]. |
| - | | '''< | + | |
| - | | '''< | + | ===== Text Conversions ===== |
| - | | '''< | + | |
| - | | '''< | + | DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML. |
| - | | '''< | + | |
| - | | '''< | + | The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, |
| - | | '''< | + | |
| - | |- align=center | + | ==== Text to Image Conversions ==== |
| - | | '''< | + | |
| - | | '''< | + | DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. Those [[doku>Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki: |
| - | | '''< | + | |
| - | | '''< | + | * 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. |
| - | | '''< | + | |
| - | | '''< | + | -> <- <-> => <= <=> >> << |
| - | | '''< | + | "He thought |
| - | | '''< | + | |
| - | |- align=center | + | <code> |
| - | | ''' | + | -> <- <-> => <= <=> >> << |
| - | | '''< | + | "He thought |
| - | | '''< | + | </code> |
| - | | '''< | + | |
| - | | ''' | + | 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: |
| - | | '''< | + | |
| - | | '''< | + | <code> |
| - | | '''< | + | I think we should do it |
| - | | ''' | + | |
| - | | '''< | + | > No we shouldn't |
| - | | '''< | + | |
| - | | '''< | + | >> |
| - | | '''< | + | |
| - | | '' | + | > Really? |
| - | | '''< | + | |
| - | | '''< | + | >> |
| - | | '''< | + | |
| - | | '''< | + | >>> Then lets do it! |
| - | | '''< | + | </code> |
| - | | '''< | + | |
| - | | '''< | + | I think we should do it |
| - | | '''< | + | |
| - | | '''< | + | > No we shouldn't |
| - | | '''< | + | |
| - | | '''< | + | >> |
| - | | '''< | + | |
| - | |- align=center | + | > Really? |
| - | | '''< | + | |
| - | | '''< | + | >> |
| - | | '''< | + | |
| - | | '''< | + | >>> Then lets do it! |
| - | | '''< | + | |
| - | | '''< | + | ===== Tables ===== |
| - | | '' | + | |
| - | | ''' | + | DokuWiki supports a simple syntax to create tables. |
| - | | '''< | + | |
| - | | '''< | + | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ |
| - | | '''< | + | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | |
| - | | '''< | + | | Row 2 Col 1 | some colspan (note the double pipe) || |
| - | | '''< | + | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | |
| - | | '''< | + | |
| - | | '''< | + | Table rows have to start and end with a '' |
| - | | '''< | + | |
| - | | '''< | + | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ |
| - | | '''< | + | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |
| - | | '''< | + | | Row 2 Col 1 | some colspan (note the double pipe) || |
| - | | '' | + | | Row 3 Col 1 |
| - | | '''< | + | |
| - | | '''< | + | To connect cells horizontally, |
| - | | '''< | + | |
| - | | '''< | + | Vertical tableheaders are possible, too. |
| - | | '''< | + | |
| - | | '''< | + | | ^ Heading 1 ^ Heading 2 ^ |
| - | | '''< | + | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 |
| - | | '''< | + | ^ Heading 4 | no colspan this time | |
| - | | '''< | + | ^ Heading 5 |
| - | | '''< | + | |
| - | | '''< | + | As you can see, it's the cell separator before a cell which decides about the formatting: |
| - | | '''< | + | |
| - | |- align=center | + | | ^ Heading 1 ^ Heading 2 ^ |
| - | | '''< | + | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 |
| - | | '''< | + | ^ Heading 4 |
| - | | '''< | + | ^ Heading 5 |
| - | | ''' | + | |
| - | | '''< | + | 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 syntax those cells should not contain anything else. |
| - | | ''' | + | |
| - | | '''< | + | ^ Heading 1 ^ Heading 2 ^ Heading 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. |
| - | | '''< | + | |
| - | | '''< | + | ^ Table with alignment |
| - | | '''< | + | | right| |
| - | | '''< | + | |left | |
| - | | ''' | + | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | |
| - | | '''< | + | |
| - | | '''< | + | This is how it looks in the source: |
| - | | '''< | + | |
| - | | '''< | + | ^ Table with alignment |
| - | | '''< | + | |
| - | | '''< | + | |left | |
| - | | '''< | + | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | |
| - | | '''< | + | |
| - | |- align=center | + | Note: Vertical alignment is not supported. |
| - | | '''< | + | |
| - | | '''< | + | ===== No Formatting ===== |
| - | | ''' | + | |
| - | | ''' | + | If you need to display text exactly like it is typed (without any formatting), |
| - | | '''< | + | |
| - | | '''< | + | <nowiki> |
| - | | ''' | + | This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, |
| - | | ''' | + | </nowiki> |
| - | | '''< | + | The same is true for %%// |
| - | | ''' | + | |
| - | | '''< | + | |
| - | | '''< | + | This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, |
| - | | '''< | + | </nowiki> |
| - | | '''< | + | The same is true for %%// |
| - | | '''< | + | |
| - | | '''< | + | ===== 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 '' |
| - | | '''< | + | |
| - | | '''< | + | This is text is indented by two spaces. |
| - | | '''< | + | |
| - | | '''< | + | <code> |
| - | | '''< | + | This is preformatted code all spaces are preserved: like |
| - | | '''< | + | </code> |
| - | | '''< | + | |
| - | | ''' | + | <file> |
| - | | '''< | + | This is pretty much the same, but you could use it to show that you quoted a file. |
| - | | '''< | + | </file> |
| - | |} | + | |
| + | Those blocks were created by this source: | ||
| + | |||
| + | This is text is indented by two spaces. | ||
| + | |||
| + | | ||
| + | This is preformatted code all spaces are preserved: like | ||
| + | </code> | ||
| + | |||
| + | | ||
| + | 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 | ||
| + | */ | ||
| + | class HelloWorldApp { | ||
| + | public static void main(String[] args) { | ||
| + | | ||
| + | } | ||
| + | } | ||
| + | </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 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, | ||
| + | |||
| + | ==== Downloadable Code Blocks ==== | ||
| + | |||
| + | When you use the '' | ||
| + | |||
| + | <code> | ||
| + | <file php myexample.php> | ||
| + | <?php echo "hello world!"; | ||
| + | </file> | ||
| + | </code> | ||
| + | |||
| + | <file php myexample.php> | ||
| + | <?php echo "hello world!"; | ||
| + | </file> | ||
| + | |||
| + | 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 | ||
| + | | // | ||
| + | |||
| + | 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>http:// | ||
| - | {| class=" | + | {{rss>http://slashdot.org/index.rss 5 author date 1h }} |
| - | ! < | + | |
| - | ! width=40% | < | + | |
| - | ! width=40% | < | + | |
| - | |- | + | |
| - | | < | + | |
| - | |class=mw-code| & | + | |
| - | | | + | |
| - | :::'''& | + | |
| - | |- | + | |
| - | | < | + | |
| - | |class=mw-code|& | + | |
| - | | | + | |
| - | :::'''& | + | |
| - | |- | + | |
| - | | < | + | |
| - | |class=mw-code|& | + | |
| - | | | + | |
| - | :::'''& | + | |
| - | |} | + | |
| - | < | + | |
| - | < | + | |
| - | See the list of all HTML entities on the Wikipedia article [[wikipedia: | + | |
| - | == HTML tags and symbol entities displayed themselves (with and without interpreting them) == < | ||
| - | </ | ||
| - | :< | ||
| - | :< | + | ===== Control Macros ===== |
| - | :< | + | Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: |
| - | < | + | |
| - | === Nowiki for HTML === < | + | |
| - | </ | + | |
| - | << | + | |
| - | * < | + | |
| - | < | + | |
| - | * &<< | + | |
| - | < | + | |
| - | To print & symbol escapes as text, use "< | + | |
| - | == Other formatting == <!--T:150--> | + | ^ Macro ^ Description | |
| + | | %%~~NOTOC~~%% | ||
| + | | %%~~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 | | ||
| - | < | + | ===== Syntax Plugins ===== |
| - | Beyond the text formatting markup shown hereinbefore, | + | |
| - | </ | + | |
| - | * {{ll|Help: | + | DokuWiki' |
| - | * {{ll|Help: | + | |
| - | * {{ll|Help: | + | |
| - | < | + | |
| - | < | + | |
| - | * References – see [[< | + | |
| - | * [[< | + | |
| - | <!--T:153--> | + | ~~INFO:syntaxplugins~~ |
| - | You can find more references at [[< | + | |
| - | </ | + | |
| - | [[Category: | + | |
computing/wikisyntax.txt · Last modified: 2024/02/17 17:10 by oemb1905
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: GNU Free Documentation License 1.3
