Help:Syntax

From UIT
(Difference between revisions)
Jump to: navigation, search
m
(Navigation)
 
(71 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{TOC right}}
 
{{TOC right}}
== Access Control ==
+
= Access Control =
=== Write Access ===
+
== Write Access ==
All pages are only editable with a granted Novell Account. See [[here]] a list of all users.
+
All pages are only editable with a granted Novell Account. See [[Special:ListUsers|ListUsers]] for a list of all users.
  
=== Read Access ===
+
== Read Access ==
 
All pages are by default visible by everybody. Is you want to restrict a page to registered users only, add the following line at the begin of the page.
 
All pages are by default visible by everybody. Is you want to restrict a page to registered users only, add the following line at the begin of the page.
 
+
<pre>{{private}}</pre>
 
This line is automatically added if a new page is created.
 
This line is automatically added if a new page is created.
  
== Formatting ==
+
for a page to be readable by everybody you can simply erase the <code><nowiki>{{private}}</nowiki></code> tag and/or add the following tag
 +
<pre>{{public}}</pre>
  
|
+
= Formatting =
'''''bold & italic'''''
+
== Headings ==
|-
+
<pre>
| Escape wiki markup
+
= Heading 1 =
| <pre>
+
== Heading 2 ==
&lt;nowiki>no ''markup''</nowiki&gt;
+
=== Heading 3 ===
 +
==== Heading 4 ====
 +
===== Heading 5 =====
 +
====== Heading 6 ======
 
</pre>
 
</pre>
|
+
= Heading 1 =
<nowiki>no ''markup''</nowiki>
+
== Heading 2 ==
|-
+
=== Heading 3 ===
| Escape wiki markup once
+
==== Heading 4 ====
| <pre>
+
===== Heading 5 =====
[[API]]&lt;nowiki/>extension
+
====== Heading 6 ======
 +
 
 +
== Bold & Italic ==
 +
<pre>
 +
'''This is a bold text'''
 +
</pre>
 +
'''This is a bold text'''
 +
<pre>
 +
''This is an italic text''
 
</pre>
 
</pre>
|
+
''This is an italic text''
[[API]]<nowiki/>extension
+
<pre>
|-
+
'''''This is a bold & italic text'''''
! colspan="3" style="background:#ABE" | section formatting – ''only at the beginning of the line''
+
</pre>
|-
+
'''''This is a bold & italic text'''''
| Headings of different levels
+
| <pre>
+
  
== Level 2 ==
+
== Code ==
 +
=== Block Code ===
 +
<source lang="text">
 +
<pre>
 +
Code formatted style here
 +
</pre>
 +
</source>
  
=== Level 3 ===
+
<pre>
 
+
Code formatted style here
==== Level 4 ====
+
</pre>
 
+
===== Level 5 =====
+
 
+
====== Level 6 ======
+
  
 +
=== Inline code ===
 +
<pre>
 +
<code> This is Inline code </code>
 
</pre>
 
</pre>
----
 
{{note|
 
* [[Help_talk:Formatting#Level_1|Skip Level 1]], it is page name level.
 
* An article with 4 or more headings automatically creates a [[wikipedia:Wikipedia:Section#Table of contents (TOC)|table of contents]].
 
}}
 
|
 
  
== Level 2 ==
+
<code> This is a Inline code </code>
  
=== Level 3 ===
+
=== Syntax Highlighting ===
 +
For syntax highlighted code see the [[Help:Extentions#Syntax_Highlighting_Geshi|Geshi Extension]].
  
==== Level 4 ====
+
== No Wiki Markup ==
 
+
<pre>
===== Level 5 =====
+
<nowiki><nowiki>Text ''without'' '''wiki''' markup</nowiki></nowiki>
 
+
====== Level 6 ======
+
 
+
|-
+
| Horizontal rule
+
| <pre>
+
Text above
+
----
+
Text below
+
 
</pre>
 
</pre>
|
+
<nowiki>Text ''without'' '''wiki''' markup</nowiki>
Text above
+
 
----
+
== Lists ==
Text below
+
=== Bullet list ===
|-
+
| Bullet list
+
|
+
 
<pre>
 
<pre>
 
* Start each line
 
* Start each line
Line 84: Line 82:
 
Any other start ends the list.
 
Any other start ends the list.
 
</pre>
 
</pre>
|
+
 
 
* Start each line
 
* Start each line
 
* with an [[Wikipedia:asterisk|asterisk]] (*).
 
* with an [[Wikipedia:asterisk|asterisk]] (*).
Line 92: Line 90:
 
*** But jumping levels creates empty space.
 
*** But jumping levels creates empty space.
 
Any other start ends the list.
 
Any other start ends the list.
|-
+
 
| Numbered list
+
=== Numbered list ===
|
+
 
<pre>
 
<pre>
 
# Start each line
 
# Start each line
Line 106: Line 103:
  
 
# end the list and start another.
 
# end the list and start another.
Any other start also
+
Any other start also ends the list.
ends the list.
+
 
</pre>
 
</pre>
|
+
 
 
# Start each line
 
# Start each line
 
# with a [[Wikipedia:Number_sign|number sign]] (#).
 
# with a [[Wikipedia:Number_sign|number sign]] (#).
Line 120: Line 116:
  
 
# end the list and start another.
 
# end the list and start another.
Any other start also
+
Any other start also ends the list.
ends the list.
+
 
|-
+
== Indent ==
| Definition list
+
<pre>
| <pre>
+
;item 1
+
: definition 1
+
;item 2
+
: definition 2-1
+
: definition 2-2
+
</pre>
+
|
+
;item 1
+
: definition 1
+
;item 2
+
: definition 2-1
+
: definition 2-2
+
|-
+
| Indent text
+
| <pre>
+
 
: Single indent
 
: Single indent
 
:: Double indent
 
:: Double indent
 
::::: Multiple indent
 
::::: Multiple indent
 
</pre>
 
</pre>
----
+
 
{{Note|This workaround may be controversial from the viewpoint of accessibility.}}
+
|
+
 
: Single indent
 
: Single indent
 
:: Double indent
 
:: Double indent
 
::::: Multiple indent
 
::::: Multiple indent
 +
 +
== Tables ==
 +
{|class=wikitable
 
|-
 
|-
| Mixture of different types of list
+
|<nowiki>{|</nowiki> || <nowiki><table></nowiki> || '''Tabellenanfang'''
|
+
|-
 +
|<nowiki>|+</nowiki> || <nowiki>&nbsp;</nowiki> || '''Tabellenüberschrift''', ''optional;'' nur einmal pro Tabelle zwischen Tabellenanfang und erster Zeile definierbar
 +
|-
 +
|<nowiki>|-</nowiki> || <nowiki><tr></nowiki> || neue '''Tabellenzeile'''<!-- , Unklar ''optional in der ersten Zeile'' -- wiki engine assumes the first row -->
 +
|-
 +
|<nowiki>!</nowiki>  || <nowiki><th></nowiki> || '''Tabellenkopfzelle''', ''optional.'' Aufeinanderfolgende Kopfzellen können, durch doppelte Ausrufezeichen (!!) getrennt, in der gleichen Zeile folgen oder mit einfachen Ausrufezeichen (!) auf einer neuen Zeile beginnen.
 +
|-
 +
|<nowiki>|</nowiki>  || <nowiki><td></nowiki> || '''Tabellenzelle''', ''Pflicht!'' Aufeinanderfolgende Zellen können, durch doppelte Striche (<nowiki>||</nowiki>) getrennt, in der gleichen Zeile folgen oder mit einfachem Strich (<nowiki>|</nowiki>) auf einer neuen Zeile beginnen.
 +
|-
 +
|<nowiki>|}</nowiki> || <nowiki></table></nowiki> || '''Tabellenende'''
 +
|}
 +
 
 
<pre>
 
<pre>
# one
+
{|class=wikitable
# two
+
#* two point one
+
#* two point two
+
# three
+
#; three item one
+
#: three def one
+
# four
+
#: four def one
+
#: this looks like a continuation
+
#: and is often used
+
#: instead<br/>of &lt;nowiki><br/>&lt;/nowiki>
+
# five
+
## five sub 1
+
### five sub 1 sub 1
+
## five sub 2
+
</pre>
+
----
+
{{note|The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also be controversial.}}
+
|
+
# one
+
# two
+
#* two point one
+
#* two point two
+
# three
+
#; three item one
+
#: three def one
+
# four
+
#: four def one
+
#: this looks like a continuation
+
#: and is often used
+
#: instead<br/>of <nowiki><br/></nowiki>
+
# five
+
## five sub 1
+
### five sub 1 sub 1
+
## five sub 2{{anchor|pre}}
+
 
|-
 
|-
| Preformatted text
+
| Cell 1-1 || Cell 1-2 || Cell 1-3
| <pre>
+
|-
Start each line with a space.
+
| Cell 2-1 || Cell 2-2 ||
Text is '''preformatted''' and
+
|-
''markups'' '''''can''''' be done.
+
| Cell 3-1 || Cell 3-2
 +
|-
 +
| Cell 4
 +
|-
 +
|}
 
</pre>
 
</pre>
----
+
{|class=wikitable
{{note|This way of preformatting only applies to section formatting. Character formatting markups are still effective.}}
+
|-
|
+
| Cell 1-1 || Cell 1-2 || Cell 1-3
Start each line with a space.
+
|-
Text is '''preformatted''' and
+
| Cell 2-1 || Cell 2-2 ||
''markups'' '''''can''''' be done.
+
|-
 +
| Cell 3-1 || Cell 3-2
 +
|-
 +
| Cell 4
 
|-
 
|-
| Preformatted text blocks
 
| <pre> <nowiki><nowiki>Start with a space in the first column,
 
(before the <nowiki>).
 
 
Then your block format will be
 
    maintained.
 
 
This is good for copying in code blocks:
 
 
def function():
 
    """documentation string"""
 
 
    if True:
 
        print True
 
    else:
 
        print False</nowiki></nowiki>
 
</pre>
 
|
 
<nowiki>Start with a space in the first column,
 
(before the <nowiki>).
 
 
Then your block format will be
 
    maintained.
 
 
This is good for copying in code blocks:
 
 
def function():
 
    """documentation string"""
 
 
    if True:
 
        print True
 
    else:
 
        print False</nowiki>
 
 
|}
 
|}
  
 
+
== Links ==
=== Headings ===
+
=== Internal Links ===
 +
'''Note: Double square brackets and | for separation.'''
 
<pre>
 
<pre>
= Heading 1 =
+
[[Namelink|DisplayName]]
== Heading 2 ==
+
e.g.
=== Heading 3 ===
+
[[Help:Extentions|Extention page]]
==== Heading 4 ====
+
===== Heading 5 =====
+
====== Heading 6 ======
+
 
</pre>
 
</pre>
 +
[[Help:Extentions|Extention page]]
  
= Heading 1 =
+
You can also omit the part after the separator and only the important part of the link will be displayed.
== Heading 2 ==
+
=== Heading 3 ===
+
==== Heading 4 ====
+
===== Heading 5 =====
+
====== Heading 6 ======
+
 
+
=== Bold & Italic ===
+
 
<pre>
 
<pre>
'''This is a Bold text'''
+
[[Help:Extentions|]]
 
</pre>
 
</pre>
'''This is a Bold text'''
+
[[Help:Extentions|Extentions]]
 +
=== External Links ===
 +
'''Note: Single square brackets and <space> for separation.'''
 
<pre>
 
<pre>
''This is an Italic text''
+
[http://urladdress Display name]
 +
e.g.
 +
[http://hevs.ch HES-SO//VS Webpage]
 
</pre>
 
</pre>
''This is an Italic text''
+
[http://hevs.ch HES-SO//VS Webpage]
<pre>
+
'''''bold & italic'''''
+
</pre>
+
'''''bold & italic'''''
+
  
 +
= File & Picture Upload =
 +
To upload a file click on the [[Special:Upload|Upload File]] button that is located on the left panel. Your file must be smaller than 2MB and the extension must be authorized.
  
=== Code ===
+
For the moment the authorized extensions are: png, gif, jpg, jpeg, pdf, zip, rar, tar, tgz, gz, txt, bash, config, vhdl, do
 +
 
 +
== File Links ==
 +
In order to download a file. It can be an image or any other type of authorized file.
 +
 
 +
'''Note: Double Brackets and | for separation with type ''Media''.'''
 
<pre>
 
<pre>
<pre>
+
[[Media:filename.extension|Display name]]
Code formatted style here
+
e.g.
</pre>
+
[[Media:edawiki.jpg|Display name]]
 
</pre>
 
</pre>
 +
[[Media:edawiki.jpg|Display name]]
  
 +
== Images ==
 +
'''Note: Double Brackets and | for separation with type ''File''.'''
 
<pre>
 
<pre>
Code formatted style here
+
[[File:filename.extension|options|caption]]
 +
e.g.
 +
[[File:edawiki.jpg|left|100px|EDA Wiki Logo left]]
 +
[[File:edawiki.jpg|center|100px|EDA Wiki Logo center]]
 +
[[File:edawiki.jpg|right|100px|EDA Wiki Logo right]]
 +
[[File:edawiki.jpg|thumb|100px|EDA Wiki Logo thumbnail]]
 +
[[File:edawiki.jpg|link=Help:Syntax|200px]]
 
</pre>
 
</pre>
 +
[[File:edawiki.jpg|left|100px|EDA Wiki Logo left]]
 +
[[File:edawiki.jpg|center|100px|EDA Wiki Logo center]]
 +
[[File:edawiki.jpg|right|100px|EDA Wiki Logo right]]
 +
[[File:edawiki.jpg|thumb|100px|EDA Wiki Logo thumbnail]]
 +
[[File:edawiki.jpg|link=Help:Syntax|200px]]
  
=== No Wiki Markup ===
+
=Templates=
 +
 
 +
== Table of Content ==
 +
To put the Table of Content (TOC) that the right side of the page write the following at the beginning of a page
 
<pre>
 
<pre>
<nowiki>Text without wiki markup</nowiki>
+
{{TOC right}}
 
</pre>
 
</pre>
  
== Tables ==
+
== Navigation ==
{|cellpadding="5" cellspacing="0" border="1"
+
If somebody want to use some kind of Navigation inside pages, a template was created called <pre>nav</pre>
 +
 
 +
Put the pages you want to refer to into the appropriate parameter fields. If a parameter is not specified, it will point to the [[Main_Page]].
 +
 
 +
{|class=wikitable
 
|-
 
|-
|<nowiki>{|</nowiki> || <nowiki><table></nowiki> || '''Tabellenanfang'''
+
| Parameter || Description
 
|-
 
|-
|<nowiki>|+</nowiki> || <nowiki>&nbsp;</nowiki> || '''Tabellenüberschrift''', ''optional;'' nur einmal pro Tabelle zwischen Tabellenanfang und erster Zeile definierbar
+
| left || Previous page
 
|-
 
|-
|<nowiki>|-</nowiki> || <nowiki><tr></nowiki> || neue '''Tabellenzeile'''<!-- , Unklar ''optional in der ersten Zeile'' -- wiki engine assumes the first row -->
+
| right || Next page
|-
+
|<nowiki>!</nowiki>  || <nowiki><th></nowiki> || '''Tabellenkopfzelle''', ''optional.'' Aufeinanderfolgende Kopfzellen können, durch doppelte Ausrufezeichen (!!) getrennt, in der gleichen Zeile folgen oder mit einfachen Ausrufezeichen (!) auf einer neuen Zeile beginnen.
+
 
|-  
 
|-  
|<nowiki>|</nowiki>  || <nowiki><td></nowiki> || '''Tabellenzelle''', ''Pflicht!'' Aufeinanderfolgende Zellen können, durch doppelte Striche (<nowiki>||</nowiki>) getrennt, in der gleichen Zeile folgen oder mit einfachem Strich (<nowiki>|</nowiki>) auf einer neuen Zeile beginnen.
+
| up || Parent page
 
|-
 
|-
|<nowiki>|}</nowiki> || <nowiki></table></nowiki> || '''Tabellenende'''
 
 
|}
 
|}
  
== Links ==
+
The detailed syntax is shown below.
=== Internal Links ===
+
<pre>
+
  
</pre>
 
 
=== External Links ===
 
 
<pre>
 
<pre>
 
+
{{nav|left=page/to/the/left|up=parent|right=page/to/the/right}}
 +
e.g.
 +
{{nav|up=Help:Contents|right=Help:Extentions}}
 
</pre>
 
</pre>
  
=== File Links ===
+
The above example will create following field:
<pre>
+
{{nav|up=Help:Contents|right=Help:Extentions}}
  
</pre>
+
==Floating Box==
  
=== Images ===
+
<pre>{{FloatBox|left|The title here|The content here}}</pre>
<pre>
+
  
</pre>
+
{{FloatBox|left|The title here|
 
+
The content here
 
+
}}
== Table of Content ==
+
To put the Table of Content (TOC) that the right side of the page write the following at the beginning of a page
+
<pre>
+
{{TOC right}}
+
</pre>
+
  
== Categories ==
+
= Categories =
 
In order to put a page into a Category add the following line at the end of the page:
 
In order to put a page into a Category add the following line at the end of the page:
 
<pre>
 
<pre>
 
[[Category:Category name]]
 
[[Category:Category name]]
 
</pre>
 
</pre>
 
 
 
To see a list of all available Categories see [[Special:Categories|here]].
 
To see a list of all available Categories see [[Special:Categories|here]].
  
  
 
[[Category:Help]]
 
[[Category:Help]]

Latest revision as of 19:41, 11 December 2013

Contents

Access Control

Write Access

All pages are only editable with a granted Novell Account. See ListUsers for a list of all users.

Read Access

All pages are by default visible by everybody. Is you want to restrict a page to registered users only, add the following line at the begin of the page.

{{private}}

This line is automatically added if a new page is created.

for a page to be readable by everybody you can simply erase the {{private}} tag and/or add the following tag

{{public}}

Formatting

Headings

= Heading 1 =
== Heading 2 ==
=== Heading 3 ===
==== Heading 4 ====
===== Heading 5 =====
====== Heading 6 ======

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Bold & Italic

'''This is a bold text'''

This is a bold text

''This is an italic text''

This is an italic text

'''''This is a bold & italic text'''''

This is a bold & italic text

Code

Block Code

<pre>
Code formatted style here
</pre>
Code formatted style here

Inline code

<code> This is Inline code </code>

This is a Inline code

Syntax Highlighting

For syntax highlighted code see the Geshi Extension.

No Wiki Markup

<nowiki>Text ''without'' '''wiki''' markup</nowiki>

Text ''without'' '''wiki''' markup

Lists

Bullet list

* Start each line
* with an [[Wikipedia:asterisk|asterisk]] (*).
** More asterisks gives deeper
*** and deeper levels.
* Line breaks<br/>don't break levels.
*** But jumping levels creates empty space.
Any other start ends the list.
  • Start each line
  • with an asterisk (*).
    • More asterisks gives deeper
      • and deeper levels.
  • Line breaks
    don't break levels.
      • But jumping levels creates empty space.

Any other start ends the list.

Numbered list

# Start each line
# with a [[Wikipedia:Number_sign|number sign]] (#).
## More number signs gives deeper
### and deeper
### levels.
# Line breaks<br/>don't break levels.
### But jumping levels creates empty space.
# Blank lines

# end the list and start another.
Any other start also ends the list.
  1. Start each line
  2. with a number sign (#).
    1. More number signs gives deeper
      1. and deeper
      2. levels.
  3. Line breaks
    don't break levels.
      1. But jumping levels creates empty space.
  4. Blank lines
  1. end the list and start another.

Any other start also ends the list.

Indent

: Single indent
:: Double indent
::::: Multiple indent
Single indent
Double indent
Multiple indent

Tables

{| <table> Tabellenanfang
|+   Tabellenüberschrift, optional; nur einmal pro Tabelle zwischen Tabellenanfang und erster Zeile definierbar
|- <tr> neue Tabellenzeile
! <th> Tabellenkopfzelle, optional. Aufeinanderfolgende Kopfzellen können, durch doppelte Ausrufezeichen (!!) getrennt, in der gleichen Zeile folgen oder mit einfachen Ausrufezeichen (!) auf einer neuen Zeile beginnen.
| <td> Tabellenzelle, Pflicht! Aufeinanderfolgende Zellen können, durch doppelte Striche (||) getrennt, in der gleichen Zeile folgen oder mit einfachem Strich (|) auf einer neuen Zeile beginnen.
|} </table> Tabellenende
{|class=wikitable
|-
| Cell 1-1 || Cell 1-2 || Cell 1-3
|-
| Cell 2-1 || Cell 2-2 ||
|- 
| Cell 3-1 || Cell 3-2
|-
| Cell 4
|-
|}
Cell 1-1 Cell 1-2 Cell 1-3
Cell 2-1 Cell 2-2
Cell 3-1 Cell 3-2
Cell 4

Links

Internal Links

Note: Double square brackets and | for separation.

[[Namelink|DisplayName]]
e.g.
[[Help:Extentions|Extention page]]

Extention page

You can also omit the part after the separator and only the important part of the link will be displayed.

[[Help:Extentions|]]

Extentions

External Links

Note: Single square brackets and <space> for separation.

[http://urladdress Display name]
e.g.
[http://hevs.ch HES-SO//VS Webpage]

HES-SO//VS Webpage

File & Picture Upload

To upload a file click on the Upload File button that is located on the left panel. Your file must be smaller than 2MB and the extension must be authorized.

For the moment the authorized extensions are: png, gif, jpg, jpeg, pdf, zip, rar, tar, tgz, gz, txt, bash, config, vhdl, do

File Links

In order to download a file. It can be an image or any other type of authorized file.

Note: Double Brackets and | for separation with type Media.

[[Media:filename.extension|Display name]]
e.g.
[[Media:edawiki.jpg|Display name]]

Display name

Images

Note: Double Brackets and | for separation with type File.

[[File:filename.extension|options|caption]]
e.g.
[[File:edawiki.jpg|left|100px|EDA Wiki Logo left]]
[[File:edawiki.jpg|center|100px|EDA Wiki Logo center]]
[[File:edawiki.jpg|right|100px|EDA Wiki Logo right]]
[[File:edawiki.jpg|thumb|100px|EDA Wiki Logo thumbnail]]
[[File:edawiki.jpg|link=Help:Syntax|200px]]
EDA Wiki Logo left
EDA Wiki Logo center
EDA Wiki Logo right
EDA Wiki Logo thumbnail

Edawiki.jpg

Templates

Table of Content

To put the Table of Content (TOC) that the right side of the page write the following at the beginning of a page

{{TOC right}}

Navigation

If somebody want to use some kind of Navigation inside pages, a template was created called
nav

Put the pages you want to refer to into the appropriate parameter fields. If a parameter is not specified, it will point to the Main_Page.

Parameter Description
left Previous page
right Next page
up Parent page

The detailed syntax is shown below.

{{nav|left=page/to/the/left|up=parent|right=page/to/the/right}}
e.g.
{{nav|up=Help:Contents|right=Help:Extentions}}

The above example will create following field:

Navigation
Arrow left.gif Main_Page Arrow up.gif Help:Contents Help:Extentions Arrow right.gif

Floating Box

{{FloatBox|left|The title here|The content here}}


The title here

The content here

Categories

In order to put a page into a Category add the following line at the end of the page:

[[Category:Category name]]

To see a list of all available Categories see here.

Personal tools
Namespaces
Variants
Actions
Navigation
Browse
Toolbox