Help:Editing

From Audacity Manual
Jump to: navigation, search

This page is an edited version of one copied from Wikipedia and is available under the terms of the GNU Free Documentation License. Further editing help is on their site here.

Also see our Consistency guidelines so that wording and layout is consistent across pages and/or particular families of pages.

Description You type You get
Applies anywhere
Italicise text

''italic''

italic

Bold text

'''bold'''

bold

Bold and italic

'''''bold & italic'''''

bold & italic

Internal link (to Audacity Manual):
to page displayed as name of the page
[[name of page]]
name of page
to page displayed as custom display text
[[name of page|display text]]
display text
to heading on page displayed as custom display text
[[name of page#heading|display text]]
display text
Redirect to another page - strongly discouraged except as temporary measure

#REDIRECT [[Target page]]

Target page

External link

(to other web sites)

[http://www.example.org]
[http://www.example.org display text]
http://www.example.org

[1]
display text
http://www.example.org

Applies only at the beginning of the line
Headings

A Table of Contents (TOC) is automatically generated when four headings are added to an article. To force a TOC to appear, type __TOC__. On all Reference pages, we use __NOTOC__ to ensure there is no TOC.

== Level 1 ==

=== Level 2 ===

==== Level 3 ====

===== Level 4 =====

====== Level 5 ======

Contents

Level 1

Level 2

Level 3

Level 4
Level 5
Bullet list

* 1st point
* 2nd point
** sub point about 2nd point
* 3rd point

  • 1st point
  • 2nd point
    • sub point about 2nd point
  • 3rd point
Numbered list

# 1st step
# 2nd step
## substep of 2nd step
# 3rd step

  1. 1st step
  2. 2nd step
    1. substep of 2nd step
  3. 3rd step
Bullet list inside numbered list

NB: Adding to an existing numbered point after the embedded bullet points will not indent properly. Use HTML <ul> inside <ol> instead.

# 1st step
# 2nd step
#* If (a) applies do this
#* If (b) applies do this
# 3rd step

  1. 1st step
  2. 2nd step
    • If (a) applies do this
    • If (b) applies do this
  3. 3rd step
 
Thumbnail image

[[Image:StereoMini-RCA.jpg|thumb|Caption text]]

Caption text

Tables

Column heading 1 Column heading 2 Column heading 3
Row heading 1 Cell 2 Cell 3
Row heading A Cell B Cell C

Special wikicode can be used as a shortcut to create a table. The pipe (vertical bar) codes function exactly the same as HTML table markup, so a knowledge of HTML table code will help in understanding pipe code. The shortcuts are as follows:

  • The entire table is encased with curly brackets and a vertical bar character (a pipe). So use {| to begin a table, and |} to end it. Each one needs to be on its own line:
{| class="wikitable"
  table code goes here
|}
  • An optional table caption is included with a line starting with a vertical bar and plus sign "|+" and the caption after it:
{| class="wikitable"
|+ caption
  table code goes here
|}
  • To start a new table row, type a vertical bar and a hyphen on its own line: "|-". The codes for the cells in that row will start on the next line.
{| class="wikitable"
|+ The table's caption
|-
  cell code goes here
|-
  cell code goes here
|}
  • Type the codes for each table cell in the next row, starting with a bar:
{| class="wikitable"
|+ The table's caption
|-
| cell codes go here
|-
| cells in the next row go here
| more cells in the same row here
|}
  • Cells can be separated with either a new line and new bar, or by a double bar "||" on the same line. Both produce the same output:
{| class="wikitable"
|+ The table's caption
|-
|Cell 1 || Cell 2 || Cell 3
|-
|Cell A 
|Cell B
|Cell C
|}
  • a row of column headings is identified by using "!" instead of "|", and using "!!" instead of "||". Header cells typically render differently than regular cells, depending on the browser. They are often rendered in a bold font and centered.
{| class="wikitable"
|+ The table's caption
! Column heading 1 !! Column heading 2 !! Column heading 3
|-
|Cell 1 || Cell 2 || Cell 3
|-
|Cell A
|Cell B
|Cell C
|}

Templates

To insert a template into the text, type:

{{nameOfTemplate|Text to be displayed}}

For example, when you type:

Click on {{menu|File > Open}}

Click on File > Open
is displayed.

If the text to be displayed include the equals sign, the text must either be preceded by "1=" or wrapped in <nowiki> </nowiki> tags.

For example, type:

{{note|1=The following example explains why 1 + 1 = 2}}

to display

The following example explains why 1 + 1 = 2

For this reason it is easier and more readable to use a template inside a template, rather than a <span class=...> </span> structure.

For example, it is easier to type:

{{note|Use {{menu|File > Save Project As}} to make a copy of your project}}

than to type:

{{note|1=Use <span class="menu">File > Save Project As</span> to make a copy of your project}}

both produce:

Use File > Save Project As to make a copy of your project
Personal tools