Documents: Difference between revisions

From Salish Sea Wiki
mNo edit summary
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{documentmain}}
{{documentmain}}[[Category:Main Page]]
<big>'''Document pages describe published reports and articles.  Pages either link to files uploaded on the wiki, to a off-site location, or to a [http://scholar.google.com/schhp?hl=en&as_sdt=0,48 Google Scholar search].  Provided here are directions of creating a document page, and a list of all document pages.'''</big>
<big>'''Document pages describe published reports and articles.  Pages either link to files uploaded on the wiki, to a off-site location, or to a [http://scholar.google.com/schhp?hl=en&as_sdt=0,48 Google Scholar search].  Provided here are directions of creating a document page, and a list of all document pages.'''</big>


==Documents and the Social Contract==
==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.
Review 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:
#'''Create a link''' - Usually documents are associated with an [[effort]] page or some relevant [[place]] page.
#*A document link using standard naming will look like this:  <code><nowiki>[[file:Smith et al 2010 short nickname.pdf]]</nowiki></code>
#*If you are uploading a document, you must begin the document name with "file:" and end the document with a file type, preferably ".pdf", if the document is offsite, and pointed at with a link, you don't.
#*Please read about '''standard names''' below--Name, Year, abbreviated title
#'''Follow the link to upload''' - save the page, and your new file link will be red, indicating no associated page. Click the link, and you will go to the upload page.  Follow instructions.
#'''Add text to the description box''' - if you have a weak description it will be hard to find your document
#*Start a document page with the document template code:  <code><nowiki>{{product}}[[category:document]]</nowiki></code>
#*List other categories: site and place categories tell "where", topic categories tell "what"; effort categories tell "why"
#*Standard Citation in bold. A great favor to future wiki users, and often includes keywords.
#*If your document is offsite, put a link pointing at the document, for example a publisher page, an agency archive, or a google scholar search.
#*Some quick bulleted notes about why you are including the document--include keywords in your narrative that someone might search for.
 
That's it!  Now you can point to your document page 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==
==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:
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
:'''''Simenstad & Cordell 2000 salmonid habitat assessment pacific northwest
Line 12: Line 28:
:'''''Gray et al 2002 salmon river habitat restoration performance
:'''''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. 
You can also create a redirect page to point at you document page using a short citation, such as:
 
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
:'''''Simenstad & Cordell 2000
Line 20: Line 34:
:'''''Gray et al 2002
:'''''Gray et al 2002


To create these two pages we recommend the following sequence:
Type the short citation in search, click on the "create this page" link and save with <code><nowiki>#redirect[[fulldocumentname]]</nowiki></code>
#Create the full document page but only using the short name.
#Then [[Move]] the mage to a new location using its long name--the wiki will automatically create a [[redirect]].


==Creating a Document Page==
==Short Citation for Multiple Documents in a Single Year?==
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 Page|create a new wiki page]] using the document [[template code]].
If the same author creates two or more documents in a single year, a short 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 <big><nowiki>{{ambiguous citation}}</nowiki></big> and then presents the potential document pages to sort out the choices.


Both kinds of document pages should have the same content:
==Creating a Google Scholar Search==
 
#'''Document Template Code''' - Type the [[template code]] <big><nowiki>{{document}}</nowiki></big> at the top of text.
#'''Categories''' - Pick some appropriate [[categories]] and add them to the top of text (examples are given in the edit page instructions).
#'''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.
#'''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.
#'''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 <big><nowiki>"~~~"</nowiki></big> 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 <big><nowiki>{{ambiguous citation}}</nowiki></big> 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:  
If the document is under copyright, and cannot be uploaded, you can insert a google scholar link, like so:  


  <small><nowiki>[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]</nowiki></small>
  <small><nowiki>[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]</nowiki></small>


Just go to [http://scholar.google.com/schhp?hl=en&as_sdt=0,48 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:  
Just go to [http://scholar.google.com/schhp?hl=en&as_sdt=0,48 google scholar], type in a competent 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:  


:''' <small>[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]</small>
:''' <small>[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]</small>


===Uploading a Document===
==More Info About Uploading a Document==
The second way to create a document page is to actually upload a file to the wiki.  This is a good choice if there is not currently a stable web location for the document, or it otherwise may become difficult to find.  The content should be the same as for an off-wiki page.  Follow the [[special:upload|Upload a Document]] link found on any document page and follow instructions. Upload a document page, you should use the long page name format, and manually create a short name page with a [[redirect]]
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 [[special:upload|Upload a Document]] link found on any document page and follow instructions.


{|
{|
Line 54: Line 55:


===Documents On-Wiki (uploaded)===
===Documents On-Wiki (uploaded)===
<DynamicPageList>
{{#dpl:
category=document
|category=document
namespace=file
|namespace=file
ordermethod=sortkey
|ordermethod=title
order=ascending
|order=ascending
mode=unordered
|mode=unordered
suppresserrors=true
|suppresserrors=true
shownamespace=false
|shownamespace=false
</DynamicPageList>
}}
|style="width:50%;padding:0px 20px; vertical-align:top;"|
|style="width:50%;padding:0px 20px; vertical-align:top;"|
===Cited (not uploaded)===
===Cited (not uploaded)===
<DynamicPageList>
<DPL>
category=document
category=document
namespace=foo
namespace=foo
Line 71: Line 73:
order=ascending
order=ascending
mode=unordered
mode=unordered
shownamespace=false
suppresserrors=true
suppresserrors=true
</DynamicPageList>
</DPL>

Latest revision as of 00:09, 9 April 2024


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

Review 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 are associated with an effort page or some relevant place page.
    • A document link using standard naming will look like this: [[file:Smith et al 2010 short nickname.pdf]]
    • If you are uploading a document, you must begin the document name with "file:" and end the document with a file type, preferably ".pdf", if the document is offsite, and pointed at with a link, you don't.
    • Please read about standard names below--Name, Year, abbreviated title
  2. Follow the link to upload - save the page, and your new file link will be red, indicating no associated page. Click the link, and you will go to the upload page. Follow instructions.
  3. Add text to the description box - if you have a weak description it will be hard to find your document
    • Start a document page with the document template code: {{product}}[[category:document]]
    • List other categories: site and place categories tell "where", topic categories tell "what"; effort categories tell "why"
    • Standard Citation in bold. A great favor to future wiki users, and often includes keywords.
    • If your document is offsite, put a link pointing at the document, for example a publisher page, an agency archive, or a google scholar search.
    • Some quick bulleted notes about why you are including the document--include keywords in your narrative that someone might search for.

That's it! Now you can point to your document page 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

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

You can also create a redirect page to point at you document page using a short citation, such as:

Simenstad & Cordell 2000
Odum 1988
Gray et al 2002

Type the short citation in search, click on the "create this page" link and save with #redirect[[fulldocumentname]]

Short Citation for Multiple Documents in a Single Year?

If the same author creates two or more documents in a single year, a short 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 to sort out the choices.

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 competent 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)