Wiki Markup Reference

出自耶穌台灣
於 2008年2月29日 (五) 11:09 由 Chienwen留言 | 貢獻 所做的修訂 (新頁面: [http://developer.mozilla.org/en/docs/index.php?title=MDC:Wiki_Markup_Reference&oldid=58124 Source] __NOEDITSECTION__ The following is an MDC-specific wiki markup reference sheet that re...)
(差異) ←上個修訂 | 最新修訂 (差異) | 下個修訂→ (差異)

Source


The following is an MDC-specific wiki markup reference sheet that reflects our current "best practices" for marking up pages in this wiki. It is subject to change, so these are recommendations rather than hard-and-fast rules.

If you need to do some markup that goes against these guidelines, feel free. Just try to stick to these guidelines as much as possible.

If you have any questions about the guidelines, contact Eric Shepherd, or ask on the #devmo IRC channel at irc://irc.mozilla.org.

Basics

Sections, Paragraphs, Newlines

Result Markup
Sections


Section


Sub-section


Sub-sub-section

Sub-sub-sub-section

If your document needs more than four section levels, it is recommended that you break it up into smaller pages and link those together.

= Section =

== Sub-section ==

=== Sub-sub-section ===

==== Sub-sub-sub-section ====
Paragraphs and Newlines

A single carriage-return between lines does nothing.

Leaving a blank line

indicates a new paragraph.

You can
use "br" tags
to force
a newline.

A single carriage-return between
lines does nothing.

Leaving a blank line

indicates a new paragraph.

You can<br />
use "br" tags<br />
to force<br />
a newline.


Text Formatting

Result Markup
Text Formatting

italic or emphasis

''italic'' or ''emphasis''

bold or strong

'''bold''' or '''strong'''

bold italic or very strong

'''''bold italic''''' or '''''very strong'''''

Here is some in-line code as an example.

Here is some <code>in-line code</code> as an example.
This is how
    to do code
    blocks.
<pre>
This is how
    to do code
    blocks.
</pre>

Blockquotes - this is a blockquote.

<blockquote>
Blockquotes - this is a blockquote.
</blockquote>

Small text.

<small>Small text.</small>

Big text.

<big>Big text.</big>

Strikeout.

<strike>Strikeout.</strike>

Underlined.

<u>Underlined.</u>

SuperScript.

<sup>Super</sup>Script.

SubScript.

<sub>Sub</sub>Script.


Links

Result Markup
Internal Links

Simple internal link to another page...

April 1st is April Fool's Day.

April 1st is [[April Fool's Day]].

Simple internal link to a named anchor in the same page...

April 1st is April Fool's Day.

April 1st is [[#April Fool's Day]].

Internal link where the target page title is different than the link text...

April 1st happens to be Dria's birthday.

[[April Fool's Day|April 1st]] happens to be Dria's birthday.

Internal link to a specific section of another page...

Some April Fool Birthdays.

[[April Fool's Day#Birthdays|Some April Fool Birthdays]].

Endings are blended into the link...

In April, the crocuses begin to bloom.

In April, the [[crocus]]es begin to bloom.

Adding a signature that links to your User page...

Dria

or

Dria 13:39, 15 Mar 2005 (EST)

~~~

or

~~~~
External Links

Straight URL linking...

http://www.mozilla.org

http://www.mozilla.org

External Link with different link text...

Mozilla Project

[http://www.mozilla.org Mozilla Project]

Link to bug in Mozilla's Bugzilla...

模板:Bug

{{bug|322603}}
Interwiki Links

Link to Mozilla wiki's "Firefox" page...

Firefox

[[wikimo:Firefox|Firefox]]

Link to Wikipedia.org's "Mozilla" article...

Mozilla

[[wikipedia:Mozilla|Mozilla]]


Comments

Result Markup

The comment here is not shown in the result. It is exactly the same as an HTML comment.

Use comments to leave notes and instructions for other writers, editors, and reviewers.

The comment here is not shown
in the result.  It is exactly the
same as an HTML comment.

Use comments to leave notes and
instructions for other writers,
editors, and reviewers.

<!--- Here's the comment. --->


Lists

Result Markup
Bulleted Lists
  • Manuals
    • Reference
    • Guide
  • Articles
    • Tutorials
      • JavaScript
      • HTML
      • CSS
    • Tips & Tricks
  • FAQs

List bullets, indenting, and so forth can be changed via CSS.

* Manuals
** Reference
** Guide
* Articles
** Tutorials
*** JavaScript
*** HTML
*** CSS
** Tips & Tricks
* FAQs
Numbered Lists
  1. Manuals
    1. Reference
    2. Guide
  2. Articles
    1. Tutorials
      1. JavaScript
      2. HTML
      3. CSS
    2. Tips & Tricks
  3. FAQs

List numbers and styling can be changed via CSS.

# Manuals
## Reference
## Guide
# Articles
## Tutorials
### JavaScript
### HTML
### CSS
## Tips & Tricks
# FAQs


Advanced markup

Tables

Result Markup
Table Markup

You can use regular HTML table markup to do wiki tables, or you can use the wiki markup. The wiki table markup uses fewer characters, but that's the only real advantage. Use what you're most comfortable with.

heading 1 heading 2
cell 1 cell 2
<table class="standard-table">
  <tr>
    <th>heading 1</th>
    <th>heading 2</th>
  </tr>
  <tr>
    <td>cell 1</td>
    <td>cell 2</td>
  </tr>
</table>
heading 1 heading 2
cell 1 cell 2
{| class="standard-table"
|-
!heading 1
!heading 2
|-
|cell 1
|cell 2
|}

OR

{| class="standard-table"
|-
!heading 1 !! heading 2
|-
|cell 1 || cell 2
|}

Images

Result Markup
Images

Inline image...

Firefox-logo.png

[[Image:Firefox-logo.png]]

Inline image with alt text...

Firefox - Take back the web.

[[Image:Firefox-logo.png|Firefox - Take back the web.]]

Thumbnail image with alt text...

Flower macro shot.
[[Image:Flower.jpg|thumb|Flower macro shot.]]

Link to a picture...

Flower macro shot.

[[media:Flower.jpg|Flower macro shot.]]

Categories

Every page in the wiki should be included in at least one MediaWiki Category. To add a category to a page, use the following syntax:

These category links should be put at the bottom of the page after the content. Add as many Category links as appropriate. For example, a tutorial about how to use Venkman could be in the "Venkman", "Tools", and "Tutorials" categories.

All categories, in turn, should be put in Category:All Categories.


Reference to versions in other languages

It is always nice when there are references to the page's versions written in other languages. For example, to insert in this page a reference to this page's version in Portuguese, simply add the following syntax at the end of this page:

[[pt:Referência de Marcação Wiki]]

In other words, you simply need to add the internal link to the desired site with the prefix which refers to the page's language.

The reference to other languages pages also apply to category pages.


Force Ignore of Wiki Markup

If you need a particular piece of wiki markup ignored by the parser, simply enclose it in "nowiki" tags, like so:

<nowiki>'''this wiki markup will not be interpreted'''</nowiki>

'''this wiki markup will not be interpreted'''


HTML in Wikitext

The following tags are currently allowed in wiki markup:


Special Characters

Result Markup

Umlauts and accents:

è é ê ë ì í

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


è é ê ë ì í

&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; &laquo; &raquo; &sect; &para;
&dagger; &Dagger; &bull; - &ndash; &mdash;

Commercial symbols:
™ © ® ¢ € ¥

£ ¤
&trade; &copy; &reg; &cent; &euro; &yen;
&pound; &curren;
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:
∫ ∑ ∏ √ − ± ∞
≈ ∝ ≡ ≠ ≤ ≥
× · ÷ ∂ ′ ″
∇ ‰ ° ∴ ℵ ø
∈ ∉ ∩ ∪ ⊂ ⊃ ⊆ ⊇
¬ ∧ ∨ ∃ ∀ ⇒ ⇔
→ ↔ ↑

&int; &sum; &prod; &radic; &minus; &plusmn; &infin;
&asymp; &prop; &equiv; &ne; &le; &ge; 
&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; &uarr;
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.


Useful Firefox extensions

Other references

MDC-specific

External