Help:Editing: Difference between revisions

From OniGalore
Jump to navigation Jump to search
(→‎Interwiki links: adding API link to get actual interwiki list from our wiki)
(minor rewrite; added sections for basic formatting, images and categories (shocking that we never had these before now))
Line 1: Line 1:
:'''After reading this page, please see our rules on the [[OniGalore:Policy]] page.'''
:''After reading this page, please see our rules on the [[OniGalore:Policy]] page.''


==Editing OniGalore==
We won't be giving a detailed course on MediaWiki markup here; just a few basic "how to"s, "do"s and "don't"s that will mostly get you by, when it comes to our wiki. For more details, see the section [[#Further Help|Further Help]] below. Wikimedia's general [http://meta.wikimedia.org/wiki/Help:Help Help] is also available in [http://meta.wikimedia.org/wiki/Aiuto:Aiuto Italian] and [http://meta.wikimedia.org/wiki/Помощь:Помощь Russian], as well as many other languages. That is where you'll find the most detailed info on the MediaWiki software.
We won't be giving a detailed course on MediaWiki markup here; just a few basic "how to"s, "do"s and "don't"s that will mostly get you by, when it comes to our wiki. For more details, see the section [[#Further Help|Further Help]] below.


Wikimedia's general [http://meta.wikimedia.org/wiki/Help:Help Help] is also available in [http://meta.wikimedia.org/wiki/Aiuto:Aiuto Italian] and [http://meta.wikimedia.org/wiki/Помощь:Помощь Russian], as well as Greek and French and Slovenian. That is where you'll find the most up-to-date info on the MediaWiki software.
==Text formatting==
===Common formatting===
The most common way to emphasize or set apart some text in a line is to use apostrophes to create italicized and bold text:<br />
<code><nowiki>''Using two''</nowiki></code> will give you ''italics''.<br />
<code><nowiki>'''Using three'''</nowiki></code> will give you '''bold'''.


===Links===
Underlining text is not as convenient; it requires you to fall back to raw HTML markup:<br />
Basically, there are thee types of links: 1) links to external pages and files; 2) intralinks to other pages on the wiki; 3) interwiki links.
<code><nowiki><u>Here's the underline tag</u></nowiki></code> gives you <u>Here's the underline tag</u>.


====External links====
Finally, although we have not been in the habit of using it on OniGalore, you can highlight text with the mark tag:<br />
<code><nowiki><mark>Pay attention</mark></nowiki></code> yields <mark>Pay attention</mark>.
 
===Monospace and unformatted text===
This line actually starts with a " " character. It is rendered in a box, with a fixed-size font.
 
Do this for several lines to set apart a whole block of text (e.g., programming code).
The previous line is only empty in the rendered box; if you edit this page, you'll see the " " character in the wiki markup.
 
You can still put text in ''italics'', '''bold''', or '''''bold italics'''''.
However, leading "*", "#", ":" and ";" won't work :
*bla
#bla
;bla
:bla
 
:For regular indentation (like this line), you should start the line with ":" as shown below.
 
There are several other options, the <nowiki><pre></nowiki>, <nowiki><tt></nowiki>, <nowiki><code></nowiki>, and <nowiki><nowiki></nowiki> tags, which will not be discussed in-depth here, but play around with them to see how they behave slightly differently from each other.
 
==Line formatting==
Everyone likes lists. Below are four methods for listing items, but there are also buttons available in the toolbar that make it faster to create these lists than typing the markup by hand. See the documentation for [[XEB]] to learn about the toolbar buttons.
 
'''Normal newlines'''<br />
A quirk of wiki markup is that two consecutive lines will be displayed as one line. In other words, a single newline is ignored. This actually goes back to the fact that wiki markup is based on HTML, which behaves the same way. Instead of hitting Return once to start a new line, you need to hit it twice. Alternately, you can force a linebreak at any time with the <nowiki><br /></nowiki> tag.
 
'''Numbered lists'''<br />
#This line actually begins with a "#" character.
##This line actually begins with two "#" characters.
##So does this one.
#Here's the next single-"#" line.
 
'''Bulleted lists'''<br />
*This line actually begins with a "*" character.
**This line begins with two "*" characters.
 
'''Indented paragraphs'''<br />
:This line begins with a ":" character. The whole paragraph will wrap around using this indentation.
:When starting a second indented line, you don't need to put an extra newline after the previous line like you normally would.
::The more ":"s you put at the start of the line, the more indentation you get.
 
'''Titled paragraphs'''<br />
;This line starts with a ";"
:Starting the next line with a ":" creates the impression of a paragraph under a title, useful for typesetting word definitions, dialogue lines, etc.
 
==Links==
Basically, there are thee types of links: (1) links to external pages and files, (2) intrawiki links to other pages on the wiki, and (3) interwiki links.
 
===External links===
(1a) Write the following to get some text acting as an ''outgoing'' hyperlink.
(1a) Write the following to get some text acting as an ''outgoing'' hyperlink.
  '''['''<nowiki>http://oni.bungie.org/community/forum/ here is our forum</nowiki>''']'''
  '''['''<nowiki>http://oni.bungie.org/community/forum/ here is our forum</nowiki>''']'''
The result is: [http://oni.bungie.org/community/forum/ here is our forum]
The result is: [http://oni.bungie.org/community/forum/ here is our forum]


(1b) If you omit the alternative text, the result will be different:
(1b) If you omit the label text, the result will be different:
  Here '''['''<nowiki>http://oni.bungie.org/community/forum/</nowiki>''']''' is our forum
  Here '''['''<nowiki>http://oni.bungie.org/community/forum/</nowiki>''']''' is our forum
The result is: here [http://oni.bungie.org/community/forum/] is our forum
The result is: here [http://oni.bungie.org/community/forum/] is our forum. However, this is not part of our usual style on this wiki. You should always label your links.


(1c) You can also write URLs without any markup. Like this:
(1c) You can also write URLs without any markup. Like this:
:Here is our forum: http://oni.bungie.org/community/forum/
:Here is our forum: http://oni.bungie.org/community/forum/
Note that images will appear inline if you do that.
Note that external images will appear inline if you use their bare URL like this.


====Intralinks====
===Intrawiki links===
(2a) Write the following to get an ''intrawiki'' link to one of our own pages.
(2a) Write the following to get an ''intrawiki'' link to one of our own pages:
  '''[['''<nowiki>Quotes/Consoles#STURMANDERUNG_:_Final_Stage</nowiki>''']]'''
  '''[['''<nowiki>Quotes/Consoles#STURMANDERUNG_:_Final_Stage</nowiki>''']]'''
The result is this: [[Quotes/Consoles#STURMANDERUNG_:_Final_Stage]]
The result is this: [[Quotes/Consoles#STURMANDERUNG_:_Final_Stage]]


(2b) Write following to get an ''intrawiki'' link which is fixed to some text
(2b) Write following to get an ''intrawiki'' link which is labeled with some text:
  '''[['''<nowiki>OniSplit#Download_links</nowiki>'''|'''<nowiki>here you can download onisplit</nowiki>''']]'''
  '''[['''<nowiki>OniSplit#Download_links</nowiki>'''|'''<nowiki>here you can download onisplit</nowiki>''']]'''
The result is this: [[OniSplit#Download_links|You can download OniSplit here]]
The result is this: [[OniSplit#Download_links|You can download OniSplit here]]


This kind of link (2a/2b) spares you from writing '''<nowiki>http://wiki.oni2.net/</nowiki>'''<font style="color:#777">OniSplit#Download_links</font>
This kind of link (2a/2b) spares you from writing '''<nowiki>http://wiki.oni2.net/</nowiki>OniSplit#Download_links'''


====Interwiki links====
===Interwiki links===
You can link to pages on [http://en.wiktionary.org Wiktionary], the [http://en.wiktionary.org English Wikipedia] and [http://meta.wikimedia.org Meta-Wiki] as if they were pages of our own wiki, using the prefixes '''<nowiki>[[wiktionary:]]</nowiki>''', '''<nowiki>[[wikipedia:]]</nowiki>''' and '''<nowiki>[[metawikipedia:]]</nowiki>'''. The complete list of currently supported interwiki links can be obtained by clicking [http://wiki.oni2.net/w/api.php?action=query&meta=siteinfo&siprop=interwikimap here].
You can link to pages on [http://en.wiktionary.org Wiktionary], the [http://en.wiktionary.org English Wikipedia] and [http://meta.wikimedia.org Meta-Wiki] as if they were pages of our own wiki, using the prefixes '''<nowiki>[[wiktionary:]]</nowiki>''', '''<nowiki>[[wikipedia:]]</nowiki>''' and '''<nowiki>[[metawikipedia:]]</nowiki>'''. The complete list of currently supported interwiki links can be obtained by clicking [http://wiki.oni2.net/w/api.php?action=query&meta=siteinfo&siprop=interwikimap here].


====Templates and transclusion====
==Images and categories==
Text can be "transcluded" from one place on the wiki to another using <nowiki>{{this markup}}</nowiki>. Transclusion means that whenever the original text is updated, so is the text inserted in place of the page link enclosed in double-braces.  Transclusion is most commonly used in order to place templates on a page.  Here's [[:Category:Templates|a list of templates]]. Pick one, and then click on "What links here" once you're on the template page. You should see a list of pages, each one probably followed by "(transclusion)".  Look at the wiki code for those pages to see how the template's text or markup was placed into the page.
To place an image, you type its name inside of double brackets, preceded by "Image:", e.g. <code><nowiki>[[Image:TXMPPOSTER3.png]]</nowiki></code>. This markup will be replaced by the named image. If you only want to link to the page of an image, you type <code><nowiki>[[:Image:TXMPPOSTER3.png]]</nowiki></code> to get [[:Image:TXMPPOSTER3.png]].
 
Templates are not a special kind of wiki page; they're simply a term that we use to refer to pages that are meant to be transcluded.  Templates usually provide a standardized format for something like a [[:Template:Chapters|table]], or else they supply a standard [[:Template:Cleanup|header]] or [[:Template:OBD_File_Footer|footer]].  You should familiarize yourself with the templates if you plan to do a decent amount of editing; they are not only timesavers, they also help editors make their edits fit in with OniGalore standards, and make it easier to change large amounts of wiki text at once.


===Various tips===
Categories work the same way. Every page on the wiki should be placed into at least one category using this kind of markup at the end of the page: <code><nowiki>[[Category:Policies and documentation]]</nowiki></code>. This will cause the name of the category to appear at the bottom of the page. However, if you only want to link to a category page, not place the current page into that category, you use the same technique as linking to an image page: <code><nowiki>[[:Category:Policies and documentation]]</nowiki></code> gives you [[:Category:Policies and documentation]]. To see what categories are available, you can look at the [[Site Map]].
====Line formatting====
Everyone likes lists. Below are four methods for listing items, but there are also buttons available in the toolbar that make it faster to create these lists than typing the markup by hand. See the documentation for [[XEB]] to learn about the toolbar buttons.


'''Numbered lists'''<br />
==Templates and transclusion==
#This line actually begins with a "#" character
Text can be "transcluded" from one place on the wiki to another using <nowiki>{{this markup}}</nowiki>. Transclusion means that whenever the original text is updated, so is the text inserted in place of the page link enclosed in double-braces. Transclusion is most commonly used in order to place templates on a page. Here's [[:Category:Templates|a list of templates]]. Pick one, and then click on "What links here" once you're on the template page.  You should see a list of pages, each one probably followed by "(transclusion)".  Look at the wiki code for those pages to see how the template's text or markup was placed into the page.
##This line actually begins with two "#" characters
###This line actually begins with three "#" characters
###This line actually begins with three "#" characters
##This line actually begins with two "#" characters
#This line actually begins with a "#" character
 
'''Bulleted lists'''<br />
*This line actually begins with a "*" character
**This line actually begins with two "*" characters
***This line actually begins with three "*" characters
**This line actually begins with two "*" characters
*This line actually begins with a "*" character
 
'''Indented paragraphs'''<br />
:This line actually begins with a ":" character. The whole paragraph will wrap around indented; it all has to be on the same line, though.
:To start a new paragraph indented the same way, just start another line with a ":"<br>You can also use the <nowiki><br></nowiki> tag to start a new line.
::Put "::" at the start of the line to indent more.
:::Put ":::" at the start of the line to indent even more.
(actually, it's a lot like tabulation)
 
'''Definitions (titled paragraphs)'''<br />
;This line starts with a ";"
;This one too, but:it switched to indented text when it encountered a ":" (have a look at the markup).
This allows one to typeset definitions, dialogue lines etc rather easily. You can also use it as a quick way to put a line in bold.
*the advantage of the leading ";" is that you don't have to bother about the extra new line before the bold-faced line
*the drawback is that the line can't contain a ":" unless you escape it (e.g. with the <nowiki><nowiki></nowiki> tag).
;Like this <nowiki>: ":"</nowiki>
 
"Definitions" can occur within an already indented paragraph :
:bla
::bla
::;BLA:bla
::bla
:bla
Custom indentation only works flawlessly when you use nothing but ":"; the ";" is a bit limited.
 
===Unformatted ASCII===
  This line actually starts with a " " character. It is rendered in a box, with a fixed-size font.


Do this for several lines to set apart a whole block of text (e.g., programming code).
Templates are not a special kind of wiki page; they're simply a term that we use to refer to pages that are meant to be transcludedTemplates usually provide a standardized format for something like a [[:Template:Chapters|table]], or else they supply a standard [[:Template:Cleanup|header]] or [[:Template:OBD_File_Footer|footer]].  You should familiarize yourself with the templates if you plan to do a decent amount of editing; they are not only time-savers, they also help editors make their edits fit in with OniGalore standards, and make it easier to change large amounts of wiki text at once.
The previous line is only empty in the rendered box; in the markup, there's a " " character.
    This one begins with 5 leading spaces in the markup; only 4 are there when rendered.
  You can still put text in ''italics'', '''bold''', or '''''bold italics'''''.
However, leading "*", "#", ":" and ";" won't work :
*bla
#bla
;bla
:bla
Bottom line : be careful when you use leading spaces in your text : is that ''really'' what you want?
:For regular indentation (like this line), prefer ":".


==Further Help==
==Further help==
Here's some more comprehensive help, straight from the source.
Here's some more comprehensive help, straight from the source.



Revision as of 03:32, 3 August 2017

After reading this page, please see our rules on the OniGalore:Policy page.

We won't be giving a detailed course on MediaWiki markup here; just a few basic "how to"s, "do"s and "don't"s that will mostly get you by, when it comes to our wiki. For more details, see the section Further Help below. Wikimedia's general Help is also available in Italian and Russian, as well as many other languages. That is where you'll find the most detailed info on the MediaWiki software.

Text formatting

Common formatting

The most common way to emphasize or set apart some text in a line is to use apostrophes to create italicized and bold text:
''Using two'' will give you italics.
'''Using three''' will give you bold.

Underlining text is not as convenient; it requires you to fall back to raw HTML markup:
<u>Here's the underline tag</u> gives you Here's the underline tag.

Finally, although we have not been in the habit of using it on OniGalore, you can highlight text with the mark tag:
<mark>Pay attention</mark> yields Pay attention.

Monospace and unformatted text

This line actually starts with a " " character. It is rendered in a box, with a fixed-size font.
Do this for several lines to set apart a whole block of text (e.g., programming code).

The previous line is only empty in the rendered box; if you edit this page, you'll see the " " character in the wiki markup.
You can still put text in italics, bold, or bold italics.
However, leading "*", "#", ":" and ";" won't work :
*bla
#bla
;bla
:bla
For regular indentation (like this line), you should start the line with ":" as shown below.

There are several other options, the <pre>, <tt>, <code>, and <nowiki> tags, which will not be discussed in-depth here, but play around with them to see how they behave slightly differently from each other.

Line formatting

Everyone likes lists. Below are four methods for listing items, but there are also buttons available in the toolbar that make it faster to create these lists than typing the markup by hand. See the documentation for XEB to learn about the toolbar buttons.

Normal newlines
A quirk of wiki markup is that two consecutive lines will be displayed as one line. In other words, a single newline is ignored. This actually goes back to the fact that wiki markup is based on HTML, which behaves the same way. Instead of hitting Return once to start a new line, you need to hit it twice. Alternately, you can force a linebreak at any time with the <br /> tag.

Numbered lists

  1. This line actually begins with a "#" character.
    1. This line actually begins with two "#" characters.
    2. So does this one.
  2. Here's the next single-"#" line.

Bulleted lists

  • This line actually begins with a "*" character.
    • This line begins with two "*" characters.

Indented paragraphs

This line begins with a ":" character. The whole paragraph will wrap around using this indentation.
When starting a second indented line, you don't need to put an extra newline after the previous line like you normally would.
The more ":"s you put at the start of the line, the more indentation you get.

Titled paragraphs

This line starts with a ";"
Starting the next line with a ":" creates the impression of a paragraph under a title, useful for typesetting word definitions, dialogue lines, etc.

Links

Basically, there are thee types of links: (1) links to external pages and files, (2) intrawiki links to other pages on the wiki, and (3) interwiki links.

External links

(1a) Write the following to get some text acting as an outgoing hyperlink.

[http://oni.bungie.org/community/forum/ here is our forum]

The result is: here is our forum

(1b) If you omit the label text, the result will be different:

Here [http://oni.bungie.org/community/forum/] is our forum

The result is: here [1] is our forum. However, this is not part of our usual style on this wiki. You should always label your links.

(1c) You can also write URLs without any markup. Like this:

Here is our forum: http://oni.bungie.org/community/forum/

Note that external images will appear inline if you use their bare URL like this.

Intrawiki links

(2a) Write the following to get an intrawiki link to one of our own pages:

[[Quotes/Consoles#STURMANDERUNG_:_Final_Stage]]

The result is this: Quotes/Consoles#STURMANDERUNG_:_Final_Stage

(2b) Write following to get an intrawiki link which is labeled with some text:

[[OniSplit#Download_links|here you can download onisplit]]

The result is this: You can download OniSplit here

This kind of link (2a/2b) spares you from writing http://wiki.oni2.net/OniSplit#Download_links

Interwiki links

You can link to pages on Wiktionary, the English Wikipedia and Meta-Wiki as if they were pages of our own wiki, using the prefixes [[wiktionary:]], [[wikipedia:]] and [[metawikipedia:]]. The complete list of currently supported interwiki links can be obtained by clicking here.

Images and categories

To place an image, you type its name inside of double brackets, preceded by "Image:", e.g. [[Image:TXMPPOSTER3.png]]. This markup will be replaced by the named image. If you only want to link to the page of an image, you type [[:Image:TXMPPOSTER3.png]] to get Image:TXMPPOSTER3.png.

Categories work the same way. Every page on the wiki should be placed into at least one category using this kind of markup at the end of the page: [[Category:Policies and documentation]]. This will cause the name of the category to appear at the bottom of the page. However, if you only want to link to a category page, not place the current page into that category, you use the same technique as linking to an image page: [[:Category:Policies and documentation]] gives you Category:Policies and documentation. To see what categories are available, you can look at the Site Map.

Templates and transclusion

Text can be "transcluded" from one place on the wiki to another using {{this markup}}. Transclusion means that whenever the original text is updated, so is the text inserted in place of the page link enclosed in double-braces. Transclusion is most commonly used in order to place templates on a page. Here's a list of templates. Pick one, and then click on "What links here" once you're on the template page. You should see a list of pages, each one probably followed by "(transclusion)". Look at the wiki code for those pages to see how the template's text or markup was placed into the page.

Templates are not a special kind of wiki page; they're simply a term that we use to refer to pages that are meant to be transcluded. Templates usually provide a standardized format for something like a table, or else they supply a standard header or footer. You should familiarize yourself with the templates if you plan to do a decent amount of editing; they are not only time-savers, they also help editors make their edits fit in with OniGalore standards, and make it easier to change large amounts of wiki text at once.

Further help

Here's some more comprehensive help, straight from the source.

Reading
Go | Search | Stop words | URL | Namespace | Page name | Section
Backlinks | Link | Piped link | Interwiki link | Redirect | Category | Image page
Logging in and preferences
Logging in | Preferences | User style
Editing
Advanced editing | Editing FAQ | Edit toolbar | Export | Import | Shortcuts
Tracking changes
Recent changes (enhanced) | Related changes | Watching pages | Diff
Page history | Edit summary | User contributions | Minor edit | Patrolled edit
Style & formatting
Wikitext examples | Reference card | HTML in wikitext | List | Table | Sorting | Colors
Special input and output
Inputbox | Special characters | Displaying a formula | Images (uploads) | EasyTimeline
Advanced functioning
Template | Advanced templates | Parser function | ParserFunctions | Parameter default
Variable | Magic word | System message | Substitution | Array | Calculation
Page management
Starting a new page | Renaming (moving) a page | Protecting pages | Deleting a page
Special pages
Talk page | Testing | Sandbox