Difference between revisions of "Help:Editing"

From Inside Electronics

 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[http://www.mediawiki.org/wiki/Help:Formatting Formatting help]] from MediaWiki
+
The following information is copied from the MediaWiki [http://www.mediawiki.org/wiki/Help:Formatting Formatting help] page and may be out of date.
  +
  +
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 <code><nowiki>''this''</nowiki></code>
  +
  +
== Text formatting markup ==
  +
  +
{| class="wikitable"
  +
! Description !! You type !! You get
  +
|-
  +
! colspan="3" style="background:#ABE" | character (inline) formatting – ''applies anywhere''
  +
|-
  +
|Italic text
  +
| <code><nowiki>''italic''</nowiki></code>
  +
|''italic''
  +
|-
  +
| Bold text
  +
| <code><nowiki>'''bold'''</nowiki></code>
  +
|'''bold'''
  +
|-
  +
| Bold and italic
  +
| <code><nowiki>'''''bold & italic'''''</nowiki></code>
  +
|'''''bold & italic'''''
  +
|-
  +
|Escape wiki markup
  +
| <code><nowiki><nowiki>no ''markup''&lt;/nowiki></nowiki></code>
  +
|<nowiki>no ''markup''</nowiki>
  +
|-
  +
! colspan="3" style="background:#ABE" | section formatting – ''only at the beginning of the line''
  +
|-
  +
|Headings of different levels
  +
| <pre>=level 1=
  +
==level 2==
  +
===level 3===
  +
====level 4====
  +
=====level 5=====
  +
======level 6======</pre>
  +
An article with 4 or more headings automatically creates a [[wikipedia:Wikipedia:Section#Table of contents (TOC)|table of contents]].
  +
  +
|<!-- hack to prevent TOC viewing for h1 - h6 elements: their style is hardcopied here -->
  +
<div style="font-size: 188%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa">Level 1</div>
  +
<div style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa">Level 2</div>
  +
<div style="font-size: 132%; font-weight: bold">Level 3</div><!--
  +
--><b>Level 4</b><!--
  +
--><div style="font-size: 86%; font-weight: bold">Level 5</div><!--
  +
--><b style="font-size: 80%">Level 6</b>
  +
|-
  +
|Horizontal rule
  +
| <code>----</code>
  +
|
  +
----
  +
|-
  +
|Bullet list
  +
|
  +
<pre>
  +
* one
  +
* two
  +
* three
  +
** three point one
  +
** three point two
  +
</pre>
  +
Inserting a blank line will end the first list and start another.
  +
|
  +
* one
  +
* two
  +
* three
  +
** three point one
  +
** three point two
  +
|-
  +
|Numbered list
  +
|
  +
<pre>
  +
# one
  +
# two<br />spanning more lines<br />doesn't break numbering
  +
# three
  +
## three point one
  +
## three point two
  +
</pre>
  +
|
  +
# one
  +
# two<br />spanning more lines<br />doesn't break numbering
  +
# three
  +
## three point one
  +
## three point two
  +
|-
  +
|Definition list
  +
|<pre>
  +
;item 1
  +
: definition 1
  +
;item 2
  +
: definition 2-1
  +
: definition 2-2
  +
</pre>
  +
|
  +
;item 1
  +
: definition 1
  +
;item 2
  +
: definition 2-1
  +
: definition 2-2
  +
|-
  +
| Adopting definition list to indent text
  +
|
  +
<pre>: Single indent
  +
:: Double indent
  +
::::: Multiple indent</pre>
  +
This workaround may be controversial from the viewpoint of accessibility.
  +
|
  +
: Single indent
  +
:: Double indent
  +
::::: Multiple indent
  +
|-
  +
| Mixture of different types of list
  +
|
  +
<pre>
  +
# one
  +
# two
  +
#* two point one
  +
#* two point two
  +
# three
  +
#; three item one
  +
#: three def one
  +
# four
  +
#: four def one
  +
#: this rather looks like the continuation of # four
  +
#: and thus often used instead of <br />
  +
# five
  +
## five sub 1
  +
### five sub 1 sub 1
  +
## five sub 2
  +
  +
;item 1
  +
:* definition 1-1
  +
:* definition 1-2
  +
:
  +
;item 2
  +
:# definition 2-1
  +
:# definition 2-2
  +
</pre>
  +
The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also be controversial.
  +
|
  +
# one
  +
# two
  +
#* two point one
  +
#* two point two
  +
# three
  +
#; three item one
  +
#: three def one
  +
# four
  +
#: four def one
  +
#: this rather looks like the continuation of <code># four</code>
  +
#: often used instead of <code>&lt;br /></code>
  +
# five
  +
## five sub 1
  +
### five sub 1 sub 1
  +
## five sub 2
  +
;item 1
  +
:* definition 1-1
  +
:* definition 1-2
  +
:
  +
;item 2
  +
:# definition 2-1
  +
:# definition 2-2
  +
|-
  +
|-
  +
|Preformatted text
  +
|
  +
<pre>
  +
preformatted text is done with
  +
a '''space''' at the
  +
''beginning'' of the line
  +
</pre>
  +
This way of preformatting only applies to section formatting, and character formatting markups are still effective.
  +
|
  +
preformatted text is done with
  +
a '''space''' at the
  +
''beginning'' of the line
  +
|}
  +
  +
== HTML ==
  +
Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code>&lt;code></code>, <code>&lt;div></code>, <code><nowiki><span></nowiki></code> and <code><nowiki><font></nowiki></code>. These apply anywhere you insert them.
  +
  +
{| class="wikitable"
  +
!Description
  +
!You type
  +
!You get
  +
|-
  +
| Strikethrough
  +
| <code>&lt;del>Strikethrough&lt;/del></code> or <code>&lt;s>Strikethrough&lt;/s></code>
  +
|<del>Strikethrough</del>
  +
|- style="white-space:nowrap"
  +
|Fixed width text
  +
| <code>&lt;tt>Fixed width text&lt;/tt></code> or <code>&lt;code>source code&lt;/code></code>
  +
| <tt>Fixed width text</tt>
  +
|-
  +
|Blockquotes
  +
| <code>
  +
text text text text text text text text text text text text
  +
text text text text text text text text text text text text
  +
&lt;blockquote> quote quote quote quote quote quote &lt;/blockquote>
  +
text text text text text text text text text text text text
  +
</code>
  +
| text text text text text text text text text text text text text text text text text text text text text text text text <blockquote> quote quote quote quote quote quote </blockquote> text text text text text text text text text text text text
  +
|-
  +
|Comment
  +
| <code>&lt;!-- This is a comment --></code>
  +
Text can only be viewed in the edit window.
  +
|
  +
<!-- This is a real invisible comment -->
  +
|-
  +
|Completely preformatted text
  +
|
  +
<code><nowiki><pre>this way, all markups are '''ignored'''</pre></nowiki></code>
  +
|
  +
<pre> this way, all markups are '''ignored'''</pre>
  +
|}

Latest revision as of 22:26, 19 September 2009

The following information is copied from the MediaWiki Formatting help page and may be out of date.

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
character (inline) formatting – 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''
section formatting – only at the beginning of the line
Headings of different levels
=level 1=
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======

An article with 4 or more headings automatically creates a table of contents.

Level 1
Level 2
Level 3
Level 4
Level 5
Level 6
Horizontal rule ----
Bullet list
* one
* two
* three
** three point one
** three point two

Inserting a blank line will end the first list and start another.

  • one
  • two
  • three
    • three point one
    • three point two
Numbered list
# one
# two<br />spanning more lines<br />doesn't break numbering
# three
## three point one
## three point two
  1. one
  2. two
    spanning more lines
    doesn't break numbering
  3. three
    1. three point one
    2. three point two
Definition list
;item 1
: definition 1
;item 2
: definition 2-1
: definition 2-2
item 1
definition 1
item 2
definition 2-1
definition 2-2
Adopting definition list to indent text
: Single indent
:: Double indent
::::: Multiple indent

This workaround may be controversial from the viewpoint of accessibility.

Single indent
Double indent
Multiple indent
Mixture of different types of list
# one
# two
#* two point one
#* two point two
# three
#; three item one
#: three def one
# four
#: four def one
#: this rather looks like the continuation of # four
#: and thus often used instead of <br />
# five
## five sub 1
### five sub 1 sub 1
## five sub 2

;item 1
:* definition 1-1
:* definition 1-2
:
;item 2
:# definition 2-1
:# definition 2-2

The usage of #: and *: for breaking a line within an item may also be controversial.

  1. one
  2. two
    • two point one
    • two point two
  3. three
    three item one
    three def one
  4. four
    four def one
    this rather looks like the continuation of # four
    often used instead of <br />
  5. five
    1. five sub 1
      1. five sub 1 sub 1
    2. five sub 2
item 1
  • definition 1-1
  • definition 1-2
item 2
  1. definition 2-1
  2. definition 2-2
Preformatted text
 preformatted text is done with
 a '''space''' at the 
 ''beginning'' of the line

This way of preformatting only applies to section formatting, and character formatting markups are still effective.

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

HTML

Some HTML tags are allowed in MediaWiki, for example <code>, <div>, <span> and <font>. These apply anywhere you insert them.

Description You type You get
Strikethrough <del>Strikethrough</del> or <s>Strikethrough</s> Strikethrough
Fixed width text <tt>Fixed width text</tt> or <code>source code</code> Fixed width text
Blockquotes

text text text text text text text text text text text text text text text text text text text text text text text text <blockquote> quote quote quote quote quote quote </blockquote> text text text text text text text text text text text text

text text text text text text text text text text text text text text text text text text text text text text text text

quote quote quote quote quote quote

text text text text text text text text text text text text
Comment <!-- This is a comment -->

Text can only be viewed in the edit window.

Completely preformatted text

<pre>this way, all markups are '''ignored'''</pre>

 this way, all markups are '''ignored'''