User:Cxw/Cite web trans/doc: Difference between revisions

Revision as of 15:45, 22 January 2010

Revision as of 15:49, 22 January 2010

Line 1:

{{Documentation subpage}}

<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

This [[Wikipedia:Template namespace|template]] is used to cite online sources in Wikipedia articles. {{tl|Cite news}} can also be used when citing a news source; for general information about citations in Wikipedia articles, see [[Wikipedia:Cite sources]]. A general discussion of the use of templates for adding citations to Wikipedia articles is available at [[Wikipedia:Citation templates]].

== Usage ==

'''''Note''''': None of the parameters should be capitalised, in order to avoid the article being tagged as having a broken citation. For example, use "url", "title", etc. - not "URL", "Title", etc.

=== Common forms with authors in any format ===

Citations within a page should use consistent formats. However, there is no consensus about which format is best. The following examples are for citations where one or more authors are listed in a single {{para|author|<var>authors</var>}} parameter, using any format. Also shown below are three separate date formats that are commonly used in Wikipedia:

;YYYY-MM-DD: <code><nowiki>{{User:Cxw/Cite web trans |url= |title= |author= |date= |work= |publisher= |accessdate=</nowiki>{{#time: Y-m-d }}<nowiki>}}</nowiki></code>

;Day Month Year: <code><nowiki>{{User:Cxw/Cite web trans |url= |title= |author= |date= |work= |publisher= |accessdate=</nowiki>{{#time: j F Y }}<nowiki>}}</nowiki></code>

;Month Day, Year: <code><nowiki>{{User:Cxw/Cite web trans |url= |title= |author= |date= |work= |publisher= |accessdate=</nowiki>{{#time: F j, Y }}<nowiki>}}</nowiki></code>

=== Common forms with last1, first1; last2, first2 ===

The examples below will suffice for up to two authors each with first and last names; for more, just create more parameters in a similar style:

;YYYY-MM-DD: <code><nowiki>{{User:Cxw/Cite web trans |url= |title= |last1= |first1= |last2= |first2= |date= |work= |publisher= |accessdate=</nowiki>{{#time: Y-m-d }}<nowiki>}}</nowiki></code>

;Day Month Year: <code><nowiki>{{User:Cxw/Cite web trans |url= |title= |last1= |first1= |last2= |first2= |date= |work= |publisher= |accessdate=</nowiki>{{#time: j F Y }}<nowiki>}}</nowiki></code>

;Month Day, Year: <code><nowiki>{{User:Cxw/Cite web trans |url= |title= |last1= |first1= |last2= |first2= |date= |work= |publisher= |accessdate=</nowiki>{{#time: F j, Y }}<nowiki>}}</nowiki></code>

=== All parameters ===

When copying all parameters in either the vertical or horizontal layouts, delete those which are not needed.

;All parameters, horizontal layout: <code><nowiki>{{User:Cxw/Cite web trans |url= |title= |first= |last= |author= |authorlink= |coauthors= |date= |month= |year= |work= |publisher= |___location= |page= |pages= |at= |language= |trans_title= |format= |doi= |archiveurl= |archivedate= |accessdate= |quote= |ref= |separator= |postscript= }}</nowiki></code>

;All parameters, vertical layout:

<pre>

{{User:Cxw/Cite web trans

| url =

| title =

| first =

| last =

| author =

| authorlink =

| coauthors =

| date =

| month =

| year =

| work =

| publisher =

| ___location =

| page =

| pages =

| at =

| language =

| trans_title =

| format =

| doi =

| archiveurl =

| archivedate =

| accessdate =

| quote =

| ref =

| separator =

| postscript =

}}

</pre>

==== Required parameters ====

*'''url''': URL of online item. Start the url with the communications protocol, e.g. <nowiki>http://</nowiki>.

*'''title''': Title of online item. This title will appear as the citation itself, hyperlinked to the URL.

==== Optional parameters ====

* author parameters

** '''author

** '''last''' works with '''first''' to produce <code>last, first</code>

** '''authorlink''' works either with '''author''' or with '''last''' & '''first''' to link to the appropriate wikipedia article. Does not work with URLs.

** '''last1''', '''first1''', ..., '''last9''', '''first9''' and optionally '''authorlink1''', ..., '''authorlink9''' for specifying more authors (note: '''last1''', '''first1''' and '''authorlink1''' are synonyms for '''last''', '''first''' and '''authorlink''', so use ''either'' '''last1''' or '''last''', not both)

** '''coauthors''': alternate way of specifying additional authors

* a date parameter

** ''either'' '''date''': Full date of publication. Should not be wikilinked.

** ''or'' '''year''': Year of publication, and '''month''': Name of the month of publication. If you also have the day, use '''date''' instead. Should not be wikilinked.

*'''format''': Format, e.g. PDF. HTML implied if not specified.

*'''work''': If this item is part of a larger "work", such as a book, periodical or website, write the name of that work. Do not italicize; the software will do so automatically.

*'''publisher''': Publisher, if any—for example if the website is hosted by a government service, educational institution, or company. (The '''publisher''' is not usually the name of the website (that is usually the '''work''').

**'''___location''': Geographical place of publication.

* a page parameter

** ''either'' '''page''': Page number if a multi-page web article and referencing a single page. "page=5" produces ''p. 5.''

** ''or'' '''pages''': Page numbers if a multi-page web article and referencing more than one page. "pages=5–7" produces ''pp. 5–7''. This is for listing the pages relevant to the citation, not a total number of pages.<!-- Commented out: Not implemented in the template! This is especially useful for [[PDF]] format, where the page can be linked to with the <code>#page=''number''</code> anchor tagged on the end of the URL:

*:<code><nowiki>pages = [http://www.example.org/file.pdf#page=123 p. 123]</nowiki></code>-->

** ''or'' '''at''': When the page prefix is unwanted. "at=Table 5" produces ''Table 5''.

*'''language''': language of publication (don't specify "English" as this is the default).

**'''trans_title''': A translated title of the article, in case the original title is in a foreign language. Would normally be used in conjunction with the 'language' parameter.

* '''doi''': A [[digital object identifier]] for the document, such as ''<nowiki>10.1038/news070508-7</nowiki>''

**'''Doilabel''': If the doi contains some characters that must be [[Percent-encoding|escaped]], use "doilabel" for the unescaped version. See {{tl|doi}}: "id" is equivalent to "doi" and "label" is "doilabel"

* archive parameters ''(if used, must be used both of them together)''

** '''archiveurl''': The URL of an [[Web archiving|archived]] copy of the page, if (or in case) the url becomes unavailable. Typically used to refer to services like [[WebCite]] and [[Internet Archive|Archive.org]].

** '''archivedate''': Date when the item was archived. Should not be wikilinked.

*'''accessdate''': Full date when item was accessed. Should not be wikilinked.

*'''quote''': Relevant quote from online item.

*'''ref''': ID for anchor. By default, no anchor is generated. The ordinary nonempty value {{para|ref|<var>ID</var>}} generates an anchor with the given <code><var>ID</var></code>; such a linkable reference can be made the target of [[Wikipedia:Citing sources/Further considerations #Wikilinks to full references|wikilinks to full references]], especially useful in short citations like [[Wikipedia:Citing sources #Shortened footnotes|shortened notes]] and [[Wikipedia:Parenthetical referencing|parenthetical referencing]]. The special value {{para|ref|harv}} generates an anchor suitable for the {{tl|harv}} template; see ''[[Template:Citation/doc #Anchors for Harvard referencing templates|anchors for Harvard referencing templates]]''.

*'''separator''' / '''postscript''': The punctuation to use between fields / at the end of the citation

==== Duplicate periods ====

By default, {{tl|User:Cxw/Cite web trans}} separates some fields with periods, so don't encode those fields ending with a period or a duplicate period will be added. Example: "publisher=Camelot, Inc" will correctly show as <code>Camelot, Inc.</code> but "publisher=Camelot, Inc." will incorrectly show as <code>Camelot, Inc..</code>

== Examples ==

Line 383 ⟶ 277:

}}</span>

==See= alsoAll parameters ===

* [[User:Citation bot|Citation bot]]

When copying all parameters in either the vertical or horizontal layouts, delete those which are not needed.

* [[Wikipedia:Citation templates|Citation templates]]

* [[Wikipedia:Citing sources|Citing sources]]

;All parameters, horizontal layout: <code><nowiki>{{User:Cxw/Cite web trans |url= |title= |first= |last= |author= |authorlink= |coauthors= |date= |month= |year= |work= |publisher= |___location= |page= |pages= |at= |language= |trans_title= |format= |doi= |archiveurl= |archivedate= |accessdate= |quote= |ref= |separator= |postscript= }}</nowiki></code>

* [[Wikipedia:Citing sources/example style|Citing sources/example style]]

* [[WP:DOI|Digital Object Identifier]]

;All parameters, vertical layout:

* [[Template:Cite book]]

<pre>

* [[Template:Cite journal]]

{{User:Cxw/Cite web trans

* [[Zotero]]

| url =

| title =

| first =

| last =

| author =

| authorlink =

| coauthors =

| date =

| month =

| year =

| work =

| publisher =

| ___location =

| page =

| pages =

| at =

| language =

| trans_title =

| format =

| doi =

| archiveurl =

| archivedate =

| accessdate =

| quote =

| ref =

| separator =

| postscript =

}}

</pre>

<includeonly>