Home Wiki > Help:Wiki reference card
Sign up | Login

Help:Wiki reference card

tagline: From openSUSE

This is a quick reference to use when editing the wiki.
Warning The openSUSE wiki guidelines describe the best way and practice to follow across the openSUSE wiki. In order to avoid conflicts, to bring uniformity, consistency and reliable source of information, look at the wiki portal.

Start a new page

To start a new page type http://en.opensuse.org/Namespace:Page_title into address bar of your browser, where:

  • Namespace is the appropriate namespace for your article.
  • Page_title is title of your article.

In our wiki article title is part of URL, so pay attention when you choose it that is really something that you want to keep as title.

When you press enter you will see either existing page, so someone was faster and wrote article, or empty page informing you that such page does not exist, giving you few options: "There is currently no text in this page. You can search for this page title in other pages, search the related logs, or edit this page. Select edit this page and start writing article.

Links to pages that don’t exist, will be in red. To create that page, simply click on that link to create it. An edit window will appear.


Basic Formatting

  • ''Italic text'' gives Italic text.
  • '''Bold text''' gives Bold text.
  • '''''Bold & Italic text''''' gives Bold & Italic text.
  • --~~~~ gives after saving your signature.
  • <nowiki>text w/o [[wikification]]</nowiki> gives text w/o [[wikification]] used in help like this one, to show wiki text.
  • <pre>block of text w/o reformatting</pre> gives:
    block of text w/o reformatting
  • Start line with a space gives the same as <pre>block of text w/o reformatting</pre>.

Headings

  • Use the = (Heading) markup, not the ''' (bold) markup ''' to create a heading. This way, the table of contents is automatically generated from the headings and that helps readers to go directly to the section of interest.
  • Start with double equal sign "==" not a single "=" :
==heading 1==
===subheading 1.1===
===subheading 1.2===
==heading 2==
===subheading 2.2===
====subheading 2.2.1====
=====subheading 2.2.1.1=====

Lists

Here you will learn how to use lists in this wiki:

* itemized list  ----List with dots
** second level
*** Third level

# numbered list  ----Numbered list
## second level
### Third level
<!-- the css has to be fixed to show bold and ident using ; and : correctly -->
; DNA: Deoxyribonucleic acid
 ''----Definition list''
;; rDNA: Ribosomal DNA
: colon indents line
:: more indented line

Links

Internal link

  • Source: The most popular browser is [[Firefox]].
  • Gives: The most popular browser is Firefox.

External link

Simple

Behind another text is the way majority web links work.

Language wiki link

  • Source: [[de:Wiki reference card]]
  • Gives: Link in the left sidebar.

Multimedia

  • Source: Here is a pic [[File:Icon-distribution.png]]
  • Gives:
    Here is a pic Icon-distribution.png


  • Source: Here is a pic [[File:Icon-distribution.png|frame|Caption]]
  • Gives:
    Here is a pic
    Caption


  • Source: Here is a pic [[File:Icon-distribution.png|thumb|Caption]]
  • Gives:
    Here is a pic
    Caption



Tables

A Table is an arrangement of columns and rows used to organize and position data. The syntax used is based on MediaWiki, so you may find some of the advice on http://en.wikipedia.org/wiki/Help:Table helpful. Following are some examples.

A simple table

Code:

{|
| topleft || topmiddle || topright
|-
| bottomleft || bottommiddle || bottomright
|}

Result:

topleft topmiddle topright
bottomleft bottommiddle bottomright

A more complex example using CSS styles

Notice the CSS in the first line, in style=""; this allows powerful manipulation of table appearance. You can also add CSS to a row or cell; the syntax for a row is |- style="CSS-goes-here", and for a cell is || style="CSS-goes-here" | content ||.

Centering the table on the page is achieved by margin:auto (which sets the left and right margins to be equal, and hence centering is achieved).

A grid (borders between cells) is achieved by putting a border around each cell. CSS allows you to specify a margin outside the border, called "margin", and a margin inside the border, called "padding".

You can find a good CSS reference here: http://reference.sitepoint.com/css, and a good reference on HTML colour names here: http://www.cryer.co.uk/resources/javascript/html2.htm.

Code:

{| style="border:2px solid brown; width:500px; padding:5px; margin:auto; background:lightcyan"
|+ Table caption here
|- bgcolor=grey
! Table !! Headers !! Go !! style="width:200px" | Here
|-
|text || align=right | right || m || 12.1
|- style="background:lightyellow;height:5em;vertical-align:middle"
|yellow! || align=center | center || m || 11.3
|-
|text || align=left | left || f || 12.2
|-
!Row header #1
| 13 || f || 12.1
|-
! style="border:1px solid darkgrey" | Row header #2
| 4 || style="background:orange; border:3px solid red" | f || 11.3
|-
!Row header #3
| colspan=3 | ''This cell spans no less than three columns''
|}

Result:

Table caption here
Table Headers Go Here
text right m 12.1
yellow! center m 11.3
text left f 12.2
Row header #1 13 f 12.1
Row header #2 4 f 11.3
Row header #3 This cell spans no less than three columns

More on Table Templates.


Categories

  • Source: [[Category:News]]
  • Gives: Adds the article to the Cateogry:News.
  • Note: New categories are created automatically.
  • Source: [[:Category:News]]
  • Gives: Link to Category:News.
  • Source: [[:Category:News|All news in openSUSE]]
  • Gives: All news in openSUSE link to category with different name.
  • Categories can be member of other categories. This way you create hierachy of categories.
  • Each category consists of 2 parts. First is article similar to other in the wiki and second is automatically created list of members (articles and categories).
  • Special:Categories is list of all categories; red links are for those without first part.

Special characters

TBD


Templates

To insert a block of text from Template type:

{{Template_Name}}

The template can be found under Template:Template_Name. For example: http://en.opensuse.org/Template:Template_Name

More on Help Template.