Differences

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

--- help [2014/05/06 16:55]
cyburt
+++ help [2014/05/12 10:10]
cyburt
@@ Line 7: / Line 7: @@
 For more details see the official, more comprehensive [[https://www.dokuwiki.org/manual|DokuWiki Manual]] and [[https://www.dokuwiki.org/wiki:syntax|DokuWiki Syntax]]
-   * add an internal link: <code>  [[file_name|textline]] </code>
+===== Basic Text Formatting =====
-   * the file you will upload will be renamed to "file_name" and "textline" will be the name of the link on the wiki page.
-   * on the resulting page, click the red link "textline" and follow instructions to upload the file
-   * if the link is not red the file name already existed.
-   * Change file version: Through "Special Pages" on the left you can reach "File list" (under Media reports ...) where you can upload new versions of files.
-== Add a link to an external webpage ==
+DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
-<code> [[http://mediawiki.org|MediaWiki]] </code>
+  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
+  Of course you can **__//''combine''//__** all these.
-== Add an image ==
+You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-   * add an internal link <code>  [[image_file_name|thumb]] </code>
+  You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-   * "thumb" makes a thumbnail. Uploaded file will be renamed image_file_name.
-   * Click on the red link "File:image_file_name" which will appear on the page and follow upload instructions.
-== Link to an existing wiki page or create a new page ==
+You can mark something as <del>deleted</del> as well.
-   * add a link to a page by typing <pre> [[Page_name]] </pre>
+  You can mark something as <del>deleted</del> as well.
-   * Create a new page: If the page does not exist the link will be red. Click to create page.
-== Text formatting ==
+**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.
+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.
+  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 =====
+DokuWiki supports multiple ways of creating links.
+==== External ====
+External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <andi@splitbrain.org> are recognized, too.
+  DokuWiki supports multiple ways of creating links. External links are recognized
+  automagically: http://www.google.com or simply www.google.com - You can set
+  link text as well: [[http://www.google.com|This Link points to google]]. Email
+  addresses like this one: <andi@splitbrain.org> are recognized, too.
+==== Internal ====
+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
+  a [[pagename]] or use an additional [[pagename|link text]].
+[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
+You can use [[some:namespaces]] by using a colon in the pagename.
+  You can use [[some:namespaces]] by using a colon in the pagename.
+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]].
+  This links to [[syntax#internal|this Section]].
+Notes:
+  * 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 ====
+DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].
+  DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis.
+  For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].
+===== Image Links ====
+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://www.php.net|{{wiki:dokuwiki-128.png}}]]
+Please note: The image formatting is the only formatting syntax accepted in link names.
+The whole [[#images_and_other_files|image]] and [[#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
+===== 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 =====
+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 ''<nowiki>~~NOTOC~~</nowiki>'' in the document.
+==== 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:
+----
+===== Media Files =====
+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:dokuwiki-128.png}}
+Resize to given width:            {{wiki:dokuwiki-128.png?50}}
+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}}
+  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}}
+By using left or right whitespaces you can choose the alignment.
+{{ wiki:dokuwiki-128.png}}
+{{wiki:dokuwiki-128.png }}
+{{ wiki:dokuwiki-128.png }}
+  {{ wiki:dokuwiki-128.png}}
+  {{wiki:dokuwiki-128.png }}
+  {{ wiki:dokuwiki-128.png }}
+Of course, you can add a title (displayed as a tooltip by most browsers), too.
+{{ wiki:dokuwiki-128.png |This is the caption}}
+  {{ 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 | ''gif'', ''jpg'', ''png''  |
+| Video | ''webm'', ''ogv'', ''mp4'' |
+| Audio | ''ogg'', ''mp3'', ''wav''  |
+| Flash | ''swf''                    |
+If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
+==== 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 ''video.webm'' and ''video.ogv'' next to the referenced ''video.mp4'', DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.
+Additionally DokuWiki supports a "poster" image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''video.jpg'' file would work.
+===== Lists =====
+Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''*'' for unordered lists or a ''-'' for ordered ones.
+  * 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>
-   <br /> line break without linespace
+  * This is a list
-   leave blank line for new paragraph
+  * The second item
-   *   use for bulleted lists as bullet (**, ***, ... for deeper levels)
+    * You may have different levels
-   #   does numbered lists (##, ###, ... for deeper levels)
+  * Another item
-   == Text == creates a new section with headline "Text" and a horizontal line
-   ---- creates a horizontal line
+  - The same list but ordered
-   '''Text''' makes "Text" bold
+  - 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]].
 === Plugins ===
@@ Line 48: / Line 210: @@
    * Boxes Plugin:  [[https://www.dokuwiki.org/plugin:box?s[]=html]]
+   * iframes Plugin:  [[https://www.dokuwiki.org/plugin:iframe]]
+   * Columns Plugin:  [[https://www.dokuwiki.org/plugin:columns?s[]=two&s[]=column]]
-**[[http://www.gatehousesuiteseastlansing.com/|The Gatehouse Suites-East Lansing (Students)]]**
-**[[http://www.kelloggcenter.com/|The Kellogg Center (Lecturers)]]**
-[[http://maps.msu.edu/|{{:msu_main_campus.jpg|MSU Campus Maps}}]]
 ~~DISCUSSION|Help Discussion~~

Talent

User Tools

Site Tools

Differences

Page Tools