Differences

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

--- usage:syntax [2008/05/15 11:39]
wkunert Added information about colouring.
+++ usage:syntax [2011/09/09 14:53] (current)
andreasreiter [Formatting Syntax]
@@ Line 1: / Line 1: @@
 ====== Formatting Syntax ======
-[[http://wiki.splitbrain.org/wiki:dokuwiki|Dokuwiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains <del>all</del> most possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing the //Edit this page// button at the bottom of the page. If you want to try something, just use the [[usage:sandbox|sandbox]] page. The simpler markup is easily accessible via [[usage:syntax#quickbuttons|quickbuttons]], too.
+[[http://wiki.splitbrain.org/wiki:dokuwiki|Dokuwiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains <del>all</del> most possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing the //Edit this page// button at the bottom of the page. If you want to try something, just use the [[usage:sandbox:overview|sandbox]] page. The simpler markup is easily accessible via [[usage:syntax#quickbuttons|quickbuttons]], too.
 ===== Quickbuttons =====
@@ Line 38: / Line 38: @@
   DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
   Of course you can **__//''combine''//__** all these.
+You can also <color orange>colourise</color> your text.
+  You can also <color orange>colourise</color> your text.
+Following colours are available:
+  * <color black>black</color>
+  * <color navy>navy</color>
+  * <color blue>blue</color>
+  * <color green>green</color>
+  * <color teal>teal</color>
+  * <color lime>aqua</color>
+  * <color maroon>maroon</color>
+  * <color purple>purple</color>
+  * <color olive>olive</color>
+  * <color gray>gray</color>
+  * <color silver>silver</color>
+  * <color red>red</color>
+  * <color fuchsia>fuchsia</color>
+  * <color yellow>yellow</color>
+  * <color white>white</color> (white)
+  * <color orange>orange</color>
 You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
@@ Line 58: / Line 80: @@
 You should use forced newlines only if really needed.
-Following colours can be used with
-  <color ...>coloured characters</color>:
-black, navy, blue, green, teal, lime, aqua, maroon, purple, olive, gray, silver, red, fuchsia, yellow, white, orange.
 ===== Links =====
@@ Line 360: / Line 377: @@
+===== Picture Gallery =====
+A basic gallery can be added by selecting a [[namespace]] like this:
+  {{gallery>namespace}}
+All imagefiles in the selected namespace will be added to the image gallery. Note: those images need to be a valid [[pagename]], eg. all lowercase.
+Instead of using a whole namespace of images, you can also specify a single image -- this makes most sense when combined with the lightbox mode (see below).
+  {{gallery>namespace:someimage.jpg}}
+The created gallery can be aligned by using whitespace (defaults to centered):
+  {{gallery> namespace}} (right aligned)
+  {{gallery>namespace }} (left aligned)
+  {{gallery> namespace }} (centered)
+You can define the wanted thumbnail size by adding its dimension as parameter:
+  {{gallery>namespace?150x150}}
+The default is a dimension of 120x120 pixels.
+You can define the number of columns as well:
+  {{gallery>namespace?6}}
+The default number of columns is 5 and can be configured in the config manager. If you specify a 0 no table is used instead all thumbnails are added in a sequence.
+To have the filename displayed below the thumbnails add the ''showname'' parameter (if this is made the default in the config, you may disable it with ''noshowname''):
+  {{gallery>namespace?showname}}
+If you want the files sorted in the reverse order use the ''reverse'' keyword (if this is made the default in the config, you may disable it with ''noreverse''):
+  {{gallery>namespace?reverse}}
+If you don't want to link to the image detail pages but directly to the image itself use the ''direct'' parameter (if this is made the default in the config, you may disable it with ''nodirect''):
+  {{gallery>namespace?direct}}
+For fancy JavaScript based inline browsing of the images use the ''lightbox'' keyword ((This feature is based on the [[http://www.huddletogether.com/projects/lightbox/|Lightbox]] and [[http://serennz.cool.ne.jp/sb/sp/lightbox/|Lightbox Plus]] scripts with some additions)). This feature implicitly sets the direct parameter. If this is made the default in the config, you may disable it with ''nolightbox''.
+  {{gallery>namespace?lightbox}}
+All params can be combined:
+  {{gallery>namespace?150x150&6&showname}}
+You can also specify the size of lightbox images. It is done the same way as with thumbnails, except using a capital 'X'. The default is 800X600.
+  {{gallery>namespace?lightbox&500X400}}
+IMPORTANT: When you have added your pictures they may not show up in the gallery: add '&purge=true' to the end of the URL to clear the cache - and then you should see them.
+=== About the Lightbox mode ===
+This mode will open the clicked picture inside the current browser window without leaving the current page. You can close the picture view by clicking the little X in the upper right corner or anywhere in the picture. You can move to the next or previous image by using the arrow buttons in the lower corners.
+The picture is downsized if necessary to fit into the current browser window. You can enlarge it with the arrow button in the top corner.
+The following keys can be used to navigate:
+^ Key             ^ Action ^
+| ''->'' or ''n'' | next image |
+| ''<-'' or ''p'' | previous image |
+| ''x'' or ''c'' or ''ESC'' | close the image view |
+The Lightbox feature will also be used for all images embedded using the standard DokuWiki image syntax and having set the ''direct'' parameter. This behavior can easily be disabled by changing the ''lightboxForEveryImg'' variable to ''0'' at the very top of the ''script.js'' file.
+More info at :[[http://www.dokuwiki.org/plugin:gallery|DokuWiki-Gallery]]
+Note: The feature does not use [[http://www.huddletogether.com/projects/lightbox2/|Version 2]] of the Lightbox script because of its heavy and DokuWiki-incompatible dependencies.

GSI - BEA Wiki

User Tools

Site Tools

Differences

Page Tools