slitaz-dev-tools annotate tazwikiss/rootfs/var/www/wiki/pages/Help.txt @ rev 245

tazwikiss: use sedesc()
author Pascal Bellard <pascal.bellard@slitaz.org>
date Wed Sep 02 10:14:11 2015 +0200 (2015-09-02)
parents add86f2168cd
children b59cc28d47e2
rev   line source
slaxemulator@15 1 TOC
slaxemulator@15 2 !Help
slaxemulator@15 3
slaxemulator@15 4 Here is a summary of all the formatting rules in ''WiKiss''.
slaxemulator@15 5 Click "Edit" on top or bottom of this page to see how it works.
slaxemulator@15 6 (if you see "Page Locked", do a chmod 775 on this file via a ftp client)
slaxemulator@15 7
slaxemulator@15 8 See also [AideTables] to create tables.
slaxemulator@15 9
slaxemulator@15 10 ----
slaxemulator@15 11
pascal@245 12 Tiles use the exclamation mark '''!'''
pascal@245 13 ^! Big
pascal@245 14 ^!! Less big
pascal@245 15 ^!!! Smaller
slaxemulator@15 16 gives you :
slaxemulator@15 17 ! Big
slaxemulator@15 18 !! Less big
slaxemulator@15 19 !!! Smaller
slaxemulator@15 20
slaxemulator@15 21 To automatically add a table of contents in a page, add the '''TOC''' mark in it :
slaxemulator@15 22 * at the last line to be clearer, there is no influence on position ;
slaxemulator@15 23 * at the first line if you need to write TOC in your page. Only the first occurrence will be replaced.
slaxemulator@15 24
slaxemulator@15 25 ----
slaxemulator@15 26
slaxemulator@15 27 Styles use the single quote '
slaxemulator@15 28 * ^''^'Bold^''^' --> '''Bold'''
slaxemulator@15 29 * ^''italic^'' --> ''italic''
slaxemulator@15 30 * ^''^''^'Bold and italic^''^''^' --> '''''Bold and italic'''''
slaxemulator@15 31
slaxemulator@15 32 ----
slaxemulator@15 33
pascal@245 34 Stroke of a work use quote and two dashes
slaxemulator@15 35 ^'--Stroked--' --> '--Stroked--'
slaxemulator@15 36
pascal@245 37 the same applies for underline, quote followed by by two underscore
slaxemulator@15 38 ^'__Underlined__' --> '__Underlined__'
slaxemulator@15 39
slaxemulator@15 40 ----
slaxemulator@15 41
slaxemulator@15 42 The ordered lists use sharp '''#'''
slaxemulator@15 43 # First
slaxemulator@15 44 # Second
slaxemulator@15 45 # Third
slaxemulator@15 46
slaxemulator@15 47 ----
slaxemulator@15 48
slaxemulator@15 49 Non ordered lists use the star '''*'''
slaxemulator@15 50 * Apple
slaxemulator@15 51 * Pear
slaxemulator@15 52 * Peach
slaxemulator@15 53
slaxemulator@15 54 ----
slaxemulator@15 55
pascal@245 56 The code, and all of those things where formatting is important, use the braces
pascal@245 57 ^{{import sys
pascal@245 58 if len(sys.argv) == 2:
pascal@245 59 print "Hello",sys.argv^[1]}}
slaxemulator@15 60 give :
slaxemulator@15 61 {{import sys
slaxemulator@15 62 if len(sys.argv) == 2:
slaxemulator@15 63 print "Hello",sys.argv[1]}}
slaxemulator@15 64
slaxemulator@15 65 ----
slaxemulator@15 66
slaxemulator@15 67 The separation between paragraphs of text is done through an empty line.
pascal@245 68 To force a line break in the middle of a paragraph, use: ^
slaxemulator@15 69
slaxemulator@15 70 ----
slaxemulator@15 71
slaxemulator@15 72 Some special characters are recognized:
pascal@245 73 * Arrows: &lt;^-- : &lt;--, ^--> : -->, &lt;^--> : &lt;-->
pascal@245 74 * Copyrights: ^(c) or ^(C) : (c), ^(r) or ^(R) : (r)
pascal@245 75 * Fractions: ^(1/2) : (1/2), ^(1/4) : (1/4), ^(3/4) : (3/4)
pascal@245 76 * Miscellaneous: ^(+-) : (+-), ^(!=) : (!=)
pascal@245 77 * Some icons: ^(phone) : (phone), ^(wphone) : (wphone), ^(bflag) : (bflag), ^(wflag) : (wflag) ^(radioactive) : (radioactive), ^(sad) : (sad), ^(smile) : (smile), ^(recycle) : (recycle), ^(wheelchair) : (wheelchair), ^(anchor) : (anchor), ^(flower) : (flower), ^(gear) : (gear), ^(volt) : (volt), ^(warn) : (warn), ^(skull) : (skull), ^(star) : (star)
slaxemulator@15 78
slaxemulator@15 79 ----
slaxemulator@15 80
slaxemulator@15 81 Links to wiki-pages use square brackets :
slaxemulator@15 82 '''^['''Accueil''']''' --> [Accueil]
slaxemulator@15 83
slaxemulator@15 84 If a page does not exists, it will be created on first click.
pascal@245 85 Click on "SandBox" below and you will be able to create it ...
slaxemulator@15 86 [SandBox]
slaxemulator@15 87
slaxemulator@15 88 To link a wiki-page with a different text use :
slaxemulator@15 89 '''^['''Beginning'''|?page='''Accueil''']''' --> [Beginning|?page=Accueil]
slaxemulator@15 90
slaxemulator@15 91 The external links and addresses eMail are automagically recognized ...
slaxemulator@15 92 * ^http://wikiss.tuxfamily.org/ --> http://wikiss.tuxfamily.org/
slaxemulator@15 93 * wikiss^@example.org --> wikiss@example.org
slaxemulator@15 94
slaxemulator@15 95 or through a text between square brackets :
slaxemulator@15 96 * '''^['''Visit WiKiss web site'''|'''^http://wikiss.tuxfamily.org/''']''' --> [Visit WiKiss web site|http://wikiss.tuxfamily.org/]
slaxemulator@15 97
slaxemulator@15 98 with a ? you get a Wikipedia link in the current language :
slaxemulator@15 99 * '''^[?'''Wiki''']''' --> [?Wiki]
slaxemulator@15 100
slaxemulator@15 101 ----
slaxemulator@15 102
pascal@245 103 Images are automagically inserted with the picture URL between square brackets
slaxemulator@15 104 '''^['''^http://wikiss.tuxfamily.org/img/logo_100.png''']''' -->
slaxemulator@15 105 [http://wikiss.tuxfamily.org/img/logo_100.png]
slaxemulator@15 106
pascal@245 107 You can also use an image as a link :
slaxemulator@15 108 '''^['''^http://wikiss.tuxfamily.org/img/logo_100.png'''|'''^http://wikiss.tuxfamily.org/''']''' -->
slaxemulator@15 109 [http://wikiss.tuxfamily.org/img/logo_100.png|http://wikiss.tuxfamily.org/]
slaxemulator@15 110
slaxemulator@15 111 But also position the image on a floating left or right:
slaxemulator@15 112 [http://wikiss.tuxfamily.org/img/logo_100.png|left] [http://wikiss.tuxfamily.org/img/logo_100.png|http://wikiss.tuxfamily.org|right]
slaxemulator@15 113
pascal@245 114
pascal@245 115 &lt;-- '''^['''^http://wikiss.tuxfamily.org/img/logo_100.png'''|left]'''
slaxemulator@15 116 '''^['''^http://wikiss.tuxfamily.org/img/logo_100.png'''|'''^http://wikiss.tuxfamily.org'''|right]''' -->
pascal@245 117
slaxemulator@15 118
slaxemulator@15 119 ----
slaxemulator@15 120
slaxemulator@15 121 ... to insert lines, simply use four dashes : '''---- '''
slaxemulator@15 122
slaxemulator@15 123 ----
slaxemulator@15 124
pascal@245 125 Finally, in order to neutralize the syntax WiKiss, use the caret ^
slaxemulator@15 126 Thus, enter '''^^^['''WiKiss''']''' can display ^[WiKiss] rather than [WiKiss]
slaxemulator@15 127
slaxemulator@15 128 ----
slaxemulator@15 129
slaxemulator@15 130 Try it, you'll see, it's very simple.