Help:Editing: Difference between revisions

From FreeCAD Documentation
m (catfix)
(→‎External links: Interwiki added)
Line 159: Line 159:
Start with 2 equals signs not 1 because 1 creates H1 tags which should be reserved for page title.
Start with 2 equals signs not 1 because 1 creates H1 tags which should be reserved for page title.
|<pre>
|<pre>
== Section headings ==

''Headings'' organize your writing into sections.
The Wiki software can automatically generate
a table of contents from them.

=== Subsection ===

Using more equals signs creates a subsection.

==== A smaller subsection ====

Don't skip levels,
like from two to four equals signs.

Start with 2 equals signs not 1
because 1 creates H1 tags
which should be reserved for page title.
</pre>
|-
|
* ''Unordered [[Help:List|list]]s'' are easy to do:
** Start every line with a star.
*** More stars indicate a deeper level.
*: Previous item continues.
** A new line
* in a list
marks the end of the list.
*Of course you can start again.
|<pre>
* ''Unordered lists'' are easy to do:
** Start every line with a star.
*** More stars indicate a deeper level.
*: Previous item continues.
** A new line
* in a list
marks the end of the list.
* Of course you can start again.
</pre>
|-
|
# ''Numbered lists'' are:
## Very organized
## Easy to follow
A new line marks the end of the list.
# New numbering starts with 1.

|<pre>
# ''Numbered lists'' are:
## Very organized
## Easy to follow
A new line marks the end of the list.
# New numbering starts with 1.
</pre>
|-
|
Another kind of list is a ''definition list'':
; Word : Definition of the word
; Here is a longer phrase that needs a definition
: Phrase defined
; A word : Which has a definition
: Also a second one
: And even a third
|<pre>
Another kind of list is a ''definition list'':
; Word : Definition of the word
; Here is a longer phrase that needs a definition
: Phrase defined
; A word : Which has a definition
: Also a second one
: And even a third
</pre>
|-
|
* You can even do mixed lists
*# and nest them
*# inside each other
*#* or break lines<br />in lists.
*#; definition lists
*#: can be
*#;; nested too
|<pre>
* You can even do mixed lists
*# and nest them
*# inside each other
*#* or break lines<br />in lists.
*#; definition lists
*#: can be
*#;; nested too
</pre>
|-
|
: A colon (:) indents a line or paragraph.
A new line after that starts a new paragraph. <br />
This is often used for discussion on [[talk pages]].
: We use 1 colon to indent once.
:: We use 2 colons to indent twice.
::: We use 3 colons to indent 3 times, and so on.
|<pre>
: A colon (:) indents a line or paragraph.
A new line after that starts a new paragraph. <br />
This is often used for discussion on talk pages.
: We use 1 colon to indent once.
:: We use 2 colons to indent twice.
::: We use 3 colons to indent 3 times, and so on.
</pre>
|-
|
You can make [[w:horizontal dividing line|horizontal dividing line]]s (----)
to separate text.
----
But you should usually use sections instead,
so that they go in the table of contents.
|<pre>
You can make horizontal dividing lines (----)
to separate text.
----
But you should usually use sections instead,
so that they go in the table of contents.
</pre>
|-
|
You can add footnotes to sentences using the ''ref'' tag -- this is especially good for citing a source.

:There are over six billion people in the world.<ref>CIA World Factbook, 2006.</ref> <br />

References: <references/>

For details, see [[Wikipedia:Footnotes]] and [[Help:Footnotes]].
|
<pre><nowiki>
You can add footnotes to sentences using the ''ref'' tag
-- this is especially good for citing a source.

:There are over six billion people in the world.
<ref>CIA World Factbook, 2006.</ref> <br />

References: <references/>

For details, see [[Wikipedia:Footnotes]] and [[Help:Footnotes]].
</nowiki></pre>
|}

===External links===
===External links===


Line 331: Line 188:
|
|
The ''first letter'' of articles is automatically
The ''first letter'' of articles is automatically
capitalized, so [[wikipedia]] goes to the same place
capitalized, so [[Main page]] goes to the same place
as [[Wikipedia]]. Capitalization matters after the
as [[main page]]. Capitalization matters after the
first letter.
first letter.
|<pre>
|<pre>
The ''first letter'' of articles is automatically
The ''first letter'' of articles is automatically
capitalized, so [[wikipedia]] goes to the same place
capitalized, so [[Main page]] goes to the same place
as [[Wikipedia]]. Capitalization matters after the
as [[main page]]. Capitalization matters after the
first letter.
first letter.
</pre>
</pre>
Line 398: Line 255:
|-
|-
|
|
You can make a link to Wikipedia by typing:
[[wikipedia:Python (programming language)]]

You can make an external link just by typing a URL:
You can make an external link just by typing a URL:
http://www.nupedia.com
http://www.nupedia.com
Line 408: Line 268:
|
|
<pre>
<pre>
You can make a link to Wikipedia by typing:
[[wikipedia:Python (programming language)]]

You can make an external link just by typing a URL:
You can make an external link just by typing a URL:
http://www.nupedia.com
http://www.nupedia.com
Line 473: Line 336:
</pre>
</pre>
|}
|}

===Just show what I typed===

:''See also [[Help:Wiki markup examples#Just show what I typed]].

A few different kinds of formatting will tell the Wiki to display things as you typed them.

{| {{prettytable}} border="1" cellpadding="2" cellspacing="0"
|-
!What it looks like
!What you type
|-
|
<nowiki>
The nowiki tag ignores [[Wiki]] ''markup''.
It reformats text by removing
new lines and multiple spaces.
It still interprets special
characters: →
</nowiki>
|<pre>
&lt;nowiki&gt;
The nowiki tag ignores [[Wiki]] ''markup''.
It reformats text by removing
new lines and multiple spaces.
It still interprets special
characters: &amp;rarr;
&lt;/nowiki&gt;
</pre>
|-
|
<pre>
The pre tag ignores [[Wiki]] ''markup''.
It also doesn't reformat text.
It still interprets special characters: →
</pre>
|<pre>
&lt;pre&gt;
The pre tag ignores [[Wiki]] ''markup''.
It also doesn't reformat text.
It still interprets special characters: &amp;rarr;
&lt;/pre&gt;
</pre>
|-
|
Leading spaces are another way to preserve formatting.

Putting a space at the beginning of each
line stops the text from being reformatted.
It still interprets [[Wiki]] ''markup'' and
special characters: →
|<pre>
Leading spaces are another way to preserve formatting.

Putting a space at the beginning of each
line stops the text from being reformatted.
It still interprets [[Wiki]] ''markup'' and
special characters: &amp;rarr;
</pre>
|}

===Images, tables, video, and sounds===

After uploading, just enter the filename, highlight it and press the "embedded image"-button of the edit_toolbar.

This will produce the syntax for uploading a file '''<nowiki>[[Image:filename.png]]</nowiki>'''

This is a very quick introduction. For more information, see:
* [[Help:Images and other uploaded files]] for how to upload files
* [[Help:Extended image syntax]] for how to arrange images on the page
* [[Help:Table]] for how to create a table

{| {{prettytable}} border="1" cellpadding="2" cellspacing="0"
|-
!What it looks like
!What you type
|-
|
A picture, including alternate text:

[[Image:Wiki.png|The logo for this Wiki]]

You can put the image in a frame with a caption:
[[Image:Wiki.png|frame|The logo for this Wiki]]
|<pre>
A picture, including alternate text:

[[Image:Wiki.png|The logo for this Wiki]]

You can put the image in a frame with a caption:
[[Image:Wiki.png|frame|The logo for this Wiki]]
</pre>
|-
|
A link to Wikipedia's page for the image:
[[:Image:Wiki.png]]

Or a link directly to the image itself:
[[Media:Wiki.png]]
|<pre>
A link to Wikipedia's page for the image:
[[:Image:Wiki.png]]

Or a link directly to the image itself:
[[Media:Wiki.png]]
</pre>
|-
|
Use '''media:''' links to link directly to sounds
or videos: [[media:Sg_mrob.ogg|A sound file]]
|<pre>
Use '''media:''' links to link directly to sounds
or videos: [[media:Sg_mrob.ogg|A sound file]]
</pre>
|-
|
{| border="1" cellspacing="0" cellpadding="5" align="center"
! This
! is
|-
| a
| table
|-
|}
|<pre>
{| border="1" cellspacing="0" cellpadding="5" align="center"
! This
! is
|-
| a
| table
|-
|}

</pre>
|}

=== Mathematical formulas ===
You can format mathematical formulas with [[w:TeX|TeX]] markup. See [[Help:Formula]].
{| {{prettytable}} border="1" cellpadding="2" cellspacing="0"
|-
!What it looks like
!What you type
|-
|
<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>
|<pre><nowiki>
<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>
</nowiki></pre>
|}

===Templates===

'''[[Help:Template|Templates]]''' are segments of Wiki markup that are meant to be copied automatically ("transcluded") into a page.
You add them by putting the template's name in <nowiki>{{double braces}}</nowiki>.

Some templates take ''parameters'', as well, which you separate with the pipe character.
{| {{prettytable}} border="1" cellpadding="2" cellspacing="0"
|-
!What it looks like
!What you type
|-
|
{{Transclusion demo}}
|<pre>
{{Transclusion demo}}
</pre>
|-
|
This template takes two parameters, and
creates underlined text with a hover box
for many modern browsers supporting CSS:

{{H:title|This is the hover text|
Hover your mouse over this text}}

Go to this page to see the H:title template
itself: {{tl|H:title}}

|<pre>
This template takes two parameters, and
creates underlined text with a hover box
for many modern browsers supporting CSS:

{{H:title|This is the hover text|
Hover your mouse over this text}}

Go to this page to see the H:title template
itself: {{tl|H:title}}
</pre>
|}



== Minor edits ==
== Minor edits ==

Revision as of 09:48, 24 October 2006

The original version of this page can be found at Wikipedia.


This Editing Overview has a lot of wikitext examples. You may want to keep this page open in a separate browser window for reference while you edit.

Editing basics

Start editing
To start editing a MediaWiki page, click the Edit this page (or just edit) link at one of its edges. This brings you to the edit page: a page with a text box containing the wikitext: the editable source code from which the server produces the webpage. If you just want to experiment, please do so in the sandbox, not here.
Type your changes
You can just type your text. However, also using basic wiki markup (described in the next section) to make links and do simple formatting adds to the value of your contribution.
Summarize your changes
Write a short edit summary in the small field below the edit-box. You may use shorthand to describe your changes, as described in the legend.
Preview before saving
When you have finished, click Show preview to see how your changes will look -- before you make them permanent. Repeat the edit/preview process until you are satisfied, then click Save page and your changes will be immediately applied to the article.


Basic text formatting

What it looks like What you type

You can italicize text by putting 2 apostrophes on each side.

3 apostrophes will bold the text.

5 apostrophes will bold and italicise the text.

(4 apostrophes don't do anything special -- there's just 'one left over'.)

You can ''italicize text'' by putting 2 
apostrophes on each side. 

3 apostrophes will bold '''the text'''. 

5 apostrophes will bold and italicize 
'''''the text'''''.

(4 apostrophes don't do anything special -- there's just ''''one left over''''.)

A single newline has no effect on the layout. But an empty line

starts a new paragraph.

A single newline
has no effect
on the layout.
But an empty line

starts a new paragraph.

You can break lines
without a new paragraph.
Please use this sparingly.

You can break lines<br />
without a new paragraph.<br />
Please use this sparingly.

You should "sign" your comments on talk pages:
- Three tildes gives your user name: Karl Wick
- Four tildes give your user name plus date/time: Karl Wick 07:46, 27 November 2005 (UTC)
- Five tildes gives the date/time alone: 07:46, 27 November 2005 (UTC)

You should "sign" your comments 
on talk pages: <br />
- Three tildes gives your user
name: ~~~ <br />
- Four tildes give your user 
name plus date/time: ~~~~ <br />
- Five tildes gives the 
date/time alone: ~~~~~ <br />

You can use HTML tags, too, if you want. Some useful ways to use HTML:

Put text in a typewriter font. The same font is generally used for computer code.

Strike out or underlinetext, or write it in small caps.

Superscripts and subscripts: X2, H2O

Invisible comments to editors (<!-- -->) only appear while editing the page.

If you wish to make comments to the public, you should usually go on the talk page, though.

You can use <b>HTML tags</b>,
too, if you want. Some useful
ways to use HTML:

Put text in a <tt>typewriter
font</tt>. The same font is 
generally used for <code>
computer code</code>.

<strike>Strike out</strike>
or <u>underline</u> text,
or write it <span style=
"font-variant:small-caps">
in small caps</span>.

Superscripts and subscripts:
X<sup>2</sup>, H<sub>2</sub>O

Invisible comments to editors (&lt;!-- --&gt;) 
only appear while editing the page.
<!-- Note to editors: blah blah blah. -->

If you wish to make comments to the public, 
you should usually go on the [[talk page]], though.

For a list of HTML tags that are allowed, see HTML in wikitext. However, you should avoid HTML in favor of Wiki markup whenever possible.

Organizing your writing

What it looks like What you type
Section headings

Headings organize your writing into sections. The Wiki software can automatically generate a table of contents from them.

Subsection

Using more equals signs creates a subsection.

A smaller subsection

Don't skip levels, like from two to four equals signs.

Start with 2 equals signs not 1 because 1 creates H1 tags which should be reserved for page title.

===External links===

You will often want to make clickable ''links'' to other pages.

{| {{prettytable}} width="100%"  border="1" cellpadding="2" cellspacing="0"
|-
!What it looks like
!What you type
|-
|
Here's a link to a page named [[Arts and Letters Magazine]].
You can even say [[arts and letters magazine]]s
and the link will show up correctly.
|<pre>
Here's a link to a page named [[Arts and Letters Magazine]].
You can even say [[arts and letters magazine]]s
and the link will show up correctly.

You can put formatting around a link. Example: Wikipedia.

You can put formatting around a link.
Example: ''[[Wikipedia]]''.

The first letter of articles is automatically capitalized, so Main page goes to the same place as main page. Capitalization matters after the first letter.

The ''first letter'' of articles is automatically
capitalized, so [[Main page]] goes to the same place
as [[main page]]. Capitalization matters after the
first letter.

The weather in Riga is a page that doesn't exist yet. You could create it by clicking on the link.

[[The weather in Riga]] is a page that doesn't exist
yet. You could create it by clicking on the link.

You can link to a page section by its title:

If multiple sections have the same title, add a number. #Example section 3 goes to the third section named "Example section".

You can link to a page section by its title:

*[[List of cities by country#Morocco]].

If multiple sections have the same title, add
a number. [[#Example section 3]] goes to the
third section named "Example section".

You can make a link point to a different place with a piped link. Put the link target first, then the pipe character "|", then the link text.

Or you can use the "pipe trick" so that text in brackets does not appear.

You can make a link point to a different place
with a [[Help:Piped link|piped link]]. Put the link
target first, then the pipe character "|", then
the link text.

*[[Help:Link|About Links]]
*[[List of cities by country#Morocco|
Cities in Morocco]]

Or you can use the "pipe trick" so that text in
brackets does not appear. 

*[[Spinning (textiles)|Spinning]]

You can make a link to Wikipedia by typing: wikipedia:Python (programming language)

You can make an external link just by typing a URL: http://www.nupedia.com

You can give it a title: Nupedia

Or leave the title blank: [1]

You can make a link to Wikipedia by typing:
[[wikipedia:Python (programming language)]]

You can make an external link just by typing a URL:
http://www.nupedia.com

You can give it a title:
[http://www.nupedia.com Nupedia]

Or leave the title blank:
[http://www.nupedia.com]

Linking to an e-mail address works the same way: mailto:someone@domain.com or someone

Linking to an e-mail address works the same way:
mailto:someone@domain.com or 
[mailto:someone@domain.com someone]

You can redirect the user to another page.

#REDIRECT [[Official position]]

Category links do not show up in line but instead at page bottom and cause the page to be listed in the category.

Add an extra colon to link to a category in line without causing the page to be listed in the category: Category:Help

[[Help:Category|Help]] do not show up in line
but instead at page bottom ''and cause the page to be
listed in the category.''
[[Category:Help]]

Add an extra colon to ''link'' to a category in line
without causing the page to be listed in the category:
[[:Category:Help]]

The Wiki reformats linked dates to match the reader's date preferences. These three dates will show up the same if you choose a format in your Preferences:

The Wiki reformats linked dates to match the reader's
date preferences. These three dates will show up the
same if you choose a format in your
[[Special:Preferences|]]:
* [[July 20]], [[1969]]
* [[20 July]] [[1969]]
* [[1969]]-[[07-20]]

Minor edits

A logged-in user can mark an edit as "minor". Minor edits are generally spelling corrections, formatting, and minor rearrangement of text. Users may choose to hide minor edits when viewing Recent Changes.

Marking a significant change as a minor edit is considered bad Wikiquette. If you have accidentally marked an edit as minor, make a dummy edit, verify that the "[ ] This is a minor edit" check-box is unchecked, and explain in the edit summary that the previous edit was not minor.