Help:How to edit a page

From IT frameworks

Jump to: navigation, search
These help-pages are for a large part based on the help-pages on the english Wikipedia. Check them out for a more complete set of help-pages, but keep in mind that not everything there is applicable here.

The IT governance resource is a wiki, meaning that anyone can easily edit any unprotected page, and save those changes immediately to that page, making the alterations visible to every other reader. The content is free for all to read, but only registered users are allowed to edit pages. Registration is free.

Contents

Introduction

Editing most pages is easy. Simply click on the "edit this page" tab at the top of an article (or on an [Edit]-link next to a section). This will bring you to a new page with a text box containing the editable text of the original page. If you add information to a page, please provide references, as unreferenced facts are subject to removal. When you are finished with an edit, you should write a short edit summary in the small field below the edit-box. To see how the page looks with your edits, press the "Show preview" button. To see the differences between the page with your edits and the previous version of the page, press the "Show changes" button. If you're satisfied with what you see press the "Save page" button. Your changes will immediately be visible to all IT governance users.

You can also click on the "Discussion" tab to see the corresponding talk page, which contains comments about the page from other users. Click on the "new section" tab to start a new section, or edit the page in the same way as an article page.

You should also remember to sign your messages on talk pages with four tildes (~~~~), but you should not sign edits you make to regular articles. In page history, the MediaWiki software automatically keeps track of which user makes each change.

Minor edits

A check to the "minor edit" box signifies that only superficial differences exist between the version with your edit and the previous version: typo corrections, formatting and presentational changes, rearranging of text without modifying content, etc. A minor edit is a version that the editor believes requires no review and could never be the subject of a dispute.

Major edits

There are several things that a user can do to ensure that major edits are performed smoothly. Before engaging in a major edit, a user should consider discussing proposed changes on the article discussion/talk page. Once the edit has been completed, the inclusion of an edit summary will assist in documenting the changes. These steps will all help to ensure that major edits are well received.

A major edit should be reviewed to confirm that it is consensual to all concerned editors. Therefore, any change that affects the meaning of an article is major (not minor), even if the edit is a single word.

There are no necessary terms to which you have to agree when doing major edits, but the recommendations above have become best practice. If you do it your own way, the likelihood of your edits being reedited may be higher.

Wiki markup

The wiki markup is the syntax system you can use to format a Wikipedia page. Below is an extended list of examples of how to use it.

Basic text formatting

You can format the page using Wikitext special characters.

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.

(Using 4 apostrophes doesn't do anything special --
they are just ' left over ones' that are included as part of the text.)

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

(Using 4 apostrophes doesn't do anything
special -- <br /> they are just ''''left
over ones'''' that are included as part
of the text.)

A single newline generally has no effect on the layout. These can be used to separate sentences within a paragraph. Some editors find that this aids editing and improves the diff function (used internally to compare different versions of a page).

But an empty line starts a new paragraph.

When used in a list, a newline does affect the layout (see below).

A single newline
generally has no effect on the layout.
These can be used to separate
sentences within a paragraph.
Some editors find that this aids editing
and improves the ''diff'' function
(used internally to compare
different versions of a page).

But an empty line
starts a new paragraph.

When used in a list, a newline ''does''
affect the layout ([[#lists|see below]]).

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

Please do not start a link or italics or bold on one line and close it on the next.

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

Please do not start a link or
''italics'' or '''bold''' on one line
and close it on the next.

You should "sign" your comments on talk pages:
- Three tildes gives your signature: Kristian
- Four tildes give your signature plus date/time: Kristian 14:17, 22 December 2008 (UTC)
- Five tildes gives the date/time alone: 14:17, 22 December 2008 (UTC)

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

HTML tags

You can use some HTML tags too. However, you should avoid HTML in favor of Wiki markup whenever possible.


What it looks like What you type

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

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

Strike out or underline text, or write it in small caps.

<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: X2, H2O

Superscripts and subscripts:
X<sup>2</sup>, H<sub>2</sub>O
Centered text
  • Please note the American spelling of "center".
<center>Centered text</center>
* Please note the American spelling of "center".
The blockquote command formats block quotations, typically by surrounding them with whitespace and a slightly different font.
<blockquote>
The '''blockquote''' command formats block
quotations, typically by surrounding them
with whitespace and a slightly different font.
</blockquote>

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

  • If you wish to make comments to the public, you should usually use the talk page.
Invisible comments to editors (&lt;!-- --&gt;)
appear only while editing the page.
<!-- Note to editors: blah blah blah. -->

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.

== 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 newline
* 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 newline marks the end of the list.

  1. New numbering starts with 1.
# ''Numbered lists'' are:
## Very organized
## Easy to follow
A newline marks the end of the list.
# New numbering starts with 1.

Here's a definition list:

Word 
Definition of the word
A longer phrase needing definition
Phrase defined
A word 
Which has a definition
Also a second one
And even a third

Begin with a semicolon. One item per line; a newline can appear before the colon, but using a space before the colon improves parsing.

Here's a ''definition list'':
; Word : Definition of the word
; A longer phrase needing definition
: Phrase defined
; A word : Which has a definition
: Also a second one
: And even a third

Begin with a semicolon. One item per line;
a newline can appear before the colon, but
using a space before the colon improves
parsing.
  • You can even do mixed lists
    1. and nest them
    2. inside each other
      • or break lines
        in lists.
      definition lists
      can be
      nested 
      too
* You can even do mixed lists
*# and nest them
*# inside each other
*#* or break lines<br>in lists.
*#; definition lists
*#: can be
*#:; nested : too
A colon (:) indents a line or paragraph.

A newline starts a new paragraph.
Should only be used on talk pages.
For articles, you probably want the blockquote tag.

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.
Should only be used on talk pages.
For articles, you probably want the blockquote tag.
: We use 1 colon to indent once.
:: We use 2 colons to indent twice.
::: 3 colons to indent 3 times, and so on.

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.

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.

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.[<cite_link_label_group->]
References:
  1. ^ CIA World Factbook, 2006.
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>

References: <references/>

Links

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

What it looks like What you type

Here's a link to a page named Change Manager. You can even say change Managers and the link will show up correctly.

Here's a link to a page named [[Change Manager]].
You can even say [[change Manager]]s
and the link will show up correctly.

You can put formatting around a link. Example: Main Page.

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

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

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

Intentionally permanent red link is a page that doesn't exist yet. You could create it by clicking on the link.

[[Intentionally permanent red link]] 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:

You can link to a page section by its title:

* [[Change Manager#Production]].

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 a title that contains disambiguation text will appear with more concise link text.

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.

* [[Help:Contents|To the help-pages]]
* [[Change Manager#Production|KPIs and Metrics for Change Manager]]

Or you can use the "pipe trick" so that a title that
contains disambiguation text will appear with more concise
link text.

* [[Example (text)|Example]]
* [[City, Nation|City]]

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

You can give it a title: FreeCode

Or leave the title blank: [1]

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

You can give it a title:
[http://www.freecode.no/ FreeCode]

Or leave the title blank:
[http://www.freecode.no]

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

Linking to an e-mail address works the same way:
mailto:someone@example.com or [mailto:someone@example.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:Service Transition

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

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

Just show what I typed

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

What it looks like What you type

The nowiki tag ignores [[Wiki]] ''markup''. It reformats text by removing newlines and multiple spaces. It still interprets special characters: →

<nowiki>
The nowiki tag ignores
[[Wiki]] ''markup''.
It reformats text by
removing
newlines    and multiple
 spaces.
It still interprets special
characters: &rarr;
</nowiki>
The pre tag ignores [[Wiki]]
 ''markup''.
It also doesn't     reformat
 text.
It still interprets special
characters: →
<pre>
The pre tag ignores [[Wiki]]
 ''markup''.
It also doesn't     reformat
 text.
It still interprets special
characters: &rarr;
</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: →
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 [[Wikipedia:Wiki|]]
 ''markup'' and special
 characters: &rarr;

Images and tables

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 [[Image:filename.png]]

This is a very quick introduction. For more information about tables, see:

What it looks like What you type

A picture, including alternate text:

This Wiki's logo

You can put the image in a frame with a caption:

This Wiki's logo
A picture, including alternate text:

[[Image:Freecode_wiki_logo.png|This Wiki's logo]]

The image in a frame with a caption:
[[Image:Freecode_wiki_logo.png|frame|This Wiki's logo]]

A link to the wiki's page for the image: Image:Freecode_wiki_logo.png

Or a link directly to the image itself: Media:Freecode_wiki_logo.png

A link to the wiki's page for the image:
[[:Image:Freecode_wiki_logo.png]]

Or a link directly to the image itself:
[[Media:Freecode_wiki_logo.png]]
This is
a table
{| border="1" cellspacing="0" cellpadding="5" align="center"
! This
! is
|-
| a
| table
|-
|}

Personal tools