Help:Editing

From OpenCms Wiki
Revision as of 14:24, 31 October 2006 by 134.100.101.1 (Talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Template:Wiki Manual


Copied From Wikipedia


Contents

Gentoo Wiki specific introduction

The Gentoo Linux Wiki is a WikiWiki, meaning that anyone can easily edit any article and have those changes posted immediately.

The wiki markup

In the left column of the table below, you can see what effects are possible. In the right column, you can see how those effects were achieved. In other words, to make text look like it looks in the left column, type it in the format you see in the right column.

You may want to keep this page open in a separate browser window for reference. If you want to try out things without danger of doing any harm, you can do so in the Sandbox.

Sections, paragraphs, lists and lines

What it looks like What you type

Start your sections as follows:



New section

Subsection

Sub-subsection


== New section ==

=== Subsection ===

==== Sub-subsection ====

A single newline has no effect on the layout. These can be used to separate sentences within a paragraph. Some editors find that this aids editing and improves the diff function.

But an empty line starts a new paragraph.

A single newline
has no effect on the layout. 
These can be used to separate
sentences within a paragraph.
Some editors find that this aids editing
and improves the ''diff'' function.

But an empty line
starts a new paragraph.
You can break lines
without starting a new paragraph.
You can break lines<br />
without starting a new paragraph.
  • Lists are easy to do:
    • start every line with a star
      • more stars means deeper levels
* Lists are easy to do:
** start every line with a star
*** more stars means deeper levels

  1. Numbered lists are also good
    1. very organized
    2. easy to follow
# Numbered lists are also good
## very organized
## easy to follow
  • You can even do mixed lists
    1. and nest them
      • like this
* You can even do mixed lists
*# and nest them
*#* like this
Definition list 
list of definitions
item 
the item's definition
; Definition list : list of definitions
; item : the item's definition
  • One item per line, no hard NEWLINE.
A colon indents a line or paragraph.

A manual newline starts a new paragraph.

  • This is primarily for displayed material, but is also used for discussion on Talk pages.
: A colon indents a line or paragraph.
A manual newline starts a new paragraph.





IF a line starts with a space THEN
  it will be formatted exactly 
    as typed;
  in a fixed-width font;
  lines won't wrap;
ENDIF
this is useful for:
  * pasting preformatted text;
  * algorithm descriptions;
  * program source code;
  * ASCII art and chemical structures;

WARNING If you make it wide, you force the whole page to be wide and hence less readable, especially for people who use lower resolutions. Never start ordinary lines with spaces.

 IF a line starts with a space THEN
   it will be formatted exactly 
     as typed;
   in a fixed-width font;
   lines won't wrap;
 ENDIF
 this is useful for:
   * pasting preformatted text;
   * algorithm descriptions;
   * program source code;
   * ASCII art and chemical structures;
Centered text.
<center>Centered text.</center>
A horizontal dividing line: this is above it

and this is below it.

Mainly useful for separating threads on Talk pages.

A horizontal dividing line: this is above it
----
and this is below it. 

Links, URLs, images

.
What it looks like What you type
London has public transport.
  • First letter of target is automatically capitalized.
  • Internally spaces are automatically represented as underscores (typing an underscore has the same effect as typing a space, but is not recommended).

Thus the link above is to http://gentoo-wiki.com/Public_transport, which is the article with the name "Public transport". See also Wikipedia:Canonization.

London has [[public transport]].

Wikipedia:World Heritage Sites#New Zealand
is an example link to a section name on a page, see == headers == above.

Links to non-existent sections aren't broken, they are treated as links to the top of the page.
[[Wikipedia:World Heritage Sites#New Zealand]]
Same target, different name:

answers.
(This is a piped link.)

Same target, different name: 
[[wiki FAQ|answers]]
Endings are blended into the link: sandboxs
Endings are blended 
into the link: [[sandbox]]s
When adding a comment to a Talk page,

you should sign it. You can do this by adding three tildes for your user name:

Thrasher

or four for user name plus date/time:

Thrasher 08:10 Oct 5, 2002 (UTC)
When adding a comment to a Talk page,
you should sign it. You can do this by
adding three tildes for your user name:
: ~~~
or four for user name plus date/time:
: ~~~~
How to hack gentoo is a page that doesn't

exist yet.

  • You can create it by clicking on the link.


  • To create a new page:
    1. Create a link to it on some other page.
    2. Save that page.
    3. Click on the link you just made. The new page will open for editing.
  • After creating a page, search for its title and make sure that everyone correctly links to it.
[[How to hack gentoo]] is a page 
that doesn't exist yet.
Help:Editing is this page. Self links appear as bold text when the article is viewed.
[[Help:Editing]] is this page.
net-im/gaim is a link to portage on Gentoo-Portage.com
[[Gentoo-Portage:net-im/gaim|net-im/gaim]]

or

[[Ebuild:net-im/gaim|net-im/gaim]]

Redirect one article title to another by putting text like this in its first line. Note that redirects to sections do not work yet. #REDIRECT [[example#example]] will redirect to the example page, but not to any particular section on it. It is possible this feature will be implemented in future, so such redirects could be used now for future compatibility.

#REDIRECT [[example]]

To link to books, you can use Wikipedia:ISBN links.

ISBN 0123456789X

ISBN 0123456789X

"What links here" and "Related changes" can be linked as:

Special:Whatlinkshere/Wikipedia:How to edit a page and Special:Recentchangeslinked/Wikipedia:How to edit a page

[[Special:Whatlinkshere/Wikipedia:How to edit a page]] and [[Special:Recentchangeslinked/Wikipedia:How to edit a page]]

Character formatting

What it looks like What you type

Emphasize, strongly, very strongly.

  • These are double and triple apostrophes (single-quote marks), not double-quote marks.
  • Note that on almost all browsers, these appear as italic and bold; for semantic reasons, <i> and <b> are preferable in mathematical formulas.
''Emphasize'', '''strongly''', 
'''''very strongly'''''.
A typewriter font for technical terms.
  • For semantic reasons, <code> should be used instead when writing computer programs
A typewriter font for <tt>technical terms</tt>.
You can use small text for captions.
You can use <small>small text</small> for captions.
You can strike out deleted material

and underline new material.

You can <strike>strike out deleted material</strike>
and <u>underline new material</u>.

Umlauts and accents:
(See wikipedia:Special characters)
� � � � � �

À Á Â Ã Ä Å
Æ Ç È É Ê Ë
Ì Í Î Ï Ñ Ò
Ó Ô Õ Ö Ø Ù
Ú Û Ü ß à á
â ã ä å æ ç
è é ê ë ì í
î ï ñ ò ó ô
œ õ ö ø ù ú
û ü ÿ



� � � � � �
&Agrave; &Aacute; &Acirc; &Atilde; &Auml; &Aring; 
&AElig; &Ccedil; &Egrave; &Eacute; &Ecirc; &Euml; 
&Igrave; &Iacute; &Icirc; &Iuml; &Ntilde; &Ograve; 
&Oacute; &Ocirc; &Otilde; &Ouml; &Oslash; &Ugrave; 
&Uacute; &Ucirc; &Uuml; &szlig; &agrave; &aacute; 
&acirc; &atilde; &auml; &aring; &aelig; &ccedil; 
&egrave; &eacute; &ecirc; &euml; &igrave; &iacute;
&icirc; &iuml; &ntilde; &ograve; &oacute; &ocirc; 
&oelig; &otilde; &ouml; &oslash; &ugrave; &uacute; 
&ucirc; &uuml; &yuml;

Punctuation:
¿ ¡ § ¶
† ‡ • —
‹ › « »
‘ ’ “ ”


&iquest; &iexcl; &sect; &para;
&dagger; &Dagger; &bull; &mdash;
&lsaquo; &rsaquo; &laquo; &raquo;
&lsquo; &rsquo; &ldquo; &rdquo;

Commercial symbols:
™ © ® ¢ € ¥

£ ¤

&trade; &copy; &reg; &cent; &euro; &yen; 
&pound; &curren;
Subscript: x2

Superscript: x2 or x²

  • The latter method of superscript can't be used in the most general context, but is preferred when possible (as with units of measurement) because most browsers have an easier time formatting lines with it.

ε0 = 8.85 × 10−12 C² / J m.

1 hectare = 1 E4 m�

Subscript: x<sub>2</sub>
Superscript: x<sup>2</sup> or x&sup2;







&epsilon;<sub>0</sub> =
8.85 &times; 10<sup>&minus;12</sup>
C&sup2; / J m.


1 hectare = 1 E4 m�

Greek characters:

α β γ δ ε ζ
η θ ι κ λ μ ν
ξ ο π ρ σ ς
τ υ φ χ ψ ω
Γ Δ Θ Λ Ξ Π
Σ Φ Ψ Ω


&alpha; &beta; &gamma; &delta; &epsilon; &zeta; 
&eta; &theta; &iota; &kappa; &lambda; &mu; &nu; 


&xi; &omicron; &pi; &rho;  &sigma; &sigmaf;
&tau; &upsilon; &phi; &chi; &psi; &omega;
&Gamma; &Delta; &Theta; &Lambda; &Xi; &Pi; 
&Sigma; &Phi; &Psi; &Omega;

Math characters:
∫ ∑ ∏ √ − ± ∞
≈ ∝ ≡ ≠ ≤ ≥ →
× · ÷ ∂ ′ ″
∇ ‰ ° ∴ ℵ ø
∈ ∉ ∩ ∪ ⊂ ⊃ ⊆ ⊇
¬ ∧ ∨ ∃ ∀ ⇒ ⇔
→ ↔
(See also WikiProject Mathematics)

&int; &sum; &prod; &radic; &minus; &plusmn; &infin;
&asymp; &prop; &equiv; &ne; &le; &ge; &rarr;
&times; &middot; &divide; &part; &prime; &Prime;
&nabla; &permil; &deg; &there4; &alefsym; &oslash;
&isin; &notin; &cap; &cup; &sub; &sup; &sube; &supe;
&not; &and; &or; &exist; &forall; &rArr; &hArr;
&rarr; &harr;
x2   ≥   0 true.
  • To space things out, use non-breaking spaces - &nbsp;.
  • &nbsp; also prevents line breaks in the middle of text, this is useful in formulas.
<i>x</i><sup>2</sup>&nbsp;&nbsp;&ge;&nbsp;&nbsp;0 true.

Complicated formulae:
  <math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>

  
<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>

Suppressing interpretation of markup:
Link → (<i>to</i>) the [[Gentoo-Portage Wiki FAQ]]

  • Used to show literal data that would otherwise have special meaning.
  • Escapes all Wikipedia:wiki markup, including that which looks like HTML tags.
  • Does not escape HTML character references.
  • To escape HTML character references such as &rarr; use &amp;rarr;
<nowiki>Link &rarr; (<i>to</i>) 
the [[Wikipedia FAQ]]</nowiki>

Commenting page source:
not shown in page

  • Used to leave comments in a page for future editors.
<!-- comment here -->

Common Formatting

To keep a consistant look throughout the wiki we have setup some templates to help keep things familiar; use these wherever appropriate.

Template Listing

Tables

Placement of the Table of Contents (TOC)

At the current status of the wiki markup language, at least four headers trigger the TOC in front of the first header (or after introductory sections). Putting __NOTOC__ anywhere forces the TOC to disappear.

Tables

There are two ways to build tables:

  • in special Wiki-markup (see Using tables)
  • with the usual HTML elements: <table>, <tr>, <td> or <th>.

Variables

CodeEffect
{{CURRENTMONTH}}11
{{CURRENTMONTHNAME}}November
{{CURRENTMONTHNAMEGEN}}November
{{CURRENTDAY}}23
{{CURRENTDAYNAME}}Saturday
{{CURRENTYEAR}}2024
{{CURRENTTIME}}00:25
{{NUMBEROFARTICLES}}245

NUMBEROFARTICLES is the number of pages in the main namespace which contain a link and are not a redirect, i.e. number of articles, stubs containing a link, and disambiguation pages).

Transclusion

The MediaWiki software used by Wikipedia has limited support for transclusion. This means standardized text chunks (such as boilerplate text) can be inserted into articles. For example, typing {{msg:stub}} will appear as This article is a stub. You can help Wikipedia by expanding it. when the page is saved. Other commonly used ones are {{msg:disambig}} for disambiguation pages and {{msg:spoiler}} for spoiler warnings.

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox