Difference between revisions of "Help:Getting started"

(created article)
 
(added extended wiki help instructions.)
Line 3: Line 3:
 
== Creating your account ==
 
== Creating your account ==
  
*Select the “Account” drop down and click “Create account.”
+
To create an account, please email [mailto:folgerpedia@folger.edu folgerpedia@folger.edu] for permissions.
*Enter your username. The username must be camel case, first name and last name, e.g. WilliamShakespeare.
 
*Enter your password and confirm password.  
 
*Enter your real name. Edits made in Folgerpedia cannot be anonymous.
 
*Select “Create your account”
 
  
 
== Creating an article ==
 
== Creating an article ==
Line 33: Line 29:
 
To edit in the MediaWiki editor, select the paper icon drop down and click “Edit source.” This is the HTML editor. To view what the finished product will look like without saving, select “Show preview” at the bottom of the page.  
 
To edit in the MediaWiki editor, select the paper icon drop down and click “Edit source.” This is the HTML editor. To view what the finished product will look like without saving, select “Show preview” at the bottom of the page.  
 
For editing tips, see the [http://www.mediawiki.org/wiki/Help:Contents MediaWiki help page].
 
For editing tips, see the [http://www.mediawiki.org/wiki/Help:Contents MediaWiki help page].
 +
 +
== MediaWiki links for editing basics ==
 +
 +
*http://en.wikipedia.org/wiki/Help:Cheatsheet
 +
**Quick reference glossary of frequent actions used in wiki markup.
 +
*http://www.mediawiki.org/wiki/Help:Contents
 +
**This is your MediaWiki bible. Most questions regarding MediaWiki markup can be answered by referring to this list.
 +
*http://folgerpedia.folger.edu/Help:Getting_started
 +
**Basic outline for beginning work in Folgerpedia.
 +
*http://folgerpedia.folger.edu/Folgerpedia:Manual_of_Style
 +
**This article is very important—in order to maintain consistency across the wiki, we ask that all editors refer to this guide continually to ensure that they are following all style requirements.
 +
*http://www.mediawiki.org/wiki/Manual:FAQ
 +
**For more in depth problems, consult the FAQ. Please report any wiki malfunctions to folgerpedia@folger.edu.
 +
*http://www.mediawiki.org/wiki/MediaWiki
 +
**To read the documentation about the MediaWiki platform, please feel free to consult this link.
 +
 +
== Getting started ==
 +
 +
*Select your account profile drop down. Choose “Preferences.” Under “User profile,” change your password and then further down the page confirm your email. You will receive a confirmation email in your inbox. Follow the link in the email and your email address will be confirmed.
 +
*While still in “Preferences,” navigate to the “Editing” header. Check the box labeled “Enable enhanced editing toolbar.” This toolbar will make editing in the “Edit source” mode (MediaWiki markup) much easier. The other option is to edit in “Edit” mode (VisualEditor) which appears the same as the finished article.
 +
 +
== MediaWiki markup—quick tips ==
 +
 +
*'''Article titles''' should appear in sentence case only, unless there are proper nouns in the title. Types of articles include: List of…, Annotated bibliography of…, …at the Folger, etc. To view a full list of article titles, navigate to the “Gear wheel” icon→Special pages→Lists of pages→All pages. To create a new article, enter the exact descriptive title into the search bar and select the search icon. A new link displayed in red will appear on the next page. Click the link to create the new article.
 +
*'''Headings''': The presence of 4 headings or more (levels 2-5) automatically creates a table of contents. Level 1 headings are reserved for titles of articles only. Please leave one line of space underneath each heading. Markup example: <nowiki>=== Level 3 ===</nowiki>
 +
*'''Bulleted lists''': Use an asterisk to render a bullet point. To indent the next bullet point, add another asterisk.
 +
<nowiki>Example: *Point 1
 +
  **Point 1 clarification.</nowiki>
 +
*'''Numbered lists''': To create a numbered list, simply place a “#” before each entry.
 +
*'''Text''': Bold lettering is rendered by placing three individual apostrophes around the desired text. Example: ‘’’Bold lettering’’’ In a similar vein, italics are rendered by placing two individual apostrophes around the desired text. Example: ‘’italic text’’
 +
*'''Links''': To link to an external webpage, the markup should look like this:<nowiki>[http://folger.edu Folger website]</nowiki>—the text on the right will render as a blue link in the article without displaying the URL. To link to another Folgerpedia article, the markup should look like this <nowiki> [[Playbill collection]] </nowiki> (this can also be used to create a new article by placing a new title within double brackets). To refer to an article by a different title follow this example:<nowiki> [[Playbill collection | Playbills at the Folger]] = [[Original article title | Display title]]</nowiki>. To link to an article from a different wiki within the Folger structure, simply attach the prefix of the wiki to the markup like this:<nowiki> [[folgerpedia:Playbill_collection|Playbill collection]]</nowiki>.
 +
*'''Upload an image''': Select the “Gear wheel” icon. Click on “Upload file.” Choose your file and put the photo credit in the “Summary” box. The wiki markup for an image looks like this:<nowiki>[[File:___]]</nowiki>. The easiest way to use the correct file name is to copy and paste the new file name from the top of the page after the file is uploaded.
 +
*Before saving, describe your changes in the summary box at the bottom of the editing page. Select “Show preview” in order to view your article before it is published in order to catch any possible mistakes in your text or markup. After reviewing your article, save it.
 +
*To undo unwanted saved changes, navigate to the “Paper” dropdown at the top right hand corner and select “History.” You will then be able to revert to the previous version of the article by choosing the version you want from the list of changes (this is why it is a good idea to label your changes in the summary at the bottom of the edit page).
 +
  
 
==== Editing reminders ====
 
==== Editing reminders ====

Revision as of 15:28, 14 July 2014

For a brief overview of Folgerpedia, please read the Folgerpedia article.

Creating your account

To create an account, please email folgerpedia@folger.edu for permissions.

Creating an article

  • Before getting started writing your article, please read our Folgerpedia:Manual of Style.
    • Types of articles include lists, annotated bibliographies, character and play descriptions, as well as descriptions of individual items in the collection.
      • For lists, title should read “List of…”
      • For annotated bibliographies, title should read “Annotated bibliography of…”
      • For individual collection items ??
  • To create an article, enter the exact desired descriptive title into the search bar and click the search icon.
    • Be sure your title is in sentence case—only the first word in the title should be capitalized unless it is a proper noun.

n.b. in order to check whether an article on your chosen topic already exists, select the middle “Gear wheel” drop down, select “Special pages” and then navigate to “All pages” for a list of all articles. If your article does not exist, the title will appear in red underneath the search bar. To create the article, click the red title link and you will be taken to an empty editing space.

Creating content and editing

Once you have navigated to the new editing space, you have the option of editing in one of two modes. Please be sure to read the editing warnings at the bottom of the article before saving.

VisualEditor

To edit in VisualEditor, select the paper icon drop down and click “Edit.” The page should be a tan background and a toolbar will appear along the top. This editing method displays the page as it will look as a finished product. For editing tips, see the VisualEditor help page.

MediaWiki editor

To edit in the MediaWiki editor, select the paper icon drop down and click “Edit source.” This is the HTML editor. To view what the finished product will look like without saving, select “Show preview” at the bottom of the page. For editing tips, see the MediaWiki help page.

MediaWiki links for editing basics

Getting started

  • Select your account profile drop down. Choose “Preferences.” Under “User profile,” change your password and then further down the page confirm your email. You will receive a confirmation email in your inbox. Follow the link in the email and your email address will be confirmed.
  • While still in “Preferences,” navigate to the “Editing” header. Check the box labeled “Enable enhanced editing toolbar.” This toolbar will make editing in the “Edit source” mode (MediaWiki markup) much easier. The other option is to edit in “Edit” mode (VisualEditor) which appears the same as the finished article.

MediaWiki markup—quick tips

  • Article titles should appear in sentence case only, unless there are proper nouns in the title. Types of articles include: List of…, Annotated bibliography of…, …at the Folger, etc. To view a full list of article titles, navigate to the “Gear wheel” icon→Special pages→Lists of pages→All pages. To create a new article, enter the exact descriptive title into the search bar and select the search icon. A new link displayed in red will appear on the next page. Click the link to create the new article.
  • Headings: The presence of 4 headings or more (levels 2-5) automatically creates a table of contents. Level 1 headings are reserved for titles of articles only. Please leave one line of space underneath each heading. Markup example: === Level 3 ===
  • Bulleted lists: Use an asterisk to render a bullet point. To indent the next bullet point, add another asterisk.

Example: *Point 1 **Point 1 clarification.

  • Numbered lists: To create a numbered list, simply place a “#” before each entry.
  • Text: Bold lettering is rendered by placing three individual apostrophes around the desired text. Example: ‘’’Bold lettering’’’ In a similar vein, italics are rendered by placing two individual apostrophes around the desired text. Example: ‘’italic text’’
  • Links: To link to an external webpage, the markup should look like this:[http://folger.edu Folger website]—the text on the right will render as a blue link in the article without displaying the URL. To link to another Folgerpedia article, the markup should look like this [[Playbill collection]] (this can also be used to create a new article by placing a new title within double brackets). To refer to an article by a different title follow this example: [[Playbill collection | Playbills at the Folger]] = [[Original article title | Display title]]. To link to an article from a different wiki within the Folger structure, simply attach the prefix of the wiki to the markup like this: [[folgerpedia:Playbill_collection|Playbill collection]].
  • Upload an image: Select the “Gear wheel” icon. Click on “Upload file.” Choose your file and put the photo credit in the “Summary” box. The wiki markup for an image looks like this:[[File:___]]. The easiest way to use the correct file name is to copy and paste the new file name from the top of the page after the file is uploaded.
  • Before saving, describe your changes in the summary box at the bottom of the editing page. Select “Show preview” in order to view your article before it is published in order to catch any possible mistakes in your text or markup. After reviewing your article, save it.
  • To undo unwanted saved changes, navigate to the “Paper” dropdown at the top right hand corner and select “History.” You will then be able to revert to the previous version of the article by choosing the version you want from the list of changes (this is why it is a good idea to label your changes in the summary at the bottom of the edit page).


Editing reminders

  • Please note that all contributions to Folgerpedia may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
  • You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
  • Do not submit copyrighted work without permission!