Help:Editing

From OWASP
Jump to: navigation, search

See the Tutorial for OWASP-specific editing information.


Template:H:h One of the user rights that can be set for a user group is "edit", the right to edit a page. A wiki can grant this right for example to all users who are not blocked (this is the default), or only to those who have logged in.

This page is intended to provide a brief overview of the editing process. Each of these topics are covered somewhere else in more detail. Look at the right hand side of the page for the Editor table of contents.

One could just open Help:Wikitext examples, and click "edit" on the page you want to change, and hack away, however some of the advanced wikitext and editing facilities can help save a lot of time. A more in-depth introductory guide is available at Help:Editing all-in-one guide.

Editing basics

Review policy and conventions

Make sure that what you want to write belongs where you want to put it. The operator of the site likely has specific plans for the site, and your content might be deleted or unappreciated. You can always use the talk pages to ask questions or check to see if your idea will be accepted. Please make note of the license your contributions will be covered with.

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 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.

Most frequent wiki markup explained

Here are the 6 most frequently used wiki markups. If you need more help see:

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 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 bold '''the text'''. 

5 apostrophes will bold 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 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>
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.

== 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 newline
  • 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.

Here's a link to a page named Official position. You can even say official positions and the link will show up correctly.

Here's a link to a page named
 [[Official position]].
You can even say 
[[official position]]s
and the link will show up 
correctly.

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

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

Further reading

Please help by filling in missing links. Hint: If the link is red, then the page is waiting for you to create it.

Editing help

Wiki markups and codes

Template:Meta

Page management

Others

Template:H:f