Difference between revisions of "Help:Editing"

From Camera-wiki.org
Jump to: navigation, search
m (Target of link was moved, & link didn't work. Looks ok now.)
m (Notes: clarity tweaks and a small formatting correction)
(36 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Helpful Wiki Syntax ==
+
==Basics==
  
* '''<nowiki>'''</nowiki>'''fat'''<nowiki>'''</nowiki>''' lets appear the word fat like this: '''fat'''
+
Most Camera-wiki.org pages have an "Edit" link in a tab at the top of the page. Click this, and the page contents will be shown in a text-editing box, along with many additional symbols and punctuation marks. These are the page markup codes used by our [http://www.mediawiki.org/ MediaWiki software] to format different page elements in the desired way.
* '''<nowiki>''</nowiki>'''italic'''<nowiki>''</nowiki>''' lets appear the word italic like this: ''italic''
 
  
== Lists ==
+
===Tool buttons===
* simple list: A simple list is a text block with several lines. Each line begins with an asterisk symbol ('''<nowiki>*</nowiki>''') followed by a blank
 
  
== Linking ==
+
A page-editing window has the following ribbon of tool buttons above it. These are shortcuts to insert formatting code for you—so you don't need to memorize the code or worry about making mistakes.
* '''LINK''': A simple link looks like '''<nowiki>[</nowiki>'''http''':'''//www.address-so-and-so.com so and so'''<nowiki>]</nowiki>''' and appears as [http://www.address-so-and-so.com so and so]
 
  
Better link to contents of camera-wiki first. External links are usually put at the end of a camera-wiki article.
+
[http://www.flickr.com/photos/camerawiki/5637846925/in/pool-camerawiki http://farm6.static.flickr.com/5305/5637846925_e7e06c5a9a.jpg]
  
* '''LINK''' inside camera-wiki: '''<nowiki>[[</nowiki>'''so and so'''<nowiki>]]</nowiki>'''
+
When you click one of these buttons, you'll see code (multiple quotation marks, etc.) appear at the insertion point. All these marks have a specific meaning, interpreted by the MediaWiki software to display the finished page as you intend. We will explain some of this "wiki markup" below.
* '''LINK''' inside camera-wiki with synonym: '''<nowiki>[[</nowiki>'''so and so'''<nowiki>|</nowiki>'''soso'''<nowiki>]]</nowiki>'''
 
  
* You can link to a singular version of a page with a plural word by doing this '''<nowiki>[[lens]]es</nowiki>''' which renders like this [[lens]]es.
+
Let's start with just the first five buttons. From the left:
* If you'd like to link to a category, you can do something like this '''<nowiki>[[:Category:lens makers|lens makers]]</nowiki>''' which renders like this [[:Category:lens makers|lens makers]].
 
  
== Pictures ==
+
#'''B''' —Bold text
 +
#'''''I''''' —Italic text
 +
#'''<u>Ab</u>''' —Link to another wiki page
 +
#[Globe] —Link to an external web page
 +
#'''A''' —Headline of an article section
  
The most important feature in a photographic wiki is the placement of pictures. This wiki has no special tags for images. Use
+
=== Some simple wiki markup ===
  
'''<'''div class="floatright"'''>''' image-address '''<'''/div'''>''' for images on the '''right''' side of the browserwindow,
+
* '''<nowiki>'''bold'''</nowiki>''' (three single quotation marks before and after the text) adds boldface: '''bold'''
 +
* '''<nowiki>''italic''</nowiki>''' (two single quotation marks before and after) italicizes: ''italic''
  
and
+
=== Linking ===
  
'''<'''div class="floatleft"'''>''' image-address '''<'''/div'''>''' for images on the '''left''' side of the browserwindow
+
A simple link to '''a page outside camera-wiki.org''' (an ''external link'') is created by '''<nowiki>[http://www.address-so-and-so.com Title_of_page]</nowiki>''' and appears as [http://www.address-so-and-so.com Title_of_page]. Note the format: URL, space, title. (Do not use the pipe | character, mentioned below.)
  
[[Camera_wiki:_Adding_images]] gives more advice on formatting pictures.
+
Within the main text of an article, it is better to minimize external links. (External links are usually put at the end of an article, whether in a footnote or in a list.)
  
 +
By contrast, '''links inside camera-wiki.org''' may be added freely. Such a link is easy to make: it's the exact title of the article linked to, in double square brackets: '''<nowiki>[[Article]]</nowiki>'''.
  
== Chapters and text structure ==
+
A '''link inside camera-wiki.org''' but with link text different from the title of the linked article: '''<nowiki>[[Article | other text]]</nowiki>'''. Note the vertical line, called a "pipe" &mdash; you'll find this at the far right of your keyboard.
  
* A chapter begins with a headline enclosed in two double equal signs ('''==''')
+
An article title can be made plural (or otherwise extended) by adding the desired suffix outside the closing brackets: '''<nowiki>[[lens]]es</nowiki>''' renders [[lens]]es.
* Further structuring of a camera-wiki article is possible by sub-headlines enclosed in two triple or quadruple equal signs ('''===''', '''====''')
 
  
==Contents==
+
If you'd like to '''link to a category''', you can do so by prefixing "Category" with a colon: '''<nowiki>[[:Category:lens makers|lens makers]]</nowiki>''' renders [[:Category:lens makers|lens makers]].
* it's always good to know the [[Camera-wiki.org: Quality standards|Camera-wiki quality standards]]
+
 
* If you want to stop the wiki from turning certain text into "wiki text", you can use the '''<nowiki><nowiki></nowiki></nowiki>''' tags.  Anything between these tags shouldn't be altered by the wiki software.
+
=== Section headings===
* If you know that the topic of your article needs much more information than you actually are able to write into it, then give it the special categorization '''<nowiki>{{stub}}</nowiki>'''
+
 
 +
* A named section begins with a headline enclosed between two double equal signs ('''<nowiki>==Heading text==</nowiki>''')
 +
* When an article has more than three section headings, the wiki software will automatically create a table of contents towards the top of the page
 +
* Further structuring of a camera-wiki article is possible using subheadings enclosed between two triple or quadruple equal signs ('''===''', '''====''')
 +
 
 +
==Other useful markup==
 +
 
 +
===Special characters===
 +
 
 +
Sometimes your text may need an unusual character not found on your keyboard. The following are some common examples, which you can type or paste into into your article to display the desired character.
 +
 
 +
Note that the ampersand ('''&''') at the beginning and the semicolon (''';''') at the end are part of the code: Both must be included.
 +
 
 +
* '''&amp;nbsp;''' creates a <u>n</u>on-<u>b</u>reaking <u>sp</u>ace, one that will not break over two lines; useful if (for example) you don't want the ''A'' to be separated from the ''Ikonta'' in ''Ikonta&nbsp;A.''
 +
* '''&amp;frac14;''', '''&amp;frac12;''' and '''&amp;frac34;''' give the fractions '''&frac14;''', '''&frac12;''', and '''&frac34;'''
 +
* '''&amp;times;''' gives the typographically-correct<!-- May we please skip this cumbersome adjective? It's defensible, but just seems to add weight. --> multiplication symbol, in for example 6'''&times;'''9&nbsp;cm.
 +
 
 +
=== Lists ===
 +
* simple list: A simple list is a text block with several lines, each with a solid blue dot at the start—a 'bullet list'. simply type each line beginning with an asterisk symbol ('''<nowiki>*</nowiki>''') followed by a space before the text:
 +
 
 +
{|
 +
||
 +
<nowiki>*</nowiki> Cameras
 +
<nowiki>*</nowiki> Lenses
 +
<nowiki>*</nowiki> Tripods
 +
||
 +
gives this:
 +
||
 +
* Cameras
 +
* Lenses
 +
* Tripods
 +
|}
 +
 
 +
If you use hash characters (#) instead of asterisks, you get a '''numbered''' list instead.
 +
 
 +
{|
 +
||
 +
<nowiki>#</nowiki> Cameras
 +
<nowiki>#</nowiki> Lenses
 +
<nowiki>#</nowiki> Tripods
 +
||
 +
gives this:
 +
||
 +
# Cameras
 +
# Lenses
 +
# Tripods
 +
|}
 +
 
 +
=== Tables ===
 +
see [[Help:Editing Tables]]
 +
 
 +
=== Pictures ===
 +
 
 +
We strongly encourage use of Camera-wiki.org's [[Template:Flickr_image|Flickr image template]]. This is inserted into the text by clicking the rightmost button on the toolbar above the edit window (the one whose icon resembles a photograph). Our [[Help:Adding images|help page on adding images]] explains in detail how to include images in a wiki page.
 +
 
 +
=== Categorizing your page ===
 +
 
 +
Indexing a page with categories helps visitors find other, related pages. To learn how to do this, please see our [[Help:Categories|help page about categories]].
 +
 
 +
===Notes===
 +
You can include footnotes in your text. These are strongly encouraged for acknowledging the sources of your information, without interrupting the flow of your article. Footnotes can also be used as an alternative to parentheses, for comments aside from the main flow of the text. To use footnotes, you '''must''' include a section at the bottom, where you want the footnotes to appear:
 +
 
 +
 
 +
'''<nowiki> ==Notes== </nowiki>'''
 +
 
 +
'''<nowiki><references /></nowiki>'''
 +
 
 +
 
 +
The '''<nowiki><references /></nowiki>''' tag must appear as shown; but you may vary the heading text, what level of heading you use, and where this appears, if needed.
 +
 
 +
The footnote ''text'' is entered at the point in the text from which you want to reference it.
 +
 
 +
The second rangefinder model of the Agifold was introduced in 1955<nowiki><ref>Some sources say 1954.</ref></nowiki>. It has a redesigned top housing.
 +
 
 +
The article text will show
 +
 
 +
"The second rangefinder model of the Agifold was introduced in 1955<ref>Some sources say 1954.</ref>. It has a redesigned top housing."
 +
 
 +
For certain [[Sources:_English_language|standard reference works]] the wiki has set up template "shortcuts." Here's an example of that:
 +
 
 +
The second rangefinder model of the Agifold was introduced in 1955<nowiki><ref>{{McKeown12}} Page 41.</ref></nowiki>. It has a redesigned top housing.
 +
 
 +
This displays as,
 +
 
 +
"The second rangefinder model of the Agifold was introduced in 1955<ref>{{McKeown12}} Page 41.</ref>. It has a redesigned top housing."
 +
 
 +
At the bottom of the page, these two notes produce,
 +
 
 +
'''Notes'''
 +
<references />
 +
 
 +
===Other tips===
 +
* When writing for Camera-wiki.org, keep in mind our [[Camera-wiki.org:Quality standards|quality standards]].
 +
* If you want to prevent the interpretation of what you write as markup commands, you can use the '''<nowiki><nowiki></nowiki></nowiki>''' tags.  Anything between these tags will be displayed just as it is typed.
 +
* If you know an article you have begun needs much more information than you can soon provide, then add '''<nowiki>{{stub}}</nowiki>''' to it (including the double curly brackets). This flags it for other editors.
 +
 
 +
==Further reading==
 +
*[[Help:Markup reference|Markup reference]]
 +
 
 +
[[Category: Editing guidelines]]

Revision as of 06:22, 4 July 2011

Basics

Most Camera-wiki.org pages have an "Edit" link in a tab at the top of the page. Click this, and the page contents will be shown in a text-editing box, along with many additional symbols and punctuation marks. These are the page markup codes used by our MediaWiki software to format different page elements in the desired way.

Tool buttons

A page-editing window has the following ribbon of tool buttons above it. These are shortcuts to insert formatting code for you—so you don't need to memorize the code or worry about making mistakes.

5637846925_e7e06c5a9a.jpg

When you click one of these buttons, you'll see code (multiple quotation marks, etc.) appear at the insertion point. All these marks have a specific meaning, interpreted by the MediaWiki software to display the finished page as you intend. We will explain some of this "wiki markup" below.

Let's start with just the first five buttons. From the left:

  1. B —Bold text
  2. I —Italic text
  3. Ab —Link to another wiki page
  4. [Globe] —Link to an external web page
  5. A —Headline of an article section

Some simple wiki markup

  • '''bold''' (three single quotation marks before and after the text) adds boldface: bold
  • ''italic'' (two single quotation marks before and after) italicizes: italic

Linking

A simple link to a page outside camera-wiki.org (an external link) is created by [http://www.address-so-and-so.com Title_of_page] and appears as Title_of_page. Note the format: URL, space, title. (Do not use the pipe | character, mentioned below.)

Within the main text of an article, it is better to minimize external links. (External links are usually put at the end of an article, whether in a footnote or in a list.)

By contrast, links inside camera-wiki.org may be added freely. Such a link is easy to make: it's the exact title of the article linked to, in double square brackets: [[Article]].

A link inside camera-wiki.org but with link text different from the title of the linked article: [[Article | other text]]. Note the vertical line, called a "pipe" — you'll find this at the far right of your keyboard.

An article title can be made plural (or otherwise extended) by adding the desired suffix outside the closing brackets: [[lens]]es renders lenses.

If you'd like to link to a category, you can do so by prefixing "Category" with a colon: [[:Category:lens makers|lens makers]] renders lens makers.

Section headings

  • A named section begins with a headline enclosed between two double equal signs (==Heading text==)
  • When an article has more than three section headings, the wiki software will automatically create a table of contents towards the top of the page
  • Further structuring of a camera-wiki article is possible using subheadings enclosed between two triple or quadruple equal signs (===, ====)

Other useful markup

Special characters

Sometimes your text may need an unusual character not found on your keyboard. The following are some common examples, which you can type or paste into into your article to display the desired character.

Note that the ampersand (&) at the beginning and the semicolon (;) at the end are part of the code: Both must be included.

  • &nbsp; creates a non-breaking space, one that will not break over two lines; useful if (for example) you don't want the A to be separated from the Ikonta in Ikonta A.
  • &frac14;, &frac12; and &frac34; give the fractions ¼, ½, and ¾
  • &times; gives the typographically-correct multiplication symbol, in for example 6×9 cm.

Lists

  • simple list: A simple list is a text block with several lines, each with a solid blue dot at the start—a 'bullet list'. simply type each line beginning with an asterisk symbol (*) followed by a space before the text:
* Cameras
* Lenses
* Tripods

gives this:

  • Cameras
  • Lenses
  • Tripods

If you use hash characters (#) instead of asterisks, you get a numbered list instead.

# Cameras
# Lenses
# Tripods

gives this:

  1. Cameras
  2. Lenses
  3. Tripods

Tables

see Help:Editing Tables

Pictures

We strongly encourage use of Camera-wiki.org's Flickr image template. This is inserted into the text by clicking the rightmost button on the toolbar above the edit window (the one whose icon resembles a photograph). Our help page on adding images explains in detail how to include images in a wiki page.

Categorizing your page

Indexing a page with categories helps visitors find other, related pages. To learn how to do this, please see our help page about categories.

Notes

You can include footnotes in your text. These are strongly encouraged for acknowledging the sources of your information, without interrupting the flow of your article. Footnotes can also be used as an alternative to parentheses, for comments aside from the main flow of the text. To use footnotes, you must include a section at the bottom, where you want the footnotes to appear:


==Notes==

<references />


The <references /> tag must appear as shown; but you may vary the heading text, what level of heading you use, and where this appears, if needed.

The footnote text is entered at the point in the text from which you want to reference it.

The second rangefinder model of the Agifold was introduced in 1955<ref>Some sources say 1954.</ref>. It has a redesigned top housing.

The article text will show

"The second rangefinder model of the Agifold was introduced in 1955[1]. It has a redesigned top housing."

For certain standard reference works the wiki has set up template "shortcuts." Here's an example of that:

The second rangefinder model of the Agifold was introduced in 1955<ref>{{McKeown12}} Page 41.</ref>. It has a redesigned top housing.

This displays as,

"The second rangefinder model of the Agifold was introduced in 1955[2]. It has a redesigned top housing."

At the bottom of the page, these two notes produce,

Notes

  1. Some sources say 1954.
  2. McKeown, James M. and Joan C. McKeown's Price Guide to Antique and Classic Cameras, 12th Edition, 2005-2006. USA, Centennial Photo Service, 2004. ISBN 0-931838-40-1 (hardcover). ISBN 0-931838-41-X (softcover). Page 41.

Other tips

  • When writing for Camera-wiki.org, keep in mind our quality standards.
  • If you want to prevent the interpretation of what you write as markup commands, you can use the <nowiki></nowiki> tags. Anything between these tags will be displayed just as it is typed.
  • If you know an article you have begun needs much more information than you can soon provide, then add {{stub}} to it (including the double curly brackets). This flags it for other editors.

Further reading