alternatehistory.com wiki

User Tools

Site Tools

Trace:
wiki:syntax

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
wiki:syntax [2006/07/24 03:10] – Ian the Adminwiki:syntax [2009/02/18 05:10] – old revision restored Thande
Line 1: Line 1:
 +====== Wiki Basics ======
 +
 +A Wiki is a collection of web pages that anyone can edit and add to using their web browser - in this case, anyone who is a member of the [[http://www.alternatehistory.com/discussion|AlternateHistory.com discussion board]].  Click "Edit Page" on the menu bar up above, and you can edit the current page in a text editor window.  Wiki pages are not as complicated as normal web pages, so they use simple options for things like bold and highlighted text.
 +
 +What makes a Wiki really easy is the ability to create new web pages.  Basically, within the Wiki you can add a link to a page whether or not it already exists yet.  Putting square brackets around a word or phrase <nowiki>[[Like this]]</nowiki> creates a link to a page named "Like this".  If a page by that name has already been created in the Wiki, you now have a link to it.  If it hasn't been created... just click on the link and you will get the option to "Create this page"!
 +
 +You could say that these are the three basic principles of the wiki:
 +  * Can be edited by anyone
 +  * Links and new pages can be added almost instantly
 +  * Used straightforward, text-based formatting to control how the page looks rather than web page code
 +
 +The rest of this document describes all of the various options for formatting text.  But always remember that the toolbar on top of the editor window has shortcut buttons.  For example, you can just highlight a block of text and hit the "H3" button and it will make it into a size 3 header.
 +
 +The four rightmost buttons on the editor bar can be very useful:
 +  * The smilies menu
 +  * Special characters menu
 +  * Signature, which inserts your username and the current date and time
 +  * Add File/Image, which lets you upload files to the Wiki and browse files to include in a page (the Wiki's folder tree is on the left of the browser)
 +
 +
 ====== Formatting Syntax ====== ====== Formatting Syntax ======
  
Line 7: Line 27:
 DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these. DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
  
-  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. +<code> 
-  Of course you can **__//''combine''//__** all these.+DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. 
 +Of course you can **__//''combine''//__** all these. 
 +</code>
  
 You can use <sub>subscript</sub> and <sup>superscript</sup>, too. You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
  
-  You can use <sub>subscript</sub> and <sup>superscript</sup>, too.+<code> 
 +You can use <sub>subscript</sub> and <sup>superscript</sup>, too. 
 +</code>
  
 You can mark something as <del>deleted</del> as well. You can mark something as <del>deleted</del> as well.
  
-  You can mark something as <del>deleted</del> as well.+<code> 
 +You can mark something as <del>deleted</del> as well. 
 +</code>
  
 **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. **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.
Line 24: Line 50:
 or followed by\\ a whitespace \\this happens without it. or followed by\\ a whitespace \\this happens without it.
  
-  This is some text with some linebreaks\\ Note that the +<code> 
-  two backslashes are only recognized at the end of a line\\ +This is some text with some linebreaks\\ Note that the 
-  or followed by\\ a whitespace \\this happens without it.+two backslashes are only recognized at the end of a line\\ 
 +or followed by\\ a whitespace \\this happens without it. 
 +</code>
  
 You should use forced newlines only if really needed. You should use forced newlines only if really needed.
Line 38: Line 66:
 External links are recognized automagically: http://www.google.com or simply www.google.com - You can set Linknames, too: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <andi@splitbrain.org> are recognized, too. External links are recognized automagically: http://www.google.com or simply www.google.com - You can set Linknames, too: [[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 +<code> 
-  automagically: http://www.google.com or simply www.google.com - You can set +DokuWiki supports multiple ways of creating links. External links are recognized 
-  Linknames, too: [[http://www.google.com|This Link points to google]]. Email +automagically: http://www.google.com or simply www.google.com - You can set 
-  addresses like this one: <andi@splitbrain.org> are recognized, too.+Linknames, too: [[http://www.google.com|This Link points to google]]. Email 
 +addresses like this one: <andi@splitbrain.org> are recognized, too. 
 +</code>
  
 ==== Internal ==== ==== Internal ====
Line 47: Line 77:
 Internal links are created by using square brackets. You can either just give a [[doku>wiki:pagename]] or use an additional [[doku>wiki:pagename|Title Text]]. Wiki pagenames are converted to lowercase automatically, special characters are not allowed.  Internal links are created by using square brackets. You can either just give a [[doku>wiki:pagename]] or use an additional [[doku>wiki:pagename|Title Text]]. Wiki pagenames are converted to lowercase automatically, special characters are not allowed. 
  
-  Internal links are created by using square brackets. You can either just give +<code> 
-  a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames +Internal links are created by using square brackets. You can either just give 
-  are converted to lowercase automatically, special chars are not allowed.+a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames 
 +are converted to lowercase automatically, special chars are not allowed. 
 +</code>
  
 You can use [[wiki:namespaces]] by using a colon in the pagename. You can use [[wiki:namespaces]] by using a colon in the pagename.
  
-  You can use [[wiki:namespaces]] by using a colon in the pagename.+<code> 
 +You can use [[wiki:namespaces]] by using a colon in the pagename. 
 +</code>
  
 For details about namespaces see [[doku>wiki:namespaces]]. For details about namespaces see [[doku>wiki:namespaces]].
Line 59: Line 93:
 Linking to a specific section is possible, too. Just add the sectionname behind a hash character as known from HTML. This links to [[syntax#internal|this Section]]. Linking to a specific section is possible, too. Just add the sectionname behind a hash character as known from HTML. This links to [[syntax#internal|this Section]].
  
-  This links to [[syntax#internal|this Section]].+<code> 
 +This links to [[syntax#internal|this Section]]. 
 +</code>
  
 Notes: Notes:
Line 72: Line 108:
 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: 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}}]]+<code> 
 +[[http://www.php.net|{{wiki:dokuwiki-128.png}}]] 
 +</code>
  
 [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] [[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
Line 84: Line 122:
 You can add footnotes ((This is a footnote)) by using double parentheses. You can add footnotes ((This is a footnote)) by using double parentheses.
  
-  You can add footnotes ((This is a footnote)) by using double parentheses.+<code> 
 +You can add footnotes ((This is a footnote)) by using double parentheses. 
 +</code>
  
 ===== Sectioning ===== ===== Sectioning =====
Line 94: Line 134:
 == Headline Level 5 == == Headline Level 5 ==
  
-  ==== Headline Level 3 ==== +<code> 
-  === Headline Level 4 === +==== Headline Level 3 ==== 
-  == Headline Level 5 ==+=== Headline Level 4 === 
 +== Headline Level 5 == 
 +</code>
  
 By using four or more dashes, you can make a horizontal line: By using four or more dashes, you can make a horizontal line:
Line 105: Line 147:
  
 You can include external and internal [[doku>images]] with curly brackets. Optionally you can specify the size of them. You can include external and internal [[doku>images]] with curly brackets. Optionally you can specify the size of them.
 +
 +Images can be uploaded with the "Add File/Image" button on the right of the text editor button toolbar.  You can use files and images that you upload, or browse for files uploaded by others.  On the left side of the file browser is the Wiki's folder structure, allowing you to choose various folders to view and save files.
 +
  
 Real size:                        {{wiki:dokuwiki-128.png}} Real size:                        {{wiki:dokuwiki-128.png}}
Line 114: Line 159:
 Resized external image:           {{http://de3.php.net/images/php.gif?200x50}} Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}
  
-  Real size:                        {{wiki:dokuwiki-128.png}} +<code> 
-  Resize to given width:            {{wiki:dokuwiki-128.png?50}} +Real size:                        {{wiki:dokuwiki-128.png}} 
-  Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} +Resize to given width:            {{wiki:dokuwiki-128.png?50}} 
-  Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}+Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} 
 +Resized external image:           {{http://de3.php.net/images/php.gif?200x50}} 
 +</code>
  
  
Line 128: Line 175:
 {{ wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }}
  
-  {{ wiki:dokuwiki-128.png}} +<code> 
-  {{wiki:dokuwiki-128.png }} +{{ wiki:dokuwiki-128.png}} 
-  {{ wiki:dokuwiki-128.png }}+{{wiki:dokuwiki-128.png }} 
 +{{ wiki:dokuwiki-128.png }} 
 +</code>
  
 Of course, you can add a title (displayed as a tooltip by most browsers), too. Of course, you can add a title (displayed as a tooltip by most browsers), too.
Line 136: Line 185:
 {{ wiki:dokuwiki-128.png |This is the caption}} {{ wiki:dokuwiki-128.png |This is the caption}}
  
-  {{ wiki:dokuwiki-128.png |This is the caption}}+<code> 
 +{{ wiki:dokuwiki-128.png |This is the caption}} 
 +</code>
  
 If you specify a filename (external or internal) that is not an image (''gif,jpeg,png''), then it will be displayed as a link instead. If you specify a filename (external or internal) that is not an image (''gif,jpeg,png''), then it will be displayed as a link instead.
Line 171: Line 222:
  
 DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. More smileys can be placed in the ''smiley'' directory and configured in the ''conf/smileys.conf'' file. Here is an overview of Smileys included in DokuWiki. DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. More smileys can be placed in the ''smiley'' directory and configured in the ''conf/smileys.conf'' file. Here is an overview of Smileys included in DokuWiki.
 +
 +Remember that the editor toolbar has a menu button that allows you to choose from the available smilies.
  
   * 8-) %%  8-)  %%   * 8-) %%  8-)  %%
Line 211: Line 264:
 Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: 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 I think we should do it
Line 246: Line 301:
 Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers. Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers.
  
-  ^ Heading 1      ^ Heading 2       ^ Heading 3          ^ +<code> 
-  | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | +^ Heading 1      ^ Heading 2       ^ Heading 3          ^ 
-  | Row 2 Col 1    | some colspan (note the double pipe) || +| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | 
-  | Row 3 Col 1    | Row 2 Col 2     | Row 2 Col 3        |+| Row 2 Col 1    | some colspan (note the double pipe) || 
 +| Row 3 Col 1    | Row 2 Col 2     | Row 2 Col 3        | 
 +</code>
  
 To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators! To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!
Line 262: Line 319:
 As you can see, it's the cell separator before a cell which decides about the formatting: As you can see, it's the cell separator before a cell which decides about the formatting:
  
-  |              ^ Heading 1            ^ Heading 2          ^ +<code> 
-  ^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | +|              ^ Heading 1            ^ Heading 2          ^ 
-  ^ Heading 4    | no colspan this time |                    | +^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | 
-  ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |+^ Heading 4    | no colspan this time |                    | 
 +^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        | 
 +</code>
  
 Note: Vertical spans (rowspan) are not possible. Note: Vertical spans (rowspan) are not possible.
Line 278: Line 337:
 This is how it looks in the source: This is how it looks in the source:
  
-  ^           Table with alignment           ^^^ +<code> 
-  |         right|    center    |left          | +^           Table with alignment           ^^^ 
-  |left          |         right|    center    | +|         right|    center    |left          | 
-  | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |+|left          |         right|    center    | 
 +| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | 
 +</code>
  
 ===== Nonparsed Blocks ===== ===== Nonparsed Blocks =====
  
-You can include non parsed blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags ''code'' or ''file''.+You can include non parsed blocks into your documents by either indenting them by using the tags ''code'' or ''file''.
  
 <code> <code>
Line 301: Line 362:
 </nowiki> </nowiki>
  
-See the source of this page to see how to use these blocks.+See the source of this page to see how to use these blocks.  One tip is that ''nowiki'' can be used to strip formatting within a paragraph, while ''code'' will create a highlighted block across the entire screen.
  
  
wiki/syntax.txt · Last modified: 2023/04/04 12:21 by 127.0.0.1
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki