Help:Editing: Difference between revisions

From PortlandWiki
Jump to navigation Jump to search
(→‎Videos: Highlight video code examples.)
m (Add a category instruction.)
 
(32 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{RightTOC}}
{{RightTOC}}
'''So you want to edit PortlandWiki?''' Well, don't screw anything up.
; So you want to edit PortlandWiki?


''Just kidding!'' It's impossible to screw PortlandWiki up, since ''everything can be undone''. So go wild. But if you want some guidance on what are best practices (and most of us do), keep reading.
'''''You're in luck!''''' It's impossible to screw PortlandWiki up, since ''everything can be undone''. So go wild. But if you want some guidance on what are best practices (and most of us do), keep reading.


Not the editing and writing type? Check out our [[PW:To do|to do list]], it's full of random miscellaneous things to do that will help us build a great Portland resource we can all enjoy and be proud of!
Not the editing and writing type? Check out our [[PW:To do|to do list]], it's full of random miscellaneous things to do that will help us build a great Portland resource we can all enjoy and be proud of!
Line 9: Line 9:
Creating a new PortlandWiki page is reasonably quick and mostly pain-free. As this wiki matures, there may come a time when most contributions will consist of editing and/or updating existing pages. But Portland Wiki is still growing like half-wild toddler, so what's stopping you? Go ahead, start a new page. You can ''do'' it!
Creating a new PortlandWiki page is reasonably quick and mostly pain-free. As this wiki matures, there may come a time when most contributions will consist of editing and/or updating existing pages. But Portland Wiki is still growing like half-wild toddler, so what's stopping you? Go ahead, start a new page. You can ''do'' it!


Let's look at a few elements<ref>[[wikipedia:Wikipedia:Cheatsheet|Wikipedia Cheatsheet]]</ref> you may want to include in even a minimalist new PortlandWiki page<ref>[[mediawikiwiki:Help:Starting_a_new_page|Help:Starting a new page]]</ref>.
=== Starting a new page ===
'''1. In the "Search" box (top, right of your screen), type this:'''
 
<pre>Your new page name</pre>
 
'''2. Click the little magnifying glass icon you see there in the search box.''' You'll see a "red link" to the page name you just searched for. Click that red link and begin editing.
 
(Sorry we've been too lame to add an "edit page" button yet; that's been on the "to do" list of several <span class="plainlinks">[http://portlandwiki.org/index.php?title=Special%3AListUsers&username=&group=bureaucrat PortlandWiki admins]</span> for at least 18 months. Hey, we're volunteers; bad excuse, but true...)
 
'''3. Suppose you're adding a new page to a group of already existing pages.''' At the top of your new article, type this little navigational feature:
 
<pre><<< [[Main page in your page group]]</pre>
 
(That'll help get folks back to the main page.)
 
And finally...
=== Add a <span class="plainlinks">[http://portlandwiki.org/index.php?title=Special:Categories&limit=1000 category]</span> ===
'''4. At the bottom of your new article, type this:'''
 
<pre><nowiki>[[Category:The most appropriate category for your page]]</nowiki></pre>
 
'''Here's a list of existing categories:''' <span class="plainlinks">[http://portlandwiki.org/index.php?title=Special:Categories&limit=1000 PortlandWiki Category List]</span>
 
'''Don't forget to save! :-)'''
 
Now let's look at a few elements<ref>[[wikipedia:Wikipedia:Cheatsheet|Wikipedia Cheatsheet]]</ref> you may want to include in even a minimalist new PortlandWiki page<ref>[[mediawikiwiki:Help:Starting_a_new_page|Help:Starting a new page]]</ref>.


=== Page title ===
=== Page title ===
Line 33: Line 58:
* Next, click on the Edit menu ([[Help:Editing#Take_a_peek_under_our_skirts|instructions below)]] and insert the wiki text to display your image.
* Next, click on the Edit menu ([[Help:Editing#Take_a_peek_under_our_skirts|instructions below)]] and insert the wiki text to display your image.
<br style="clear:both"/><!-- this prevents the following code from overlapping preceding images -->
<br style="clear:both"/><!-- this prevents the following code from overlapping preceding images -->
<big>The wiki text to display the image shown to the right is:</big><br />
<nowiki>
[[File:Stop-TriMet-Service-Cuts-Rally.JPG|thumb|400px|[[OPAL]]'s [http://www.opalpdx.org/2010/08/rally-for-the-bus/ Rally for the BUS], held in front of [[Portland City Hall]] on September 1st, 2010.]]
</nowiki>


=== How about a handy list? ===
;The wiki text to display the image shown on the right is:
* Foo
<code><nowiki>[[File:Stop-TriMet-Service-Cuts-Rally.JPG|thumb|400px|[[OPAL]]'s [http://www.opalpdx.org/2010/08/rally-for-the-bus/ Rally for the BUS], held in front of [[Portland City Hall]] on September 1st, 2010.]]</nowiki></code>
* ''Bar''
* [http://www.limbo.in/ Foo lisH]
 
== Other Tricks ==
[[Special:Templates|Templates]], [[Template:Infobox|Infoboxes]], [[Special:Categories|tags]], [[Special:Categories|categories]] and many other bits of wiki stuff help connect articles in useful ways, making PortlandWiki easier to navigate.


== Videos ==
<div class="thumb tright"><div class="thumbinner" style="">
<div class="thumb tright"><div class="thumbinner" style="">
<videoflash>nGeXdv-uPaw</videoflash>
<videoflash>nGeXdv-uPaw</videoflash>
<div class="thumbcaption">[http://youtu.be/nGeXdv-uPaw She's Alive... Beautiful... Finite... Hurting... Worth Dying for.]</div></div></div>
<div class="thumbcaption">[http://youtu.be/nGeXdv-uPaw She's Alive... Beautiful... Finite... Hurting... Worth Dying for.]</div></div></div>
 
Burdened by an empire in decline, plummeting literacy rates and petty little verbal jabs -- like the U.S. becoming “Europe’s Mexico”<ref>[http://labornotes.org/2011/07/next-low-wage-haven-usa Next Low-Wage Haven: USA]</ref> -- flung our way by high-minded [[wikipedia:Eurotrash (term)|Eurotrash]] from [[wikipedia:Old Europe (politics)|Old Europe]]'s crustier regions, Americans have a lot to ''celebrate''!
== Videos ==
Burdened by an empire in decline, literacy rates that are plummeting and petty little verbal jabs -- like the U.S. becoming “Europe’s Mexico”<ref>[http://labornotes.org/2011/07/next-low-wage-haven-usa Next Low-Wage Haven: USA]</ref> -- flung our way by high-minded [[wikipedia:Eurotrash (term)|Eurotrash]] from [[wikipedia:Old Europe (politics)|Old Europe]]'s crustier regions, Americans have a lot to ''celebrate''!


Why?
Why?


Because we've got ''videos''!
Because we've got ''videos''!!!


Not only that, but we've got a handy little tool called [[mediawikiwiki:Extension:VideoFlash|VideoFlash]] installed on [[PortlandWiki]]! That means you can embed videos in the articles you edit.
Not only that, but we've got a handy little tool called [[mediawikiwiki:Extension:VideoFlash|VideoFlash]] installed on [[PortlandWiki]]! That means you can embed videos in the articles you edit.


Here's an example of the code you use:
=== Here's an example of the code you use: ===
<pre>
<code><nowiki><div class="thumb tright"><div class="thumbinner" style=""></nowiki></code>
<div class="thumb tright"><div class="thumbinner" style="">
<code><nowiki><videoflash>nGeXdv-uPaw</videoflash></nowiki></code>
<videoflash>nGeXdv-uPaw</videoflash>
<code><nowiki><div class="thumbcaption">[http://youtu.be/nGeXdv-uPaw She's Alive... Beautiful... Finite... Hurting... Worth Dying for.]</div></div></div></nowiki></code>
<div class="thumbcaption">[http://youtu.be/nGeXdv-uPaw She's Alive... Beautiful... Finite... Hurting... Worth Dying for.]</div></div></div>
 
</pre>
# The top line -- <code><nowiki><div class="thumb tright"><div class="thumbinner" style=""></nowiki></code> -- aligns your video to the right of the article and allows text to wrap beside it.
# The top line -- <span style="background-color:yellow;"><nowiki><div class="thumb tright"><div class="thumbinner" style=""></nowiki></span> -- aligns your video to the right of the article and allows text to wrap beside it.
# The middle line -- <code><nowiki><videoflash>nGeXdv-uPaw</videoflash></nowiki></code> -- contains the video code -- <span style="background-color:yellow;">nGeXdv-uPaw</span> -- sandwiched between the videoflash tags.
# The middle line -- <span style="background-color:yellow;"><nowiki><videoflash>nGeXdv-uPaw</videoflash></nowiki></span> -- contains the video code -- <span style="background-color:yellow;">nGeXdv-uPaw</span> -- sandwiched between the videoflash tags.
# The last line...<br />
# The last line...<br />
<span style="background-color:yellow;"><nowiki><div class="thumbcaption">[http://youtu.be/nGeXdv-uPaw She's Alive... Beautiful... Finite... Hurting... Worth Dying for.]</div></div></div></nowiki></span>
<code><nowiki><div class="thumbcaption">[http://youtu.be/nGeXdv-uPaw She's Alive... Beautiful... Finite... Hurting... Worth Dying for.]</div></div></div></nowiki></code>
:...contains the "caption" for your video that you can link back to its source.
:...contains the "caption" for your video that you can link back to its source.


The results are what you see to the right on this page! Yaaaay!!!
The results are what you see to the right on this page! Yaaaay!!!
=== Find the specific code configurations for many of the most popular video formats here: ===
[[mediawikiwiki:Extension:VideoFlash#Usage|Extension:VideoFlash]]
=== Image & Video Tricks ===
;Faking a "thumb" with alt "link"
* [[mediawikiwiki:Help talk:Images#Faking a "thumb" with alt "link"|Faking a "thumb" with alt "link"]]
=== How about a handy list? ===
* {{Foo}}
* ''{{Bar}}''
* [http://www.limbo.in/ {{Foo}} lisH]
== Templates ==
Templates are handy pages that simplify text, image or object insertion.
=== Foo ===
With this example, we'll use a simple <nowiki>{{Foo}}</nowiki> template to insert the word "{{Foo}}" into a simple [[wikipedia:Limerick (poetry)|limerick]]:
:''There once was a man named McGoo''
:''Who fixed things with a dollop of glue''
:''He reached in his pocket''
:''To fix brok'n locket''
:''And pulled out a handful of'' <span style="background-color:yellow;">{{Foo}}</span>
To use the <nowiki>{{Foo}}</nowiki> template, simply follow the instructions on the [[Template:Foo|Foo template page]].
=== Bar ===
Now let's show an example that employs [[PortlandWiki]]'s lovely li'l <nowiki>{{Foo}}</nowiki> template with our nice 'n' handy <nowiki>{{Bar}}</nowiki> template in this simple [[wikipedia:Drive My Car#Lyrics|lyric]]:
:''Baby you can <span style="background-color:yellow;">{{Foo}}</span> my <span style="background-color:orange;">{{Bar}}</span>''
:''Yes I'm gonna be <span style="background-color:yellow;">{{Foo}}</span> <span style="background-color:orange;">{{Bar}}</span>''
:''Baby you can <span style="background-color:yellow;">{{Foo}}</span> my <span style="background-color:orange;">{{Bar}}</span>''
:''And maybe I'll <span style="background-color:yellow;">{{Foo}}</span> <span style="background-color:orange;">{{Bar}}</span>''
To use the <nowiki>{{Bar}}</nowiki> template, simply follow the instructions on the [[Template:Bar|Bar template page]].
=== McDork ===
OK. You maybe you're thinking "why should I waste my time inserting <nowiki>{{Foo}}</nowiki> or <nowiki>{{Bar}}</nowiki> templates when I can just simply type ''Foo'' or ''Bar''?"
Good point! But have you considered what you could accomplish with a more ''robust'' template? A template, say, like [[PortlandWiki]]'s handy and useful <nowiki>{{McDork}}</nowiki> template, for instance?
[[PortlandWiki]]'s "McDork" template is a simple [[wikipedia:Limerick (poetry)|limerick]] template that will appear wherever you insert the code as shown here:
<code><nowiki>{{McDork}}</nowiki></code>
'''This is the result:'''
{{McDork}}
== Other Template Resources ==
* <span class="plainlinks">[http://portlandwiki.org/Category:Templates Category:Templates]</span>
: [[PortlandWiki]]'s collection of wiki templates.
* [[:Category:Templates|Infobox Templates]]
: [[PortlandWiki]]'s "categorical" collection of infobox templates.
* [[mediawikiwiki:Help:Templates|MediaWiki's Template Help Page]]
: SPECIAL NOTE: [[mediawikiwiki:Help:Templates#Copying from one wiki to another|Copying complex templates from one wiki to another.]]


=== Tags or Categories ===
=== Tags or Categories ===
Did you just create or edit a restaurant article? If it's not already tagged with the "Restaurants" category, tag it with the following bit of code at the end of the article:
Did you just create or edit a restaurant article? If it's not already tagged with the "Restaurants" category, tag it with the following bit of code at the end of the article:
* <nowiki>[[Category: Restaurants]]</nowiki>
* <nowiki>[[Category: Restaurants]]</nowiki>
See [[PortlandWiki]]'s fine and upstanding list of "categories" (or "tags") for details:
* [[Special:Categories|categories / tags]]
== [[wikipedia:Transclusion|Transclude]] content from one page to another ==
The [[mediawikiwiki:MediaWiki|MediaWiki]] software that powers PortlandWiki gives you many options for pulling content from one article to another. You can pull small snippets or copy whole pages from one page to another.
; Grab a bit of content from one page and use it on another.
Below we'll describe a couple of ways you can pull content from one page and use it on another.
=== [[mediawikiwiki:Extension:Labeled Section Transclusion|Labeled Section Transclusion]] ===
[[mediawikiwiki:Extension:Labeled Section Transclusion|Labeled Section Transclusion]] is one of the many [[mediawikiwiki:Category:Extensions|extensions]] PortlandWiki comes equipped with. Here are a couple of the many ways you can use it.
'''1. Embed the intro content from one page into another.'''<br />
Use this code on the page you want to pull content to:
<nowiki>{{#lsth:pagename}}</nowiki>
(Replace '''pagename''' with the name of the PortlandWiki page you want to pull the intro from.) All content above the first [[metawikipedia:Help:Section|section header]] will be embedded into your receiving page.
'''Example:''' See the box labeled '''Anti-Austerity Discussion Group''' on the '''[[CA/Continuations|People’s Budget Project]]''' page.
'''2. Embed a specific [[metawikipedia:Help:Section|section]] from one page into another.'''<br />
2(a) Use the code shown below to grab the section of a page. Insert the first bit of code ('''<code><nowiki><section begin=content-you-want /></nowiki></code>''') at the beginning of the content you want to embed on the other page, and the second bit ('''<code><nowiki><section end=content-you-want /></nowiki></code>''') at the end.
<pre><nowiki><section begin=content-you-want />
The content of the section you want to embed.
<section end=content-you-want /></nowiki></pre>
2(b) Next, insert the following bit of code into the page on which you want to embed the content from the other page:
<nowiki>{{#section:pagename|content-you-want}}</nowiki>


== Take a peek under our skirts ==
== Take a peek under our skirts ==
Want to see what actual wiki text (wiki formatting mark-up code)<ref>[http://en.wikipedia.org/wiki/Help:Wiki_markup Help:Wiki markup]</ref> looks like so you can "try this at home"? Yes? Click [http://portlandwiki.org/index.php?title=Help:Editing&action=edit here]. (You can also click the "Edit" menu, sandwiched between the "Read" and "View history" menus, which are all located just to the left of the Search box situated at the top, right of each page.)
Want to see what actual wiki text (wiki formatting mark-up code)<ref>[http://en.wikipedia.org/wiki/Help:Wiki_markup Help:Wiki markup]</ref> looks like so you can "try this at home"? Yes? Click [http://portlandwiki.org/index.php?title=Help:Editing&action=edit here]. (You can also click the "Improve" menu, sandwiched between the "Read" and "View history" menus, which are all located just to the left of the Search box situated at the top, right of each page.)


== Useful external links are a nice distraction ==
== Useful external links are a nice distraction ==
Line 86: Line 188:
* [[wikipedia:Wikipedia:Meetup_Box|Wikipedia:Meetup Box]]
* [[wikipedia:Wikipedia:Meetup_Box|Wikipedia:Meetup Box]]
* [[wikipedia:Template:Cent|Template:Centralized discussion]]
* [[wikipedia:Template:Cent|Template:Centralized discussion]]
* [[wikipedia:Wikipedia:Picture tutorial|Wikipedia:Picture tutorial]]
* [[wikipedia:Template:Annotated_image|Template:Annotated image]]
* [[wikipedia:Template:Annotated_image|Template:Annotated image]]
* [[wikipedia:Help:Formatting|Format your text using wiki markup.]]
* [[wikipedia:Help:Formatting|Format your text using wiki markup.]]

Latest revision as of 12:42, 18 May 2013

So you want to edit PortlandWiki?

You're in luck! It's impossible to screw PortlandWiki up, since everything can be undone. So go wild. But if you want some guidance on what are best practices (and most of us do), keep reading.

Not the editing and writing type? Check out our to do list, it's full of random miscellaneous things to do that will help us build a great Portland resource we can all enjoy and be proud of!

Create a new page!

Creating a new PortlandWiki page is reasonably quick and mostly pain-free. As this wiki matures, there may come a time when most contributions will consist of editing and/or updating existing pages. But Portland Wiki is still growing like half-wild toddler, so what's stopping you? Go ahead, start a new page. You can do it!

Starting a new page

1. In the "Search" box (top, right of your screen), type this:

Your new page name

2. Click the little magnifying glass icon you see there in the search box. You'll see a "red link" to the page name you just searched for. Click that red link and begin editing.

(Sorry we've been too lame to add an "edit page" button yet; that's been on the "to do" list of several PortlandWiki admins for at least 18 months. Hey, we're volunteers; bad excuse, but true...)

3. Suppose you're adding a new page to a group of already existing pages. At the top of your new article, type this little navigational feature:

<<< [[Main page in your page group]]

(That'll help get folks back to the main page.)

And finally...

Add a category

4. At the bottom of your new article, type this:

[[Category:The most appropriate category for your page]]

Here's a list of existing categories: PortlandWiki Category List

Don't forget to save! :-)

Now let's look at a few elements[1] you may want to include in even a minimalist new PortlandWiki page[2].

Page title

The first element you'll want to decide on as you create your new wiki page is a page title. The easiest way to entitle your new page is to perform a search to see if another Portland Wiki page already exists with that title. It's not likely you'll run into that problem while Portland Wiki is still a "tot," but if you do, perhaps you can think up another page title.

To search for a page, type your search query into the search box located in the top right corner of any PortlandWiki page.[3]

Consider visiting PortlandWiki's Sandbox page, where PortlandWiki contributors can freshen up their wiki markup skills.

Page structure

To create a new page, please include a minimal page structure, something like:

Clever paragraph header here

Grab your reader's attention with an eye-catching paragraph headline.

Next: two or three sentences about your subject

Now write a witty, light-of-heart (yet heavy of mind) opening paragraph.

OPAL's Rally for the BUS, held in front of Portland City Hall on September 1st, 2010.

Want an image with that?

The appropriate image[4] (one that won't permanently freak out a well-disciplined nun or psychologically harm a small child) can brighten up any wiki page. Here's how you can include an image:

  • First, upload your pic by clicking the "Upload file" menu located under the "Toolbox" heading shown in the list of menu items on the left side of the page.
  • Next, click on the Edit menu (instructions below) and insert the wiki text to display your image.


The wiki text to display the image shown on the right is
[[File:Stop-TriMet-Service-Cuts-Rally.JPG|thumb|400px|[[OPAL]]'s [http://www.opalpdx.org/2010/08/rally-for-the-bus/ Rally for the BUS], held in front of [[Portland City Hall]] on September 1st, 2010.]]

Videos

Burdened by an empire in decline, plummeting literacy rates and petty little verbal jabs -- like the U.S. becoming “Europe’s Mexico”[5] -- flung our way by high-minded Eurotrash from Old Europe's crustier regions, Americans have a lot to celebrate!

Why?

Because we've got videos!!!

Not only that, but we've got a handy little tool called VideoFlash installed on PortlandWiki! That means you can embed videos in the articles you edit.

Here's an example of the code you use:

<div class="thumb tright"><div class="thumbinner" style="">
<videoflash>nGeXdv-uPaw</videoflash>
<div class="thumbcaption">[http://youtu.be/nGeXdv-uPaw She's Alive... Beautiful... Finite... Hurting... Worth Dying for.]</div></div></div>
  1. The top line -- <div class="thumb tright"><div class="thumbinner" style=""> -- aligns your video to the right of the article and allows text to wrap beside it.
  2. The middle line -- <videoflash>nGeXdv-uPaw</videoflash> -- contains the video code -- nGeXdv-uPaw -- sandwiched between the videoflash tags.
  3. The last line...
<div class="thumbcaption">[http://youtu.be/nGeXdv-uPaw She's Alive... Beautiful... Finite... Hurting... Worth Dying for.]</div></div></div>
...contains the "caption" for your video that you can link back to its source.

The results are what you see to the right on this page! Yaaaay!!!

Find the specific code configurations for many of the most popular video formats here:

Extension:VideoFlash

Image & Video Tricks

Faking a "thumb" with alt "link"

How about a handy list?

Templates

Templates are handy pages that simplify text, image or object insertion.

Foo

With this example, we'll use a simple {{Foo}} template to insert the word "Foo" into a simple limerick:

There once was a man named McGoo
Who fixed things with a dollop of glue
He reached in his pocket
To fix brok'n locket
And pulled out a handful of Foo

To use the {{Foo}} template, simply follow the instructions on the Foo template page.

Bar

Now let's show an example that employs PortlandWiki's lovely li'l {{Foo}} template with our nice 'n' handy {{Bar}} template in this simple lyric:

Baby you can Foo my Bar
Yes I'm gonna be Foo Bar
Baby you can Foo my Bar
And maybe I'll Foo Bar

To use the {{Bar}} template, simply follow the instructions on the Bar template page.

McDork

OK. You maybe you're thinking "why should I waste my time inserting {{Foo}} or {{Bar}} templates when I can just simply type Foo or Bar?"

Good point! But have you considered what you could accomplish with a more robust template? A template, say, like PortlandWiki's handy and useful {{McDork}} template, for instance?

PortlandWiki's "McDork" template is a simple limerick template that will appear wherever you insert the code as shown here:

{{McDork}}

This is the result:

Gal From McDork
There once was a gal from McDork
When she wanted to drink she pulled cork
Aft' she spent her last ducat
She would reach for her bucket
What she left there you could eat with a fork

Other Template Resources

PortlandWiki's collection of wiki templates.
PortlandWiki's "categorical" collection of infobox templates.
SPECIAL NOTE: Copying complex templates from one wiki to another.

Tags or Categories

Did you just create or edit a restaurant article? If it's not already tagged with the "Restaurants" category, tag it with the following bit of code at the end of the article:

  • [[Category: Restaurants]]

See PortlandWiki's fine and upstanding list of "categories" (or "tags") for details:

Transclude content from one page to another

The MediaWiki software that powers PortlandWiki gives you many options for pulling content from one article to another. You can pull small snippets or copy whole pages from one page to another.

Grab a bit of content from one page and use it on another.

Below we'll describe a couple of ways you can pull content from one page and use it on another.

Labeled Section Transclusion

Labeled Section Transclusion is one of the many extensions PortlandWiki comes equipped with. Here are a couple of the many ways you can use it.

1. Embed the intro content from one page into another.
Use this code on the page you want to pull content to:

{{#lsth:pagename}}

(Replace pagename with the name of the PortlandWiki page you want to pull the intro from.) All content above the first section header will be embedded into your receiving page.

Example: See the box labeled Anti-Austerity Discussion Group on the People’s Budget Project page.

2. Embed a specific section from one page into another.

2(a) Use the code shown below to grab the section of a page. Insert the first bit of code (<section begin=content-you-want />) at the beginning of the content you want to embed on the other page, and the second bit (<section end=content-you-want />) at the end.

<section begin=content-you-want />
The content of the section you want to embed.
<section end=content-you-want />

2(b) Next, insert the following bit of code into the page on which you want to embed the content from the other page:

{{#section:pagename|content-you-want}}

Take a peek under our skirts

Want to see what actual wiki text (wiki formatting mark-up code)[6] looks like so you can "try this at home"? Yes? Click here. (You can also click the "Improve" menu, sandwiched between the "Read" and "View history" menus, which are all located just to the left of the Search box situated at the top, right of each page.)

Useful external links are a nice distraction

wikEd - In-browser wiki text editor.
Templates (like Template:Meetup)

Refer Readers to References!