Help:Editing

From CodeBlocks
Jump to: navigation, search

General

To edit a MediaWiki page, click on the "Edit this page" (or just "edit") link at one of its edges. This will bring you to a page with a text box containing the wikitext: the editable source code from which the server produces the webpage. For the special codes, see below.

After adding to or changing the wikitext it is useful to press "Preview", which produces the corresponding webpage in your browser but does not make it publicly available yet (not until you press "Save"). Errors in formatting, links, tables, etc., are often much easier to discover from the rendered page than from the raw wikitext.

If you are not satisfied you can make more changes and preview the page as many times as necessary. Then write a short edit summary in the small text field below the edit-box and when finished press "Save". Depending on your system, pressing the "Enter" key while the edit box is not active (i.e., there is no typing cursor in it) may have the same effect as pressing "Save".

You may find it more convenient to copy and paste the text first into your favorite text editor, edit and spell check it there, and then paste it back into your web browser to preview. This way, you can also keep a local backup copy of the pages you have edited. It also allows you to make changes offline, but before you submit your changes, please make sure nobody else has edited the page since you saved your local copy (by checking the page history), otherwise you may accidently revert someone else's edits. If someone has edited it since you copied the page, you'll have to merge their edits into your new version (you can find their specific edits by using the "diff" feature of the page history). These issues are handled automatically by the Mediawiki software if you edit the page online, retrieving and submitting the wikicode in the same text box.

Dummy edit

If the wikitext is not changed no edit will be recorded and the edit summary is discarded.

A dummy edit is a change in wikitext that has no effect on the rendered page, such as changing the number of newlines at some position from 0 to 1 or from 2 to 3 or conversely (changing from 1 to 2 makes a difference, see below). This allows an edit summary, and is useful for correcting a previous edit summary, or an accidental marking of a previous edit as "minor" (see below). Also it is sometimes needed to refresh the cache of some item in the database.

Minor edits

When editing a page, a logged-in user has the option of flagging the edit as a "minor edit". This feature is important, because users can choose to hide minor edits in their view of the Recent Changes page, to keep the volume of edits down to a manageable level.

When to use this is somewhat a matter of personal preference. The rule of thumb is that an edit of a page that consists of spelling corrections, formatting, and minor rearranging of text should be flagged as a "minor edit". A major edit is basically something that makes the entry worth revisiting for somebody who wants to watch the article rather closely. So any "real" change, even if it is a single word, should be flagged as a "major edit".

The reason for not allowing a user who is not logged in to mark an edit as minor is that vandalism could then be marked as a minor edit, in which case it would stay unnoticed longer. This limitation is another reason to log in.

The wiki markup

In the left column of the table below, you can see what effects are possible. In the right column, you can see how those effects were achieved. In other words, to make text look like it looks in the left column, type it in the format you see in the right column.

You may want to keep this page open in a separate browser window for reference. If you want to try out things without danger of doing any harm, you can do so in the Sandbox.

General formatting

What it looks like What you type

You can emphasize text by putting two apostrophes on each side. Three apostrophes will emphasize it strongly. Five apostrophes is even stronger.

You can ''emphasize text'' by putting two
apostrophes on each side. Three apostrophes
will emphasize it '''strongly'''. Five
apostrophes is '''''even stronger'''''.

You can strike out text, and underline it too.

You can <strike>strike out text</strike>, and <u>underline it too</u>.

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.
  • Lists are easy.
    • Start every line with an asterisk.
      • The more asterisks the deeper the list item.
* Lists are easy.
** Start every line with an asterisk.
** The more asterisks the deeper the list item.
  1. Numbered lists are easy too.
    1. Just start every line with the hash symbol.
# Numbered lists are easy too.
## Just start every line with the hash symbol.
A colon indents a line or paragraph.
: A colon indents a line or paragraph.

To put in preformated text, as computer code usually is, leave the first character on a line blank:

 printf("Hello, World!\n");
To put in preformated text, as computer code usually is, leave the first character on a line blank:

  printf("Hello, World!\n");
For long longer passages of
preformatted text,
put the <pre> mark at the
beginning and the </@re>
mark at the end - but change
that @ to a p. 
<pre>
For long longer passages of
preformatted text,
put the <pre> mark at the
beginning and the </@re> 
mark at the end - but change
that @ to a p.

You should "sign" your comments on talk pages:

Three tildes gives your user name: Sethjackson
Four tildes give your user name plus date/time: Sethjackson 08:21, 27 May 2006 (EDT)
Five tildes gives the date/time alone: 08:21, 27 May 2006 (EDT)
You should "sign" your comments
on talk pages:
: Three tildes gives your user
name: ~~~
: Four tildes give your user 
name plus date/time: ~~~~
: Five tildes gives the 
date/time alone: ~~~~~

Templates

Some part of a page may correspond in the edit box to just a reference to another page, in the form {{name}}, referring to the page "Template:name" (or if the name starts with a namespace prefix, it refers to the page with that name; if it starts with a colon it refers to the page in the main namespace with that name without the colon). This is called a template. For changing that part of the page, edit that other page. Sometimes a separate edit link is provided for this purpose.

Creating a New Page

The Code::Blocks wiki does not seem to have a direct way to create a new wiki page. However, you can put a link to the non-existent page on an existing page with something like this:

[[Name of the page I want to create]]

When you save that page and it displays, you will see the link in red because the page doesn't exist. But click on the link anyway and you will be offered a chance to create the page. If desired, you can later remove the link on the originally existing page. There should be a more direct way, but this one at least works.

Page protection

In a few cases the link labeled "Edit this page" is replaced by the text "Protected page" (or equivalents in the language of the project). In that case the page can not be edited.