Difference between revisions of "Help:Contents"
(Added WIP tagging information) |
(→Tables) |
||
(10 intermediate revisions by 4 users not shown) | |||
Line 8: | Line 8: | ||
For questions on writing style (e.g. punctuation, capitalization, quotes) see the Wikipedia "Manual of Style" available here: http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style | For questions on writing style (e.g. punctuation, capitalization, quotes) see the Wikipedia "Manual of Style" available here: http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style | ||
+ | |||
+ | A very good HTML to MediaWiki converter - http://labs.seapine.com/htmltowiki.cgi | ||
==Example Wiki Text== | ==Example Wiki Text== | ||
Line 34: | Line 36: | ||
Block tag processing with nowiki tag like <nowiki>''this'' and *this</nowiki>. | Block tag processing with nowiki tag like <nowiki>''this'' and *this</nowiki>. | ||
+ | |||
+ | ===List Items=== | ||
+ | <ol> | ||
+ | <li>text 1...items within lists are numbered</li> | ||
+ | <li>text 2</li> | ||
+ | <li>text 3</li> | ||
+ | </ol> | ||
+ | This text interrupts the numbered list. | ||
+ | <ol start=4> | ||
+ | <li>text 4...numbering can resume suing the "start =n" tag where n represents the new list starting number</li> | ||
+ | <li>text 5</li> | ||
+ | <li>text 6</li> | ||
+ | </ol> | ||
+ | |||
+ | ===Indentation=== | ||
+ | Text can be indented by making the first character of a line a colon | ||
+ | :One colon indentation | ||
+ | ::Two colon indentation | ||
+ | :::Three colon indentation | ||
+ | ::::Four colon indentation | ||
+ | :::Back to Three colons | ||
+ | ::Back to Two colons | ||
===Tables=== | ===Tables=== | ||
Line 103: | Line 127: | ||
A decent HTML to Wiki converter can be found here - http://www.uni-bonn.de/~manfear/html2wiki-tables.php | A decent HTML to Wiki converter can be found here - http://www.uni-bonn.de/~manfear/html2wiki-tables.php | ||
+ | |||
+ | Nearly the formatting of any Wiki table described here - https://simple.wikipedia.org/wiki/Wikipedia:Wikitable | ||
===Cross References=== | ===Cross References=== | ||
Line 108: | Line 134: | ||
<pre> | <pre> | ||
− | To reference | + | To reference an internal section of the PinWiki, place the section heading within double brackets like this... |
[[Beginner's_Notes#Top_5_things_to_know:]] | [[Beginner's_Notes#Top_5_things_to_know:]] | ||
− | + | The section name can be identified by viewing the "title=" field of the URL in your web browser once you've clicked on that section from the Table of Contents. | |
− | To simplify the link name, add a vertical bar with your choice of name. | + | |
+ | To simplify the link name and remove the "http:" formal URL name, add a vertical bar with your choice of name. | ||
− | [[Beginner's_Notes#Top_5_things_to_know:| | + | [[Beginner's_Notes#Top_5_things_to_know:|Top 5 Things to Know]] |
(See the examples below) | (See the examples below) | ||
</pre> | </pre> | ||
− | Here's the first link: | + | Here's the first link: [[Beginner's_Notes#Top_5_things_to_know:]]<br> |
− | Here's the link with a custom name: [[Beginner's_Notes#Top_5_things_to_know:| | + | Here's the link with a custom name: [[Beginner's_Notes#Top_5_things_to_know:|Top 5 Things to Know]] |
− | |||
===Adding a New Page=== | ===Adding a New Page=== | ||
Line 129: | Line 155: | ||
<pre> | <pre> | ||
− | + | To use a descriptive link, type out the link's URL, followed | |
− | by a | + | by a space, and then the description of the link, like this: |
− | [http://www.pinwiki.com/] | + | [http://www.pinwiki.com/ PinWiki] |
(see the example below) | (see the example below) | ||
</pre> | </pre> | ||
+ | Thank you for contributing to the [http://www.pinwiki.com/ PinWiki]!<br> | ||
Example of a descriptive link which hides the link's url [http://pinwiki.com/wiki/index.php?title=Gottlieb_System_80#Power_Problems Power Problems] | Example of a descriptive link which hides the link's url [http://pinwiki.com/wiki/index.php?title=Gottlieb_System_80#Power_Problems Power Problems] | ||
Line 161: | Line 188: | ||
{{WIP}} | {{WIP}} | ||
</pre> | </pre> | ||
+ | Don't forget to remove the tag when your draft is complete. Changes can still be made after this, but removing the tag indicates that the initial major edits are complete. | ||
+ | |||
+ | == Embedding Videos == | ||
+ | |||
+ | Please post here: http://www.pinwiki.com/wiki/index.php?title=User_talk:Pinball_Wizard about videos you would like to embed prior to embedding them. We typically try to upload videos to the PinWiki YouTube account to help keep the content from disappearing in the future. | ||
+ | |||
+ | |||
+ | |||
+ | To embed a YouTube video: | ||
+ | |||
+ | < youtube >foo< /youtube > (Remove the spaces to actually use this). | ||
+ | |||
+ | where ''foo'' is the video ID from the URL. i.e. if the video's URL is http://www.youtube.com/watch?v=VyBSS48E4xI, then the embed code would be '''< youtube> VyBSS48E4xI< /youtube >'''. | ||
+ | |||
+ | === Other supported video services === | ||
+ | |||
+ | See [http://www.shoutwiki.com/wiki/Help:YouTube ShoutWiki's help page on using the YouTube extension] for more information, such as using alternate, non-YouTube providers to embed content. | ||
+ | |||
+ | === Setting width and height === | ||
+ | See [http://community.wikia.com/wiki/Help:YouTube_extension Wikia's old help page about this extension]. It explains further details, such as how to set width and height. | ||
+ | |||
+ | You can change the width and height of the video box | ||
+ | |||
+ | * Width is controlled with width="xxx", where xxx is the number of pixels. The default is 640 pixels. | ||
+ | * Height is controlled in the same way with height="xxx". The default is 385 pixels. | ||
+ | |||
+ | So the example from above could be: | ||
+ | |||
+ | < youtube width="200" height="120" >CCz1kmfqL7g< /youtube > |
Latest revision as of 08:02, 22 October 2017
A quick reference card is available here: http://meta.wikimedia.org/wiki/Help:Reference_card
A very good description of Wiki markup can be found here: http://en.wikipedia.org/wiki/Help:Wiki_markup
A Wiki cheat sheet - http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet
An add-in for MS Office is available. Search the web for "Microsoft Office Word Add-in For MediaWiki" to find a download from microsoft.com
For questions on writing style (e.g. punctuation, capitalization, quotes) see the Wikipedia "Manual of Style" available here: http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style
A very good HTML to MediaWiki converter - http://labs.seapine.com/htmltowiki.cgi
1 Example Wiki Text
View the source for this page to see common formatting tags.
Paragraphs are just text. Italics are like this. Bold is like this.
- Indented paragraph.
1.1 Heading level 3
- List 1a
- List 2a
- List 2b
- List 2c
- List 1b
- Ordered 2a
- Ordered 2B
- List 1c
Preformat text with the "pre" tag.
Block tag processing with nowiki tag like ''this'' and *this.
1.2 List Items
- text 1...items within lists are numbered
- text 2
- text 3
This text interrupts the numbered list.
- text 4...numbering can resume suing the "start =n" tag where n represents the new list starting number
- text 5
- text 6
1.3 Indentation
Text can be indented by making the first character of a line a colon
- One colon indentation
- Two colon indentation
- Three colon indentation
- Four colon indentation
- Back to Three colons
- Three colon indentation
- Back to Two colons
- Two colon indentation
1.4 Tables
Here's an example of a basic table:
r1c1 | r1c2 |
r2c1 | r2c2 |
r3c1 | r3c2 |
For a cleaner look, add the class="wikitable" tag:
r1c1 | r1c2 |
r2c1 | r2c2 |
r3c1 | r3c2 |
This table looks just like the previous, but uses a slightly different markup style:
r1c1 | r1c2 |
r2c1 | r2c2 |
r3c1 | r3c2 |
To add headers to your table, use the ! symbol:
Col 1 | Col 2 | Col 3 |
---|---|---|
r1c1 | r1c2 | r1c3 |
r2c1 | r2c2 | r2c3 |
r3c1 | r3c2 | r3c3 |
To add cells that span columns, use the colspan attribute:
Table header | |||
---|---|---|---|
Col 1 | Col 2 | Col 3 | Col 4 |
r1c1 | r1c2 | r1c3 | r1c4 |
r2c1 | r2c2 | r2c3 | r2c4 |
r3c1 | r3c2 | subheader | |
r4c1 | r4c2 | r4c3 | r4c4 |
A handy Comma Separated Variable (CSV) to Wiki Table translator is available here: http://area23.brightbyte.de/csv2wp.php
A decent HTML to Wiki converter can be found here - http://www.uni-bonn.de/~manfear/html2wiki-tables.php
Nearly the formatting of any Wiki table described here - https://simple.wikipedia.org/wiki/Wikipedia:Wikitable
1.5 Cross References
Reference other sections of the wiki like this -> Beginner's Notes
To reference an internal section of the PinWiki, place the section heading within double brackets like this... [[Beginner's_Notes#Top_5_things_to_know:]] The section name can be identified by viewing the "title=" field of the URL in your web browser once you've clicked on that section from the Table of Contents. To simplify the link name and remove the "http:" formal URL name, add a vertical bar with your choice of name. [[Beginner's_Notes#Top_5_things_to_know:|Top 5 Things to Know]] (See the examples below)
Here's the first link: Beginner's_Notes#Top_5_things_to_know:
Here's the link with a custom name: Top 5 Things to Know
1.6 Adding a New Page
To create a new page, add a reference to a non-existent page like this -> Non-existent page. Save the page with the reference and simply double-click the new link to open/create the new page.
1.7 Links
To use a descriptive link, type out the link's URL, followed by a space, and then the description of the link, like this: [http://www.pinwiki.com/ PinWiki] (see the example below)
Thank you for contributing to the PinWiki!
Example of a descriptive link which hides the link's url Power Problems
1.8 Images and Files
To include a file in a page, use a link in one of the following forms:
[[Image:File.jpg]] to use the full version of the file [[Image:File.png|200px|thumb|left|alt text]] to use a 200 pixel wide rendition in a box in the left margin with 'alt text' as description [[Media:File.ogg]] for directly linking to the file without displaying the file<br><br> [[Media:File.ogg | description word(s)]] for directly linking to a the file without displaying the file, but adding a descriptive "hyperlink" from a word or words (see the example below)
Example of a descriptive hyperlink to a photo - This is a System 80 sound board
1.9 Creating White Space Breaks between sections
Use the <br clear=all> tag at the end of an inserted thumbnail with text, when the thumbnail is above the next subsection. If you don't, your text from the next subsection will typically rise up to the thumbnail. This is in turn really screws up the page formatting. (see GTB Sys1 Intro section for an example)
1.10 Wiki Color Formatting
Wiki color formatting - http://meta.wikimedia.org/wiki/Wiki_color_formatting_help
2 Flagging Draft Pages as "Work in Progress"
While working on a PinWiki page, it's good practice to flag it as a "Work In Progress." This is done by adding the WIP category to the top of the page. The format for the WIP tag is shown here:
{{WIP}}
Don't forget to remove the tag when your draft is complete. Changes can still be made after this, but removing the tag indicates that the initial major edits are complete.
3 Embedding Videos
Please post here: http://www.pinwiki.com/wiki/index.php?title=User_talk:Pinball_Wizard about videos you would like to embed prior to embedding them. We typically try to upload videos to the PinWiki YouTube account to help keep the content from disappearing in the future.
To embed a YouTube video:
< youtube >foo< /youtube > (Remove the spaces to actually use this).
where foo is the video ID from the URL. i.e. if the video's URL is http://www.youtube.com/watch?v=VyBSS48E4xI, then the embed code would be < youtube> VyBSS48E4xI< /youtube >.
3.1 Other supported video services
See ShoutWiki's help page on using the YouTube extension for more information, such as using alternate, non-YouTube providers to embed content.
3.2 Setting width and height
See Wikia's old help page about this extension. It explains further details, such as how to set width and height.
You can change the width and height of the video box
- Width is controlled with width="xxx", where xxx is the number of pixels. The default is 640 pixels.
- Height is controlled in the same way with height="xxx". The default is 385 pixels.
So the example from above could be:
< youtube width="200" height="120" >CCz1kmfqL7g< /youtube >