Difference between revisions of "Guidelines"

From Coastal Plain Plants Wiki
Jump to: navigation, search
(Add a new plant species page)
(40 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
=Become a Contributor=
 
=Become a Contributor=
  
To become a contributor, click "Create Account" on the upper right hand side of the page, and send an email introducing yourself to webmaster [http://talltimbers.org/bio-robertson Kevin Robertson] including your username and real name. Contributors unknown to the webmaster will not be retained. It is suggested that you make the username short, preferably your initials, as it will be used to cite contributions with a link to your contributor page, explained below.  
+
To become a contributor, click "Create Account" on the upper right hand side of the page and complete the form.  Please send an email introducing yourself to webmaster [http://talltimbers.org/bio-robertson Kevin Robertson] including your username and real name. Contributors not known to the webmaster will not be retained. You will have a contributor webpage set up that will allow you to cite your contributions to your webpage using your username, explained below.  
 
   
 
   
 
=Overview=
 
=Overview=
Line 10: Line 10:
 
1) Edit pages directly using the guidelines below.  
 
1) Edit pages directly using the guidelines below.  
  
2) Request a plant species form as a Word (docx) file, edit the form and submit to [http://talltimbers.org/bio-robertson Kevin Robertson] for incorporation into the website.
+
2) Request a plant species form as a Word (docx) file, edit the form, and send it to [http://talltimbers.org/bio-robertson Kevin Robertson] for incorporation into the website.
  
3) Submit other sources of information, such as notes or spreadsheets containing relevant data about plants, for incorporation into the website.  
+
3) Submit other sources of information, such as notes, databases, documents, etc. relating to Coastal Plain plants, for incorporation into the website.  
  
4) Volunteer to be interviewed about your knowledge on certain plants by contacting [http://talltimbers.org/bio-robertson Kevin Robertson].
+
4) Communicate information directly to [http://talltimbers.org/bio-robertson Kevin Robertson] to be incorporated into the site.
  
 
=Editing=
 
=Editing=
  
Coastal Plain Plants uses a Wikimedia platform, the same as used for Wikipedia. To edit pages, login, then click the "Edit" tab or and of the "Edit" hyperlinks on pages.  After editing, click the "Save Page" button at the bottom, which brings you back to the Read (front end) view.  If you are not familiar with editing in Wikimedia, a good place to start is this [http://en.wikipedia.org/wiki/Wikipedia:Tutorial tutorial].  Many more sophisticated commands can be searched online. Some basic commands are:
+
Coastal Plain Plants uses a Wikimedia platform, the same as used for Wikipedia. A good place to start learning how to edit is this [http://en.wikipedia.org/wiki/Wikipedia:Tutorial tutorial], and more sophisticated commands can be searched online, but some basic instructions are as follows:
  
<nowiki>''italic''</nowiki> (apostrophes, not quotation marks) Use for plant species binomials, e.g. ''Dyschoriste oblongifolia''.
+
To edit pages, login, then click the "Edit" tab or and of the "Edit" hyperlinks on pages.
  
<nowiki>'''bold'''</nowiki>
+
After editing, click the "Save Page" button at the bottom, and then it will go back to the front end view.
  
<nowiki>'''''bold italic'''''</nowiki>
+
If there were no edits, then clicking the "Read" tab at the top will bring you back to the front end view.
  
<nowiki>=Heading=</nowiki> e.g.
+
Italics and bold lettering are specified with apostrophes (not quotation marks). For example:
  
<nowiki>==Subheading==</nowiki> e.g.  
+
Typing <nowiki>''Dyschoriste oblongifolia''</nowiki> (two apostrophes) returns ''Dyschoriste oblongifolia''.
  
<nowiki>===Sub-subheading===</nowiki> e.g.
+
Typing <nowiki>'''Dyschoriste oblongifolia'''</nowiki> (three apostrophes) returns '''Dyschoriste oblongifolia'''.  
  
Contributors are encouraged to use the default headings for plant species pages, but additional headings can be added as needed and appropriate.  
+
Typing <nowiki>'''''Dyschoriste oblongifolia'''''</nowiki> (five apostrophes) returns '''''Dyschoriste oblongifolia'''''.
  
pipe "|" divider: SHIFT + BACKSLASH
+
Default subheadings are provided for each plant webpage.  However, if they do not have any information under them yet then they are hidden using the format <nowiki><!--</nowiki> hidden subheading <nowiki>--></nowiki>.  If you delete the <nowiki><!--- and --></nowiki> then the subheading will appear in the Read window.
  
<nowiki>: single indent</nowiki>
+
==Citing Contributions==
 
 
<nowiki>:: double indent, etc.</nowiki>
 
 
 
<nowiki>* bullet point</nowiki>
 
 
 
Link to an external source: <nowiki>Example: [http://plants.usda.gov NRCS Plants Database]</nowiki>  The part after the space is what will appear as a hyperlink: [http://plants.usda.gov NRCS Plants Database]
 
 
 
=Citing Contributions=
 
  
 
Contributions should always be cited, but they can be cited in various ways with varying amounts of information.  
 
Contributions should always be cited, but they can be cited in various ways with varying amounts of information.  
  
==Cite by Contributor username==
+
===Cite by Contributor username===
 
 
Minimally the contributor should be identified by typing the username in double brackets in parentheses after the contribution, e.g. "The plant is a perennial. <nowiki>([[KMR]])</nowiki>", which will appear as "The plant is a perennial ([[KMR]]).". On the first time this will create a hyperlink to a page that is not yet created, so the link will appear red after the page is saved.  If you click on this hyperlink, you will be prompted to edit the new page that has your username as the title.  To set up a contributor template for this page, type or paste <nowiki>{{subst:Template:Contributor}}</nowiki> in the editing area.  After saving the page, this will create a template where you can fill in and edit information about yourself. This page can include links to a personal or professional web page where contact information may be more secure. You can also ask the [http://talltimbers.org/bio-robertson webmaster] to set this up for you.
 
 
 
After your Contributor page is created, typing your user name in double brackets will create a link to that page.
 
  
To appear on the list of Contributors, go to the [http://coastalplainplants.org/wiki/index.php/Contributors Contributors] page, start editing, and insert a link to your page in alphabetical order of Contributors' last names.  To do this, type your username and real name inside double brackets and separated by a pipe, e.g. <nowiki>[[KMR|Kevin Robertson]]</nowiki>.  This will provide your name linked to your Contributor page, e.g. [[KMR|Kevin Robertson]].   
+
Minimally the contributor should be identified by typing his or her initials or last name in double brackets within parentheses after the contribution. For example, if the contributor's user name is KMR, he would write, "The plant is a perennial. <nowiki>([[KMR]])</nowiki>", which will appear as "The plant is a perennial ([[KMR]])".  This hyperlink connects to your contributor webpage.   
  
==Cite notes or literature using the <nowiki><ref> function</nowiki>==
+
Please fill out your contributor webpage with all of the information that you would like a reader to know.
 +
This page can include links to a personal or professional web page where contact information may be more secure.
  
To provide additional background information about the contribution that you do not want to appear in the text, references may be added which appear as a hyperlinked superscript number linking to a footnote at the bottom of the page.  Type <nowiki><ref> followed by the information to be cited and then </ref></nowiki>
+
===Create footnotes using the <nowiki><ref> </ref> function</nowiki>===
  
==Cite literature using Author-Date format==
+
Type <nowiki><ref> followed by the reference information to be cited, followed by </ref></nowiki>.  This will insert a hyperlinked superscript number that links to the reference, which is automatically placed at the bottom of the page. This can be used to add specific notes about an observation or cite published literature
  
To cite published literature, we suggest using the author-date format, e.g. (Smith and Blackburn 1994), and write or paste the full reference in alphabetical order under the "References" section.  
+
If the same source is going to be cited multiple times on the same page, the first time you cite the source, type <nowiki><ref name="short name of reference">, followed by the reference, then </ref>. Then every time afterward you can just write <ref name="short name of reference"/></nowiki> and it cites the reference with a hyperlinked subscript as above.
  
If a reference is going to be used frequently on different pages, it can be made into a template. For example, the first time the reference is cited, type <nowiki>{{Template:Smith and Blackburn 1994}}. After the page is saved, this will appear as a red hyperlink.  If you click that hyperlink, it will bring you to a new page, where you can type in the full reference and save the page.  Afterwards, any time you write {{Template:Smith and Blackburn 1994}} in the References section, the full reference will appear after you save the page.</nowiki>
+
==Create links to other pages==
  
==Cite with links to other pages==
+
Links to external webpages can be inserted by placing the URL followed by text for the hyperlink in single brackets.  For example, typing <nowiki>[http://plants.usda.gov NRCS]</nowiki> will appear as [http://plants.usda.gov NRCS]. 
  
As described above, links to other pages can be inserted.  For example, typing <nowiki>([http://plants.usda.gov NRCS])</nowiki> will appear as [http://plants.usda.gov NRCS] linked to the USDA NRCS database.  
+
Links to other pages within Coastal Plain Plants can be made by using double brackets.  For example <nowiki>[[Dyschoriste oblongifolia]]</nowiki> will return [[Dyschoriste oblongifolia]].
  
If the same webpage is cited multiple times on that page, you can use the Author-Date form described above, e.g. (USDA NRCS 2015), and provide the full citation under the References and Notes section along with the link.
+
==Add images==
  
=Add images=
+
To add an image, it first has to be uploaded.  To upload an image, click Upload File under Tools in the side bar menu and follow the instructions.  If the file is over 2 MB then it cannot be uploaded.  In that case, the image size will need to be reduced in another software application, such as Microsoft Paint, before uploading.  Reference to the uploaded image is case-sensitive, so note the exact case of the file name and extension.
  
To add an image, it first has to be uploaded.  To upload an image, in the sidebar menu under Tools click Upload file and follow the instructions.  If the file is too large then it will not allow the image to be uploaded.  In that case, the image size will need to be reduced in another software application, such as Microsoft Paint, before uploading.  When uploading, note whether or not the format indicator "JPG" is in lowercase or uppercase letters, as references made to the image later are case-sensitive.
+
===Add images to gallery===
  
==Add images to plant species pages==
+
To add an image to the Photo Gallery, add one line of information per image in between the gallery opening and closing statements, e.g.:  
 
 
Images can be added to the Taxobox (see below) if there is not one there already, or the Photo Gallery. To add to the Photo Gallery, add one line of information per image in between the gallery opening and closing statements, e.g.:  
 
 
   
 
   
<nowiki><gallery widths=180px>
+
<nowiki><gallery widths=180px></nowiki>
  
File:Salvia_azurea.jpg|''Salvia azurea'' Photo by Kevin Robertson, Pebble Hill Plantation, GA
+
<nowiki>File:Salvia_azurea.jpg|''Salvia azurea'' Photo by Kevin Robertson, Pebble Hill Plantation, GA</nowiki>
  
</gallery></nowiki>
+
</nowiki></gallery></nowiki>
  
 
The part after the pipe provides a caption, so it looks like:
 
The part after the pipe provides a caption, so it looks like:
Line 92: Line 79:
 
</gallery>
 
</gallery>
  
==Add institution image to Main Page==
+
===Add institution image to Main Page===
  
Add uploaded images to the gallery as described for plant pages, but you can also add a link from the image to your institution:
+
Add uploaded images to the gallery as described for plant pages, but you can also add a link from the image to your institution's website by adding link=your_institution_URL after the pipe, e.g.:
 
   
 
   
<nowiki><gallery>
+
<nowiki><gallery mode=packed heights=70px></nowiki>
  
File:TT_logo_1.jpg|link=http://www.ttrs.org
+
<nowiki>File:TT_logo_1.jpg|link=http://www.ttrs.org</nowiki>
File:idigbio_logo.jpg|link=http://www.idigbio.org
 
File:fsu_bio_herb_logo.png|link=http://herbarium.bio.fsu.edu/
 
  
</gallery></nowiki>  
+
<nowiki>File:idigbio_logo.jpg|link=http://www.idigbio.org</nowiki>
  
=Add a new plant species page=
+
<nowiki></gallery></nowiki>
  
 +
==Add a new plant species page==
 +
 +
To add plant pages we suggest that you make a request for pages to be added to the [[KMR|webmaster]] to set up a new page or pages.  However, you can also set up a page yourself using the following instructions:
 +
 
*Navigate to the [http://coastalplainplants.org/wiki/index.php/Plant_species Plant Species] page, where the plant species binomials are listed in alphabetical order.
 
*Navigate to the [http://coastalplainplants.org/wiki/index.php/Plant_species Plant Species] page, where the plant species binomials are listed in alphabetical order.
 
*Start editing.   
 
*Start editing.   
*In the correct alphabetical location, add a link using the name of the new species in double brackets, e.g. <nowiki>[[Dyschoriste oblongifolia]]</nowiki>.  
+
*In the correct alphabetical location, add a link using the binomial of the new species in double brackets, e.g. <nowiki>[[Dyschoriste oblongifolia]]</nowiki>.  
 
*Save the page, and the link appears as a red hyperlink.  
 
*Save the page, and the link appears as a red hyperlink.  
 
*Select the hyperlink, and you will be brought to the new page with the plant's name as the title.  
 
*Select the hyperlink, and you will be brought to the new page with the plant's name as the title.  

Revision as of 19:54, 22 January 2016

Become a Contributor

To become a contributor, click "Create Account" on the upper right hand side of the page and complete the form. Please send an email introducing yourself to webmaster Kevin Robertson including your username and real name. Contributors not known to the webmaster will not be retained. You will have a contributor webpage set up that will allow you to cite your contributions to your webpage using your username, explained below.

Overview

Contributions to Coastal Plain Plants can be made in various ways:

1) Edit pages directly using the guidelines below.

2) Request a plant species form as a Word (docx) file, edit the form, and send it to Kevin Robertson for incorporation into the website.

3) Submit other sources of information, such as notes, databases, documents, etc. relating to Coastal Plain plants, for incorporation into the website.

4) Communicate information directly to Kevin Robertson to be incorporated into the site.

Editing

Coastal Plain Plants uses a Wikimedia platform, the same as used for Wikipedia. A good place to start learning how to edit is this tutorial, and more sophisticated commands can be searched online, but some basic instructions are as follows:

To edit pages, login, then click the "Edit" tab or and of the "Edit" hyperlinks on pages.

After editing, click the "Save Page" button at the bottom, and then it will go back to the front end view.

If there were no edits, then clicking the "Read" tab at the top will bring you back to the front end view.

Italics and bold lettering are specified with apostrophes (not quotation marks). For example:

Typing ''Dyschoriste oblongifolia'' (two apostrophes) returns Dyschoriste oblongifolia.

Typing '''Dyschoriste oblongifolia''' (three apostrophes) returns Dyschoriste oblongifolia.

Typing '''''Dyschoriste oblongifolia''''' (five apostrophes) returns Dyschoriste oblongifolia.

Default subheadings are provided for each plant webpage. However, if they do not have any information under them yet then they are hidden using the format <!-- hidden subheading -->. If you delete the <!--- and --> then the subheading will appear in the Read window.

Citing Contributions

Contributions should always be cited, but they can be cited in various ways with varying amounts of information.

Cite by Contributor username

Minimally the contributor should be identified by typing his or her initials or last name in double brackets within parentheses after the contribution. For example, if the contributor's user name is KMR, he would write, "The plant is a perennial. ([[KMR]])", which will appear as "The plant is a perennial (KMR)". This hyperlink connects to your contributor webpage.

Please fill out your contributor webpage with all of the information that you would like a reader to know. This page can include links to a personal or professional web page where contact information may be more secure.

Create footnotes using the <ref> </ref> function

Type <ref> followed by the reference information to be cited, followed by </ref>. This will insert a hyperlinked superscript number that links to the reference, which is automatically placed at the bottom of the page. This can be used to add specific notes about an observation or cite published literature.

If the same source is going to be cited multiple times on the same page, the first time you cite the source, type <ref name="short name of reference">, followed by the reference, then </ref>. Then every time afterward you can just write <ref name="short name of reference"/> and it cites the reference with a hyperlinked subscript as above.

Create links to other pages

Links to external webpages can be inserted by placing the URL followed by text for the hyperlink in single brackets. For example, typing [http://plants.usda.gov NRCS] will appear as NRCS.

Links to other pages within Coastal Plain Plants can be made by using double brackets. For example [[Dyschoriste oblongifolia]] will return Dyschoriste oblongifolia.

Add images

To add an image, it first has to be uploaded. To upload an image, click Upload File under Tools in the side bar menu and follow the instructions. If the file is over 2 MB then it cannot be uploaded. In that case, the image size will need to be reduced in another software application, such as Microsoft Paint, before uploading. Reference to the uploaded image is case-sensitive, so note the exact case of the file name and extension.

Add images to gallery

To add an image to the Photo Gallery, add one line of information per image in between the gallery opening and closing statements, e.g.:

<gallery widths=180px>

File:Salvia_azurea.jpg|''Salvia azurea'' Photo by Kevin Robertson, Pebble Hill Plantation, GA

</nowiki></gallery></nowiki>

The part after the pipe provides a caption, so it looks like:

Add institution image to Main Page

Add uploaded images to the gallery as described for plant pages, but you can also add a link from the image to your institution's website by adding link=your_institution_URL after the pipe, e.g.:

<gallery mode=packed heights=70px>

File:TT_logo_1.jpg|link=http://www.ttrs.org

File:idigbio_logo.jpg|link=http://www.idigbio.org

</gallery>

Add a new plant species page

To add plant pages we suggest that you make a request for pages to be added to the webmaster to set up a new page or pages. However, you can also set up a page yourself using the following instructions:

  • Navigate to the Plant Species page, where the plant species binomials are listed in alphabetical order.
  • Start editing.
  • In the correct alphabetical location, add a link using the binomial of the new species in double brackets, e.g. [[Dyschoriste oblongifolia]].
  • Save the page, and the link appears as a red hyperlink.
  • Select the hyperlink, and you will be brought to the new page with the plant's name as the title.
  • Type or paste the command {{subst:Template:PlantName}} to bring in the template text.
  • Save the page and begin editing

The new page will include a "Taxobox", which is a template for creating the box with the plant name, image, taxonomy, and distribution. The Taxobox will need to be edited. To fill in the Taxobox you will need:

  • Uploaded image for the species
  • Taxonomic information for the plant, which can be obtained from the NRCS Plants Database or other updated reliable source.
  • Uploaded image for the distribution of the species. Most pages so far have used images screen-saved from the NRCS Plants Database.