Documents: Difference between revisions

From Salish Sea Wiki
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{documentmain}}
{{documentmain}}
'''The document category is used for all pages that provide information about published reports and articles either uploaded here or publishedDocuments may be either uploaded to the wiki when public domain (on-wiki) or located on another server or physical location as identified by a link when copyrighted or not released for posting by the author (off-wiki).'''
<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>


'''Please follow our [[social contract]] around posting documents, and use good [[categories]] and interlinking to make your document easy to find.'''
==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.


==Documents loaded on the wiki==
==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:
#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==
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]].
 
Both kinds of document pages should have the same content:
 
#'''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:
 
<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:
 
:''' <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===
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]]
 
{|
|style="width:50%;padding:0px 20px; vertical-align:top;"|
 
===Documents On-Wiki (uploaded)===
<DynamicPageList>
<DynamicPageList>
category=document
category=document
Line 14: Line 63:
shownamespace=false
shownamespace=false
</DynamicPageList>
</DynamicPageList>
 
|style="width:50%;padding:0px 20px; vertical-align:top;"|
==Documents cited in the wiki==
===Cited (not uploaded)===
<DynamicPageList>
<DynamicPageList>
category=document
category=document
Line 24: Line 73:
suppresserrors=true
suppresserrors=true
</DynamicPageList>
</DynamicPageList>
==Creating a document page==
There are two ways to create a document page, depending on whether the document is a uploaded file (i.e. on-wiki), or whether you are referecing a document that is off-wiki.
'''To load a document onto the wiki:'''
#'''Copy''' the template below. 
#'''Click''' on the [[Special:upload|Upload File]] link. 
#'''Name''' the file using a standard citation format such as "Author et al 20##". 
#'''Paste''' the template into the summary box, and use the resulting wiki page (which will be named ''File:Author_et_al_20##'') as you document page.
#'''Assign''' [[categories]] that makes sense for your document.  Is it associated with a particular [[site]] or [[place]] or [[topic]]?
#'''Create''' a redirect page by 1) typing your new title, ''Author et al 20##'' into the search box, 2) select the 'create page' link, 3) type ''<nowiki>#REDIRECT[[File:Author et al 20##]]</nowiki>'' into the blank page, and save.  This creates a page that will direct a <nowiki>[[Author et al 20##]]</nowiki> link to your uploaded file.
'''Off-wiki''' - Use a regular document wiki page named ''Author et al 20##'' to describe the document, using the template below and including a link to an appropriate source for the document (which could include a google scholor search for the document title.)
==Standard Document Template==
''For each document page adapt the following template depending if your document is on- or off-wiki''
::<nowiki> {{document}} </nowiki>
::<nowiki>'''Citation'''</nowiki>
::<nowiki>==Links to Document==</nowiki>
::<nowiki>*'''[[Link]]''' - text</nowiki>
::<nowiki>==Abstract (Closed to Editing)==</nowiki>
::<nowiki>Abstract written by author</nowiki>
::<nowiki>==Analysis==</nowiki>
::<nowiki>Description of importance of document in relation to other efforts including links to any other documents found in this wiki</nowiki>

Revision as of 15:52, 2 December 2014


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.

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

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

Documents On-Wiki (uploaded)

Cited (not uploaded)