Help:Editing: Difference between revisions

From OniGalore
Jump to navigation Jump to search
m (Somewhat better)
(→‎Interwiki links: adding API link to get actual interwiki list from our wiki)
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Merging this with [[Help:Editing]] some time soon.
:'''After reading this page, please see our rules on the [[OniGalore:Policy]] page.'''
==Editing==
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.


For generalities on how to use a MediaWiki-powered wiki, you're encouraged to have a look [http://meta.wikimedia.org/wiki/Help:Help HERE]
==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.


(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).
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.


===Links===
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.


----
====External links====
----
(1a) Write the following to get some text acting as an ''outgoing'' hyperlink.
==Recommended==
'''['''<nowiki>http://oni.bungie.org/community/forum/ here is our forum</nowiki>''']'''
===Preview===
The result is: [http://oni.bungie.org/community/forum/ here is our forum]
:Use the "Show preview" button ''as much as possible'' before submitting. Sure, even experienced and good-willing users (like [[User:geyser|me]]) make a few edits in a row sometimes (because they think a page is done and submit it, and ''then'' go through it again and spot a typo or something), but that's nothing compared to the dozens of edits made by someone who's totally oblivious of the preview feature.
===Templates and transclusion===
More, later. Transclusion may be a bit tricky to figure out at first, but it's well worth it.
===Uploaded files===
There is no such thing as folders (just "Categories"), so keep in mind all the images go into ''one big folder''. Also, an image can't be renamed or moved in the same way a regular page can.


Therefore, please give your images the most explicit, unique, unambiguous name you can think of.
(1b) If you omit the alternative text, the result will be different:
;Like:[[:Image:GUIDO Hikari closeup.jpg|GUIDO Hikari closeup.jpg]]
Here '''['''<nowiki>http://oni.bungie.org/community/forum/</nowiki>''']''' is our forum
;NOT like:[[:Image:August4_2006.jpg|August4_2006.jpg]]
The result is: here [http://oni.bungie.org/community/forum/] is our forum
^^


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


----
====Intralinks====
----
(2a) Write the following to get an ''intrawiki'' link to one of our own pages.
==Various tips==
'''[['''<nowiki>Quotes/Consoles#STURMANDERUNG_:_Final_Stage</nowiki>''']]'''
===Line formatting===
The result is this: [[Quotes/Consoles#STURMANDERUNG_:_Final_Stage]]
====Numbered lists====
 
(2b) Write following to get an ''intrawiki'' link which is fixed to some text
'''[['''<nowiki>OniSplit#Download_links</nowiki>'''|'''<nowiki>here you can download onisplit</nowiki>''']]'''
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>
 
====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].
 
====Templates and transclusion====
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.
 
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===
====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 />
#This line actually begins with a "#" character
#This line actually begins with a "#" character
##This line actually begins with two "#" characters
##This line actually begins with two "#" characters
Line 35: Line 52:
##This line actually begins with two "#" characters
##This line actually begins with two "#" characters
#This line actually begins with a "#" character
#This line actually begins with a "#" character
====Bulleted lists====
 
'''Bulleted lists'''<br />
*This line actually begins with a "*" character  
*This line actually begins with a "*" character  
**This line actually begins with two "*" characters  
**This line actually begins with two "*" characters  
Line 41: Line 59:
**This line actually begins with two "*" characters
**This line actually begins with two "*" characters
*This line actually begins with a "*" character
*This line actually begins with a "*" character
====Indented paragraphs====
 
'''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.
: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.
: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.
Line 47: Line 66:
:::Put ":::" at the start of the line to indent even more.
:::Put ":::" at the start of the line to indent even more.
(actually, it's a lot like tabulation)
(actually, it's a lot like tabulation)
====Definitions (titled paragraphs)====
 
'''Definitions (titled paragraphs)'''<br />
;This line starts with a ";"
;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 one too, but:it switched to indented text when it encountered a ":" (have a look at the markup).
Line 55: Line 75:
;Like this <nowiki>: ":"</nowiki>
;Like this <nowiki>: ":"</nowiki>


"Definitions" occur within an already indented paragraph :
"Definitions" can occur within an already indented paragraph :
:bla
:bla
::bla
::bla
Line 61: Line 81:
::bla
::bla
:bla
:bla
Custom indentation only works flawlessly when you use nothing but ":"; the ";" is a bit limited.
===Unformatted ASCII===
===Unformatted ASCII===
  This line actually starts with a " " character. It is rendered in a box, with a fixed-size font.
  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.
  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; in the markup, there's a " " character.
  The previous line is only empty in the rendered box; in the markup, there's a " " character.
     This one begind with 5 leading spaces in the markup; only 4 are visible when rendered.
     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'''''.
  You can still put text in ''italics'', '''bold''', or '''''bold italics'''''.
  However, leading "*", "#", ":" and ";" won't work :
  However, leading "*", "#", ":" and ";" won't work :
Line 74: Line 96:
  ;bla
  ;bla
  :bla
  :bla
Bottom line : be careful when you use leading spaces : is that really what you want?
Bottom line : be careful when you use leading spaces in your text : is that ''really'' what you want?
For regular indentation, prefer ":".
:For regular indentation (like this line), prefer ":".
===Smileys===
Because of the line formatting, one should be careful with putting smileys on a new line. The following are examples of smileys that work fine :
 
^_^
 
^^
 
=)
 
%)


":)" and ";)", however, won't work on a new line. Neither will " :)" and " ;)".
==Further Help==
Here's some more comprehensive help, straight from the source.


One solution is to avoid such smilies altogether. You can also use these (add three leading "'"s) :
;[[metawikipedia:Help:Reader|Reading]]
:[[metawikipedia:Help:Go button|Go]] | [[metawikipedia:Help:Searching|Search]] | [[metawikipedia:Help:Common words, searching for which is not possible|Stop words]] | [[metawikipedia:Help:URL|URL]] | [[metawikipedia:Help:Namespace|Namespace]] | [[metawikipedia:Help:Page name|Page name]] | [[metawikipedia:Help:Section |Section]]
:[[metawikipedia:Help:What links here|Backlinks]] | [[metawikipedia:Help:Link|Link]] | [[metawikipedia:Help:Piped link|Piped link]] | [[metawikipedia:Help:Interwiki linking|Interwiki link]] | [[metawikipedia:Help:Redirect|Redirect]] | [[metawikipedia:Help:Category|Category]] | [[metawikipedia:Help:Image page|Image page]]
;Logging in and preferences
:[[metawikipedia:Help:Logging in|Logging in]] | [[metawikipedia:help:Preferences|Preferences]] | [[metawikipedia:help:User style|User style]]
;[[metawikipedia:Help:Editing|Editing]]
:[[metawikipedia:Help:Advanced editing|Advanced editing]] | [[metawikipedia:Help:Editing FAQ|Editing FAQ]] | [[metawikipedia:Help:Edit toolbar|Edit toolbar]] | [[metawikipedia:Help:Export|Export]] | [[metawikipedia:Help:Import|Import]] | [[metawikipedia:Help:Editing shortcuts|Shortcuts]]
;[[metawikipedia:Help:Tracking changes|Tracking changes]]
:[[metawikipedia:Help:Recent changes|Recent changes]] <small>([[metawikipedia:Help:Enhanced recent changes|enhanced]])</small> | [[metawikipedia:Help:Related changes|Related changes]] | [[metawikipedia:Help:Watching pages|Watching pages]] | [[metawikipedia:Help:Diff|Diff]]
:[[metawikipedia:Help:Page history|Page history]] | [[metawikipedia:Help:Edit summary|Edit summary]] | [[metawikipedia:Help:User contributions|User contributions]] | [[metawikipedia:Help:Minor edit|Minor edit]] | [[metawikipedia:Help:Patrolled edit|Patrolled edit]]
;Style & formatting
:[[metawikipedia:Help:Wikitext examples|Wikitext examples]] | [[metawikipedia:Help:Reference card|Reference card]] | [[metawikipedia:Help:HTML in wikitext|HTML in wikitext]] | [[metawikipedia:Help:List|List]] | [[metawikipedia:Help:Table|Table]] | [[metawikipedia:Help:Sorting|Sorting]] | [[metawikipedia:Help:Text_color|Colors]]
;Special input and output
:[http://www.mediawiki.org/wiki/Extension:Inputbox Inputbox] | [[metawikipedia:Help:Special characters|Special characters]] | [[metawikipedia:Help:Displaying a formula|Displaying a formula]] | [[metawikipedia:Help:Images and other uploaded files|Images<small> (uploads)</small>]] | [http://www.mediawiki.org/wiki/Extension:EasyTimeline/syntax EasyTimeline]
;Advanced functioning
:[[metawikipedia:Help:Template|Template]] | [[metawikipedia:Help:Advanced templates|Advanced templates]] | [[metawikipedia:Help:Parser function|Parser function]] | [[metawikipedia:Help:ParserFunctions|ParserFunctions]] | [[metawikipedia:Help:Parameter default|Parameter default]]
:[[metawikipedia:Help:Variable|Variable]] | [http://www.mediawiki.org/wiki/Help:Magic_words Magic word] | [[metawikipedia:Help:System message|System message]] | [[metawikipedia:Help:Substitution|Substitution]] | [[metawikipedia:Help:Array|Array]] | [[metawikipedia:Help:Calculation|Calculation]]
;Page management
:[[metawikipedia:Help:Starting a new page|Starting a new page]] | [[metawikipedia:Help:Moving a page|Renaming (moving) a page]] | [http://www.mediawiki.org/wiki/Manual:Administrators#Protection Protecting pages] | [[metawikipedia:Help:Deleting a page|Deleting a page]]
;[[metawikipedia:Help:Special page|Special pages]]
:[[metawikipedia:Help:Talk page|Talk page]] | [[metawikipedia:Help:Testing|Testing]] | [[Test|Sandbox]]


''':)


''';)
[[Category:Policies and documentation]]

Revision as of 19:29, 17 May 2017

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 below.

Wikimedia's general Help is also available in Italian and 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.

Links

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.

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 alternative text, the result will be different:

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

The result is: here [1] is our forum

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

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

Note that images will appear inline if you do that.

Intralinks

(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 fixed to 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.

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 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

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

  1. This line actually begins with a "#" character
    1. This line actually begins with two "#" characters
      1. This line actually begins with three "#" characters
      2. This line actually begins with three "#" characters
    2. This line actually begins with two "#" characters
  2. This line actually begins with a "#" character

Bulleted lists

  • 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

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 ":"
You can also use the <br> 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)

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> tag).
Like this : ":"

"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).

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

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