Difference between revisions of "Help:Quick guide to editing"

From Ballotpedia
Jump to: navigation, search
(updated page)
Line 1: Line 1:
{{help|tutorial=}}{{tnr}}
+
{{help}}{{tnr}}
  
 
This page gives you the basics of editing and formatting an article. For more advanced style guidelines, see our [[Ballotpedia:Visual style guide|visual style guide]] and [[Ballotpedia:Textual style guide|textual style guide]].
 
This page gives you the basics of editing and formatting an article. For more advanced style guidelines, see our [[Ballotpedia:Visual style guide|visual style guide]] and [[Ballotpedia:Textual style guide|textual style guide]].
  
 
==Appearance==
 
==Appearance==
=== Bold and italics ===
+
===[[Help:Cheatsheet|Bold and italics]]===
The most commonly used wiki tags are '''bold''' and ''italics''. '''Bolding''' and ''italicizing'' are done by surrounding a word or phrase with multiple apostrophes (<tt>'</tt>):
+
The most commonly used wiki tags are '''bold''' and ''italics''. '''Bolding''' and ''italicizing'' are done by surrounding a word or phrase with multiple apostrophes ( <code><nowiki>'</nowiki></code> ):
  
*If you type <nowiki>''2 for italics''</nowiki>, you'll see this: ''2 for italics''
+
* If you type <code><nowiki>''2 for italics''</nowiki></code>, you will see this: ''2 for italics''
*If you type <nowiki>'''3 for bold'''</nowiki>, you'll see this: '''3 for bold'''
+
* If you type <code><nowiki>'''3 for bold'''</nowiki></code>, you will see this: '''3 for bold'''
*If you type <nowiki>'''''5 for bold italic'''''</nowiki>, you'll see this: '''''5 for bold italic'''''
+
* If you type <code><nowiki>'''''5 for bold italic'''''</nowiki></code>, you will see this: '''''5 for bold italic'''''
  
On Ballotpedia, the first mention of an article's subject is written in '''bold'''. For example, the article on [[Arnold Schwarzenegger]] begins:
+
On Ballotpedia, the first mention of an article's subject is written in '''bold'''. For example, the article on [[Supreme Court of the United States]] begins:
 
+
:'''Arnold Schwarzenegger''' was first elected as [[Governor of California|Governor of California]] in the 2003 recall elections and won re-election in 2006.
+
 
+
 
+
 
+
<div style="float:right; margin-top: 0.0em; margin-bottom:3px; background-color: #cee0f2; padding: .2em .6em; font-size: 130%; border:1px solid #A3B1BF;"> '''[[Help:Tutorials#Basic editing|Take me to the tutorials library]]''' <span style="font-size: larger; font-weight: bold;">→</span></div>
+
  
 +
:The '''Supreme Court of the United States''' is the highest...
 +
<br>
 +
<div style="float:left; margin-top: 0.0em; margin-bottom:3px; background-color: #cee0f2; padding: .2em .6em; font-size: 130%; border:1px solid #A3B1BF;"> '''[[Help:Tutorials#Basic editing|Take me to the tutorials library]]''' <span style="font-size: larger; font-weight: bold;">→</span></div>
 +
<br><br>
  
 
===Headings and subheadings===
 
===Headings and subheadings===
Line 26: Line 24:
 
|-
 
|-
 
|
 
|
<tt><nowiki>==&nbsp;Heading&nbsp;== </nowiki></tt>
+
<tt><nowiki>==Heading== </nowiki></tt>
 
|<span style="font-size: larger; font-weight: bold;">&rarr;</span>
 
|<span style="font-size: larger; font-weight: bold;">&rarr;</span>
 
| width="70%" |
 
| width="70%" |
== Heading ==
+
==Heading==
 
|-
 
|-
 
|
 
|
<tt><nowiki>===&nbsp;Subheading&nbsp;===</nowiki></tt>
+
<tt><nowiki>===Subheading===</nowiki></tt>
 
|<span style="font-size: larger; font-weight: bold;">&rarr;</span>
 
|<span style="font-size: larger; font-weight: bold;">&rarr;</span>
 
| width="70%" |
 
| width="70%" |
=== Subheading ===
+
===Subheading===
 
|}
 
|}
  
 +
<br>
 +
<div style="float:left; margin-top: 0.0em; margin-bottom:3px; background-color: #cee0f2; padding: .2em .6em; font-size: 130%; border:1px solid #A3B1BF;"> '''[[Help:Tutorials#Basic editing|Take me to the tutorials library]]''' <span style="font-size: larger; font-weight: bold;">→</span></div>
 +
<br><br>
  
<div style="float:right; margin-top: 0.0em; margin-bottom:3px; background-color: #cee0f2; padding: .2em .6em; font-size: 130%; border:1px solid #A3B1BF;"> '''[[Help:Tutorials#Basic editing|Take me to the tutorials library]]''' <span style="font-size: larger; font-weight: bold;">→</span></div>
+
==Indenting==
 
+
 
+
 
+
=== Indenting ===
+
 
Indenting improves the readability of a discussion. Each reply should be one level deeper than the first statement.
 
Indenting improves the readability of a discussion. Each reply should be one level deeper than the first statement.
  
==== Plain indentations ====
+
===Plain indentations===
 
The simplest way of indenting is to place a colon (<tt>:</tt>) at the beginning of a line. The more colons, the more indentation. A new line (pressing '''Enter''' or '''Return''') ends the indented paragraph.
 
The simplest way of indenting is to place a colon (<tt>:</tt>) at the beginning of a line. The more colons, the more indentation. A new line (pressing '''Enter''' or '''Return''') ends the indented paragraph.
  
Line 60: Line 57:
 
|}
 
|}
  
====Bullet points====
+
===Bullet points===
 
You can also indent using ''bullets'' for lists. To insert a bullet, use an asterisk (<tt>*</tt>). Similar to indentation, more asterisks means more indentation.
 
You can also indent using ''bullets'' for lists. To insert a bullet, use an asterisk (<tt>*</tt>). Similar to indentation, more asterisks means more indentation.
  
Line 76: Line 73:
 
|}
 
|}
  
==== Numbered items ====
+
===Numbered items===
You can also create numbered lists using the number sign (<tt>#</tt>). Again, you can affect the indent of the number by the number of <tt>#</tt>s you use.
+
You can also create numbered lists using the number sign (<tt>#</tt>). Again, you can affect the indent of the number by the number of <tt>#</tt> symbols you use.
  
 
{|
 
{|
Line 92: Line 89:
 
|}
 
|}
  
<div style="float:right; margin-top: 0.0em; margin-bottom:3px; background-color: #cee0f2; padding: .2em .6em; font-size: 130%; border:1px solid #A3B1BF;"> '''[[Help:Tutorials#Basic editing|Take me back to the tutorials library]]''' <span style="font-size: larger; font-weight: bold;">→</span></div>
+
<br>
 +
<div style="float:left; margin-top: 0.0em; margin-bottom:3px; background-color: #cee0f2; padding: .2em .6em; font-size: 130%; border:1px solid #A3B1BF;"> '''[[Help:Tutorials#Basic editing|Take me back to the tutorials library]]''' <span style="font-size: larger; font-weight: bold;">→</span></div>
 +
<br><br>
  
 +
==[[Help:Links|Links]]==
 +
Links are important, but too many links can be distracting. Therefore, '''only link the first occurrence of a word'''. A [[Help:Links#Broken links|red link]] goes to a page that doesn't exist yet. When you find a <span style="color:red">red link</span>, you can start the article with something as simple as a single sentence. Short articles such as these are called [[Help:Stub|stubs]]; we can return and add information to stubs later.
  
=== Other project pages ===
 
In addition to Talk pages, we use a few other pages to talk with each other. These different areas are often referred to as '''namespaces''' &mdash; as in, "the '''Talk''' namespace."Pages in the '''Ballotpedia''' namespace (like this one!) provide information about Ballotpedia and how to use it.
 
 
Content written in a '''Template''' page will be displayed in articles that contain the template reference. For example, the content written in [[Template:Protected]] will appear in any article that contains the <tt><nowiki>{{protected}}</nowiki></tt> tag.
 
 
== Links  ==
 
 
<div style="float:right">
 
<div style="float:right">
 
{|class="wikitable" cellspacing="0" cellpadding="5" width="205"
 
{|class="wikitable" cellspacing="0" cellpadding="5" width="205"
 
|-
 
|-
|{{#ev:youtube|nJYL6s0sOGw}}<br><span style="font-size:80%">How to create 5 kinds of links</span>
+
|{{#ev:youtube|nJYL6s0sOGw}}
 +
<br><span style="font-size:80%">How to create 5 kinds of links</span>
 
|}</div>
 
|}</div>
Links are important, but too many links can be distracting. Therefore, '''only link the first occurrence of a word'''. A <span style="color:red">red link</span> goes to a page that doesn't exist yet. When you find a <span style="color:red">red link</span>, you can start the article with something as simple as a single sentence. We can return and add information later.
 
  
=== Links between Ballotpedia articles ===
+
===Internal links===
Links between Ballotpedia articles are easy to create, give users access to related information, and greatly add to Ballotpedia's utility. To link to another Ballotpedia page (called a <em>wiki link</em>), put it in <nowiki>[[ ]]</nowiki> brackets, like this:
+
'''Internal links''', also known as wiki-links, are links that allow you to link to other pages within Ballotpedia (for example, the [[Main Page]]). You can link internally by placing double brackets around the name of the article on Ballotpedia you want to link to from the page you are currently editing, in this fashion: <nowiki>[[Page name]]</nowiki>. Be sure to use the exact title of the other Ballotpedia article you are linking to, including the exact capitalization of that article; otherwise, your link will not work.
:<tt><nowiki>[[Ballotpedia]]</nowiki></tt> = [[Ballotpedia]]
+
  
To link to an article but display a different name for the link, add the pipe "|" divider followed by the alternative name. For example:
+
For more information on linking, see [[Help:Links]]
:<tt><nowiki>[[Ballotpedia|This link goes to the Ballotpedia page]]</nowiki></tt> = [[Ballotpedia|This link goes to the Ballotpedia page]]
+
  
=== Links between wikis ===
+
===Interwiki links===
[[wikipedia:Interwiki linking|Interwiki links]] allow links to be placed amongst separate projects, set apart from other links by their light blue color.  This is possible between [[Sunshine Review]], [[Ballotpedia:About|Ballotpedia]], and [[Judgepedia]]. To create one, simply add the namespace before the page title.
+
You can place links on a Ballotpedia article to articles on Ballotpedia's sister project, [[Judgepedia]]. This is known as "interwiki linking." Interwiki links are nearly indistinguishable from internal links, though they are a very slightly lighter shade of blue. There are two primary methods of interwiki linking.
  
''Example:''
+
* '''Method 1''': You can link to Judgepedia using the standard wiki link style ( [[ ]] ) as long as you place "Judgepedia:" before the exact name of the Judgepedia page you are linking to. In the edit view, that would look like this: <nowiki>[[Judgepedia:Indiana Supreme Court|State Supreme Court of Indiana]]</nowiki>, while in the saved view, it would appear as follows: [[Judgepedia:Indiana Supreme Court|State Supreme Court of Indiana]].
* <tt><nowiki>[[Sunshinereview:Cook County, Illinois|Cook County, Illinois]]</nowiki></tt> <span style="font-size: larger; font-weight: bold;">&rarr;</span> [[Sunshinereview:Cook County, Illinois|Cook County, Illinois]]
+
* <tt><nowiki>[[Judgepedia:Supreme Court of the United States]]</nowiki></tt> <span style="font-size: larger; font-weight: bold;">&rarr;</span> [[Judgepedia:Supreme Court of the United States|Supreme Court of the United States]]
+
  
A full list of sites that may be linked to with interwiki links can be seen at: [[Special:Interwiki]].
+
* '''Method 2''': Using the {{tl|JP}} template, you can link to any JP article using the exact page name after a pipe: <nowiki>{{JP|Indiana Supreme Court}}</nowiki>, which will look like this in the saved page: {{JP|Indiana Supreme Court}}. If you want the link to appear as something other than the exact page name, you can add an additional pipe after the page name, then your desired text. In the edit view, that would look like this: <nowiki>{{JP|Indiana Supreme Court|State Supreme Court of Indiana}}</nowiki>, and the saved view would appear as follows: {{JP|Indiana Supreme Court|State Supreme Court of Indiana}}.
  
=== Links outside Ballotpedia ===
+
It is worthwhile to note that you could also link to Judgepedia using the external linking style. However, if done this way, an arrow will appear, telling our readers that they will be traveling to an external source if they follow the link. It is preferable to use one of the methods above for linking to Judgepedia, because though our readers would be leaving Ballotpedia if they followed the link, they would still be within content created and managed by the Lucy Burns Institute, the sponsor of both websites.
[[Image:References.png|right|border]]To link to a website outside Ballotpedia, include the address with just a single set of <nowiki>[ ]</nowiki> brackets.
+
:<tt><nowiki>[http://www.google.com Here's the title for the link]</nowiki></tt> = [http://www.google.com Here's the title for the link]
+
  
Sometimes you'll want to add a citation inside the article text.  
+
A full list of sites that may be linked to with interwiki links can be seen at [[Special:Interwiki]].
  
*At the place you want to add the citation, add '''ref tags''' around your source (e.g. <tt><nowiki><ref>YOUR SOURCE</ref></nowiki></tt>). A small link like this one <ref> </ref> will appear next to your text, taking you to the reference section at the bottom of the page.
+
===External links===
** For proper citation format make sure to add the details of the source: newspaper or website name, the name of the article or the website page/section, and the publication date or date accessed.  
+
'''External links''' are links that take the reader from Ballotpedia to an external website. You will often find external links in the [[Help:Footnotes|footnotes]] of an article, in the "References" or "External links" sections. You may sometimes see external links as in-line links within the main text of an article. When you insert an external link, an arrow will appear in the saved version of the page after the link. That arrow exists so that you and other readers can tell the difference between an internal and external link.
** Example: <tt><nowiki><ref>[http://www.yourlinkhere.com ''Name of paper'',"Name of article," Month Day, Year]</ref></nowiki></tt>
+
*Second, copy the following text to the bottom of your page if it isn't there already. This tells the page where to add your citations:
+
::<tt><nowiki>==References==</nowiki></tt>
+
::<tt><nowiki>{{reflist}}</nowiki></tt>
+
  
===Categories===
+
To create an external link, surround a URL with single brackets ( [ ] ), insert a space, and then type the word or words you want to show up on the saved page. For example, a link to Google would look like this in the edit view: <nowiki>[http://www.google.com Google]</nowiki>, and like this is the saved view: [http://www.google.com Google].
 +
 
 +
Please note that wiki code does work within the brackets of the link, so you can format your linked text just as you would format the other text on the page. For example, <nowiki>[http://www.indystar.com/story/news/politics/2013/12/20/gov-pence-oks-bonuses-for-state-employees/4147921/ ''Indianapolis Star'', "Gov. Pence OKs bonuses for state employees," December 20, 2013]</nowiki>, will show up like this on the saved page: [http://www.indystar.com/story/news/politics/2013/12/20/gov-pence-oks-bonuses-for-state-employees/4147921/ ''Indianapolis Star'', "Gov. Pence OKs bonuses for state employees," December 20, 2013].
 +
 
 +
For more information on linking, see [[Help:Links]]
 +
 
 +
==Categories==
 
We place articles in '''categories''' with others in a related topic. Just type <tt><nowiki>[[Category:]]</nowiki></tt> at the bottom of the page and put the name of the category between the colon and the brackets. For example: <tt><nowiki>[[Category:State ballot measures]]</nowiki></tt>
 
We place articles in '''categories''' with others in a related topic. Just type <tt><nowiki>[[Category:]]</nowiki></tt> at the bottom of the page and put the name of the category between the colon and the brackets. For example: <tt><nowiki>[[Category:State ballot measures]]</nowiki></tt>
  
Line 143: Line 134:
  
 
==See also==
 
==See also==
* [[Ballotpedia:A Quick Overview|The Ballotpedia Tutorial]]
+
* [[Ballotpedia:A Quick Overview]]
* [[Help:Cheatsheet|Formatting cheatsheet]]
+
* [[Help:Cheatsheet]]
* [[:Category:Terms and definitions|Glossary of terms]]
+
* [[:Category:Terms and definitions]]
* [[Help:Naming conventions|How to name articles]]
+
* [[Ballotpedia:Naming conventions]]
 
+
<br>
<div style="float:right; margin-top: 0.0em; margin-bottom:3px; background-color: #cee0f2; padding: .2em .6em; font-size: 130%; border:1px solid #A3B1BF;"> '''[[Help:Tutorials#Basic editing|Take me back to the tutorials library]]''' <span style="font-size: larger; font-weight: bold;">→</span></div>
+
<div style="float:left; margin-top: 0.0em; margin-bottom:3px; background-color: #cee0f2; padding: .2em .6em; font-size: 130%; border:1px solid #A3B1BF;"> '''[[Help:Tutorials#Basic editing|Take me back to the tutorials library]]''' <span style="font-size: larger; font-weight: bold;">→</span></div>
 
+
==References==
+
{{reflist}}
+
  
 
[[Category:Intro editing help]]
 
[[Category:Intro editing help]]
 
[[Category:Terms and definitions]]
 
[[Category:Terms and definitions]]

Revision as of 16:37, 30 December 2013

Editing Help
1328101905 Help.png
Index
Editing guide
Cheatsheet
Policies
Copyright
Textual standards
Visual standards
Glossary of terms
Edit review process

This page gives you the basics of editing and formatting an article. For more advanced style guidelines, see our visual style guide and textual style guide.

Appearance

Bold and italics

The most commonly used wiki tags are bold and italics. Bolding and italicizing are done by surrounding a word or phrase with multiple apostrophes ( ' ):

  • If you type ''2 for italics'', you will see this: 2 for italics
  • If you type '''3 for bold''', you will see this: 3 for bold
  • If you type '''''5 for bold italic''''', you will see this: 5 for bold italic

On Ballotpedia, the first mention of an article's subject is written in bold. For example, the article on Supreme Court of the United States begins:

The Supreme Court of the United States is the highest...


Take me to the tutorials library



Headings and subheadings

Headings and subheadings are an easy way to improve the organization of an article. If you can see two or more distinct topics being discussed, you can break up the article by inserting a heading for each section. If an article has at least four headings, a table of contents will be added automatically. Headings are created like this:

==Heading==

Heading

===Subheading===

Subheading


Take me to the tutorials library



Indenting

Indenting improves the readability of a discussion. Each reply should be one level deeper than the first statement.

Plain indentations

The simplest way of indenting is to place a colon (:) at the beginning of a line. The more colons, the more indentation. A new line (pressing Enter or Return) ends the indented paragraph.

Example:
This is aligned all the way to the left.
: This is indented slightly.
:: This is indented more.
Shown:
This is aligned all the way to the left.
This is indented slightly.
This is indented more.

Bullet points

You can also indent using bullets for lists. To insert a bullet, use an asterisk (*). Similar to indentation, more asterisks means more indentation.

Example:
* First list item
* Second list item
** Sub-list item under second
* Third list item
Shown:
  • First list item
  • Second list item
    • Sub-list item under second
  • Third list item

Numbered items

You can also create numbered lists using the number sign (#). Again, you can affect the indent of the number by the number of # symbols you use.

Example:
# First item
# Second item
## Sub-item under second item
# Third item
Shown:
  1. First item
  2. Second item
    1. Sub-item under second item
  3. Third item


Take me back to the tutorials library



Links

Links are important, but too many links can be distracting. Therefore, only link the first occurrence of a word. A red link goes to a page that doesn't exist yet. When you find a red link, you can start the article with something as simple as a single sentence. Short articles such as these are called stubs; we can return and add information to stubs later.


How to create 5 kinds of links

Internal links

Internal links, also known as wiki-links, are links that allow you to link to other pages within Ballotpedia (for example, the Main Page). You can link internally by placing double brackets around the name of the article on Ballotpedia you want to link to from the page you are currently editing, in this fashion: [[Page name]]. Be sure to use the exact title of the other Ballotpedia article you are linking to, including the exact capitalization of that article; otherwise, your link will not work.

For more information on linking, see Help:Links

Interwiki links

You can place links on a Ballotpedia article to articles on Ballotpedia's sister project, Judgepedia. This is known as "interwiki linking." Interwiki links are nearly indistinguishable from internal links, though they are a very slightly lighter shade of blue. There are two primary methods of interwiki linking.

  • Method 1: You can link to Judgepedia using the standard wiki link style ( [[ ]] ) as long as you place "Judgepedia:" before the exact name of the Judgepedia page you are linking to. In the edit view, that would look like this: [[Judgepedia:Indiana Supreme Court|State Supreme Court of Indiana]], while in the saved view, it would appear as follows: State Supreme Court of Indiana.
  • Method 2: Using the {{JP}} template, you can link to any JP article using the exact page name after a pipe: {{JP|Indiana Supreme Court}}, which will look like this in the saved page: Indiana Supreme Court. If you want the link to appear as something other than the exact page name, you can add an additional pipe after the page name, then your desired text. In the edit view, that would look like this: {{JP|Indiana Supreme Court|State Supreme Court of Indiana}}, and the saved view would appear as follows: State Supreme Court of Indiana.

It is worthwhile to note that you could also link to Judgepedia using the external linking style. However, if done this way, an arrow will appear, telling our readers that they will be traveling to an external source if they follow the link. It is preferable to use one of the methods above for linking to Judgepedia, because though our readers would be leaving Ballotpedia if they followed the link, they would still be within content created and managed by the Lucy Burns Institute, the sponsor of both websites.

A full list of sites that may be linked to with interwiki links can be seen at Special:Interwiki.

External links

External links are links that take the reader from Ballotpedia to an external website. You will often find external links in the footnotes of an article, in the "References" or "External links" sections. You may sometimes see external links as in-line links within the main text of an article. When you insert an external link, an arrow will appear in the saved version of the page after the link. That arrow exists so that you and other readers can tell the difference between an internal and external link.

To create an external link, surround a URL with single brackets ( [ ] ), insert a space, and then type the word or words you want to show up on the saved page. For example, a link to Google would look like this in the edit view: [http://www.google.com Google], and like this is the saved view: Google.

Please note that wiki code does work within the brackets of the link, so you can format your linked text just as you would format the other text on the page. For example, [http://www.indystar.com/story/news/politics/2013/12/20/gov-pence-oks-bonuses-for-state-employees/4147921/ ''Indianapolis Star'', "Gov. Pence OKs bonuses for state employees," December 20, 2013], will show up like this on the saved page: Indianapolis Star, "Gov. Pence OKs bonuses for state employees," December 20, 2013.

For more information on linking, see Help:Links

Categories

We place articles in categories with others in a related topic. Just type [[Category:]] at the bottom of the page and put the name of the category between the colon and the brackets. For example: [[Category:State ballot measures]]

Every article should have a category, and it's very important to use the correct categories so others can easily find your work. The best way to find the proper categories is to look at articles on similar subjects and check which categories they use.

See also


Take me back to the tutorials library