Difference between revisions of "Wiki Editing Help"
KristinaWeis (talk | contribs) |
|||
(43 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
< [[Help FAQ]] | < [[Help FAQ]] | ||
+ | <!--<div class="auCorner">Note: The below instructions for wiki markup only works in the '''Wiki''' section of pages.</div><br />--> | ||
+ | ==Basic Wiki Formatting== | ||
+ | ---- | ||
+ | {{GenericHelpBox}} | ||
+ | There are several ways that you can change or enhance the look of the Wiki section on your page with formatting such as: headings, '''bold''' and ''italic text'', links, bulleted lists, colors, quote boxes, images and more. This page can show you how. | ||
− | + | Simple editing is one of the major benefits of using a [[WikiWiki|wiki]]. Users can edit wiki pages without knowing [[HTML]], yet still do many of the same things more easily. Please feel free to experiment in the [[Sandbox]]. | |
− | + | <small>Note that [[WikiWiki|Wiki]] is a general name for this type of collaborative software, or editable website. There are many different Wiki sites and products out there, and some use different types of "markup" (coding) than others. AboutUs.org uses a version of [[MediaWiki]] software, same as [[Wikipedia.org]], so the markup is very similar.</small> | |
− | |||
− | |||
− | + | ==Basic Text== | |
− | |||
− | |||
− | |||
− | |||
Most text does not require any special changes for wiki form. A few basic rules are: | Most text does not require any special changes for wiki form. A few basic rules are: | ||
Line 18: | Line 17: | ||
* There is no need to encode HTML characters like <, >, or &. | * There is no need to encode HTML characters like <, >, or &. | ||
− | + | ==Bold and Italic Text== | |
+ | ---- | ||
To mark text as: | To mark text as: | ||
: '''bold''', use three single quotes - <nowiki>''' bold '''</nowiki>, | : '''bold''', use three single quotes - <nowiki>''' bold '''</nowiki>, | ||
Line 24: | Line 24: | ||
: '''''bold+italic''''', use five single quotes - <nowiki>''''' bold+italic '''''</nowiki>. | : '''''bold+italic''''', use five single quotes - <nowiki>''''' bold+italic '''''</nowiki>. | ||
− | + | Note that MediaWiki (like most Wikis) processes pages line-by-line, so if you want three bold lines of text, you will need to start each with <nowiki>'''</nowiki>. Also note that unclosed or unmatched tags are not removed from the page. | |
− | + | ==Headings== | |
− | + | ---- | |
− | |||
− | |||
− | |||
− | |||
− | |||
Headings are delimited by 1-7 equal signs (=). They basically correspond to HTML's <h1> through <h7> tags. These are also called section headers and simply place whatever text you want to be a headline between the equal signs. (Note: Most headings on [[AboutUs]] are size 2, although this page is using size 3 primarily.) | Headings are delimited by 1-7 equal signs (=). They basically correspond to HTML's <h1> through <h7> tags. These are also called section headers and simply place whatever text you want to be a headline between the equal signs. (Note: Most headings on [[AboutUs]] are size 2, although this page is using size 3 primarily.) | ||
<pre>= Headline size 1 = | <pre>= Headline size 1 = | ||
== Headline size 2 == | == Headline size 2 == | ||
− | |||
==== Headline size 4 ==== | ==== Headline size 4 ==== | ||
===== Headline size 5 ===== | ===== Headline size 5 ===== | ||
− | ===== Headline size | + | </pre> |
− | + | produces: | |
+ | |||
+ | = Headline size 1 = | ||
+ | == Headline size 2 == | ||
+ | ==== Headline size 4 ==== | ||
+ | ===== Headline size 5 ===== | ||
− | + | Note: When a page has more than 4 headings on it, you will automatically end up with a '''table of contents'''. This isn't usually helpful, so it can be best to remove it. To remove the automatic table of contents, add this to the Wiki section on its own line: | |
+ | |||
+ | <nowiki>__NOTOC__</nowiki> | ||
+ | |||
+ | or if you want the table of contents right justified, use this: | ||
+ | |||
+ | <nowiki>{{RightTOC}}</nowiki> | ||
+ | |||
+ | ==Linking== | ||
+ | ---- | ||
To create an ''internal'' [[WikiLink]] to another AboutUs page simply place the name of the page (in the [[URL]] it will be everything after the aboutus.org/) in ''double'' brackets. | To create an ''internal'' [[WikiLink]] to another AboutUs page simply place the name of the page (in the [[URL]] it will be everything after the aboutus.org/) in ''double'' brackets. | ||
− | :<pre>[[AboutUs.org]]</pre> will produce: [[AboutUs.org]] | + | : <pre>[[AboutUs.org]]</pre> will produce: [[AboutUs.org]] |
− | :You can also change what the link will say using a pipe. | + | : You can also change what the link will say using a pipe. |
− | :<pre>[[AboutUs.org|AboutUs]]</pre> will produce: [[AboutUs.org|AboutUs]] | + | : <pre>[[AboutUs.org|AboutUs]]</pre> will produce: [[AboutUs.org|AboutUs]] |
− | To create an ''external'' link to another website, place the entire | + | To create an ''external'' link to another website, place the entire URL in ''single'' brackets, then add a single space to name the link. |
− | :<pre>[http://www.google.com/ Google]</pre> will produce: [http://www.google.com/ Google] | + | : <pre>[http://www.google.com/ Google]</pre> will produce: [http://www.google.com/ Google] |
+ | |||
+ | Our [[LinkingGuide|Linking Guide]] helps you understand when an external link is appropriate here at this website. | ||
===Bulleted and Numbered Lists=== | ===Bulleted and Numbered Lists=== | ||
+ | ---- | ||
Bulleted lists: | Bulleted lists: | ||
<pre> | <pre> | ||
Line 71: | Line 82: | ||
<pre> | <pre> | ||
# Text for a numbered list item. | # Text for a numbered list item. | ||
+ | # Normal numbered list. | ||
## Text for second-level list. | ## Text for second-level list. | ||
### Text for third level, etc. | ### Text for third level, etc. | ||
Line 78: | Line 90: | ||
...which looks like: | ...which looks like: | ||
# Text for a numbered list item. | # Text for a numbered list item. | ||
+ | # Normal numbered list. | ||
## Text for second-level list. | ## Text for second-level list. | ||
### Text for third level, etc. | ### Text for third level, etc. | ||
## Another Text for the second level. | ## Another Text for the second level. | ||
− | + | ==Indented Text== | |
+ | ---- | ||
Simple indented text: | Simple indented text: | ||
<pre> | <pre> | ||
Line 95: | Line 109: | ||
::: Text indented to third level | ::: Text indented to third level | ||
− | ===Preformatted Text=== | + | <!--===Preformatted Text=== |
Individual lines can be displayed as preformatted (fixed-width or "typewriter"-font) text by placing one or more spaces at the start of the line. Other wiki formatting (like links) will be applied to this kind of preformatted text. | Individual lines can be displayed as preformatted (fixed-width or "typewriter"-font) text by placing one or more spaces at the start of the line. Other wiki formatting (like links) will be applied to this kind of preformatted text. | ||
Line 111: | Line 125: | ||
This is the starting-spaces version of | This is the starting-spaces version of | ||
preformatted text. Note that links like | preformatted text. Note that links like | ||
− | [[Soccer]] still work. | + | [[Soccer]] still work.--> |
+ | ==Uploading, Posting, and Modifying Images== | ||
+ | ---- | ||
+ | Website profile pages on AboutUs.org have a built-in logo section at the top left, but you can add more images, photos and graphics to the Wiki section. | ||
− | + | See the '''[[ImageHelp|Image Help]]''' page for assistance with: | |
+ | * Uploading and adding images, photos, or logos to a page. | ||
+ | * [[ImageHelp|Modifying a picture or logo on your page]], such as changing the placement and size of your image, putting a frame around it, using a thumbnail that can be enlarged, or creating a gallery of images. | ||
+ | |||
+ | ==Wiki Editing with Templates== | ||
+ | ---- | ||
A template is a wiki page whose contents are specially intended to be inserted into another wiki page by the "transclusion" process. When you use a template, the template name is surrounded in double curly braces: <nowiki>{{NameOfTemplate}}.</nowiki> | A template is a wiki page whose contents are specially intended to be inserted into another wiki page by the "transclusion" process. When you use a template, the template name is surrounded in double curly braces: <nowiki>{{NameOfTemplate}}.</nowiki> | ||
− | + | ==Pretty Social Media Templates== | |
+ | ---- | ||
+ | <nowiki>{{Facebook|url=http://www.facebook.com/YOURINFOHERE}}</nowiki> creates: {{Facebook|url=http://www.facebook.com/AboutUs.org}} | ||
+ | |||
+ | <nowiki>{{Twitter|YOURINFOHERE}}</nowiki> creates: {{Twitter|AboutUs}} | ||
+ | |||
+ | <nowiki>{{LinkedIn|url=http://www.linkedin.com/in/YOURINFOHERE}}</nowiki> creates: {{LinkedIn|url=http://www.linkedin.com/in/beckyengel}} | ||
− | = | + | <nowiki>{{YouTube|url=http://www.youtube.com/YOURINFOHERE}}</nowiki> creates: {{YouTube|url=http://www.youtube.com/AboutUsWiki}} |
− | |||
− | ===Colors== | + | For more, see [[Business Templates for AboutUs Website Profiles]]. |
− | :'' | + | |
+ | ==Large, Stand-Out Quotes== | ||
+ | ---- | ||
+ | {{Pullquote|right|Make a quote stand out, <br>like this.|Who said it}} | ||
+ | : Type '''<nowiki>{{Pullquote|left|Type your quote here.|Attribution}}</nowiki>''' You can substitute '''left''' or '''right''' to position your quote on the page, and text will wrap around it. | ||
+ | |||
+ | : Or type '''<nowiki>{{Pullquotewide|Type your quote here.|Cite your quote here.}}</nowiki>''' to get a quote that is full-width, like this:{{Pullquotewide|Make your quote spread out across one or more lines on the page, like this.|AboutUs}} | ||
+ | |||
+ | ==Colors== | ||
+ | ---- | ||
+ | : ''Use sparingly.'' | ||
For colored text, use: | For colored text, use: | ||
− | :<nowiki>{{color|name of the color OR hex code|your text here}}</nowiki> | + | : <nowiki>{{color|name of the color OR hex code|your text here}}</nowiki> |
For example, for blue text use the following code: | For example, for blue text use the following code: | ||
− | :<nowiki>{{color|blue|your text here}}</nowiki> | + | : <nowiki>{{color|blue|your text here}}</nowiki> |
− | :The text would look like this: {{color|blue|your text here}} | + | : The text would look like this: {{color|blue|your text here}} |
− | + | <!-- | |
− | + | ==Quote Boxes== | |
− | + | ---- | |
− | |||
− | |||
− | |||
− | |||
− | |||
Type the following series of lines: | Type the following series of lines: | ||
− | :<nowiki>{{Quote-Box</nowiki><br> | + | : <nowiki>{{Quote-Box</nowiki><br> |
− | :<nowiki>|quote=Type your quote or message here. Insert quotation marks, if desired.</nowiki><br> | + | : <nowiki>|quote=Type your quote or message here. Insert quotation marks, if desired.</nowiki><br> |
− | :<nowiki>|quote-name=Type the source of your quote or second message line here</nowiki><br> | + | : <nowiki>|quote-name=Type the source of your quote or second message line here</nowiki><br> |
− | :<nowiki>|quote-TextSize=type 100% (or larger to select a type size)</nowiki><br> | + | : <nowiki>|quote-TextSize=type 100% (or larger to select a type size)</nowiki><br> |
− | :<nowiki>|quote-date=give your quote a date, if applicable</nowiki><br> | + | : <nowiki>|quote-date=give your quote a date, if applicable</nowiki><br> |
− | :<nowiki>}} (to end quote box)</nowiki> | + | : <nowiki>}} (to end quote box)</nowiki> |
{{Quote-Box | {{Quote-Box | ||
|quote="This is how you make a quote box." | |quote="This is how you make a quote box." | ||
Line 155: | Line 187: | ||
{{color|white|<br>}} | {{color|white|<br>}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ==ClickPic for internal image links== | |
− | + | ---- | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
Steps: | Steps: | ||
* [[Upload file|Upload]] the image to AboutUs that will be shown on an AboutUs page | * [[Upload file|Upload]] the image to AboutUs that will be shown on an AboutUs page | ||
Line 183: | Line 201: | ||
* Example: <nowiki>{{Clickpic|Foo.com|http://example.com/image.png}}</nowiki> | * Example: <nowiki>{{Clickpic|Foo.com|http://example.com/image.png}}</nowiki> | ||
* Note: the three sections of this template are separated with a pipe bar (|) | * Note: the three sections of this template are separated with a pipe bar (|) | ||
+ | --> | ||
+ | ==Linking Images== | ||
+ | ---- | ||
+ | To create a link to a page from an image (i.e., clicking on an image to take you to another web page). | ||
− | + | : <nowiki>[http://foo.com http://imageURL.jpg]</nowiki> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
==Posting Videos== | ==Posting Videos== | ||
− | + | ---- | |
+ | You can embed a [[YouTube.com|YouTube]] video in a page by: | ||
+ | |||
+ | * Copying the relevant identification number from the YouTube video URL (starting after the '=' sign) | ||
+ | : [[Image:YouTubeURL.jpg]] | ||
+ | * Pasting this identification number from YouTube (between <nowiki><YouTube></YouTube></nowiki> tags) into the Wiki section of the [[AboutUs]] page. | ||
+ | : Example: <nowiki><YouTube>U-shZs2I4E4</YouTube></nowiki> | ||
+ | * Save your edits and play the video. | ||
+ | |||
+ | For more information, see our [[AboutUs Video Support]] page. | ||
− | [[ | + | ==Questions?== |
− | + | ---- | |
+ | We're happy to help. Just '''[[Contact Info for AboutUs.org|choose a way to contact us]]'''. | ||
__NOTOC__ | __NOTOC__ |
Latest revision as of 08:52, 21 March 2015
Note that Wiki is a general name for this type of collaborative software, or editable website. There are many different Wiki sites and products out there, and some use different types of "markup" (coding) than others. AboutUs.org uses a version of MediaWiki software, same as Wikipedia.org, so the markup is very similar.
Basic Text
Most text does not require any special changes for wiki form. A few basic rules are:
- Do not indent paragraphs.
- Leave a single blank line between paragraphs.
- There is no need to encode HTML characters like , or &.
Bold and Italic Text
To mark text as:
- bold, use three single quotes - ''' bold ''',
- italic, use two single quotes - '' italic '',
- bold+italic, use five single quotes - ''''' bold+italic '''''.
Note that MediaWiki (like most Wikis) processes pages line-by-line, so if you want three bold lines of text, you will need to start each with '''. Also note that unclosed or unmatched tags are not removed from the page.
Headings
Headings are delimited by 1-7 equal signs (=). They basically correspond to HTML's <h1> through <h7> tags. These are also called section headers and simply place whatever text you want to be a headline between the equal signs. (Note: Most headings on AboutUs are size 2, although this page is using size 3 primarily.)
= Headline size 1 = == Headline size 2 == ==== Headline size 4 ==== ===== Headline size 5 =====
produces:
Headline size 1
Headline size 2
Headline size 4
Headline size 5
Note: When a page has more than 4 headings on it, you will automatically end up with a table of contents. This isn't usually helpful, so it can be best to remove it. To remove the automatic table of contents, add this to the Wiki section on its own line:
__NOTOC__
or if you want the table of contents right justified, use this:
{{RightTOC}}
Linking
To create an internal WikiLink to another AboutUs page simply place the name of the page (in the URL it will be everything after the aboutus.org/) in double brackets.
-
[[AboutUs.org]]
will produce: AboutUs.org
- You can also change what the link will say using a pipe.
-
[[AboutUs.org|AboutUs]]
will produce: AboutUs
To create an external link to another website, place the entire URL in single brackets, then add a single space to name the link.
-
[http://www.google.com/ Google]
will produce: Google
Our Linking Guide helps you understand when an external link is appropriate here at this website.
Bulleted and Numbered Lists
Bulleted lists:
* Text for a bulleted list item. ** Text for second-level list. *** Text for third level, etc.
...which looks like:
- Text for a bulleted list item.
- Text for second-level list.
- Text for third level, etc.
- Text for second-level list.
Numbered lists:
# Text for a numbered list item. # Normal numbered list. ## Text for second-level list. ### Text for third level, etc. ## Another Text for the second level.
...which looks like:
- Text for a numbered list item.
- Normal numbered list.
- Text for second-level list.
- Text for third level, etc.
- Another Text for the second level.
- Text for second-level list.
Indented Text
Simple indented text:
: Text to be indented (quote-block) :: Text indented more ::: Text indented to third level
...which looks like:
- Text to be indented (quote-block)
- Text indented more
- Text indented to third level
- Text indented more
Uploading, Posting, and Modifying Images
Website profile pages on AboutUs.org have a built-in logo section at the top left, but you can add more images, photos and graphics to the Wiki section.
See the Image Help page for assistance with:
- Uploading and adding images, photos, or logos to a page.
- Modifying a picture or logo on your page, such as changing the placement and size of your image, putting a frame around it, using a thumbnail that can be enlarged, or creating a gallery of images.
Wiki Editing with Templates
A template is a wiki page whose contents are specially intended to be inserted into another wiki page by the "transclusion" process. When you use a template, the template name is surrounded in double curly braces: {{NameOfTemplate}}.
Pretty Social Media Templates
{{Facebook|url=http://www.facebook.com/YOURINFOHERE}} creates: : [}}} Facebook]
{{Twitter|YOURINFOHERE}} creates: : @AboutUs
{{LinkedIn|url=http://www.linkedin.com/in/YOURINFOHERE}} creates: : [}}} LinkedIn]
{{YouTube|url=http://www.youtube.com/YOURINFOHERE}} creates: : [}}} YouTube]
For more, see Business Templates for AboutUs Website Profiles.
Large, Stand-Out Quotes
mett.in
- Type {{Pullquote|left|Type your quote here.|Attribution}} You can substitute left or right to position your quote on the page, and text will wrap around it.
- Or type {{Pullquotewide|Type your quote here.|Cite your quote here.}} to get a quote that is full-width, like this:
Make your quote spread out across one or more lines on the page, like this.AboutUs
Colors
- Use sparingly.
For colored text, use:
- {{color|name of the color OR hex code|your text here}}
For example, for blue text use the following code:
- {{color|blue|your text here}}
- The text would look like this: your text here
Linking Images
To create a link to a page from an image (i.e., clicking on an image to take you to another web page).
- [http://foo.com http://imageURL.jpg]
Posting Videos
You can embed a YouTube video in a page by:
- Copying the relevant identification number from the YouTube video URL (starting after the '=' sign)
- Pasting this identification number from YouTube (between <YouTube></YouTube> tags) into the Wiki section of the AboutUs page.
- Example: <YouTube>U-shZs2I4E4</YouTube>
- Save your edits and play the video.
For more information, see our AboutUs Video Support page.
Questions?
We're happy to help. Just choose a way to contact us.