User Tools
wiki:syntax
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
wiki:syntax [2019/01/06 04:18] 127.0.0.1 external edit |
wiki:syntax [2021/07/14 01:16] (current) peternlewis |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| [[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 [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too. | ||
| + | |||
| + | ===== DokuWiki Full Syntax ===== | ||
| + | See [DokuWiki Formatting Syntax Reference Page](https://www.dokuwiki.org/wiki:syntax) | ||
| ===== Basic Text Formatting ===== | ===== Basic Text Formatting ===== | ||
| Line 29: | Line 32: | ||
| You should use forced newlines only if really needed. | You should use forced newlines only if really needed. | ||
| + | |||
| + | ===== Lists ===== | ||
| + | ==== DokuWiki List Ref ==== | ||
| + | See [Working with Lists -- DokuWiki Reference](https://www.dokuwiki.org/faq%3Alists) | ||
| + | |||
| + | ==== Mixing Numbered and Bullet Items ==== | ||
| + | |||
| + | |||
| + | **How To Mix Unordered (Bullet) Items with Ordered (Numbered) Items in a List** | ||
| + | |||
| + | 1. Use a dash, `-`, for the numbered items | ||
| + | 2. Use an asterisk, `*`, for the bullet items | ||
| + | 3. The List Title must immediately precede the list. | ||
| + | |||
| + | This Markdown Text: | ||
| + | |||
| + | List Title Goes Here | ||
| + | - First numbered item | ||
| + | - Second numbered item | ||
| + | * First sub-bullet item | ||
| + | * Second sub-bullet item | ||
| + | - Third numbered item | ||
| + | |||
| + | Results in This Rendered Text: | ||
| + | |||
| + | List Title Goes Here | ||
| + | - First numbered item | ||
| + | - Second numbered item | ||
| + | * First sub-bullet item | ||
| + | * Second sub-bullet item | ||
| + | - Third numbered item | ||
| + | |||
| + | |||
| ===== Links ===== | ===== Links ===== | ||
| Line 58: | Line 94: | ||
| For details about namespaces see [[doku>namespaces]]. | For details about namespaces see [[doku>namespaces]]. | ||
| - | 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#internal|this Section]]. | + | === Links to Sections on a Page === |
| - | This links to [[syntax#internal|this Section]]. | ||
| - | Notes: | + | Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML.\\ |
| + | This, `[[syntax#internal|this Section]]`, links to [[syntax#internal|this Section]]. | ||
| + | |||
| + | If you want to link to a section on the page being edited, just use the `#InternalLink` on that page:\\ | ||
| + | This, `[[#internal|Link to Internal on this page]]` creates this [[#internal|Link to Internal on this page]]. | ||
| - | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | + | **Notes**: |
| - | * 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. | + | - You can get the _Internal Link_ by either of these methods: |
| - | * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much. | + | * Click on the link in the _Table of Contents_ to go to that link, and then view the link in the browser's address bar. |
| + | * Right-Click on the link in the _Table of Contents_, select _copy link_, and then view the _System Clipboard_. | ||
| + | - Links to [[syntax|existing pages]] are shown in a different style from [[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. | ||
| + | - When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much. | ||
| ==== Interwiki ==== | ==== Interwiki ==== | ||
| Line 84: | Line 127: | ||
| * 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 [[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 | <?php | ||
| /** | /** | ||
| Line 257: | Line 302: | ||
| Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | ||
| - | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | + | -> <- <-> => <= <=> |
| "He thought 'It's a man's world'..." | "He thought 'It's a man's world'..." | ||
| <code> | <code> | ||
| - | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | + | -> <- <-> => <= <=> |
| "He thought 'It's a man's world'..." | "He thought 'It's a man's world'..." | ||
| </code> | </code> | ||
| Line 278: | Line 323: | ||
| > 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> | </code> | ||
| Line 291: | Line 336: | ||
| > 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! |
| ===== Tables ===== | ===== Tables ===== | ||
wiki/syntax.1546766327.txt.gz · Last modified: 2019/01/06 04:18 by 127.0.0.1
Page Tools
