Wiki Syntax

I wish this page can help, i`ll try to say what i know about wiki syntax and html tags that can be used in our cute wiki. i know that my english and my explanation are not good at all but feel free to edit, fix mistakes and add new stuff it`s a Wiki ;-)

Structured Text

structured text is an easy method to input content to dynamic websites, it eleminates the need for using HTML for most content.

however structured text assumes only a few simple elements are required to format most content, anything that does not fit neatly with these few simple elements requires HTML, in drupal HTML and structured text can be mixed freely.

structured text is a Markup system, you write your content in plain text and put special symbols to mark elements like titles, links, images etc.

in structured text we try to focu on the structure of the content (sections, subsectios, paragraphs) and not on how it looks, a designer makes a general template that will change the way all content or some content looks like, but the content author should focus on the structure and meaning only.

it is every easy to learn, and very easy to edit and read and with the aid of a good designer the result can look very good.

Follows is the strucutred text or WikiSyntax that is supported in our drupal based website.

Paragraphs

paragpraphs are easy, any lines of text without special marks are paragraphs, paragrpahs are seperated by empty lines, any consuctive lines not seperated by empty lines will be merged in one paragaph

for instance to get this:

this is a paragraph

this is a paragraph that was written on multiple lines

this is a rather longish paragraph we are trying to demonstrate how words will wrap when the text is rendered, do you think I can find enough stuff to say to make this a big paragraph, no a very big paragraph, or how about an extremly big paragraph, blah blah blah blah blah, etc.

use this:


this is a paragraph

this is a paragraph
that was written on
multiple lines

this is a rather longish paragraph we are trying to demonstrate how words will wrap when the text is rendered, do you think I can find enough stuff to say to make this a big paragraph, no a very big paragraph, or how about an extremly big paragraph, blah blah blah blah blah, etc.

Text emphasise

For typing in italic:

lets have italics in the middle like this it will look darned pretty

Use this:


lets have italics in the middle ''like this''  it will look darned pretty

note it`s 2 of (') and it`s not (")

To get BOLD text:

lets have bold in the middle like this it will look even prettier

Use this:

lets have bold in the middle __like this__ it will look even prettier

and off course they can be mixed:

this is sooo important it is both bold and italics

like this:


''__this is sooo important__'' it is both __bold__ and ''italics''

Links

To place links:

this is the EGLUG website

Use this:


this is the [EGLUG | http://www.eglug.org] website

To add an Email to a name like this:

Person's Name

You can use this:


[Person's Name | mailto:email@eglug.org]

Images

To add an image in the middle of text like this:

You can use this:


[http://www.gnu.org/graphics/gnu-head-sm.jpg]

You can also place a thumbnail which links to an image from the image galleries like this:

that is my console look ;-)

This is how to do it:


[image:nodenumber]

Where nodenumber is the no# of the pic at the image galleries like mine has the url http://www.eglug.org/node/80 so i put the nodenumber as 80.

Headings

To place a large heading like this:

for titles

Use this:

!!! for titles

To place a 2nd level/medium heading like this:

for sections

Use this:

!! for sections

To place a small heading Like this:

for subsections

Use this:

! for subsections

Lists

To make a bullet list of items:

item 1
item 2
item 3

Use this


* item 1
* item 2
* item 3

bullet lists can have sublists

item 1
item 2
- subitem 1
- subitem 2
item 3
- subitem 1
  - subsubitem 1
  - subsubitem 2
- subitem 2

use this


* item 1
* item 2
** subitem 1
** subitem 2
* item 3
** subitem 1
*** subsubitem 1
*** subsubitem 2
** subitem 2

To place numbered lists:

test
test2
test3
testN and etcccccccc...

Use this:


#test
#test2
#test3
#testN etcccccccccc

Nesting is possible, like this:

foo
1. fubar
2. fu
  1. zot
  2. bot

you can use this:


#foo
##fubar
##fu
### zot
### bot

you can mix the nesting of bullet and numbered lists:

foo
- bullet me
  1. EGLUG SITE
  2. EGLUG
- bullet me harder
fu

Using this:


#foo
** bullet me
###[EGLUG SITE | http://www.eglug.org]
###[EGLUG | http://www.eglug.org]
** bullet me harder
# fu

to make definition lists like this:

foo: a word used for any arbitirary example
fubar: a word used for any arbitrary example of something that doesn't work
recursive: adj. see recursive

use this


;foo: a word used for any arbitirary example
;fubar: a word used for any arbitrary example of something that doesn't work
;recursive: adj. see recursive

where you put the word or expression you are defining between a semicolon and a colon followed by the definition statement.

definition lists are useful for glossaries, and for any key,value pairs (name, address, job, etc style information).

Misc

anywhere you want to add line breaks like in this paragraph use:


anywhere you want to add line breaks %%% like in this paragraph use:

line breaks
work on

lists too


* line %%% breaks
* work on %%% lists too

to add a horizental ruler like this:

use


----

To type code and commands:


$ls -la

Use this:

{{{ $ls -la }}}

you can also create WikiLinks, WikiLinks are links to pages based on their titles without knowing their address

for instance I might want to link to the Start of ArabDev Menya Training

like this:


for instance I might want to link to the [Start of ArabDev Menya Training]

if you make a WikiLink using a title that does not exist, it gives you the oppertunity to create it by clicking on it

me not exist

like this:


[me not exist]

tables

you can have simple tables using WikiSyntax

table head 1	table head 2	table head 3
table item 1,1	table item 1,2	table item 1,3
table item 2,1	table item 2,2	table item 2,3

like this:


||table head 1   ||table head 2   ||table head 3
| table item 1,1 | table item 1,2 | table item 1,3
| table item 2,1 | table item 2,2 | table item 2,3