Difference between revisions of "Template:InfoWorld/doc"

From Terminals
Jump to: navigation, search
m (put required params at the top)
m (update documentation)
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
  
 
;<code>id</code>
 
;<code>id</code>
:'''Required'''  This is the id of the google books publication.  It will identify a particular issue of InfoWorld.
+
:'''Required'''  This is the id of the google books publication.  It will identify a particular issue of the magazine.
 +
;<code>date</code>
 +
:'''Required''' The publication date of the issue of the magazine.
 
;<code>title</code>
 
;<code>title</code>
:'''Required''' The title of the article.  Use double-quotes if it is an article and not just a section header, i.e <code>title="HP Introduces New Terminals"</code> and <code>title=New Products</code>.
+
:'''Required''' The title of the article.  Use double-quotes if it is an article and not just a section header, i.e <code>title="HP Introduces New Terminals"</code> and <code>title=New Products</code>.
;<code>date</code>
 
:'''Required''' The publication date of the issue of InfoWorld.
 
 
;<code>page</code> or <code>pg</code>
 
;<code>page</code> or <code>pg</code>
:This is the page number of the article.  This is used to form the google books URL, so it must match what is in the URL.
+
:'''Required''' This is the page number of the article.  This is used to form the google books URL, so it must match what is in the URL.
 
;<code>page_prefix</code>
 
;<code>page_prefix</code>
 
:Sometimes google books uses a prefix other than "<code>PA</code>" in the page argument portion of the URL. Supply anything between the <code>lpg=</code> and the page number in the URL here. '''Default:''' <code>PA</code>
 
:Sometimes google books uses a prefix other than "<code>PA</code>" in the page argument portion of the URL. Supply anything between the <code>lpg=</code> and the page number in the URL here. '''Default:''' <code>PA</code>
 +
;<code>display_page_prefix</code>
 +
:Text to display before the page name in the display of the citation.  This does not affect the URL, but is used when the printed page name is from a special subsection, i.e. "Special Report/"
 +
;<code>display_page</code>
 +
:The page number to use in the display of the citation.  This does not affect the URL, but is used when the printed page number is different from the page number in the URL.
 
;<code>author</code>
 
;<code>author</code>
 
:The name of the author of the article, if any.
 
:The name of the author of the article, if any.
 +
;<code>volume</code>
 +
:The volume number of the issue, if any.
 +
;<code>number</code>
 +
:The number of the issue, if any.
 
;<code>name</code>
 
;<code>name</code>
 
:Names this citation so that it can be referenced again by the supplied name.
 
:Names this citation so that it can be referenced again by the supplied name.

Latest revision as of 05:51, 15 April 2012

This is the template for citing articles from InfoWorld via google books.

The parameters are as follows:

id
Required This is the id of the google books publication. It will identify a particular issue of the magazine.
date
Required The publication date of the issue of the magazine.
title
Required The title of the article. Use double-quotes if it is an article and not just a section header, i.e title="HP Introduces New Terminals" and title=New Products.
page or pg
Required This is the page number of the article. This is used to form the google books URL, so it must match what is in the URL.
page_prefix
Sometimes google books uses a prefix other than "PA" in the page argument portion of the URL. Supply anything between the lpg= and the page number in the URL here. Default: PA
display_page_prefix
Text to display before the page name in the display of the citation. This does not affect the URL, but is used when the printed page name is from a special subsection, i.e. "Special Report/"
display_page
The page number to use in the display of the citation. This does not affect the URL, but is used when the printed page number is different from the page number in the URL.
author
The name of the author of the article, if any.
volume
The volume number of the issue, if any.
number
The number of the issue, if any.
name
Names this citation so that it can be referenced again by the supplied name.