Help:Editing

From Unreal Software English Wiki
Jump to: navigation, search
Ambox notice.png Documentation
[edit] · [purge]

px [src]Some of this page's content has been taken from Wikipedia
The article author ensures that the license the content is under has not been violated in any way

The main occupation on a wiki is, of course, editing pages. This help guide will tell you how to edit pages correctly and efficiently.

Contents

Basic level

Beginner's steps

  • To start editing a page, just click the 'Edit' button on the top of the page (right next to the search box).
  • On the editing page there are three main zones - the formatting toolbar, the content space and the saving toolbar.

    Editing.png
  • The formatting toolbar will help you format your page in a few clicks - change the looks of the text, add an image, add a link to another article or to another website and so on.
  • The content space is where the main action takes place - there you write the actual page content.
  • The saving toolbar is where you finish your job - enter the edit summary and save the page or, if you're not sure if it looks how you intented it to look, view the page without actually saving it.
  • You can also see what changes you've brought to the page in comparison to the current revision by clicking 'Show changes' and mark your edit as a minor one to show that not much has been changed by ticking the 'This is a minor edit' box.

Links

  • To add a link to the page, simply write [[ArticleName]], of course replacing ArticleName with the actual name of the article you're linking to. It can also be done clicking the Internal link button on the formatting toolbar.
  • If the word you wish to turn into a link differs from the article name, the formula is a little different: [[ArticleName|linkname]], where linkname is the word you turn into a link.
  • To add an external link, write [url Linkname], where url is the URL to the page you're linking to and Linkname is the name of the link (the name can be blank, in that case you simply get this: [1]). It can also be done using the External link button on the formatting toolbar.

Creating a new article

  • To create a new article, follow these steps:
  1. Enter the desired name of the article in the search box on the top
  2. Click 'Go'
  3. On the results page, click the red link in the 'Create the page' sentence.

    Creating page.png
  • You will see the page editing dialogue where you can create the desired page.

Inserting images

  • To insert an image, write [[File:Imagename.extension]] (replace Imagename with actual image name and extension with actual image extension). Example: Ambox notice.png
  • Images have parameters that let you control how they will appear on a page. These parameters are separated with a pipe (|). A short description of the main parameters:
To insert an image thumbnail, add the thumb parameter. By default, the thumbnail is aligned right.
To change the alignment of an image, add right or left as a parameter.
To resize an image, add its size in pixels as a parameter. Example: [[File:Example.jpg|80px]]
To add a caption to an image, write the whole caption as a parameter. If the image isn't a thumbnail, the caption will be shown as a tooltip. Example: [[File:Example.jpg|Example caption]]
To add alt text to an image, add the following: alt=Alt text goes here. Alt text will be shown instead of the image if the image isn't yet loaded or if the user has disabled images in their browser.

Various formatting tips

Main article: Help:Markup

Advanced level

Tables

Tables are an important element of wiki pages. They allow the categorization of data, and if the user has some experience - in a pretty way too.

Tables can be inserted either as HTML code or using the pipe syntax. Below is a description of the table pipe syntax.

  • To begin the table, write {|. HTML parameters like class, style, align etc. can be applied to it: {| class="wikitable" for a wikitable-class table
  • To make a table heading, write !. HTML parameters can be applied to this as well - the syntax will look like this then: ! style="background:red" | Header
  • To make a table row, write |-. HTML parameters can be applied to it.
  • To make a table cell, write |. HTML parameters can be applied to this, the syntax will look like this: | style="background:red" | Cell
  • To close the table, write |}

An example table syntax:

{| class="wikitable"
! Header 1
! Header 2
|-
| Cell 1
| Cell 2
|}

Will produce

Header 1 Header 2
Cell 1 Cell 2


{| class="wikitable"
! style="background:#ffeeee" | Header 1
! style="background:#eeffee" | Header 2
|-
| style="background:#fff7f7" | Cell 1
| style="background:#f7fff7" | Cell 2
|}

Will produce

Header 1 Header 2
Cell 1 Cell 2

Namespaces

Not all wiki pages are articles about Unreal Software and its products. There are many other very different articles such as wiki documentation articles (like this one), template pages, user pages, discussion pages and so on. To differ all those pages there are namespaces.

You may have noticed that this page has the Help namespace. It means this page is an internal documentation page made to help users on different matters inside this wiki, in this case - to tell them how to correctly edit pages.

The namespaces are quite self-explanatory, but despite that fact below is a table of namespaces.

Namespace Purpose
Main (no prefix) General articles
Talk: General article discussion
Help: Wiki documentation
Template: Template pages
Special: System pages
Unreal Software English Wiki: Wiki-related pages
File: Files
Category: Article categories
MediaWiki: MediaWiki engine pages

Templates

Not always one should write page content manually. Some general details on many pages, for the sake of comfort, are turned into templates - quickly insertable elements. Template pages have their own namespace (Template:).

  • To insert a template, write the following:
    {{template}}
    Replace template with actual template name (ex. {{stub}})
  • To add something to a template page without actually including it into the template, surround it with the <noinclude></noinclude> tags.
  • To select the part of a template page that will only be included in that template, surround it with the <includeonly></includeonly> tags.


Templates have variables you can operate with. For example, the {{main}} template has one unnamed variable - the main page name. To enter a variable in a template, the following construction is used:
{{template|var}}
Replace template and var with actual template name and variable respectively.

The variables in a template can also have names to ease the understanding of what's what. Example:

{{template
|foo=Foo
|bar=Bar
}}

To concatenate (insert) a variable ON the template page:

  • If the variable is unnamed - {{{1}}}, {{{2}}} etc.
  • If the variable has a name - {{{foo}}}, {{{bar}}} etc.

HTML

Some HTML tags are also allowed on wiki pages. Below is a list of tags allowed for use with a very short description. For a more detailed documentation please visit various other sites offering detailed description of HTML tags - you won't be needing them unless you're doing a major project/article.

Tag Description
<abbr> Abbreviation (ex. abbr)
<b> Analogue of ''', makes the text bold
<big> Enlarges the font size
<blockquote> Quoted material shown as indented block
<br> Line break
<caption> Table caption
<center> (deprecated) Makes the text inside center-aligned
<cite> Title of a work
<code> Indicates computer code
<dd> Value in a <dl>-marked association list
<dt> Name in a <dl>-marked association list
<em> Analogue of '', makes the text italic
<font> (deprecated) Changes the font style
<h1> - <h6> Analogues of =heading= - ======heading======, different level headings
<hr> Analogue of ----, a horizontal line
<i> Analogue of '', makes the text italic
<ins> Indicates an insertion, makes the text underlined
<kbd> Indicates text to be entered by the user
<li> A list item in an <ol>-ordered or a <ul>-unordered list
<ol> An ordered enumerated list
<p> Indicates a paragraph break
<pre> Indicates a block of pre-formatted text
<rp> Marks Ruby parentheses as an alternative to Ruby annotations
<rt> Marks Ruby annotations
<ruby> Marks Ruby annotations
<samp> Sample output, used when showing a program or a script output
<s> Indicates a no longer relevant or valid text, makes it striked
<small> Diminishes the font size
<span> A division of text, usually presented inline with surrounding text
<strong> Analogue of ''', makes the text bold.
<sub> Indicates asubscript
<sup> Indicates asuperscript
<table> Creates a table
<td> Table data cell
<th> Table header cell (shown bold and centered)
<tr> Contains a row of cells
<u> Indicates a non-textual annotation, makes the text underlined
<ul> An unordered bulleted list
<var> Indicates a variable, makes the text italic
<!-- ... --> A comment, only visible when editing the source code

Conclusion

Now, after reading through (hopefully) this guide, you should know most of the things needed to know for an editor to create and edit pages. The Unreal Software English Wiki community wishes you to become one among the best, if not the best on this wiki. Good luck!

See also

Some other links that may prove useful when editing or creating articles:

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox