Help:Formatting

From SME Server
Revision as of 10:07, 26 June 2007 by Snoble (talk | contribs) (include {{:Category:Template}})
Jump to navigationJump to search

You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki, sometimes depending on their position. For example, to format a word in italic, you include it in two single quotes like ''this''

Text formatting markup

Description You type You get
applies anywhere
Italic text ''italic'' italic
Bold text '''bold''' bold
Bold and italic '''''bold & italic''''' bold & italic
Escape wiki markup <nowiki>no ''markup''</nowiki> no ''markup''
only at the beginning of the line
Headings of

different sizes

==level 1==
===level 2===
====level 3====
=====level 4=====

Level 1

Level 2

Level 3

Level 4
Horizontal rule

----


Bullet list

* one
* two
* three
** three and one-third
** three and two-thirds

  • one
  • two
  • three
    • three and one-third
    • three and two-thirds
Numbered list

# one
# two
# three
## three point one
## three point two

  1. one
  2. two
  3. three
    1. three point one
    2. three point two
Mixture of bulleted
and numbered lists

# one
# two
#* two point one
#* two point two

  1. one
  2. two
    • two point one
    • two point two
Definition list

;Definition
:item 1
:item 2

Definition
item 1
item 2
Preformatted text

  preformatted text is done with
  a space at the
  beginning of the line

preformatted text is done with
a space at the 
beginning of the line


Paragraphs

Mediawiki ignores normal line breaks. To start a new paragraph, leave an empty line. You can also start a newline with the HTML tag <br />.


How to make a new Template

For certain purposes like if you want to maintain some works on redundant pages without efforts, you may need to write a Template of your page.

A template is just like a page, so a "make-it-easy" template would reside at the URL: http://wiki.contribs.org/Template:Make-it-easy

Create it and copy and paste the wiki markup for what you have already done relating to "Make-it-easy" into it and save it. Then where you want to include the template on any other page just use {{Make-it-easy}}.

Templates

Templates are great at keeping things looking consistent. If you are new, you may not be ready to create them, but don't worry, they are very easy to use. Just add the contents in the "what to type" column and you will get the text in the "What it looks like" column inserted on the page.

Click on the template name for usage options that may not be apparent, translators should see Languages

What to insert What it looks like Where to insert
{{Note box|string}}
Important.png Note:
This is a sample 'Important' note

Anywhere
{{Tip box|string}}
Information.png Tip:
This is a sample tip

Anywhere
{{Warning box|string}}
Warning.png Warning:
This is a sample warning message

Anywhere
{{Level|level|comment}}
PythonIcon.png Skill level: {{{1}}}
The instructions on this page can be followed by a beginner.

[[Category: {{{1}}}]]

Under title
{{Incomplete}}
Incomplete.png Incomplete:
This article or section needs to be expanded. Please help to fill the gaps or discuss the issue on the talk page

Anywhere
{{Cleanup}}
Clean.png Cleanup:
This article or section may require cleanup. Discuss the issue on the talk page

Anywhere
{{Request_for_deletion}}
Delete.png Request for Deletion:
This article or section should be removed. Please help to correct all links to it or discuss the issue on the talk page

Top of Article
{{Ready_for_deletion}}
Stop.png Ready for Deletion:
All links to it have been either transferred or moved.

Top of Article
{{Outdated}}
Time.png Outdated:
The information on this page maybe no longer relevant.

Top of Article
{{Needs review}}
Edit-find-replace.png Not reviewed:
This howto or contrib has not been reviewed and might contain code that could harm your installation. For more information on the review process have a look at the Development Review page.

Top of Article
{{WIP box}} or

{{WIP box|Username}}

Warning.png Work in Progress:
This page is a Work in Progress. The contents off this page may be in flux, please have a look at this page history the to see list of changes.

or
Warning.png Work in Progress:
Username has marked this page as a Work in Progress. The contents off this page may be in flux, please have a look at this page history the to see list of changes.

Top of Article
{{Languages|pagename of English version}}
Top of Article
{{Repository|Repositoryname}}

The following command will configure the snetram repository on SME Server. Snetram After adding it to the database we have to update the changes to the configuration file:

signal-event yum-modify
Anywhere
{{#smeversion:package|description}}
Devel:
Contrib:
package-name
The latest version of package is available in the SME repository, click on the version number(s) for more information.
{{Donate}}
Information.png Tip:
to call the Donate template then use it in the top of a page

Top of Article
{{Template:BugzillaFileBug}}
Information.png Tip:
When you want to call the BugzillaFileBug template then use it in the bottom of a page to raise a bug under bugzilla in the wiki documentation. By example {{BugzillaFileBug|product=SME%20Contribs|component=smeserver-openvpn-bridge|title=this link}}. You have to choose a valid contrib name

Bottom of Article

Credits: Some of these templates have been integrally taken from the MythTV wiki others are heavily based on them.

More advanced formatting

Beyond the basic text formatting markup shown above, there are some more advanced formatting tricks:

External Links