Template:Cite techreport/doc
This is a documentation subpage for Template:Cite techreport. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
{{Cite arXiv}} | arXiv preprints |
---|---|
{{Cite AV media}} | audio and visual media |
{{Cite AV media notes}} | AV media liner notes |
{{Cite bioRxiv}} | bioRxiv preprints |
{{Cite book}} | books and chapters |
{{Cite citeseerx}} | CiteSeerX papers |
{{Cite conference}} | conference papers |
{{Cite encyclopedia}} | edited collections |
{{Cite episode}} | radio or TV episodes |
{{Cite interview}} | interviews |
{{Cite journal}} | academic journals |
{{Cite magazine}} | magazines, periodicals |
{{Cite mailing list}} | public mailing lists |
{{Cite map}} | maps |
{{Cite news}} | news articles |
{{Cite newsgroup}} | online newsgroups |
{{Cite podcast}} | podcasts |
{{Cite press release}} | press releases |
{{Cite report}} | reports |
{{Cite serial}} | audio or video serials |
{{Cite sign}} | signs, plaques |
{{Cite speech}} | speeches |
{{Cite ssrn}} | SSRN papers |
{{Cite techreport}} | technical reports |
{{Cite thesis}} | theses |
{{Cite web}} | web sources not covered by the above |
See also | Specific-source templates Wrapper templates |
This Citation Style 1 template is used to create citations for .
Usage
Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Delete unused parameters to avoid clutter in the edit window. Some samples may include the current date. If the date is not current, then
the page.A short blank version:
{{cite techreport |first= |last= |author2= |title= |number= |institution= |date= |year= }}
Examples
{{cite techreport
|first=M.
|last=Ouyang
|author2=N. Johnson
|title=How good are branching rules in DPLL?
|number=96-38
|institution=DIMACS
|year=1996
}}
- Ouyang, M.; N. Johnson (1996). How good are branching rules in DPLL? (Technical report). DIMACS. 96-38.
Parameters
Syntax
Nested parameters rely on their parent parameters:
- parent
- OR: parent2—may be used instead of parent
- child—may be used with parent (and is ignored if parent is not used)
- OR: child2—may be used instead of child (and is ignored if parent2 is not used)
- Where aliases are listed, only one of the parameters may be defined; if aliased parameters are defined, then only one will show.
By default, sets of fields are terminated with a period (.); this can be an issue when the last field in an abbreviation or initial with a period, as two periods then display. The only solution is to not include the last period in the value for the set of fields.
COinS
This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata; see Wikipedia:COinS.
- Be careful using templates within the citation template, as many will add a lot of extraneous HTML or CSS that will be rendered in the meta-data.
- Known templates that should not be used: {{smallcaps}}.
Deprecated
These parameters are deprecated and will no longer work. Use will place the page in Category:Pages containing cite templates with deprecated parameters.
Use accessdate:
|
Use date:
|
No longer supported:
|
Description
Authors
- last: Surname of author. Do not wikilink—use authorlink instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use last to include the same format as the source. Aliases: last, author, authors, last1, author1
- first: Given or first names of author, including title(s); for example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use authorlink instead. Aliases: first, first1.
- OR: for multiple authors, use last1, first1 through last9, first9 for up to nine authors. By default, if nine authors are defined, then only eight will show and "et al." will show in place of the last author. Aliases: last1, author1 through last9, author9.
- authorlink: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: authorlink, authorlink1, author-link, author1-link.
- OR: for multiple authors, use authorlink1 through authorlink9. Aliases: authorlink1, author1-link through authorlink9, author9-link.
- others: To record other contributors to the work, such as "Illustrated by John Smith" or "Translated by John Smith."
- When using Shortened footnotes or parenthetical referencing
styles with templates, do not use multiple names in one field else the anchor will not match the inline link.
Title
- title: Title of source. Can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displays in quotes.
- trans_title: English translation of the title if the source cited is in a foreign language. Displays in square brackets after title; if url is defined, then trans_title is included in the link. Use of the language parameter is recommended.
- Titles containing certain characters will display and link incorrectly unless those characters are encoded.
newline | [ | ] | | |
---|---|---|---|
space | [ | ] | | |
- When the title you are citing contains quotations marks or apostrophes at the beginning, end or both, you can use
 
to place a separation between that punctuation and the quotation marks this template automatically provides around the title, to avoid a non-ideal display such as '''.
- For example instead of title='name' which will display on many browsers with the quotation marks surrounding it as '''name''', use |title= 'name' , which will display as " 'name' ".
- type: Provides additional information about the media type of the source; format in sentence case. Displays in parentheses following the title. Defaults to Technical report.
- language: The language the source is written in, if not English. Displays in parentheses with "in" before the language name. Use the full language name; do not use icons or templates.
Periodical
- work (required by
{{cite journal}}
and{{cite magazine}}
): Name of the work containing the source; may be wikilinked if relevant. Displays in italics. Aliases: journal, newspaper, magazine, periodical, website. Use Latin script. For languages written in non-Latin based scripts (Arabic, Chinese, Cyrillic, Greek, Hebrew, Indic, Japanese, Korean, etc.) use a standard Romanization in this field.- script-work: Work title in its original, non-Latin script; not italicized, follows italicized Romanization defined in work. Must be prefixed with an ISO 639-1 two-character code to help browsers properly display the script. Leave empty for Latin-based scripts (Czech, French, Turkish, Vietnamese, etc.). Aliases: script-journal, script-newspaper, script-magazine, script-periodical, script-website.
- trans-work: English translation of the work title if the source cited is in a foreign language. Displays in square brackets after work or script-work. Aliases: trans-journal, trans-newspaper, trans-magazine, trans-periodical, trans-website.
... |work=Zhōngguó piàofáng |script-work=zh:中国票房 |trans-work=China Box Office ...
- issue: When the publication is one of a series that is published periodically. Alias: number. When the issue has a special title of its own, this may be given, in italics, along with the issue number, e.g.
|issue=2, ''Modern Canadian Literature''
. Displayed in parentheses following volume. - department: Title of a regular department, column, or section within the periodical or journal. Examples include "Communication", "Editorial", "Letter to the Editor", and "Review". Displays after title and is in plain text.
- When set, work changes the formatting of other parameters in the same citation:
- title is not italicized and is enclosed in quotes.
- chapter does not display (and will produce an error message).
Date
- date: Full date of source being referenced in the same format as other publication dates in the citations.[1] Do not wikilink. Displays after the authors and enclosed in parentheses. If there is no author, then displays after publisher.
- OR: year: Year of source being referenced.
- month: Name of the month of publication. If you also have the day, use date instead; do not wikilink.
- origyear: Original publication year; displays after the date or year. For clarity, please supply specifics; example:
|origyear=First published 1859
or|origyear=Composed 1904
.
- ↑ Publication dates in article references should all have the same format. See MOS:DATEUNIFY.
Publisher
- publisher: Name of publisher; may be wikilinked if relevant. Not normally included for periodicals. Corporate designations such as "Ltd", "Inc" or "GmbH" are not usually included. Displays after title; if work is defined, then publisher and location are enclosed in parentheses.
- location: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the location; examples: The Boston Globe, The Times of India. Displays preceding publisher.
- publication-date: Date of publication when different from the date the work was written. Displays only if year or date are defined and only if different, else publication-date is used and displayed as date. Use the same format as other dates in the article; do not wikilink. Follows publisher; if work is not defined, then publication-date is preceded by "published" and enclosed in parenthesis.
Edition, series, volume
- edition: When the publication has more than one edition; for example: "2nd", "Revised" etc. Displays " ed." after this field, so
|edition=2nd
produces "2nd ed." Does not display if a periodical field is defined.
- series or version: When the source is part of a series, such as a book series or a journal where the issue numbering has restarted.
- volume: For one publication published in several volumes. Displays in bold after the title and series fields; if bolding is not desired, then include the volume information in the title field.
In-source locations
- page: Page in the source that supports the content. Displays preceded with
<syntaxhighlight lang="text" enclose="none">p.</syntaxhighlight>
unless|nopp=y
. - OR: pages: Pages in the source that supports the content; separate page ranges with an en dash (–); separate non-sequential pages with a comma (,); do not use to indicate the total number of pages in the source. Displays preceded with
<syntaxhighlight lang="text" enclose="none">pp.</syntaxhighlight>
unless|nopp=y
.- nopp: Set to y to suppress the
<syntaxhighlight lang="text" enclose="none">p.</syntaxhighlight>
or<syntaxhighlight lang="text" enclose="none">pp.</syntaxhighlight>
notations where this is inappropriate; for example, where|page=Front cover
.
- nopp: Set to y to suppress the
- OR: at: For sources where a page number is inappropriate or insufficient. Overridden by
|page=
or|pages=
.
- Examples: page (p.) or pages (pp.); section (sec.), column (col.), paragraph (para.); track; hours, minutes and seconds; act, scene, canto, book, part, folio, stanza, back cover, liner notes, indicia, colophon, dust jacket, verse.
URL
- url: URL of an online location where the text of the publication can be found. Cannot be used if title is wikilinked. If applicable, the link may point to the specific page(s) referenced. Do not link to any commercial booksellers, such as Amazon.com. See: WP:PAGELINKS.
- accessdate: Full date when original URL was accessed; use the same format as other access and archive dates in the citations.[1] Do not wikilink. Not required for web pages or linked documents that do not change; mainly for use of web pages that change frequently or have no publication date. Can be hidden or styled by registered editors.
- archiveurl: The URL of an archived copy of a web page, if or in case the url becomes unavailable. Typically used to refer to services like WebCite (see: Wikipedia:Using WebCite) and Internet Archive (see: Wikipedia:Using the Wayback Machine); requires archivedate.
- archivedate: Date when the original URL was archived; preceded by default text "archived from the original on". Use the same format as other access and archive dates in the citations.[1] Do not wikilink.
- deadurl: When the URL is still live, but preemptively archived, then set
|deadurl=no
. This changes the display order with the title retaining the original link and the archive linked at the end.
- template doc demo: The archive parameters will be error checked to ensure that all the required parameters are included, or else {{citation error}} is invoked. With errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set
|template doc demo=true
to disable categorization; mainly used for documentation where the error is demonstrated.
- format: Format of the work referred to by url; for example: PDF, DOC, or XLS; displayed in parentheses after title. HTML is implied and should not be specified. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add format information for the visually impaired.
- URLs must begin with a supported URI scheme.
http://
andhttps://
will be supported by all browsers; however,ftp://
,gopher://
,irc://
,ircs://
,mailto:
andnews:
will require a plug-in or an external application and should normally be avoided. IPv6 host-names are currently not supported. - If URLs in citation template parameters contain certain characters, then they will not display and link correctly. Those characters need to be percent-encoded. For example, a space must be replaced by
%20
. To encode the URL, replace the following characters with:
sp | " | ' | < | > | [ | ] | | | } |
---|---|---|---|---|---|---|---|---|
%20 | %22 | %27 | %3c | %3e | %5b | %5d | %7c | %7d |
- Single apostrophes do not need to be encoded; however, unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; however, an unencoded pair will be parsed as the double closing braces for the template transclusion.
- ↑ 1.0 1.1 Accessdate and archivedate in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD. See: MOS:DATEUNIFY.
Anchor
- ref: ID for anchor. By default, no anchor is generated. The ordinary nonempty value
|ref=ID
generates an anchor with the given ID; such a linkable reference can be made the target of wikilinks to full references, especially useful in short citations like shortened notes and parenthetical referencing. The special value|ref=harv
generates an anchor suitable for the {{harv}} template. See: Anchors for Harvard referencing templates.
Identifiers
- id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use a template as applicable.
These identifiers create links and are designed to accept a single value. Using multiple values or other text will break the link and/or invalidate the identifier.
- arxiv: arXiv identifier; for example:
arxiv=hep-th/9205027
- asin: Amazon Standard Identification Number
- asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values:
ca
,cn
,co.jp
,co.uk
,de
,es
,fr
,it
- asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values:
- bibcode: Bibcode; used by a number of astronomical data systems; for example:
1974AJ.....79..819H
- doi: Digital object identifier; for example:
10.1038/news070508-7
. Checked to ensure it begins with (<syntaxhighlight lang="text" enclose="none">10.</syntaxhighlight>
).- doi_brokendate: Date the DOI is broken; use the same format as other dates in the article.
- isbn: International Standard Book Number; for example:
978-0-8126-9593-9
. (See: Wikipedia:ISBN and ISBN). Dashes in the ISBN are optional, but preferred. Use the 13-digit ISBN wherever possible; this can normally be found beneath the barcode as a number beginning with 978 or 979 (barcodes beginning with any other numbers are not ISBNs). For sources with the older 9 digit SBN system, prefix the number with a zero; thus, SBN 902888-45-5 should be entered as|isbn=0-902888-45-5
. Checked for length, invalid characters and the proper check digit. - issn: International Standard Serial Number; eight characters may be split into two groups of four using a hyphen, but not an en dash or a space.
- jfm: Jahrbuch über die Fortschritte der Mathematik
- jstor: JSTOR abstract; for example: "
jstor=3793107
" will generate JSTOR 3793107. - lccn: Library of Congress Control Number
- mr: Mathematical Reviews
- oclc: OCLC
- ol: Open Library
- osti: Office of Scientific and Technical Information
- pmc: PubMed Central; use article number for full-text free repository of a journal article.
- pmid: PubMed; use unique identifier.
- rfc: Request for Comments
- ssrn: Social Science Research Network
- zbl: Zentralblatt MATH
Quote
- quote: Relevant text quoted from the source. Displays enclosed in quotes. When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation.
Editors
- editor-last: Surname of editor. Do not wikilink—use editor-link instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use editor-last to include the same format as the source. Aliases: editor1-last, editor, editors.
- editor-first: Given or first names of editor, including title(s); example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use editor-link instead. Aliases: editor1-first.
- OR: for multiple editors, use editor1-last, editor1-first through editor4-last, editor4-first for up to four editors.
- editor-link: Title of existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases: editor1-link.
- OR: for multiple editors, use editor1-link through editor4-link.
- Display:
- If authors: Authors are first, followed by the editors and the included work, then the main work.
- If no authors: Editors appear before the included work; a single editor is followed by "ed."; multiple editors are followed by "eds."; more than three editors will be followed by "et al., eds."
Laysummary
- laysummary: URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary".
- laysource: Name of the source of the laysummary. Displays in italics and preceded by an endash.
- laydate: Date of the summary. Displays in parentheses.
Display options
- postscript: The closing punctuation for the citation; defaults to a period (
.
); if the parameter is present, but blank, no terminating punctuation will be used. Ignored if quote is defined. - separator: The punctuation used to separate lists of authors, editors, etc. Defaults to a period (
.
); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as 
do not use an asterisk (*
), colon (:
) or hash (#
) as they will be interpreted as wikimarkup.
This template produces COinS metadata; see COinS in Wikipedia for background information.