Edits

From Apnea Board Wiki
Jump to: navigation, search

Typewritter-man.jpg The Apnea Board Wiki Editor Guide


It's very easy to edit the contents of a wiki page. It only takes a few clicks:

  1. First you must become an Apnea Board Wiki Editor and log into your Wiki Editor Account (top right of this page).
  2. Click the "Edit" page tab at the top of the page.
  3. Make changes to the text.
  4. Click the "Save page" button.

Simple as that!


Resources for Apnea Board Wiki Editors

Using the Sandbox for experimentation

Beginning Editors are encouraged to use the Sandbox page to practice and experiment with editing. The Sandbox page is where you can "mess around with" editing without messing up actual wiki article pages. Go ahead and give it a try - Click here to go directly to the Sandbox


Available Editing Toolbars

There are two editing toolbars available to Wiki Editors.


1. The Standard (default) tool bar. It looks like this:
Old-edit-tool.jpg


2. The Enhanced tool bar. It looks like this:
New-edit-tool.jpg


To switch to the Enhanced Tool Bar:
1. Log into your Wiki Editor account (top right of this page).
2. Go to the very top right side of this page and select My preferences.
3. From within the Preferences page, go to the Editing tab.
4. Scroll down to Beta features.
5. Check the box that says "Enable enhanced editing toolbar"
6. Click on the Save button at the bottom of the page.


Editing rules, editing conventions, and formatting

The number one rule of wiki editing, is to be bold. Dive in and make changes. Other people can correct mistakes later, so have confidence, and give it a try! There can be all kinds of editing conventions, rules, and philosophy governing the editing of wiki pages, but the "be bold" rule overrides these!

In general try to write clearly and concisely and make sure you are always aiming to do something which improves the wiki contents. An edit might be to contribute whole paragraphs or pages full of information, or it could be as simple as fixing a typo or spelling mistake.

When you need to use some type of formatting e.g. new headings or bold text, you do this using wiki syntax or the buttons in the edit toolbar above. See Most Frequent Wiki Markup Explained for some of the common types of formatting used.


Edit Summary

Before you save a change, you can enter a short note in the Summary: box describing your changes. Don't worry too much about this, or spend too much time thinking about it, but try to give a little description of what you just changed e.g. "fixed typo" or "added more information about sunflowers".

The summary gets stored alongside your edit, and allows people to track changes in the wiki more effectively.


Preview

It's a good idea to use the "Show preview" button to see what your change will look like, before you save it. This is also related to tracking changes because every time you save, this is displayed to others as a separate change. This isn't something to worry about too much, but it's good to get into the habit of eliminating mistakes in your own work, by using a preview before saving, rather than saving several minor corrections afterwards.

Show changes

Another option is the "Show changes" button which allows you to see the differences between the current version and your edited version.


Other types of editing

With wiki edits you can start a new page, move (or rename) a page, or even delete a page:

Remember you should always aim to improve the overall contents of the wiki with your edits.

Editor Templates

Creation

Templates are standard wiki pages whose content is designed to be transcluded (embedded) inside other pages. Templates follow a convention that the name is prefixed with "Template:", assigning it to that namespace; besides this, you can create them like any other wiki page.

The simplest use of templates is as follows. If you create a page called "Template:Welcome" with contents:

Hello! Welcome to the wiki.

you'll have created your first template! If you then insert the code:

{{Welcome}}

in any other page, when that page is viewed the text "Hello! Welcome to the wiki." will appear instead of {{Welcome}}. The template content is "transcluded" into the other page, i.e. it is integrated in the page.

You can then insert {{Welcome}} at any point of any page where you wish to welcome someone. Suppose it is used in 100 pages. If you then change the template contents to:

Hi there! Welcome to this wonderful wiki.

and revisit any of the 100 pages where the template was used, you'll see the new text instead of the original one. In this way, you have changed the content of 100 pages without editing them, because the template is transcluded into these pages.

This is the basic mechanism. There are several additional features of transclusion that enrich this mechanism and make templates very useful.

Usage

Templates can be used in other pages in these ways:

  • {{Name}} — as described above, this link will be dynamically replaced by the current content of [[Template:Name]] at the time the page with the template link is loaded. The link will remain unchanged in the page's source.
  • {{subst:Name}} — when used, this template link will be substituted with a copy of the contents of [[Template:Name]] in the source of the transcluding page, as of the time the page with the link is saved; the contents are then a part of the including page, and can be edited normally, separately from the original. Note: changes to the source template page will not be propagated to the page with the template link.
  • {{safesubst:Name}} — this was introduced to allow for substitution that doesn't break transclusion.
  • {{msgnw:Name}} includes the template in a form that displays it as raw wiki syntax (the way <nowiki> does) when the page containing it is fetched.

In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:

  • {{Template:Pagename}} includes [[Template:Pagename]]
  • {{Foo:Pagename}} includes [[Foo:Pagename]]
  • {{:Pagename}} includes [[Pagename]]
    • {{subst::Pagename}} replaces itself with the contents of [[Pagename]]

If no such namespace exists, the full title is assumed to be a template:

  • {{Foo:Bar}} includes [[Template:Foo:Bar]]


List of existing templates for Editor use

Discussion

Every article has its own “talk page” where you can ask questions, make suggestions, or discuss corrections. Alternatively, you can ask questions and discuss wiki operations on the Apnea Board Wiki Editor's Forum (login required).

Most frequent Wiki markup explained

Here are the most frequently used types of wiki markup.


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 (talk)
  • Four tildes give your user name plus date/time: Example (talk) 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: ~~~~~

Section headings

What it looks like What you type
Section headings

Headings organize your writing into sections. The Wiki software can automatically generate a 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.

Lists and indents

What it looks like What you type
  • 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
  2. Previous item continues

A new line marks the end of the list.

  1. New numbering starts with 1.
# ''Numbered lists'' are:
## Very organized
## Easy to follow
# Previous item continues
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.

Links

What it looks like What you type

Here's a link to the Wiki Home page.

But be careful - capitalization counts!

Here's a link to the [[Wiki Home]] page.

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 placing a "#" before its title:



You can link to a page section by its title:

* [[Help:Contents#For editors]].




Restrictions

Some pages cannot be edited by everyone. A special function known as protection can be applied to a page by administrators, making the said page uneditable to certain classes of users. There are several degrees of protection:

  • If a page is fully protected, only other admins can make edits to the page.
  • A page can also be protected so that it cannot be moved.
  • In some cases, an admin might see fit to protect a page from being created.
  • For very rare pages, such as the Main Page, "cascading" protection is applied, wherein every page that is transcluded onto a page is protected too.

There are various reasons why a page might be protected. Vandalism and spam can lead to semiprotection, while content wars and other severe cases can lead to full protection. For the most part, protection is temporary and editing privileges are then restored. In any case, everyone can view the source of any page, irrespective of its level of protection.