Help:Editing: Difference between revisions

From FreeCAD Documentation
(→‎Basic text formatting: Linkfixes local adaptions)
(Linkfix, Date format removed)
Line 300: Line 300:
|-
|-
|
|
[[Help:Category|Category links]] do not show up in line
Category links do not show up in line
but instead at page bottom ''and cause the page to be
but instead at page bottom ''and cause the page to be
listed in the category.''
listed in the category.''
Line 309: Line 309:
[[:Category:Help]]
[[:Category:Help]]
|<pre>
|<pre>
[[Help:Category|Help]] do not show up in line
''Categeroy links'' do not show up in line
but instead at page bottom ''and cause the page to be
but instead at page bottom ''and cause the page to be
listed in the category.''
listed in the category.''
Line 317: Line 317:
without causing the page to be listed in the category:
without causing the page to be listed in the category:
[[:Category:Help]]
[[:Category:Help]]
</pre>
|-
|
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|Preferences]]:
* [[July 20]], [[1969]]
* [[20 July]] [[1969]]
* [[1969]]-[[07-20]]
|<pre>
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]]
</pre>
</pre>
|}
|}
Line 340: Line 322:
== Minor edits ==
== Minor edits ==


A [[Help:Logging in|logged-in]] user can mark an edit as "minor". [[Help:Minor edit|Minor edit]]s are generally spelling corrections, formatting, and minor rearrangement of text. Users may choose to ''hide'' minor edits when viewing [[Help:Recent changes|Recent Changes]].
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 [[Help:Dummy edit|dummy edit]], verify that the "<small>'''[&nbsp;] This is a minor edit'''</small>" check-box is unchecked, and explain in the edit summary that the previous edit was not minor.
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 "<small>'''[&nbsp;] This is a minor edit'''</small>" check-box is unchecked, and explain in the edit summary that the previous edit was not minor.

Revision as of 13:32, 14 November 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: Dr. Schorsch
- Four tildes give your user name plus date/time: Dr. Schorsch 20:55, 1 November 2006 (CET)
- Five tildes gives the date/time alone: 21:01, 1 November 2006 (CET)

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 [[wikipedia:talk page|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

''Categeroy links'' 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]]

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.