Sample Guide: Difference between revisions

From PWI Wiki
Jump to navigationJump to search
PWpedia>Sangodoc
Undo revision 60242 by Stormhammy (Talk)
PWpedia>Sangodoc
→Tables: Added DefTable info; other changes
 
(17 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__
'''Guide to Making Guides'''
'''Guide to Making Guides'''


 
Making guides on a wiki is very easy, with the help of the editing bar you can make a decent looking guide in a few simple steps. We want to keep our wiki as simple and clean looking as possible, so these basic techniques will help you to make your guide easy to read as well as functional. For advanced editing techniques check out the links at the end of this guide, the Meta Wiki is by far the most helpful and informative source for all of your editing needs.
 
Making guides on a Wiki is very easy, with the help of the editing bar you can make a decent looking guide in a few simple steps. We want to keep our Wiki as simple and clean looking as possible, so these basic techniques will help you to make your guide easy to read as well as functional. For advanced editing techniques check out the links at the end of this guide, the Meta Wiki is by far the most helpful and informative source for all of your editing needs.


The '''most important rule''' is: If you don't know how to do something and you are afraid to try, just put the information you have in there and someone else will come along and fix it up eventually. An alternative to this would be if you are trying to post a very large guide or contribution piece yourself, you may contact us on the forums for tips.
The '''most important rule''' is: If you don't know how to do something and you are afraid to try, just put the information you have in there and someone else will come along and fix it up eventually. An alternative to this would be if you are trying to post a very large guide or contribution piece yourself, you may contact us on the forums for tips.


For more on how to create or edit material for this wiki in a consistent format, please see the [[Wiki Style Guide]].


==Links and Creating Pages==
__NOTOC__
== Links and Creating Pages ==
First, if you do not see a '''link''' to the guide page that you want, there is a simple way to create it. In the section that you want to put the main link in, this one for example, type the following:
First, if you do not see a '''link''' to the guide page that you want, there is a simple way to create it. In the section that you want to put the main link in, this one for example, type the following:


<pre>[[Name of Guide]]</pre>
<pre>[[Name of Guide]]</pre>


Which translates into: [[Name of Guide]] , which has now become a clickable link
Which translates into: [[Name of Guide]], which has now become a clickable link


The brackets tell the server that the text is a link, and it creates the link for you. If it is a brand new link, the link will take you directly to an edit page.
The brackets tell the server that the text is a link, and it creates the link for you. If it is a brand new link, the link will take you directly to an edit page.


==Headers==
== Headers ==
If you want to make '''headers''' to break up sections of your guide, highlight the text you want to use and click the big A on the editing menu. It will look like this afterward:
If you want to make '''headers''' to break up sections of your guide, highlight the text you want to use and click the big A on the editing menu. It will look like this afterward:


Line 29: Line 27:


== Sample Header ==
== Sample Header ==
That's it for this section, try to use the headers '''very''' sparingly! Do you see how ugly this page looks with all these headers? Let's make sure your pages look much better!
That's it for this section, try to use the headers '''very''' sparingly! Do you see how ugly this page looks with all these headers? Let's make sure your pages look much better!


=== Lists ===
=== Lists ===
'''Lists''' are another simple thing that you can add easily into your guide.
'''Lists''' are another simple thing that you can add easily into your guide.


<pre>
<pre>
*Simple lists are just that,
* Simple lists are just that,
**Indenting lists is simple too!
** Indenting lists is simple too!
** start every line
** start every line
* with a star
* with a star
Line 49: Line 43:
'''This will display as:'''
'''This will display as:'''


*Simple lists are just that,
* Simple lists are just that,
**Indenting lists is simple too!
** Indenting lists is simple too!
** start every line
** start every line
* with a star
* with a star
Line 59: Line 53:


<pre>
<pre>
#Numbered lists
# Numbered lists
##Are easy too.
## Are easy too.
##Same Basic Concept
## Same Basic Concept
#Different end result.</pre>
# Different end result.
</pre>


'''This will display as:'''
'''This will display as:'''


#Numbered lists
# Numbered lists
##Are easy too.
## Are easy too.
##Same Basic Concept
## Same Basic Concept
#Different end result.
# Different end result.


'''For more list examples, go here:''' http://meta.wikimedia.org/wiki/Help:List
'''For more list examples, go here:''' http://meta.wikimedia.org/wiki/Help:List


=== Tables ===
=== Tables ===
'''Tables''' are great for organizing information, they may be a bit more complicated than lists, but they look great!
'''Tables''' are great for organizing information, they may be a bit more complicated than lists, but they look great!


We have a specific background color that we would like everyone to use for their tables. Use this in your table code at the top as shown:
We have a specific style that we would like everyone to use for their tables. Please use <nowiki>{{DefTable}}</nowiki> in your table header whenever possible, as shown here:


<pre>{| style="background:#291a0e" border="1"</pre>
<pre>{| {{DefTable}}</pre>


DefTable sets the color of table, padding, and size of border.  This keeps tables consistent and makes styles easy to update throughout the wiki wherever this template is used.  See [[Template:DefTable]] for details on use.


Now, to continue the guide
Sample table code:


<pre>{| style="background:#291a0e" border="1"  <-- color of table and size of border, keep the color consistent please
<pre>
{| {{DefTable}}
|+ This is the table title
|+ This is the table title
! left side box 1
! left side box 1
| right side box 1
| right side box 1
|-  <--this denotes the end of a line
|  <-- Just add "|" to add more horizontal cells.
! left box 2
|-  <-- This denotes the end of a line.
|right box 2
! left box 2 <-- Using "!" instead of "|" makes the cell's text appear centered and in bold.
|additional box on same line   <-- Just add "|" to add more horizontal cells
| right box 2
|-
| additional box on same line
! box3 left
|
|box 3 center
|box 3 second center
|box 3 right
|-
|-
| box 3 left
| box 3 center
| box 3 second center
| box 3 right
|}
|}
</pre>
</pre>


'''The above code displays like this:'''
'''NOTE:''' The "<-- text" parts are comments for your benefit and should not be included in an actual table.
 
The above code displays like this:


{| style="background:#291a0e" border="1"
{| {{DefTable}}
|+ This is the table title
|+ This is the table title
! left side box 1
! left side box 1
| right side box 1
| right side box 1
|
|-  
|-  
! left box 2
! left box 2
|right box 2
| right box 2
|additional box on same line
| additional box on same line
|-
|
! box3 left
|box 3 center
|box 3 second center
|box 3 right
|-
|-
| box 3 left
| box 3 center
| box 3 second center
| box 3 right
|}
|}
If you want a bit more space between the text and the table's borders use '''<nowiki>{{DefTable|cellpad=5}}</nowiki>''' (default cellpad is 4) in the table header.


== Image Insertion ==
== Image Insertion ==
'''NOTE:''' For more advanced image insertion you can use the [[Template:Imagebox|Imagebox template]]. For example, use '''<nowiki>{{Imagebox|image=ImageName|iwidth=220px|text=Your text here.}}</nowiki>''' to add a box with an image and some text underneath it to a page. See [[Template:Imagebox]] for advanced instructions.


Assuming that your image is already uploaded, here is how you insert them in the page.
Assuming that your image is already uploaded, here is how you insert them in the page.
Line 127: Line 128:
Image embedding syntax without type specification displays the image inline without any frame or visible caption.
Image embedding syntax without type specification displays the image inline without any frame or visible caption.


For example, <pre>[[image:tst.png|abc]]</pre> gives abc. The caption substitutes the 'title' attribute of the generated HTML image tag.
For example:


To add the uploaded image to an article as a thumbnail, one can write <pre>[[Image: file name including extension |thumb|caption]]</pre>
<pre>
[[Image: tst.png|abc]]
</pre>


You can also specify the size of the image. However, the default thumbnail width can be set in the preferences, so typically it is better not to specify "px", in order to respect the users' preferences. If the original size of the image is smaller than the specified size, it will not be enlarged.
This will display as 'abc'. The caption substitutes the 'title' attribute of the generated HTML image tag.


To add the uploaded image to an article as a thumbnail, one can write:


Thus <pre>[[image:tst.png|thumb|50px|abc]]</pre> is not enlarged, while <pre>[[Image:Gelderland-Position.png|thumb|50px|abc]]</pre> is shown at 50px-wide.
<pre>
[[Image: file name including extension |thumb|caption]]
</pre>


This information was pulled from the meta wiki.
You can also specify the size of the image. However, the default thumbnail width can be set in the preferences, so typically it is better not to specify "px", in order to respect the users' preferences. If the original size of the image is smaller than the specified size, it will not be enlarged.


Thus <pre>[[Image: tst.png|thumb|50px|abc]]</pre> is not enlarged, while the following is shown at 50px wide:


[http://meta.wikimedia.org/wiki/Help:Images_and_other_uploaded_files More Image Information here]
<pre>
 
[[Image:Gelderland-Position.png|thumb|50px|abc]]
</pre>


This information was pulled from the meta wiki. (''[http://meta.wikimedia.org/wiki/Help:Images_and_other_uploaded_files source]'')


----
----


This is all that you really need to help contribute to the Wiki, for advanced editing tips and guides, check out the links below:
This is all that you really need to help contribute to the Wiki, for advanced editing tips and guides, check out the links below:
 
* [http://meta.wikimedia.org/wiki/Help:Contents Meta Wiki Help Index]
[http://meta.wikimedia.org/wiki/Help:Contents Meta Wiki Help Index]
* [http://meta.wikimedia.org/wiki/Help:Wikitext Wiki Text Formatting]
 
* [http://meta.wikimedia.org/wiki/Help:List Wiki List Creation & Formatting]
[http://meta.wikimedia.org/wiki/Help:Wikitext Wiki Text Formatting]
* [http://meta.wikimedia.org/wiki/Help:Table Wiki Table Formatting]
 
<br>
[http://meta.wikimedia.org/wiki/Help:List Wiki List Creation & Formatting]
 
[http://meta.wikimedia.org/wiki/Help:Table Wiki Table Formatting]


== Signing Your Contributions ==
== Signing Your Contributions ==
I almost forgot, you can sign your contributions! All you have to do is click the signature looking thing in the editing bar, or just type this:
I almost forgot, you can sign your contributions! All you have to do is click the signature looking thing in the editing bar, or just type this:


<pre>--~~~~</pre>
<pre>
--~~~~
</pre>


Which displays like the one under this line of text.
Which displays like the one under this line of text.


--<span style="color: orange;"><u>NameHere</u></span> 00:00, 01 January 2011 (PDT)


 
Please note that you should ''always'' sign your contributions on talk pages, but ''never'' sign anywhere else.  Article pages with signatures should have the signatures removed.
 
--[[User:Eatwithspoons|Eatwithspoons]] 22:29, 29 July 2009 (UTC)


----
----
Line 173: Line 178:
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.


'''Getting started'''
'''Getting started:'''
* [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
* [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
* [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
* [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]

Latest revision as of 18:13, 3 November 2012

Guide to Making Guides

Making guides on a wiki is very easy, with the help of the editing bar you can make a decent looking guide in a few simple steps. We want to keep our wiki as simple and clean looking as possible, so these basic techniques will help you to make your guide easy to read as well as functional. For advanced editing techniques check out the links at the end of this guide, the Meta Wiki is by far the most helpful and informative source for all of your editing needs.

The most important rule is: If you don't know how to do something and you are afraid to try, just put the information you have in there and someone else will come along and fix it up eventually. An alternative to this would be if you are trying to post a very large guide or contribution piece yourself, you may contact us on the forums for tips.

For more on how to create or edit material for this wiki in a consistent format, please see the Wiki Style Guide.


Links and Creating Pages[edit]

First, if you do not see a link to the guide page that you want, there is a simple way to create it. In the section that you want to put the main link in, this one for example, type the following:

[[Name of Guide]]

Which translates into: Name of Guide, which has now become a clickable link

The brackets tell the server that the text is a link, and it creates the link for you. If it is a brand new link, the link will take you directly to an edit page.

Headers[edit]

If you want to make headers to break up sections of your guide, highlight the text you want to use and click the big A on the editing menu. It will look like this afterward:

== Sample Header ==

This translates into the following when published:

Sample Header[edit]

That's it for this section, try to use the headers very sparingly! Do you see how ugly this page looks with all these headers? Let's make sure your pages look much better!

Lists[edit]

Lists are another simple thing that you can add easily into your guide.

* Simple lists are just that,
** Indenting lists is simple too!
** start every line
* with a star
** more stars mean
*** deeper levels

This will display as:

  • Simple lists are just that,
    • Indenting lists is simple too!
    • start every line
  • with a star
    • more stars mean
      • deeper levels

Numbered Lists:

# Numbered lists
## Are easy too.
## Same Basic Concept
# Different end result.

This will display as:

  1. Numbered lists
    1. Are easy too.
    2. Same Basic Concept
  2. Different end result.

For more list examples, go here: http://meta.wikimedia.org/wiki/Help:List

Tables[edit]

Tables are great for organizing information, they may be a bit more complicated than lists, but they look great!

We have a specific style that we would like everyone to use for their tables. Please use {{DefTable}} in your table header whenever possible, as shown here:

{| {{DefTable}}

DefTable sets the color of table, padding, and size of border. This keeps tables consistent and makes styles easy to update throughout the wiki wherever this template is used. See Template:DefTable for details on use.

Sample table code:

{| {{DefTable}}
|+ This is the table title
! left side box 1
| right side box 1
|   <-- Just add "|" to add more horizontal cells.
|-  <-- This denotes the end of a line.
! left box 2  <-- Using "!" instead of "|" makes the cell's text appear centered and in bold.
| right box 2
| additional box on same line
|
|-
| box 3 left
| box 3 center
| box 3 second center
| box 3 right
|}

NOTE: The "<-- text" parts are comments for your benefit and should not be included in an actual table.

The above code displays like this:

This is the table title
left side box 1 right side box 1
left box 2 right box 2 additional box on same line
box 3 left box 3 center box 3 second center box 3 right

If you want a bit more space between the text and the table's borders use {{DefTable|cellpad=5}} (default cellpad is 4) in the table header.

Image Insertion[edit]

NOTE: For more advanced image insertion you can use the Imagebox template. For example, use {{Imagebox|image=ImageName|iwidth=220px|text=Your text here.}} to add a box with an image and some text underneath it to a page. See Template:Imagebox for advanced instructions.

Assuming that your image is already uploaded, here is how you insert them in the page.

Image embedding syntax without type specification displays the image inline without any frame or visible caption.

For example:

[[Image: tst.png|abc]]

This will display as 'abc'. The caption substitutes the 'title' attribute of the generated HTML image tag.

To add the uploaded image to an article as a thumbnail, one can write:

[[Image: file name including extension |thumb|caption]]

You can also specify the size of the image. However, the default thumbnail width can be set in the preferences, so typically it is better not to specify "px", in order to respect the users' preferences. If the original size of the image is smaller than the specified size, it will not be enlarged.

Thus

[[Image: tst.png|thumb|50px|abc]]

is not enlarged, while the following is shown at 50px wide:

[[Image:Gelderland-Position.png|thumb|50px|abc]]

This information was pulled from the meta wiki. (source)


This is all that you really need to help contribute to the Wiki, for advanced editing tips and guides, check out the links below:


Signing Your Contributions[edit]

I almost forgot, you can sign your contributions! All you have to do is click the signature looking thing in the editing bar, or just type this:

--~~~~

Which displays like the one under this line of text.

--NameHere 00:00, 01 January 2011 (PDT)

Please note that you should always sign your contributions on talk pages, but never sign anywhere else. Article pages with signatures should have the signatures removed.


Consult the User's Guide for information on using the wiki software.

Getting started: