Difference between revisions of "Help:Editing"

From ISFDB
Jump to navigation Jump to search
Line 1: Line 1:
 +
A brief overview of the editing and contributing process. Pages linked at the end  contain more information on editing functions.
  
 +
== Editing basics ==
 +
 +
===Review policy and conventions===
 +
 +
:Make sure that you submit information which is relevant to the purpose of the ISFDB specific purpose of the page you are editing. You can always use the [[Help:Talk page|talk pages]] to ask questions or check to see if your idea will be accepted. Note that all content that ypu post must be your own work, or freely available, and that it will all be released for anyoen else to use, copy, and modify.
 +
 +
=== Start editing ===
 +
:To start editing an entire ''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 ''[[help:wikitext|wikitext]]'' – the editable code from which the server produces the finished page, and often called the '''edit box'''.
 +
:''If you just want to experiment, please do so in the [[ISFDB:Sandbox|sandbox]], not in the edit box''.
 +
 +
:To edit only a singel section, click the "edit" link to the right of the section titel/headline, just '''above''' the bosdy of the section.
 +
 +
===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. [[w:Wikimedia|Wikimedia]] wikis have style guidelines available. If you follow these, your contributions will be more valuable as they won't need to be cleaned up later.
 +
 +
===Summarize your changes===
 +
:Write a short [[Help:Edit summary|edit summary]] in the small field below the edit-box. You may use shorthand to describe your changes, as described in the [[w:Wikipedia:Edit summary legend|edit summary legend]].
 +
 +
===Preview before saving!===
 +
:When you have finished, click '''[[Help:Show preview|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. Sometimes it is helpful to save in between.
 +
 +
==Most frequent wiki markup explained==
 +
<!--It is intended to be brief, or as an overview. Otherwise why we separate the materials into different pages? Thus it's best NOT to add new materials or expand here. Add more examples or expand in other areas like Wikitext examples. Thanks!-->
 +
Here are the most frequently used types of wiki markup. If you need more help see [[Help:Wikitext examples|Wikitext examples]].
 +
 +
<br clear="right" />
 +
{| class="wikitable"
 +
! style="width: 50%" | What it looks like
 +
! style="width: 50%" | What you type
 +
|-
 +
|
 +
You can ''italicize text'' by putting 2
 +
apostrophes on each side.
 +
 +
3 apostrophes will embolden '''the text'''.
 +
 +
5 apostrophes will embolden and italicize
 +
'''''the text'''''.
 +
 +
(4 apostrophes don't do anything special -- there's just ''''one left over''''.)
 +
|<pre>
 +
You can ''italicize text'' by putting 2
 +
apostrophes on each side.
 +
 +
3 apostrophes will embolden '''the text'''.
 +
 +
5 apostrophes will embolden and italicize
 +
'''''the text'''''.
 +
 +
(4 apostrophes don't do anything
 +
special -- there's just ''''one left
 +
over''''.)
 +
</pre>
 +
|-
 +
|
 +
You should "sign" your comments on talk pages:
 +
* Three tildes give your user name: [[User:Example|Example]] <br />
 +
* Four tildes give your user name plus date/time: [[User:Example|Example]] 07:46, 27 November 2005 (UTC)
 +
* Five tildes give the date/time alone: 07:46, 27 November 2005 (UTC)
 +
|<pre>
 +
You should "sign" your comments
 +
on talk pages:
 +
* Three tildes give your user
 +
name: ~~~
 +
* Four tildes give your user
 +
name plus date/time: ~~~~
 +
* Five tildes give the
 +
date/time alone: ~~~~~
 +
</pre>
 +
|-
 +
|
 +
On the ISFDB wiki, the four tilde signature is used almost invariably
 +
|-
 +
|
 +
<div style="font-size:150%;border-bottom:1px solid rgb(170,170,170);">Section headings</div>
 +
 +
''Headings'' organize your writing into sections.
 +
The Wiki software can automatically generate
 +
a [[Help:table of contents|table of contents]] from them.
 +
 +
<div style="font-size:132%;font-weight:bold;">Subsection</div>
 +
Using more equals signs creates a subsection.
 +
 +
<div style="font-size:116%;font-weight:bold;">A smaller subsection</div>
 +
 +
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 the page title.
 +
|<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>
 +
|- id="lists"
 +
|
 +
* ''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>
 +
|-
 +
|
 +
: A colon (:) indents a line or paragraph.
 +
A newline starts a new paragraph. <br>
 +
Often used for discussion on [[talk pages]].
 +
: We use 1 colon to indent once.
 +
:: We use 2 colons to indent twice.
 +
::: 3 colons to indent 3 times, and so on.
 +
|<pre>
 +
: A colon (:) indents a line or paragraph.
 +
A newline starts a new paragraph. <br>
 +
Often used for discussion on talk pages.
 +
: We use 1 colon to indent once.
 +
:: We use 2 colons to indent twice.
 +
::: 3 colons to indent 3 times, and so on.
 +
</pre>
 +
 +
 +
|-
 +
|
 +
Here's a link to the [[Main page]].
 +
 +
But be careful - capitalization counts! 
 +
|<pre>
 +
Here's a link to the [[Main page]].
 +
</pre>
 +
|-
 +
|
 +
[[The weather in London]] is a page that doesn't exist
 +
yet. You could create it by clicking on the link.
 +
|<pre>
 +
[[The weather in London]] is
 +
a page that doesn't exist
 +
yet. You could create it by
 +
clicking on the link.
 +
</pre>
 +
|-
 +
|
 +
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".
 +
|<pre>
 +
 +
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".
 +
</pre>
 +
|}
 +
 +
==Further reading==
 +
<!--More relevant links are welcome-->
 +
 +
===Editing help===
 +
* [[Help:Editing FAQ]]
 +
* [[Help:Minor edit]]
 +
 +
===Wiki markups and codes===
 +
*[[Help:Wikitext examples]]
 +
*[[m:Help:Reference card|Help:Reference card]]: a one-page summary of important commands, to be printed out and used next to the computer
 +
*[[Help:HTML in wikitext]]
 +
*[[Help:Comment tags]]
 +
*[[w:HTML element|HTML elements]]: introduction to HTML
 +
 +
===Page management===
 +
*[[Help:Starting a new page]]
 +
*{{ml|Help:Administration|Protection|Protecting pages}}
 +
 +
<small>This page is derived from the wikimedia help page at [http://meta.wikimedia.org/wiki/Help:Editing this location]</small>

Revision as of 20:46, 24 February 2008

A brief overview of the editing and contributing process. Pages linked at the end contain more information on editing functions.

Editing basics

Review policy and conventions

Make sure that you submit information which is relevant to the purpose of the ISFDB specific purpose of the page you are editing. You can always use the talk pages to ask questions or check to see if your idea will be accepted. Note that all content that ypu post must be your own work, or freely available, and that it will all be released for anyoen else to use, copy, and modify.

Start editing

To start editing an entire 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 code from which the server produces the finished page, and often called the edit box.
If you just want to experiment, please do so in the sandbox, not in the edit box.
To edit only a singel section, click the "edit" link to the right of the section titel/headline, just above the bosdy of the section.

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. Wikimedia wikis have style guidelines available. If you follow these, your contributions will be more valuable as they won't need to be cleaned up later.

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 edit summary 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. Sometimes it is helpful to save in between.

Most frequent wiki markup explained

Here are the most frequently used types of wiki markup. If you need more help see Wikitext examples.


What it looks like What you type

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

3 apostrophes will embolden the text.

5 apostrophes will embolden and italicize 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 embolden '''the text'''. 

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

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

You should "sign" your comments on talk pages:

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

On the ISFDB wiki, the four tilde signature is used almost invariably

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 the page title.

== 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.
  • 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.
* ''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.
  1. Numbered lists are:
    1. Very organized
    2. Easy to follow

A new line marks the end of the list.

  1. New numbering starts with 1.
# ''Numbered lists'' are:
## Very organized
## Easy to follow
A new line marks the end of the list.
# New numbering starts with 1.
A colon (:) indents a line or paragraph.

A newline starts a new paragraph.
Often used for discussion on talk pages.

We use 1 colon to indent once.
We use 2 colons to indent twice.
3 colons to indent 3 times, and so on.
: A colon (:) indents a line or paragraph.
A newline starts a new paragraph. <br>
Often used for discussion on talk pages.
: We use 1 colon to indent once.
:: We use 2 colons to indent twice.
::: 3 colons to indent 3 times, and so on.


Here's a link to the Main page.

But be careful - capitalization counts!

Here's a link to the [[Main page]].

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

[[The weather in London]] 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".

Further reading

Editing help

Wiki markups and codes

Page management

This page is derived from the wikimedia help page at this location