Help:Editing

From 2d4chan
Jump to navigation Jump to search

Basic text formatting[edit source]

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: Example
- Four tildes give your signature plus date/time: Example 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:
- Three tildes gives your
signature: ~~~
- Four tildes give your 
signature plus date/time: ~~~~
- Five tildes gives the 
date/time alone: ~~~~~

HTML tags[edit source]

You can use some HTML tags too. For a list of HTML tags that are allowed, see Wikipedia's HTML in wikitext help page. In general, you should avoid HTML in favor of Wiki markup whenever possible (see that Wikipedia help page for Wiki markup equivalents to permitted HTML elements, where they exist), as there are already wiki commands for italics, bolding, tables, and other nice things (look on this page for more specifics), and using HTML is much more prone to error. That said, there are some HTML commands that are useful when editing a wiki, especially on templates (it's usually better to do encapsulate the (relatively) tricky HTML in an easier-to-use template, which can be transcluded in articles).


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.

Please, be very sparing in your use of the strikethrough tag.

The "span" element can also be used to modify the font, size, and color of text. 

<strike>Strike out</strike>
or <u>underline</u> text,
or write it <span style=
"font-variant:small-caps">
in small caps</span>.

The "span" element can also be used to modify the
<span style="font-family:serif;">font</span>,
<span style="font-size:150%;">size</span>,
and <span style="color:#33aa33;">color</span> of text.

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.
  • Because the comment and anything inside it will be "snipped out" of the page before it gets passed to the renderer, comments can be used judiciously to insert spacing in the source code of a page (to make it easier for editors to read) without affecting the page's final appearance. See, for example, the lists section in Organizing your writing.
 
Invisible comments to editors (&lt;!-- --&gt;)
appear only while editing the page.
<!-- Note to editors: blah blah blah. -->

Line breaks
can be inserted
with <br> or <br/>

These line breaks can be used to get line breaks in the rendered page without inserting carriage returns into the source code, which is useful for things like lists, where carriage returns interrupt the list numbering (to get white space in the code without interrupting the list, use HTML comments -- or use both, to get line breaks in the rendered page and white space in the code). 

Line breaks<br>can be inserted<br/>with &lt;br&gt; or &lt;br/&gt;

Organizing your writing[edit source]

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.
  • And you can space out the code with HTML comments.

While it can be tempting for editors to double-return between every bullet in the list, as it makes the list easier for them to read in the editing window, this breaks up each entry into its own list of one element. This does not look unusual on the page, but it makes the page difficult to understand for vision-impaired users with screen readers, as the screen reader will read every entry as its own list (e.g. "List begins. One item. [Item.] List ends. List begins. One item. [Item.] List ends. List begins..."). If items in a list get overly long, and there is a need to separate them in the editing window, the proper way to do this is to insert an HTML comment (<!-- ... -->) that begins at the end of one item and ends on the line before the next. A comment can also be inserted into a single item in a list to accomplish the same thing, but then there should not be a new line at the end of the comment. An arbitrary number of lines and spaces can be inserted into the comment to space the items apart in the editing window, but by keeping them inside the comment, the wiki parser will strip them out before parsing the page into HTML, so the list items are kept as one continuous list. 

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

                -->
* And you can space out the code <!--


--> with HTML comments.

(I inserted the spaces before the end
of the comment right there so that the
left edge of the page would have a
clear break in it between list items.)
  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.[1]
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/>

In certain areas you may want to take advantage of collapsible text.

Collapsible text is quite versatile.
Content can be hidden upon first load
or presented in tables or other forms.

This text is not collapsible; but the next is collapsible and hidden by default: 

<div class="toccolours mw-collapsible">
In certain areas you may want to take advantage of 
[collapsible text].
</div>

{| class="mw-collapsible mw-collapsed wikitable"
! Collapsible text || is quite versatile.
|-
| Content can be || hidden upon first load
|-
| or presented in || tables or other forms. 
|}

<div class="toccolours mw-collapsible mw-collapsed">
This text is not collapsible; but the next is 
collapsible and hidden by default:
<div class="mw-collapsible-content">You can use the 
possibility of presenting or hiding content to allow 
page readers to quickly access detailed information.
</div>
</div>

Links[edit source]

Main article: Help:Link

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 Troll. You can even say trolls and the link will show up correctly. 

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

You can put formatting around a link. Example: Space Marines. 

You can put formatting around a link.
Example: ''[[Space Marines]]''.

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

The ''first letter'' of articles is automatically
capitalized, so [[space Marines]] goes to the same place
as [[Space Marines]]. 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:

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:

* [[Twilight#Quotes]].

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 [[Help:Piped link|piped link]]. Put the link
target first, then the pipe character "|", then
the link text.

* [[Help:Link|About Links]]
* [[Twilight#Quotes|Twilight quotes]]

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

* [[Rogue Trader (Sourcebook)|]]

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

You can give it a title: Nupedia

Or leave the title blank: [1]

External link can be used to link to a wiki page that cannot be linked to with [[page]]: http://meta.wikimedia.org/w/index.php?title=Fotonotes&oldid=482030#Installation 

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

You can give it a title:
[http://www.nupedia.com Nupedia]

Or leave the title blank:
[http://www.nupedia.com]

External link can be used to link to a wiki page that
cannot be linked to with [[page]]:
http://meta.wikimedia.org/w/index.php?title=Fotonotes
&oldid=482030#Installation

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:Space Marines

You can use pipes in Category links as well. The text after the pipe is the title that will be displayed in the Category page. This is useful if the page title starts with "The" or a Campaign namespace prefix, for example. 

[[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:English documentation]]

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

You can use pipes in Category links as well. The text after
the pipe is the title that will be displayed in the Category
page.  This is useful if the page title starts with "The"
or a Campaign namespace prefix, for example.

Just show what I typed[edit source]

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 [[Wiki]]
 ''markup'' and special
 characters: &rarr;

Images, tables, video, and sounds[edit source]

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, see:

What it looks like What you type

A picture, including alternate text:

This Wiki's logo

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

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

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

The image in a thumbnail with a caption:
[[Image:Comissar.png|thumb|This Wiki's logo]]

The following lets you change how images appear on the page:

  • 000px is added to the code defining an image on the page. The zeroes are replaced by a number, which determines the width of a picture in pixels, scaling the height proportionally. Making a picture more than 500 pixels wide will mess with the text or people with smaller screens, so use such excessively wide pictures only with good reason. If you add an "x" in front of the number (so instead of 300px you have x300px) the picture will instead be that number of pixtures tall and scales the width accordingly. Defining width makes it easier to predict how large a picture will be, so in all but a few cases that is used.
  • thumb is used to create thumbnails; this puts a frame aroudn the picture and allows for a caption to be added. frame does the same thing, but thumb is the standard.
  • left, center, right are all used to align a picture on the page: on the left, in the center or in the right. Pictures preferrably go on the right side of the page, unless this would mess up the vertical alignment of the picture, in which case it goes on the left. Centered images are preferrably not used because the text on the page does not wrap around it. As such, these are mostly used to center icons at the top of the page in some cases like the Tau page.

Adding this code is a matter of adding vertical lines like this one: | to divide the code. An exaple of this:

Image:Comissar.png|300px|thumb|right|This is a caption.

There is no requirement on the software to put the sections in any order nor are there strict guidelines, but something like the above is preferred for ease of editing. 

The following lets you change how images appear on the page:

*''000px'' is added to the code defining an image on the page. The zeroes are replaced by a number, which determines the width of a picture in pixels, scaling the height proportionally. Making a picture more than 500 pixels wide will mess with the text or people with smaller screens, so use such excessively wide pictures only with good reason. If you add an "x" in front of the number (so instead of 300px you have x300px) the picture will instead be that number of pixtures tall and scales the width accordingly. Defining width makes it easier to predict how large a picture will be, so in all but a few cases that is used.
*''thumb'' is used to create thumbnails; this puts a frame aroudn the picture and allows for a caption to be added. ''frame'' does the same thing, but ''thumb'' is the standard.
*''left'', ''center'', ''right'' are all used to align a picture on the page: on the left, in the center or in the right. Pictures preferrably go on the right side of the page, unless this would mess up the vertical alignment of the picture, in which case it goes on the left. Centered images are preferrably not used because the text on the page does not wrap around it. As such, these are mostly used to center icons at the top of the page in some cases like the [[Tau]] page.

Adding this code is a matter of adding vertical lines like this one: | to divide the code. An exaple of this:

Image:Comissar.png|300px|thumb|right|This is a caption.

There is no requirement on the software to put the sections in any order nor are there strict guidelines, but something like the above is preferred for ease of editing.

A link to Wikipedia's page for the image: Image:Comissar.png

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

A link to Wikipedia's page for the image:
[[:Image:Comissar.png]]

Or a link directly to the image itself:
[[Media:Comissar.png]]

Use media: links to link directly to sounds or videos: A sound file 

Use '''media:''' links to link
directly to sounds or videos:
[[media:Classical guitar scale.ogg|A sound file]]
This is
SPAR TA! 
{| border="1" cellspacing="0" cellpadding="5" align="center"
! This
! is
|- 
| SPAR
| TA!
|-
|}

Templates[edit source]

Templates are segments of Wiki markup that are meant to be copied automatically ("transcluded") into a page. You add them by putting the template's name in {{double braces}}. It is also possible to transclude other pages by using {{:colon and double braces}}.

Some templates take parameters, as well, which you separate with the pipe character.

What it looks like What you type 
{{Heresy}}

The colon is important! Heresy is a long article, hence the collapsible block. Notice that the parent page is now included in the same categories as the transcluded page is, which may be a useful feature. Finally, the background of this article is a pale blue color; that's from the collapsible block, not the article itself or the transclusion process. 

{{:Heresy}}

This template takes up to two parameters, turning it into the /tg/-default-colored Name and Trip fields. Not filling in the parameters simply gives a stylized "Anonymous."

Anonymous

Namefriend

Tripfriend !a159753zD 

This template takes up to two parameters, 
turning it into the /tg/-default-colored 
Name and Trip fields. Not filling in the 
parameters simply gives a stylized "Anonymous."

{{Anonymous}}

{{Anonymous|Namefriend}}

{{Anonymous|Tripfriend|!a159753zD}}
This Wiki's logo
Using the Clear template inserts a blank line in the text. This means that across the entire width of the screen a blank line will be included. This is useful if you want to center templates at the bottom of the screen or want to align text with images. Headers are put below the template as well.
For example, this text is typed after the Clear template. 
{{Clear}}
Retrieved from "http://2d4chan.org/mediawiki/index.php?title=Help:Editing&oldid=582653"