Help:Editing

From MeritBadgeDotOrg

(Difference between revisions)
Jump to: navigation, search
m
Current revision (18:01, July 22, 2012) (edit) (undo)
m (minor wording)
 
(28 intermediate revisions not shown.)
Line 1: Line 1:
__NOTOC__
__NOTOC__
-
== IMPORTANT - PLEASE READ ==
+
__NOEDITSECTION__
-
 
+
{{alert|All [[contributor]]s '''''must''''' read the [[MeritBadgeDotOrg:Usage standards policy|Usage standards policy]] ''prior'' to editing any article, ''especially'' those in the "main" [[namespace]].}}
-
<big><big>'''Prior to editing any pages, please read the [[MeritBadgeDotOrg:Usage standards]].'''</big></big>
+
== Editing basics ==
-
 
+
* The following editing rules apply to this web site (wiki) and may not apply to others.
-
== General editing help ==
+
* Please, pay special attention to this standard for numbering lists (most particularly, for award requirements).
-
 
+
* Our wiki is different from other standard MediaWiki sites.
-
The following editing rules apply to this web site and may not apply to others. Please pay special attention to this web site's way of creating numbering lists (most specifically for award requirements). Our system is different from other standard MediaWiki sites.
+
Line 43: Line 42:
|-
|-
|Internal link<br />
|Internal link<br />
-
(within Wikipedia)
+
(within MeritBadgeDotOrg)
|
|
<tt><nowiki>[[name of page]]</nowiki></tt><br />
<tt><nowiki>[[name of page]]</nowiki></tt><br />
<tt><nowiki>[[name of page|display text]]</nowiki></tt><br />
<tt><nowiki>[[name of page|display text]]</nowiki></tt><br />
|
|
-
[[name of page]]<br />
+
<u><font color="blue">name of page</font></u><br />
-
[[name of page|display text]]<br />
+
<u><font color="blue">display text</font></u><br />
|-
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|colspan="3" style="border-top:1px solid #cee0f2;"|
Line 57: Line 56:
<tt><nowiki>#REDIRECT [[Target page]]</nowiki></tt>
<tt><nowiki>#REDIRECT [[Target page]]</nowiki></tt>
|
|
-
<big>&#8627;</big> [[Target page]]
+
<big>&rarr;</big> <u><font color="blue">Target page</font></u>
|-
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|colspan="3" style="border-top:1px solid #cee0f2;"|
Line 159: Line 158:
== Additional notes on page formatting ==
== Additional notes on page formatting ==
-
Requirements pages for Ranks, Awards, and Merit Badges have a somewhat formal structure. Award requirements are usually listed first under the '''== Award requirements ==''' heading. The next section will most likely be '''== Notes =='''. The page should end with '''== Help with these requirements ==''' and '''== External links =='''. Additional headings can be inserted as needed if they would be of considerable benefit. Based on the above, the following four headings will be used most often with any additional headings inserted between the first two and the last two:
+
Requirements pages for Ranks, Awards, and Merit Badges have a somewhat formal structure. The first thing placed at the top of the page is the link to an appropriate image file (see [[#Adding_an_Image|Adding an Image]] below). Award requirements are usually listed first under the '''== Award requirements ==''' heading. The next section will most likely be '''== Notes =='''. The page should end with '''== Help with these requirements ==''' and '''== External links =='''. Additional headings can be inserted as needed if they would be of considerable benefit. Based on the above, the following four headings will be used most often with any additional headings inserted between the first two and the last two:
 +
 
 +
<tt><nowiki>[[Image:50miler.jpg|thumb|50 Miler Award patch. This patch is not worn on the uniform but may be worn on a jacket or patch vest or placed on blankets, backpacks, or other personal equipment.]]</nowiki></tt>
<tt><nowiki>== Award requirements ==</nowiki></tt>
<tt><nowiki>== Award requirements ==</nowiki></tt>
Line 168: Line 169:
<tt><nowiki>== External links ==</nowiki></tt>
<tt><nowiki>== External links ==</nowiki></tt>
 +
 +
== Adding an Image ==
 +
[[Image:50miler.jpg|thumb|50 Miler Award patch. This patch is not worn on the uniform but may be worn on a jacket or patch vest or placed on blankets, backpacks, or other personal equipment.]]
 +
 +
All Ranks, Awards, and Merit Badges pages should start with an image of the actual award. We will use the 50 Miler Award as an example. You will note that there is a thumbnail of the [[50 Miler Award]] patch to the right on your screen. This was done by including the following text in this page's code:
 +
 +
'''<tt><nowiki>[[Image:50miler.jpg|thumb|50 Miler Award patch. This patch is not worn on the uniform but may be worn on a jacket or patch vest or placed on blankets, backpacks, or other personal equipment.]]</nowiki></tt>'''
 +
 +
Please note the text that appears in the caption. The first sentence identifies the patch. The second sentence explains how this particular patch is displayed. In this case, this patch cannot be worn directly on the uniform. However, it can be placed on any piece of personal clothing or personal gear. This information should be included in the description text when the image is actually uploaded. Information about this image file and all other uploaded files can be found at [[Special:Imagelist]].
 +
 +
[[Image:50miler.jpg|left]]
 +
 +
Also, please note that the image above and to the right is not the original image's true size. The actual image size is shown on the left. This web site's software automatically resizes the image and places it to the far right of the screen if you use the '''''thumb''''' command. As a rule, you should always use the thumb command for an image at the beginning of an article.
 +
 +
Let's review the code above so you understand what each part does. The first portion of the code reads:
 +
 +
'''<tt><nowiki>[[Image:50miler.jpg|</nowiki></tt>'''
 +
 +
This identifies that you are using an image and the image's name is ''50miler.jpg''. See the pipe at the end of the first section of code? This indicates that this section of code is finished and will be followed with more code.
 +
 +
'''<tt><nowiki>thumb|</nowiki></tt>'''
 +
 +
The second portion of the code is simply ''thumb'' followed by another pipe. This is what forces the image to resize and also places the image to the right of the page instead of in the default position.
 +
 +
'''<tt><nowiki>50 Miler Award patch. This patch is not worn on the uniform but may be worn on a jacket or patch vest or placed on blankets, backpacks, or other personal equipment.]]</nowiki></tt>'''
 +
 +
As you can see, the last part of the code is a description of the award - it's name and where it can be worn. It's that simple. Please note that a pipe is not used after the final section of code, just the closing brackets.
 +
 +
== Suggested styles for creating links ==
 +
 +
====Within text...====
 +
To reference an external link within written text, type <nowiki>"....The [http://www.nesa.org/trail/manual.html Eagle Scout Leadership Service Project] manual (2000 Edition, or later) must be used when...."</nowiki> to get:
 +
 +
:"....The [http://www.nesa.org/trail/manual.html Eagle Scout Leadership Service Project] manual (2000 Edition, or later) must be used when...."
 +
 +
The intended purpose here is to present the reader with flowing text (with the hyperlink embedded), rather than a hyperlink stuck in the middle of the text, disrupting the readability. '''Note:''' This method also works best for internal links, as well.
 +
 +
====In a list...====
 +
To list external links, this seems to be the preferred method:
 +
 +
:*[http://www.scouting.org Boy Scouts of America] &mdash; ''official'' BSA home page
 +
:*[http://www.nesa.org National Eagle Scout Association] &mdash; Citation, details, notes, etc.
 +
:*[http://www.example.org Example] &mdash; Citation, details, notes, etc.
 +
:*[http://www.example.org Another example] &mdash; Citation, details, notes, etc.
 +
 +
Again, as above... readability. Plus, in this case, the bullets help the reader visualize the fact that it's a list. (By the way, in any case, mousing over the link will show the reader the hyperlink.)
== External links ==
== External links ==
-
More extensive editing information can be found at http://www.mediawiki.org/wiki/Help:Editing
+
===MediaWiki===
 +
*[http://www.mediawiki.org/wiki/Help:Contents MediaWiki Help:Contents] &mdash; MediaWiki Help:Contents is a great place to learn about MediaWiki
 +
**[http://www.mediawiki.org/wiki/Help:Editing MediaWiki Help:Editing] &mdash; Contains extensive help and information about editing MediaWiki pages
 +
 
 +
*[http://www.mediawiki.org/wiki/Manual:Purge MediaWiki Manual:Purge] &mdash; How to ''immediately'' purge the server-side cache for a specific page after uploading an updated image (e.g. .pdf workbooks)
 +
 
 +
===Wikipedia===
 +
*[http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page Wikipedia:How to edit a page] &mdash; an extensive page editing help section for editing on Wikipedia
 +
*[http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia:Manual of Style] &mdash; Wikipedia's '''Manual of Style''' for making pages look sharp
 +
 
 +
<blockquote style="background: white; border: 1px solid black; padding: 1em;">
 +
'''Note:''' There are a ''very'' few (sometimes minor, sometimes sigificant) differences between formatting (editing) code in Wikipedia and MediaWiki. So, if you are used to Wikipedia, you may occassionaly run into unexpected coding differences. In such cases, please refer to MediaWiki's documentation for guidance. Or, ask for help.</blockquote>
-
Information on topics such as starting a new page and inserting images can be found at http://www.mediawiki.org/wiki/Help:Contents
+
===Other===
-
Wikipedia also has an extensive page editing help section at http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page
+
*[http://web.njit.edu/~kevin/rgb.txt.html RGB to Color Name Mapping (Triplet and Hex)]

Current revision


All contributors must read the Usage standards policy prior to editing any article, especially those in the "main" namespace.

Editing basics

  • The following editing rules apply to this web site (wiki) and may not apply to others.
  • Please, pay special attention to this standard for numbering lists (most particularly, for award requirements).
  • Our wiki is different from other standard MediaWiki sites.


Description You type You get
Applies anywhere
Italicise text

''italic''

italic

Bold text

'''bold'''

bold

Bold and italic

'''''bold & italic'''''

bold & italic

Internal link

(within MeritBadgeDotOrg)

[[name of page]]
[[name of page|display text]]

name of page
display text

Redirect to another page

#REDIRECT [[Target page]]

Target page

External link

(to other websites)

[http://www.example.org]
[http://www.example.org display text]
http://www.example.org

[1]
display text
http://www.example.org

Sign your posts
on talk pages

~~~~

Your username 10:35,
20 December 2014 (UTC)

Applies only at the beginning of the line
Headings

A Table of Contents will automatically be generated when four or more headings are added to an article.

== Level 1 ==
=== Level 2 ===
==== Level 3 ====
===== Level 4 =====
====== Level 5 ======

Level 1

Level 2

Level 3

Level 4
Level 5
Bullet list

* one
* two
** two point one
* three

  • one
  • two
    • two point one
  • three
Making real asterisks

(remove the spaces
inside the < > signs)

< nowiki >*< /nowiki > one
< nowiki >**< /nowiki > two
< nowiki >***< /nowiki > three

* one
** two
*** three

MeritBadgeDotOrg's modified
numbered list

:1. one
:2. two
::1. two point one
:3. three

1. one
2. two
1. two point one
3. three
MediaWiki's standard
numbered list
(DO NOT USE)

# one
# two
## two point one
# three

  1. one
  2. two
    1. two point one
  3. three


Additional notes on page formatting

Requirements pages for Ranks, Awards, and Merit Badges have a somewhat formal structure. The first thing placed at the top of the page is the link to an appropriate image file (see Adding an Image below). Award requirements are usually listed first under the == Award requirements == heading. The next section will most likely be == Notes ==. The page should end with == Help with these requirements == and == External links ==. Additional headings can be inserted as needed if they would be of considerable benefit. Based on the above, the following four headings will be used most often with any additional headings inserted between the first two and the last two:

[[Image:50miler.jpg|thumb|50 Miler Award patch. This patch is not worn on the uniform but may be worn on a jacket or patch vest or placed on blankets, backpacks, or other personal equipment.]]

== Award requirements ==

== Notes ==

== Help with these requirements ==

== External links ==

Adding an Image

50 Miler Award patch. This patch is not worn on the uniform but may be worn on a jacket or patch vest or placed on blankets, backpacks, or other personal equipment.
50 Miler Award patch. This patch is not worn on the uniform but may be worn on a jacket or patch vest or placed on blankets, backpacks, or other personal equipment.

All Ranks, Awards, and Merit Badges pages should start with an image of the actual award. We will use the 50 Miler Award as an example. You will note that there is a thumbnail of the 50 Miler Award patch to the right on your screen. This was done by including the following text in this page's code:

[[Image:50miler.jpg|thumb|50 Miler Award patch. This patch is not worn on the uniform but may be worn on a jacket or patch vest or placed on blankets, backpacks, or other personal equipment.]]

Please note the text that appears in the caption. The first sentence identifies the patch. The second sentence explains how this particular patch is displayed. In this case, this patch cannot be worn directly on the uniform. However, it can be placed on any piece of personal clothing or personal gear. This information should be included in the description text when the image is actually uploaded. Information about this image file and all other uploaded files can be found at Special:Imagelist.

Also, please note that the image above and to the right is not the original image's true size. The actual image size is shown on the left. This web site's software automatically resizes the image and places it to the far right of the screen if you use the thumb command. As a rule, you should always use the thumb command for an image at the beginning of an article.

Let's review the code above so you understand what each part does. The first portion of the code reads:

[[Image:50miler.jpg|

This identifies that you are using an image and the image's name is 50miler.jpg. See the pipe at the end of the first section of code? This indicates that this section of code is finished and will be followed with more code.

thumb|

The second portion of the code is simply thumb followed by another pipe. This is what forces the image to resize and also places the image to the right of the page instead of in the default position.

50 Miler Award patch. This patch is not worn on the uniform but may be worn on a jacket or patch vest or placed on blankets, backpacks, or other personal equipment.]]

As you can see, the last part of the code is a description of the award - it's name and where it can be worn. It's that simple. Please note that a pipe is not used after the final section of code, just the closing brackets.

Suggested styles for creating links

Within text...

To reference an external link within written text, type "....The [http://www.nesa.org/trail/manual.html Eagle Scout Leadership Service Project] manual (2000 Edition, or later) must be used when...." to get:

"....The Eagle Scout Leadership Service Project manual (2000 Edition, or later) must be used when...."

The intended purpose here is to present the reader with flowing text (with the hyperlink embedded), rather than a hyperlink stuck in the middle of the text, disrupting the readability. Note: This method also works best for internal links, as well.

In a list...

To list external links, this seems to be the preferred method:

Again, as above... readability. Plus, in this case, the bullets help the reader visualize the fact that it's a list. (By the way, in any case, mousing over the link will show the reader the hyperlink.)

External links

MediaWiki

  • MediaWiki Manual:Purge — How to immediately purge the server-side cache for a specific page after uploading an updated image (e.g. .pdf workbooks)

Wikipedia

Note: There are a very few (sometimes minor, sometimes sigificant) differences between formatting (editing) code in Wikipedia and MediaWiki. So, if you are used to Wikipedia, you may occassionaly run into unexpected coding differences. In such cases, please refer to MediaWiki's documentation for guidance. Or, ask for help.

Other

Personal tools
language