Differences

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

--- wiki:syntax [2015/08/14 02:27]
peternlewis
+++ wiki:syntax [2018/04/17 16:38]
JMichaelTX [Windows Shares] Fix markdown error causing text to be jumbled.
@@ Line 1: / Line 1: @@
-====== Formatting Syntax ======
+====== Markdown Syntax for Wiki ======
-[[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]] (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.
 ===== Basic Text Formatting =====
@@ Line 51: / Line 51: @@
 [[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 84: / Line 133: @@
   * 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/userscript.js//:
+  * 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]]):
-  > LANG.nosmblinks = '';
+<code - conf/lang/en/lang.php>
+<?php
+/**
+ * Customization of the english language file
+ * Copy only the strings that needs to be modified
+ */
+$lang['js']['nosmblinks'] = '';
+</code>
 ==== Image Links ====
@@ Line 92: / Line 148: @@
 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://www.php.net|{{wiki:dokuwiki-128.png}}]]
+  [[http://php.net|{{wiki:dokuwiki-128.png}}]]
-[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
+[[http://php.net|{{wiki:dokuwiki-128.png}}]]
 Please note: The image formatting is the only formatting syntax accepted in link names.
@@ Line 132: / Line 188: @@
 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}}
-Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}
+Resized external image:           {{http://php.net/images/php.gif?200x50}}
   Real size:                        {{wiki:dokuwiki-128.png}}
   Resize to given width:            {{wiki:dokuwiki-128.png?50}}
   Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
-  Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}
+  Resized external image:           {{http://php.net/images/php.gif?200x50}}
@@ Line 170: / Line 226: @@
 If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
+By adding ''?linkonly'' you provide a link to the media without displaying it inline
+  {{wiki:dokuwiki-128.png?linkonly}}
+{{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image.
 ==== Fallback Formats ====
@@ Line 262: / Line 324: @@
 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
+<code>
+I think we should do it
-  > 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>
 I think we should do it
@@ Line 318: / Line 382: @@
   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
-You can have rowspans (vertically connected cells) by adding '':::'' into the cells below the one to which they should connect.
+You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect.
 ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
@@ Line 482: / Line 546: @@
 | date       | show item dates |
 | description| show the item description. If [[doku>config:htmlok|HTML]] is disabled all tags will be stripped |
+| nosort     | do not sort the items in the feed |
 | //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:DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered.
+By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''reverse'' parameter, or display the feed as is with ''nosort''.
 **Example:**

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools