Skip to Content

Wiki Syntax

khaledhosny's picture


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 focus on the structure of the content (sections, subsections, 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 structured text or WikiSyntax that is supported in our drupal based website.

Paragraphs

Paragraphs are easy, any lines of text without special marks are paragraphs, paragraphs are separated by empty lines, any conductive lines not separated by empty lines will be merged in one paragraph

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 emphasis

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:

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:

Use this:

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

To add an Email to a name like this:

You can use this:

[Person's Name | mailto:[email protected]]

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:

This is how to do it:

[image:nodenumber]


Headings

To place a large heading like this:

for titles

Use this:

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

for sections

Use this:

To place a small heading Like this:

for subsections

Use this:


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:

  1. test
  2. test2
  3. test3
  4. testN and etcccccccc...

Use this:

#test
#test2
#test3
#testN etcccccccccc

Nesting is possible, like this:

  1. 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:

  1. foo
    • bullet me

  • bullet me harder
  1. 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 arbitrary 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 arbitrary 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:


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

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 opportunity to create it by clicking on it

like this:

[me not exist]

tables

you can have simple tables using WikiSyntax

table head 1table head 2table head 3
table item 1,1table item 1,2table item 1,3
table item 2,1table item 2,2table 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

Comments

The nick of the original auth

The nick of the original author of an article shouldn't be changed to the nick of the last person who edited the article. Maybe something like

BTW, for credit, DarKnesS_WolF was the one who wrote the article, or was he the one who edited it before me?! See? This is confusing :D

Alaa's picture

check revisions

book pages are our wiki, there is no real sense of authorship in a wiki (there is a history of authorship but no ownership) so this isn't something we should worry about.

cheers, Alaa


"u know i once dream that the office of mobinil is from el 7`os :S and the one that answer u and tell u rasidak a girl called ghada"

DarKnesS_WolF's picture

Thx

thx Newcommer i messunderstod it ;) but alaa ( thx alot ) cleared everything to me :) peace

YoussefAssad's picture

Excellent!

Thanks Darknesswolf and newcomer, this reference is great. Now even a lame manager like me (serious, I'm a lamer; ask Alaa) can handle wiki syntax.

--

no credits for me

I did absolutely nothing! I only deleted one character :D

alaa: see what I mean? The original author should be unaltered

Ahmed Hashim's picture

Wiki + Arabicً

Al salamo alikom Wiki syntax is not working well with arabic specially

[Title|URL]
*
!

did you try it?

Alaa's picture

بيشتغل اهه

وا دي عنوان

  • وادي لسته
  • و لسه
    • و الفرعي

المسألة غالبا لخبطة bidi

Alaa


"i`m feeling for the 2nd time like alice in wonderland reading el wafd"

Ahmed Hashim's picture

What about view HTML code and

What about view HTML code and Java script code in the page?!

Ahmed Hashim's picture

اكشن تانى مرة

I tried more than time to include html code or any other script but all the times it disappear because browser interpret it. i tried to use brackets and other tags like code, pre but the same.

Alaa's picture

you need to escape

we input html so normally tags are interpreted, you need to use > and similar stuff.

I patched the latest wiki.module to escape html code in curly bracketed pre blocks, if you want to backport my patches to 4.5 tell me.

or perhaps we can check code.module I think it escapes html, Msameer you use code.module is it useful for writing html?

Alaa


"context is over-rated. who are you anyway?"

Ahmed Hashim's picture

Again

mm, i think my problems with wiki syntaz wont stop :( but i believe that guys here give the best help :)

what if i want to make an image refers to a link?

Pronco's picture

Mixed Wiki and HTML

You can use HTML instead of Wiki


- I'm a code junkie security enthusiast

Ahmed Hashim's picture

I know !! ---- Ahmed Hash

I know !!

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.


Dr. Radut | book