Differences

This shows you the differences between two versions of the page.

--- wiki:syntax [2018/04/14 19:56]
JMichaelTX
+++ wiki:syntax [2021/07/14 01:16] (current)
peternlewis
@@ Line 1: / Line 1: @@
-====== Markdown Syntax for Wiki ======
+====== Formatting Syntax ======
-[[doku>DokuWiki]] (system used by the Keyboard Maestro Wiki) supports some simple markup language, which tries to make the pages 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. [[#Keyboard_Shortcuts|Keyboard shortcuts]] are available for most formatting commands.
+[[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 =====
@@ Line 29: / Line 32: @@
 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**
+. Use a dash, `-`, for the numbered items
+. Use an asterisk, `*`, for the bullet items
+. 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 =====
@@ Line 51: / Line 87: @@
 [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
-==== Keyboard Shortcuts ====
-For the Mac, use `CTRL + OPT + <key>`
-**General Keys**\\
-These keys are always available in DokuWiki.
-^ Key   ^ Function                                     ^
-| ''E'' | opens the current page in edit mode          |
-| ''V'' | opens the current page in view mode (if Button "View Pagesource" is displayed)|
-| ''O'' | shows the old revisions of the current page  |
-| ''R'' | shows the recent changes                     |
-| ''F'' | sets the cursor to the search field          |
-| ''H'' | opens the startpage                          |
-| ''X'' | opens the index page                         |
-| ''T'' | moves back to top of the page                |
-**Toolbar Button Shortcuts**
-^ Button                                                                 ^ Key         ^ Function                                                              ^
-|  {{http://www.dokuwiki.org/lib/images/toolbar/bold.png?nolink}}        |  ''**b**''  | Bold formatting                                                       |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/italic.png?nolink}}      |  ''**i**''  | Italic formatting                                                     |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/underline.png?nolink}}   |  ''**u**''  | Underlined formatting                                                 |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/mono.png?nolink}}        |  ''**c**''  | Code formatting                                                       |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/strike.png?nolink}}      |  ''**d**''  | Strike-through formatting                                             |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/hequal.png?nolink}}      |  ''**8**''  | Same level headline                                                   |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/hminus.png?nolink}}      |  ''**9**''  | Lower headline                                                        |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/hplus.png?nolink}}       |  ''**0**''  | Higher headline                                                       |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/h.png?nolink}}           |             | Select headline                                                       |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/h1.png?nolink}}          |  ''**1**''  | Level 1 headline (via 'Select headline' button)                       |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/h2.png?nolink}}          |  ''**2**''  | Level 2 headline (via 'Select headline' button)                       |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/h3.png?nolink}}          |  ''**3**''  | Level 3 headline (via 'Select headline' button)                       |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/h4.png?nolink}}          |  ''**4**''  | Level 4 headline (via 'Select headline' button)                       |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/h5.png?nolink}}          |  ''**5**''  | Level 5 headline (via 'Select headline' button)                       |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/link.png?nolink}}        |  ''**l**''  | Internal link formatting (launches the Link Wizard)                   |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/linkextern.png?nolink}}  |             | External link formatting                                              |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/ol.png?nolink}}          |  ''**-**''  | Ordered list item                                                     |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/ul.png?nolink}}          |  ''**.**''  | Unordered list item                                                   |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/hr.png?nolink}}          |             | Horizontal rule                                                       |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/image.png?nolink}}       |             | [[media manager|Media Selection, includes file/attachment uploader]]  |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/smiley.png?nolink}}      |             | Smiley picker                                                         |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/chars.png?nolink}}       |             | Character picker                                                      |
-|  {{http://www.dokuwiki.org/lib/images/toolbar/sig.png?nolink}}         |  ''**y**''  | Signature (only when logged in)                                       |
----
-==== NameSpaces ====
 You can use [[some:namespaces]] by using a colon in the pagename.
@@ Line 107: / Line 94: @@
 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 ====
@@ Line 133: / 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 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
 /**
@@ Line 306: / Line 302: @@
 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'..."
 <code>
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
+-> <- <-> => <= <=>
 "He thought 'It's a man's world'..."
 </code>
@@ Line 327: / Line 323: @@
 > No we shouldn't
->> Well, I say we should
+Well, I say we should
 > Really?
->> Yes!
+Yes!
->>> Then lets do it!
+> Then lets do it!
 </code>
@@ Line 340: / Line 336: @@
 > No we shouldn't
->> Well, I say we should
+Well, I say we should
 > Really?
->> Yes!
+Yes!
->>> Then lets do it!
+> Then lets do it!
 ===== Tables =====
@@ Line 466: / Line 462: @@
 </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 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//
+There are additional [[doku>syntax_highlighting|advanced options]] available for syntax highlighting, such as highlighting lines or adding line numbers.
 ==== Downloadable Code Blocks ====

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools