Documents

From Salish Sea Wiki
Revision as of 19:23, 29 January 2020 by Pcereghino (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


Document Icon.jpg

Document

A document is a written record related to an effort or topic


UploadDocumentButton.PNG

Last Ten Documents


Wiki Rules

  • Wiki text does not reflect the policy or opinion of any agency or organization
  • Please adhere to our social contract
  • Complain here, and be nice.


Link to List of Workgroups Link to List of Efforts Link to List of Resources Link to List of Documents Link to List of Topics Link to List of Places

Link to Headwater Sites Link to Lowland Watershed Sites Link to Floodplain Sites Link to Delta Sites Link to Embayment Sites Link to Beach Sites Link to Rocky Headland Sites

Document pages describe published reports and articles. Pages either link to files uploaded on the wiki, to a off-site location, or to a Google Scholar search. Provided here are directions of creating a document page, and a list of all document pages.

Documents and the Social Contract

Uploading and providing analysis of documents should be consistent with our social contract. Don't violate copyright. Provide impersonal, evidence-driven analysis. Use concise language.

How to upload a document?

We recommend three steps to upload a document:

  1. Create a link - Usually documents can be associated with an effort page or some relevant place page. Edit the page, and create some text that introduces the document. Here is an example of a document entry with a bullet at the front -- *[[file:author year short name.pdf]] - this document is really neat -- Notice the double brackets around the file name, and that you must begin the document name with "file:" and end the document with a file type, preferably ".pdf" Please read about standard names below.
  2. Follow the link to upload - save the page, and you will notice your new file link is red. This means there is no file yet. Click the link, and you will go to the upload page. Browse to select the document from your computer. The new wiki name will be based on the link text you provided.
  3. Add text to the description box - At absolute minimum, put the document template code in the dialog box -- {{document}} -- which lets the wiki know that the page is for a document, and adds some special formatting and the document category. You can add any other categories that makes sense and a short keyword-heavy description, any links to related pages, and ideally, a standard citation, so that future wiki users can easily cite the document by cutting and pasting. You might feel lazy and choose to do less than all this and no one will stop you. Then click upload.

That's it! Now you can point to your document using web links, and others can find and comment on your document. Please contact the moderator team if you have any questions. Your document link may remain red on the original link location until you edit and save the original page again.

Standard Names for Document Pages

Every document has two pages. The page names are standardized so they are easy to find. A main document page uses the following syntax:

Simenstad & Cordell 2000 salmonid habitat assessment pacific northwest
Odum 1988 tidal fresh vs salt marsh ecology
Gray et al 2002 salmon river habitat restoration performance

note that we start with an in-line citation format, and include just enough keywords in the title to guess at content and improve search functionality.

In addition to the main document page we also create a redirect page that exists only to serve as a link to the main page. It uses an in-line citation format with no additional text:

Simenstad & Cordell 2000
Odum 1988
Gray et al 2002

To create these two pages we recommend the following sequence:

  1. Create the full document page but only using the short name.
  2. Then Move the mage to a new location using its long name--the wiki will automatically create a redirect.

Creating a Document Page

There are two kinds of main document pages, depending if the document is actually uploaded to the wiki, or if it is located off site. When you upload a file of the document to the wiki a document page is created automatically--this is a special 'file page', and uses the 'File:' prefix in its page name. If there is no uploaded document, than you use simply create a new wiki page using the document template code.

Both kinds of document pages should have the same content:

  1. Document Template Code - Type the template code {{document}} at the top of text.
  2. Categories - Pick some appropriate categories and add them to the top of text (examples are given in the edit page instructions).
  3. Bibliographic Citation - Provide a detailed bibliographic citation to help with searching and aid future users. We don't have a standard style--I tend to cut and paste from an available source.
  4. Link to Document - If the document has a stable link location, than please provide it. Consider a google scholar search if you have any doubts about the stability of the document link.
  5. Notes - This is where you put any comments or ideas provoked by the content or context of the document. While all edits are tracked, consider signing you note by adding "~~~" at the end, which will insert your user name so that a future reader may ask questions.

Multiple Documents in a Single Year?

If the same author creates two or more documents in a single year, a single citation redirect page may need to point to more than one document (for example Beamer 2014). In this case we create a new page that begins with the template {{ambiguous citation}} and then presents the potential document pages.

Creating a Google Scholar Search

If the document is under copyright, and cannot be uploaded, you can insert a google scholar link, like so:

[http://scholar.google.com/scholar?q=Simenstad+Cordell+2000+salmonid+habitat+assessment&btnG=&hl=en&as_sdt=0%2C48 Google Scholar Search for Simenstad & Cordell 2000]

Just go to google scholar, type in a competant search including authors date and keywords, and then paste search query from the address window and add the wiki markup and some link text. The example above produces the following results:

Google Scholar Search for Simenstad & Cordell 2000

More Info About Uploading a Document

Uploading a document to the wiki is a good choice if there is not currently a stable web location for the document, or it otherwise may become difficult to find in the future. The content of an uploaded document page should be the same as for an off-wiki page. Follow the Upload a Document link found on any document page and follow instructions.

Documents On-Wiki (uploaded)

Cited (not uploaded)