Difference between revisions of "Help:Editing"

From CDOT Wiki
Jump to: navigation, search
(copied the editing help from mdc)
(Text Formatting)
 
Line 29: Line 29:
 
|
 
|
 
<pre>
 
<pre>
= Section =
 
 
== Sub-section ==
 
 
=== Sub-sub-section ===
 
 
==== Sub-sub-sub=section ====
 
</pre>
 
|-
 
|-
 
|class="header" width="50%" colspan="2"|Paragraphs and Newlines
 
|-
 
 
|-
 
|
 
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.
 
|
 
<pre>
 
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.
 
</pre>
 
|-
 
|}
 
 
 
== Text Formatting ==
 
== Text Formatting ==
 
{| class="fullwidth-table"
 
{| class="fullwidth-table"
Line 203: Line 160:
 
|-
 
|-
 
|}
 
|}
 
== Lists ==
 
{| class="fullwidth-table"
 
|-
 
|class="header" width="50%"|Result
 
|class="header" width="50%"|Markup
 
|-
 
 
|-
 
|class="header" colspan="2"|Bulleted Lists
 
|-
 
 
|-
 
|
 
* Manuals
 
** Reference
 
** Guide
 
* Articles
 
** Tutorials
 
*** JavaScript
 
*** HTML
 
*** CSS
 
** Tips & Tricks
 
* FAQs
 
 
List bullets, indenting, and so forth can be changed via CSS.
 
|
 
<pre>
 
* Manuals
 
** Reference
 
** Guide
 
* Articles
 
** Tutorials
 
*** JavaScript
 
*** HTML
 
*** CSS
 
** Tips & Tricks
 
* FAQs
 
</pre>
 
|-
 
 
|-
 
|class="header" colspan="2"|Numbered Lists
 
|-
 
 
|-
 
|
 
# Manuals
 
## Reference
 
## Guide
 
# Articles
 
## Tutorials
 
### JavaScript
 
### HTML
 
### CSS
 
## Tips & Tricks
 
# FAQs
 
 
List numbers and styling can be changed via CSS.
 
|
 
<pre>
 
# Manuals
 
## Reference
 
## Guide
 
# Articles
 
## Tutorials
 
### JavaScript
 
### HTML
 
### CSS
 
## Tips & Tricks
 
# FAQs
 
</pre>
 
|-
 
|}
 
 
== Links ==
 
{| class="fullwidth-table"
 
|-
 
|class="header" width="50%"|Result
 
|class="header" width="50%"|Markup
 
|-
 
 
|-
 
|class="header" colspan="2"|Internal Links
 
|-
 
 
|-
 
|
 
'''Simple internal link to another page...'''
 
 
April 1st is [[April Fool's Day]].
 
 
|
 
<pre>
 
April 1st is [[April Fool's Day]].
 
</pre>
 
|-
 
 
|-
 
|
 
'''Internal link where the target page title is different than the link text...'''
 
 
[[April Fool's Day|April 1st]] happens to be Dria's birthday.
 
 
|
 
<pre>
 
[[April Fool's Day|April 1st]] happens to be Dria's birthday.
 
</pre>
 
|-
 
 
|-
 
|
 
'''Internal link to a specific section of another page...'''
 
 
[[April Fool's Day#Birthdays|Some April Fool Birthdays]].
 
 
|
 
<pre>
 
[[April Fool's Day#Birthdays|Some April Fool Birthdays]].
 
</pre>
 
|-
 
 
|-
 
|
 
'''Endings are blended into the link...'''
 
 
In April, the [[crocus]]es begin to bloom.
 
 
|
 
<pre>
 
In April, the [[crocus]]es begin to bloom.
 
</pre>
 
|-
 
 
|-
 
|
 
'''Adding a signature that links to your User page...'''
 
 
[[User:Dria|Dria]]
 
 
or
 
 
[[User:Dria|Dria]] 13:39, 15 Mar 2005 (EST)
 
 
|
 
<pre>
 
~~~
 
 
or
 
 
~~~~
 
</pre>
 
|-
 
 
|-
 
|class="header" colspan="2"|External Links
 
|-
 
 
|-
 
|
 
'''Straight URL linking...'''
 
 
http://www.mozilla.org
 
|
 
<pre>
 
http://www.mozilla.org
 
</pre>
 
|-
 
 
|-
 
|
 
'''External Link with different link text...'''
 
 
[http://www.mozilla.org Mozilla Project]
 
|
 
<pre>
 
[http://www.mozilla.org Mozilla Project]
 
</pre>
 
|-
 
 
|-
 
|
 
'''Link to bug in Mozilla's Bugzilla...'''
 
 
{{bug|322603}}
 
|
 
<pre>
 
{{bug|322603}}
 
</pre>
 
|-
 
 
|-
 
|class="header" colspan="2"|Interwiki Links
 
|-
 
 
|-
 
|
 
TBD
 
|
 
TBD
 
|-
 
 
|}
 
 
== Comments ==
 
<table class="fullwidth-table">
 
<td class="header" width="50%">Result</td>
 
<td class="header" width="50%">Markup</td>
 
</tr>
 
<tr>
 
<td>
 
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. --->
 
</td>
 
<td>
 
<pre>
 
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. --->
 
</pre>
 
</td>
 
</tr>
 
</table>
 
  
 
= Advanced markup =
 
= Advanced markup =

Latest revision as of 23:56, 16 September 2006

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.

== Text Formatting ==
{| class="fullwidth-table"
|-
|class="header" width="50%"|Result
|class="header" width="50%"|Markup
|-

|-
|class="header" width="50%" colspan="2"|Text Formatting
|-

|-
|
''italic'' or ''emphasis''
|
<pre>
''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.

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 about 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"
|-
|class="header"|heading 1
|class="header"|heading 2
|-
|-
|cell 1
|cell 2
|-
|}

Images

Result Markup
Images

Inline image...

File: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...

File:Flower.jpg
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, you simply need to 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 language's pages also works with 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

Devmo-specific

External