Difference between revisions of "Help:Editing"

From SDA Knowledge Base

Jump to: navigation, search
(Added another link)
(→‎Google Docs)
 
(45 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
==External links==
+
==Basic formatting==
−
*[http://en.wikipedia.org/wiki/How_to_edit How to edit a page] (Wikipedia)
+
Italics is added by surrounding a word with two pairs of apostrophes. <nowiki>''Example''</nowiki> shows up as ''Example''
−
*[http://en.wikipedia.org/wiki/Editor%27s_cheat_sheet Editing] (Wikipedia)
+
 
−
*[http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Cheat sheet] (Wikipedia)
+
Bold is done by surrounding a word with three pairs of apostrophes. <nowiki>'''Example'''</nowiki> shows up as '''Example'''
−
*[http://openwetware.org/wiki/Simple_wiki_editing_examples Simple wiki editing examples] (OpenWetWare)
+
 
 +
Section headings are created by surrounding the section title with pairs of equal signs. The numbers of pairs of equal signs designates the level heading it is. <nowiki>=Level 1=</nowiki>, <nowiki>==Level 2==</nowiki> <nowiki>===Level 3===</nowiki> and so on.
 +
 
 +
Lists can be created by adding asterisks (*) for bulleted lists or number signs (#) for numerical lists at the beginning of a line. The number of * or # indicate that it is a subpoint of the previous points.
 +
;Example
 +
<pre>
 +
*Bullet point
 +
*Bullet point 2
 +
**Sub bullet point
 +
</pre>
 +
Shows up as
 +
*Bullet point
 +
*Bullet point 2
 +
**Sub bullet point
 +
 
 +
<pre>
 +
#Item 1
 +
#Item 2
 +
##Subitem
 +
</pre>
 +
Shows up as
 +
#Item 1
 +
#Item 2
 +
##Subitem
 +
 
 +
Indents can be created through usage of the colon, and "definition lists" are started with a semicolon.
 +
<pre>
 +
;Word
 +
:Definition
 +
::Double indent
 +
</pre>
 +
Shows up as
 +
;Word
 +
:Definition
 +
::Double indent
 +
 
 +
In addition, many html tags work.
 +
 
 +
==Links==
 +
There are two main types of links.
 +
;Internal links
 +
:Links to other articles on this wiki.
 +
;External links
 +
:Links going outside the wiki.
 +
 
 +
It is recommended that you please always use internal links for linking to other articles.
 +
 
 +
===Internal links===
 +
Internal links are for other articles on the site. They are added by surrounding what you want to link to in to pairs of brackets. The format is <nowiki>[[Name of Article]]</nowiki>
 +
;Example
 +
:<nowiki>[[Main Page]]</nowiki> shows up as [[Main Page]].
 +
 
 +
Links show up as blue when you are linking to an article that exists. Links show up as red on traditional skins, orange on the SDA default skin, when the article doesn't exist.
 +
 
 +
You can combine links with general wiki formatting. You can create headings with links in them, make bold links, etc.
 +
;Example
 +
:<nowiki>''[[Contra]]''</nowiki> shows up as ''[[Contra]]''
 +
 
 +
To link to one thing, and call it something else, you used a "Piped Link". It is called this because the pipe character (|) is used. In double brackets, you first write the name of the article you want to link to, then add | then add what you want the link to say instead. The format is <nowiki>[[Name of Article|What link says]]</nowiki>
 +
;Example
 +
:<nowiki>[[Main Page|SDA Knowledge Base]]<nowiki> shows up as [[Main Page|SDA Knowledge Base]].
 +
 
 +
Note that with piped links, you can still use formatting within the link.
 +
;Example
 +
:<nowiki>[[SDA Strategy Wiki|''SDA'' '''Strategy''' Wiki]]</nowiki> shows up as [[SDA Strategy Wiki|''SDA'' '''Strategy''' Wiki]]
 +
 
 +
Linking to a specific section of an article is done through adding a number sign after the title of the article, then the name of the section. If you simply add a #, you link to a section of the article you are currently editing. Note that if an article has multiple sections with the same name, you have to add the number for which section.
 +
;Example
 +
:<nowiki>[[SDA Strategy Wiki#Finding a game]]</nowiki> shows up as [[SDA Strategy Wiki#Finding a game]]
 +
:<nowiki>[[#External links]]</nowiki> shows up as [[#External links]]
 +
 
 +
===External links===
 +
External links go outside the site. If you want to display the url, simply type the url (include the http). It will automatically appear as a hyperlink
 +
;Example
 +
:http://www.speeddemosarchive.com/
 +
 
 +
If you want to link to an external site, but have it say something other than the url, than within a single pair of brackets, you type the url, then a space, then what you want to say. <nowiki>[http://siteyouwanttolinkto.com What you call it]</nowiki>
 +
;Example
 +
:<nowiki>[http://www.speeddemosarchive.com/ SDA]</nowiki> shows up as [http://www.speeddemosarchive.com/ SDA]
 +
 
 +
==Subpages==
 +
Subpages link back to the main article at the beginning. They are added by adding a slash after the title of the main article.
 +
;Example
 +
:[[Metroid Fusion/Any%]]
 +
 
 +
==Embedding Videos==
 +
 
 +
The format for embedding videos is:
 +
<pre><nowiki>{{#ev:service|id}}</nowiki></pre>
 +
 
 +
'''Service''' is the name of the video hosting service. 
 +
{|class=wikitable
 +
|youtube
 +
|-
 +
|vimeo
 +
|-
 +
|googlevideo
 +
|}
 +
 
 +
'''id''' is the video id.  You get this from your video's url.  As an example, this is the link to Heidman's Contra speedrun on YouTube
 +
<pre><nowiki>http://www.youtube.com/watch?v=5EtECO0hE10</nowiki></pre>
 +
So the service is '''youtube''' and the video id is '''5EtECO0hE10'''
 +
So you would use:
 +
<pre><nowiki>{{#ev:youtube|5EtECO0hE10}}</nowiki></pre>
 +
 
 +
And you get: <br />
 +
{{#ev:youtube|5EtECO0hE10}}
 +
 
 +
You can also change the size of the video by adding a size parameter.
 +
 
 +
<pre><nowiki>{{#ev:service|id|width}}</nowiki></pre>
 +
 
 +
Everything else stays the same.  You're going to add a little bit after the id and enter a number for the width. 
 +
So we'll use the same video as before.  If you use:
 +
<pre><nowiki>{{#ev:youtube|5EtECO0hE10|300}}</nowiki></pre>
 +
You get:<br />
 +
{{#ev:youtube|5EtECO0hE10|300}}
 +
 
 +
==Images and other files==
 +
To add a image or other file, you must first upload it. To do so, you go to [[Special:Upload]]. Follow the instructions on the page. Don't worry about licensing. You can also upload new versions of images with the same file name, but only if they have the same filename extension (.jpg and the like).
 +
 
 +
To add it to an article, link it like you would to another page on the site. Inside double brackets, you type File:, the name of the image, and then the filename extension (.jpg, .png, etc). In full, it is <nowiki>[[File:NAME.extension]]</nowiki>
 +
 
 +
==Google Docs==
 +
[https://docs.google.com/ Google Docs] is a free online service that lets you create documents and spreadsheets that can be shared online.  It also allows for the documents to be embedded directly into pages.  Spreadsheets are particularly effective at keeping large amounts of data neatly organized into rows and columns that are easy to edit.
 +
 
 +
Before you can embed your document or spreadsheet you'll need to customize its viewer permission settings and publish it to the web
 +
 
 +
Within your document or spreadsheet do the following: <br />
 +
Click '''File'''<br />
 +
Select '''Share'''<br />
 +
Under Who has access click Change<br />
 +
Under Visibility Options Select '''Anyone with the link'''<br />
 +
Click '''Save'''<br />
 +
Click '''Done'''<br />
 +
Click '''File'''<br />
 +
Select '''Publish to the web'''<br />
 +
Select '''Start Publishing'''<br />
 +
Copy the link that appears below<br />
 +
Now you are ready to embed
 +
<br /><br />
 +
The format for embedding a google doc is:
 +
<pre><nowiki><doc id="Document key" type="type of doc"/></nowiki></pre>
 +
The doc id is the alphanumeric string of characters you see in the link you get when publishing the data. 
 +
For the type of doc, it will either be '''spreadsheet''' or '''file'''.  This is the url for the spreadsheet that has information on Contra:
 +
<pre><nowiki>https://docs.google.com/spreadsheet/pub?key=0AlQn8DYLTR-hdGdBRmdIalp1YThaTU1nYkZfejQ4Rnc&single=true&gid=0&output=html</nowiki></Pre>
 +
The document key is: '''0AlQn8DYLTR-hdGdBRmdIalp1YThaTU1nYkZfejQ4Rnc''' and the type of doc is '''spreadsheet'''
 +
So you would put in:<br />
 +
<pre><nowiki><doc id="0AlQn8DYLTR-hdGdBRmdIalp1YThaTU1nYkZfejQ4Rnc" type="spreadsheet"/></nowiki></pre>
 +
<br />
 +
And you would get:<br />
 +
<doc id="0AlQn8DYLTR-hdGdBRmdIalp1YThaTU1nYkZfejQ4Rnc" type="spreadsheet"/>
 +
<br />
 +
You also have control for how large the embedded doc is on the page.  This is probably a good idea because the Contra spreadsheet does not have very many columns.<br />
 +
<pre><nowiki><doc id="Document key" type="type of doc" width="number" height="number" /></nowiki></pre>
 +
<br />
 +
So if we wanted to resize the embedded Contra spreadsheet we would plug in the following:
 +
<nowiki><pre><doc id="0AlQn8DYLTR-hdGdBRmdIalp1YThaTU1nYkZfejQ4Rnc" type="spreadsheet" width="800" height="800" /></nowiki></pre>
 +
<br />
 +
And get:<br />
 +
<doc id="0AlQn8DYLTR-hdGdBRmdIalp1YThaTU1nYkZfejQ4Rnc" type="spreadsheet" width="800" height="800"/>
 +
<br /><br /><br />
 +
 
 +
==Tables==
 +
 
 +
;Table Formatting
 +
:<nowiki>{| class="wikitable"</nowiki> ''Begins the Table''
 +
:<nowiki> | </nowiki>''Is used for each entry across''
 +
:<nowiki> |- </nowiki> ''Skips to the next row''
 +
:<nowiki> |} </nowiki> ''Ends the table''
 +
 
 +
<nowiki>{| class="wikitable"</nowiki><br />
 +
<nowiki>|Categories</nowiki><br />
 +
<nowiki>|-</nowiki><br />
 +
<nowiki>|Any %</nowiki><br />
 +
<nowiki>|}</nowiki>
 +
 
 +
Will get you:
 +
{| class="wikitable"
 +
|Categories
 +
|-
 +
|Any%
 +
|}
 +
 
 +
Here's an example with two rows across:<br />
 +
<nowiki>{| class="wikitable"</nowiki><br />
 +
<nowiki>|Game</nowiki><br />
 +
<nowiki>|Categories</nowiki><br />
 +
<nowiki>|-</nowiki><br />
 +
<nowiki>|Contra</nowiki><br />
 +
<nowiki>|Any%</nowiki><br />
 +
<nowiki>|}</nowiki><br />
 +
 
 +
You get:
 +
{| class="wikitable"
 +
|Game
 +
|Categories
 +
|-
 +
|Contra
 +
|Any%
 +
|}

Latest revision as of 09:09, 12 July 2013

Basic formatting

Italics is added by surrounding a word with two pairs of apostrophes. ''Example'' shows up as Example

Bold is done by surrounding a word with three pairs of apostrophes. '''Example''' shows up as Example

Section headings are created by surrounding the section title with pairs of equal signs. The numbers of pairs of equal signs designates the level heading it is. =Level 1=, ==Level 2== ===Level 3=== and so on.

Lists can be created by adding asterisks (*) for bulleted lists or number signs (#) for numerical lists at the beginning of a line. The number of * or # indicate that it is a subpoint of the previous points.

Example 
*Bullet point
*Bullet point 2
**Sub bullet point

Shows up as

  • Bullet point
  • Bullet point 2
    • Sub bullet point 
#Item 1
#Item 2
##Subitem

Shows up as

  1. Item 1
  2. Item 2
    1. Subitem

Indents can be created through usage of the colon, and "definition lists" are started with a semicolon. 

;Word
:Definition
::Double indent

Shows up as

Word
Definition
Double indent

In addition, many html tags work.

Links

There are two main types of links.

Internal links
Links to other articles on this wiki.
External links
Links going outside the wiki.

It is recommended that you please always use internal links for linking to other articles.

Internal links

Internal links are for other articles on the site. They are added by surrounding what you want to link to in to pairs of brackets. The format is [[Name of Article]]

Example
[[Main Page]] shows up as Main Page.

Links show up as blue when you are linking to an article that exists. Links show up as red on traditional skins, orange on the SDA default skin, when the article doesn't exist.

You can combine links with general wiki formatting. You can create headings with links in them, make bold links, etc.

Example
''[[Contra]]'' shows up as Contra

To link to one thing, and call it something else, you used a "Piped Link". It is called this because the pipe character (|) is used. In double brackets, you first write the name of the article you want to link to, then add | then add what you want the link to say instead. The format is [[Name of Article|What link says]]

Example
[[Main Page|SDA Knowledge Base]]<nowiki> shows up as [[Main Page|SDA Knowledge Base]]. Note that with piped links, you can still use formatting within the link. ;Example :<nowiki>[[SDA Strategy Wiki|''SDA'' '''Strategy''' Wiki]] shows up as SDA Strategy Wiki

Linking to a specific section of an article is done through adding a number sign after the title of the article, then the name of the section. If you simply add a #, you link to a section of the article you are currently editing. Note that if an article has multiple sections with the same name, you have to add the number for which section.

Example
[[SDA Strategy Wiki#Finding a game]] shows up as SDA Strategy Wiki#Finding a game
[[#External links]] shows up as #External links

External links

External links go outside the site. If you want to display the url, simply type the url (include the http). It will automatically appear as a hyperlink

Example
http://www.speeddemosarchive.com/

If you want to link to an external site, but have it say something other than the url, than within a single pair of brackets, you type the url, then a space, then what you want to say. [http://siteyouwanttolinkto.com What you call it]

Example
[http://www.speeddemosarchive.com/ SDA] shows up as SDA

Subpages

Subpages link back to the main article at the beginning. They are added by adding a slash after the title of the main article.

Example
Metroid Fusion/Any%

Embedding Videos

The format for embedding videos is: 

{{#ev:service|id}}

Service is the name of the video hosting service.

youtube
vimeo
googlevideo

id is the video id. You get this from your video's url. As an example, this is the link to Heidman's Contra speedrun on YouTube 

http://www.youtube.com/watch?v=5EtECO0hE10

So the service is youtube and the video id is 5EtECO0hE10 So you would use: 

{{#ev:youtube|5EtECO0hE10}}

And you get:

You can also change the size of the video by adding a size parameter. 

{{#ev:service|id|width}}

Everything else stays the same. You're going to add a little bit after the id and enter a number for the width. So we'll use the same video as before. If you use: 

{{#ev:youtube|5EtECO0hE10|300}}

You get:

Images and other files

To add a image or other file, you must first upload it. To do so, you go to Special:Upload. Follow the instructions on the page. Don't worry about licensing. You can also upload new versions of images with the same file name, but only if they have the same filename extension (.jpg and the like).

To add it to an article, link it like you would to another page on the site. Inside double brackets, you type File:, the name of the image, and then the filename extension (.jpg, .png, etc). In full, it is [[File:NAME.extension]]

Google Docs

Google Docs is a free online service that lets you create documents and spreadsheets that can be shared online. It also allows for the documents to be embedded directly into pages. Spreadsheets are particularly effective at keeping large amounts of data neatly organized into rows and columns that are easy to edit.

Before you can embed your document or spreadsheet you'll need to customize its viewer permission settings and publish it to the web

Within your document or spreadsheet do the following:
Click File
Select Share
Under Who has access click Change
Under Visibility Options Select Anyone with the link
Click Save
Click Done
Click File
Select Publish to the web
Select Start Publishing
Copy the link that appears below
Now you are ready to embed

The format for embedding a google doc is: 

<doc id="Document key" type="type of doc"/>

The doc id is the alphanumeric string of characters you see in the link you get when publishing the data. For the type of doc, it will either be spreadsheet or file. This is the url for the spreadsheet that has information on Contra: 

https://docs.google.com/spreadsheet/pub?key=0AlQn8DYLTR-hdGdBRmdIalp1YThaTU1nYkZfejQ4Rnc&single=true&gid=0&output=html

The document key is: 0AlQn8DYLTR-hdGdBRmdIalp1YThaTU1nYkZfejQ4Rnc and the type of doc is spreadsheet So you would put in:

<doc id="0AlQn8DYLTR-hdGdBRmdIalp1YThaTU1nYkZfejQ4Rnc" type="spreadsheet"/>


And you would get:

Open in new window


You also have control for how large the embedded doc is on the page. This is probably a good idea because the Contra spreadsheet does not have very many columns.

<doc id="Document key" type="type of doc" width="number" height="number" />


So if we wanted to resize the embedded Contra spreadsheet we would plug in the following: <pre><doc id="0AlQn8DYLTR-hdGdBRmdIalp1YThaTU1nYkZfejQ4Rnc" type="spreadsheet" width="800" height="800" /></pre>
And get:

Open in new window




Tables

Table Formatting
{| class="wikitable" Begins the Table
| Is used for each entry across
|- Skips to the next row
|} Ends the table

{| class="wikitable"
|Categories
|-
|Any %
|}

Will get you:

Categories
Any%

Here's an example with two rows across:
{| class="wikitable"
|Game
|Categories
|-
|Contra
|Any%
|}

You get:

Game Categories
Contra Any%
Retrieved from "https://kb.speeddemosarchive.com/index.php?title=Help:Editing&oldid=35318"
Personal tools