Template:Cite newsgroup/doc

Jump to navigation Jump to search
Citation Style 1 templates
{{Cite arXiv}}arXiv preprints
{{Cite AV media}}audio and visual
{{Cite AV media notes}}audio and visual liner notes
{{Cite bioRxiv}}bioRxiv preprints
{{Cite book}}books
{{Cite conference}}conference papers
{{Cite encyclopedia}}edited collections
{{Cite episode}}radio or television episodes
{{Cite interview}}interviews
{{Cite journal}}academic journals and papers
{{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}}articles with SSRN identifiers
{{Cite techreport}}technical reports
{{Cite thesis}}theses
{{Cite web}}web sources not covered by the above
See also:

This Citation Style 1 template is used to create citations for online newsgroups.

Usage[edit source]

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 purge the page.

Horizontal format

  • {{cite newsgroup |title= |author= |date= |newsgroup= |message-id= |url= |access-date=December 27, 2024}}

Vertical format 

{{cite newsgroup
 | title =
 | author =
 | date =
 | newsgroup =
 | message-id =
 | url =
 | access-date = 27 December, 2024
 }}

Examples[edit source]

{{cite newsgroup | author = Tanenbaum, A. S. | title = LINUX is obsolete | date = January 29, 1992 | newsgroup = comp.os.minix | message-id = 12595@star.cs.vu.nl | quote = I am not unhappy with LINUX }}

{{cite newsgroup | author = A. S. Tanenbaum | title = LINUX is obsolete | date = January 29, 1992 | newsgroup = comp.os.minix | message-id = 12595@star.cs.vu.nl | url = http://groups.google.com/group/comp.os.minix/browse_thread/thread/c25870d7a41696d2/f447530d082cd95d?tvc=2 | access-date = November 27, 2006 }}

Parameters[edit source]

Syntax[edit source]

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 multiple aliased parameters are defined, then only one will show.

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata. See Starfleet Logistics:COinS. As a general rule, only one data item per parameter. Do not include explanatory or alternate text:

  • Use |date=27 September 2007 not |date=27 September 2007 (print version 25 September)

Use of templates within the citation template is discouraged because many of these templates will add extraneous HTML or CSS that will be included raw in the metadata. Also, HTML entities, for example  , –, etc, should not be used in parameters that contribute to the metadata. Do not include Wiki markup '' (italic font) or ''' (bold font) because these markup characters will contaminate the metadata.

COinS metadata is created for these parameters[edit source]

  • |periodical=, |journal=, |newspaper=, |magazine=, |work=, |website=, |encyclopedia=, |encyclopaedia=, |dictionary=
  • |chapter=, |contribution=, |entry=, |article=, |section=
  • |title=
  • |publication-place=, |publicationplace=, |place=, |location=
  • |date=, |year=, |publication-date=, |publicationdate=
  • |series=, |version=
  • |volume=
  • |issue=, |number=
  • |page=, |pages=, |at=
  • |edition=
  • |publisher=, |distributor=, |institution=
  • |url=
  • |chapter-url=, |chapterurl=, |contribution-url=, |contributionurl=, |section-url=, |sectionurl=
  • |author#=, |author-last#=, |author#-last=, |last#=, |surname#=
  • |author-first#=, |author#-first=, |first#=, |given#=
  • any of the named identifiers (|isbn=, |issn=, |doi=, |pmc=, etc)

By default, sets of fields are terminated with a period (.).

Deprecated[edit source]

{{#lst:Help:CS1 errors|deprecated_params_table }}

Description[edit source]

Authors[edit source]

  • last: Surname of a single author. Do not wikilink—use author-link instead. For corporate authors or authors for whom only one name is listed by the source, use last or one of its aliases (e.g. |author=Bono). Aliases: surname, author, last1, surname1, author1.
    • author: this parameter is used to hold the complete name of a single author (first and last) or to hold the name of a corporate author. This parameter should never hold the names of more than one author.
    • first: Given or first names of author; for example: Firstname Middlename or Firstname M. or Firstname M., Sr. Do not wikilink—use author-link instead. Aliases: given, first1, given1. Requires last; first name will not display if last is empty.
    • OR: for multiple authors, use last1, first1 through lastn, firstn, where n is any consecutive number for an unlimited number of authors (each firstn requires a corresponding lastn). See the display parameters to change how many authors are displayed. Aliases: surname1, given1 through surnamen, givenn, or author1 through authorn. For an individual author plus an institutional author, you can use |first1=...|last1=...|author2=....
    • author-link: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: author-link1, authorlink, authorlink1, author1-link, author1link.
    • OR: for multiple authors, use author-link1 through author-linkn. Aliases: authorlink1 through authorlinkn, or author1-link through authorn-link, or author1link through authornlink.
    • name-list-format: displays authors and editors in Vancouver style when set to vanc and when the list uses last/first parameters for the name list(s).
  • vauthors: comma-separated list of author names in Vancouver style; enclose corporate or institutional author names in doubled parentheses:
    |vauthors=Smythe JB, ((Megabux Corp.))
    • author-link and author-mask may be used for the individual names in |vauthors= as described above
  • authors: Free-form list of author names; use of this parameter is discouraged because it does not contribute to a citation's metadata; not an alias of last.
  • translator-last: Surname of translator. Do not wikilink—use translator-link instead. Aliases: translator-surname, translator1, translator1-last, translator-last1.
    • translator-first: Given or first names of translator. Do not wikilink—use translator-link instead. Aliases: translator-given, translator1-first, translator-first1.
    • OR: for multiple translators, use translator-last1, translator-first1 through translator-lastn, translator-firstn, where n is any consecutive number for an unlimited number of translators (each translator-firstn requires a corresponding translator-lastn). Aliases: translator1-last, translator1-first through translatorn-last, translatorn-first, or translator1 through translatorn.
    • translator-link: Title of existing Wikipedia article about the translator—not the translator's website; do not wikilink. Aliases: translator-link1, translator1-link.
    • OR: for multiple translators, use translator-link1 through translator-linkn. Aliases: translator1-link through translatorn-link.
  • collaboration: Name of a group of authors or collaborators; requires author, last, or vauthors listing one or more primary authors; follows author name-list; appends "et al." to author name-list.
  • Note: When using shortened footnotes or parenthetical referencing styles with templates, do not use multiple names in one field, or else the anchor will not match the inline link.

Title[edit source]

(See also Help:Citation Style 1 §Titles and chapters.)

  • title: Title of source. Can be wikilinked to an existing Starfleet Logistics article or url may be used to add an external link, but not both. Displays in italics. If script-title is defined, title holds a Romanization of title in script-title.
    • script-title: Original title for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc); not italicized, follows italicized Romanization defined in title. May be prefixed with an ISO 639-1 two-character code to help browsers properly display the script:
      ... |title=Tōkyō tawā |script-title=ja:東京タワー |trans-title=Tokyo Tower ...
    • 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 not display and link correctly unless those characters are encoded.
newline [ ] |
space [ ] {{!}} (preferred)
{{bracket|text}} | or {{pipe}} – see also Help:Table § Rendering the pipe
  • title-link: Title of existing Starfleet Logistics article about the source named in title – do not use a web address; do not wikilink. Alias: titlelink.
  • newsgroup: Name of newsgroup; a link is automatically created; do not wikilink.
  • type: Provides additional information about the media type of the source. May alternatively be used to identify the type of manuscript linked to in the title, if this is not the final version of a manuscript (e.g. if a preprint of a manuscript is freely available, but the version of record is behind a paywall). Format in sentence case. Displays in parentheses following the title. Examples: Thesis, Booklet, Accepted manuscript, CD liner, Press release. Alias: medium.
  • language: The language in which the source is written. Displays in parentheses with "in" before the language name or names. Use the full language name or the proper language code (list of supported codes / names). When the source uses more than one language, list them individually, separated by commas, e.g. |language=French, German or |language=fr, de. The use of language names or language codes recognized by Wikimedia adds the page to the appropriate subcategory of Category:CS1 foreign language sources. Do not use templates or wikilinks. When the language is "English" (or "en"), no language is displayed in the citation. When two or more languages are listed, do not include "and" before the last language ("and" is inserted automatically by the template). Aliases: lang

Date[edit source]

  • date: Date of source being referenced. Can be full date (day, month, and year) or partial date (month and year, season and year, or year). Use same format as other publication dates in the citations.[date 1] Required when year is used to disambiguate {{sfn}} links to multiple-work citations by the same author in the same year.[more] Do not wikilink. Displays after the authors and is enclosed in parentheses. If there is no author, then displays after publisher. For acceptable date formats, see Help:Citation Style 1 § Dates.
For approximate year, precede with "c. ", like this: |date=c. 1900.

For no date, or "undated", use |date=n.d.
  • year: Year of source being referenced. Use of |date= is recommended unless all of the following conditions are met:
    1. The |date= format is YYYY-MM-DD.
    2. The citation requires a CITEREF disambiguator.
    3. The template uses |ref=harv or |mode=cs2, or the template is {{citation}}.
  • orig-year: Original publication year; displays in square brackets after the date (or year). For clarity, please supply specifics. For example: |orig-year=First published 1859 or |orig-year=Composed 1904. Alias: origyear
  • df: date format; sets rendered dates to the specified format; does not support date ranges or seasonal dates. Accepts one value which may be one of these:
    dmy – set publication dates to day month year format; access- and archive-dates are not modified;
    mdy – as above for month day, year format
    ymd – as above for year initial numeric format YYYY-MM-DD
    dmy-all – set publication, access-, and archive-dates to day month year format;
    mdy-all – as above for month day, year format
    ymd-all – as above for year initial numeric format YYYY-MM-DD
  1. ^ Publication dates in references within an article should all have the same format. This may be a different format from that used for archive and access dates. See MOS:DATEUNIFY.

Series, volume[edit source]

  • 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 after the title and series fields; volume numbers should be entered just as a numeral (e.g. 37); volume values that are wholly digits, wholly uppercase roman numerals, or less than five characters will appear in bold. Any non-numeric value of five or more characters will be presumed to follow some other convention and will not appear in bold.

URL[edit source]

  • url: URL of an online location where the text of the publication named by title can be found. Cannot be used if title is wikilinked. If applicable, the link may point to the specific page(s) referenced. Remove tracking parameters from URLs, e.g. #ixzz2rBr3aO94 or ?utm_source=google&utm_medium=...&utm_term=...&utm_campaign=.... For linking to pages in PDF files or in Google Books, see SF:PAGELINKS. Do not link to any commercial booksellers, such as Amazon.com; use |ISBN= or |OCLC= to provide neutral search links for books. Invalid URLs, including those containing spaces, will result in an error message.
    • access-date: Full date when the content pointed to by url was last verified to support the text in the article; do not wikilink; requires url; use the same format as other access and archive dates in the citations.[date 1] Not required for linked documents that do not change. For example, access-date is required for online sources, such as personal websites, that do not have a publication date; see SF:CITEWEB. Access dates are not required for links to published research papers, published books, or news articles with publication dates. Note that access-date is the date that the URL was found to be working and to support the text being cited. Can be hidden or styled by registered editors. Alias: accessdate.
    • archive-url: The URL of an archived snapshot of a web page. Typically used to refer to services such as Internet Archive (see Starfleet Logistics:Using the Wayback Machine), WebCite (see Starfleet Logistics:Using WebCite) and archive.is (see Starfleet Logistics:Using archive.is); requires archive-date and url. By default (overridden by |url-status=live, or the equivalent |dead-url=no, deprecated but still used in many articles) the archived link is displayed first, with the original link at the end. Alias: archiveurl.
      • archive-date: Archive-service snapshot-date; preceded in display by default text "archived from the original on". Use the same format as other access and archive dates in the citations. This does not necessarily have to be the same format that was used for citing publication dates.[date 1] Do not wikilink; templated dates are discouraged. Alias: archivedate.
      • url-status: this optional parameter is ignored if archive-url is not set. If omitted, or with null value, the default value is |url-status=dead. When the URL is still live, but pre-emptively archived, then set |url-status=live; this changes the display order, with the title retaining the original link and the archive linked at the end. When the original URL has been usurped for the purposes of spam, advertising, or is otherwise unsuitable, setting |url-status=unfit or |url-status=usurped suppresses display of the original URL (but |url= and |archive-url= are still required).
      • dead-url (deprecated; replaced by url-status above): Functionality is identical to that of |url-status=: |dead-url=yes or null is the same as |url-status=dead; |dead-url=no is the same as |url-status=live; similarly for |dead-url=usurped or |dead-url=unfit. Global replacement of, for example, |dead-url=no with |url-status=live in CS1 and CS2 templates is safe (but be careful with null value "|dead-url=").
    • 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 one of the subcategories of Category:Articles with incorrect citation syntax. Set |template-doc-demo=true to disable categorization; mainly used for documentation where the error is demonstrated. Alias: no-cat.
  • format: Format of the work referred to by url; for example: PDF, DOC, or XLS; displayed in parentheses after title. (For media format, use type.) HTML is implied and should not be specified. Automatically added when a PDF icon is displayed. 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:// and https:// will be supported by all browsers; however, ftp://, gopher://, irc://, ircs://, mailto: and news: may 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 %7b %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. ^ a b Access-date and archive-date in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD. See MOS:DATEUNIFY.

Additional note: (deprecated; use url) use of googleid= with the Google style id of a posting will automatically generate an appropriate URL. (The Google style-id can be determined by clicking 'Show Original' in the Groups UI. The Google Style id is the number between the "/msg/" and "?dmode=" portions of the URL used to show the original.)

Anchor[edit source]

Identifiers[edit source]

  • message-id: the newsgroup's message identifier; the value in the message header between angle-brackets < and >; do not include the angle-brackets in |message-id=; must include @.
  • id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use a template as applicable. For example, |id=NCJ 122967 will append "NCJ 122967" at the end of the citation. You can use templates such as |id={{NCJ|122967}} to append NCJ 122967 instead.

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. In general, the parameters should include only the variable part of the identifier, e.g. rfc=822 or pmc=345678.

When an URL is equivalent to the link produced by the corresponding identifier (such as a DOI), don't add it to any URL parameter but use the appropriate identifier parameter, which is more stable and may allow to specify the access status. The |url= parameter or title link can then be used for its prime purpose of providing a convenience link to an open access copy which would not otherwise be obviously accessible.

  • arxiv: arXiv identifier; for example: arxiv=hep-th/9205027 (before April 2007) or arxiv=0706.0001 (April 2007 – December 2014) or arxiv=1501.00001 (since January 2015). Do not include extraneous file extensions like ".pdf" or ".html".
  • asin: Amazon Standard Identification Number; if first character of asin value is a digit, use isbn. Because this link favours one specific distributor, include it only if standard identifiers are not available. Example asin=B00005N5PF
    • asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values: au, br, ca, cn, co.jp, co.uk, de, es, fr, it, mx
  • bibcode: Bibcode; used by a number of astronomical data systems; for example: 1974AJ.....79..819H. Comment: Techies are aware of the 2019 switch from old to new ADS URLs: the old URLs should continue working after October 2019 even though deprecated; see the April/May 2019 and June 2019 discussions.
  • biorxiv: bioRxiv id, a 6-digit number at the end of the biorXiv URL (e.g. 078733 for http://biorxiv.org/content/early/2016/10/01/078733 or https://dx.doi.org/10.1101/078733)
  • citeseerx: CiteSeerX id, a string of digits and dots found in a CiteSeerX URL (e.g. 10.1.1.176.341 for http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.176.341 )
  • doi: Digital object identifier; for example: 10.1038/news070508-7. It is checked to ensure it begins with (10.).
    • doi-broken-date: Date the DOI was found to be non-working at https://dx.doi.org. Use the same format as other dates in the article. Alias: doi-inactive-date
  • eissn: International Standard Serial Number for the electronic media of a serial publication; eight characters may be split into two groups of four using a hyphen, but not an en dash or a space; example eissn=1557-2986 Alias: EISSN
  • hdl: Handle System identifier for digital objects and other resources on the Internet; example hdl=20.1000/100 Alias: HDL
  • isbn: International Standard Book Number; for example: 978-0-8126-9593-9. (See Starfleet Logistics:ISBN and ISBN § Overview.) Hyphens in the ISBN are optional, but preferred. Use the ISBN actually printed on or in the book. Use the 13-digit ISBN – beginning with 978 or 979 – when it is available. If only a 10-digit ISBN is printed on or in the book, use it. ISBNs can be found on the page with the publisher's information – usually the back of the title page – or 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. Do not convert a 10-digit ISBN to 13-digit by just adding the 978 prefix; the last digit is a calculated check digit and just making changes to the numbers will make the ISBN invalid. This parameter should hold only the ISBN without any additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens, with "X" permitted as the last character in a 10-digit ISBN – and the proper check digit. Alias: ISBN
  • ismn: International Standard Music Number; for example: 979-0-9016791-7-7. Hyphens or spaces in the ISMN are optional. Use the ISMN actually printed on or in the work. This parameter should hold only the ISMN without any additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens – and the proper check digit. Alias: ISMN
  • 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; example issn=2049-3630 Alias: ISSN
  • jfm: Jahrbuch über die Fortschritte der Mathematik; example jfm=53.0144.01
  • jstor: JSTOR reference number; for example: jstor=3793107 will generate JSTOR 3793107.
  • lccn: Library of Congress Control Number. When present, alphabetic prefix characters are to be lower case; example lccn=2004042477
  • mr: Mathematical Reviews; example mr=630583
  • oclc: OCLC; WorldCat's Online Computer Library Center; example oclc=9355469
  • ol: Open Library identifier; do not include "OL" in the value; example ol=7030731M
  • osti: Office of Scientific and Technical Information; example osti=4367507
  • pmc: PubMed Central; use article number for open repository full-text of a journal article, e.g. pmc=345678. Do not include "PMC" in the value. See also the pmid parameter, below; these are two different identifiers.
    • embargo: Date that pmc goes live; if this date is in the future, then pmc is not linked until that date.
  • pmid: PubMed; use unique identifier; example pmid=17322060 See also the pmc parameter, above; these are two different identifiers.
  • rfc: Request for Comments; example rfc=3143
  • ssrn: Social Science Research Network; example ssrn=1900856
  • zbl: Zentralblatt MATH; example zbl=0472.53010 For zbMATH search results like JFM 35.0387.02 use jfm=35.0387.02

Quote[edit source]

  • 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 must include terminating punctuation.

Laysummary[edit source]

  • lay-url: URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary". Aliases: lay-summary (deprecated), laysummary (deprecated).
    • lay-source: Name of the source of the laysummary. Displays in italics and preceded by an endash. Alias: laysource.
    • lay-date: Date of the summary. Displays in parentheses. Alias: laydate.

Display options[edit source]

  • mode: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For |mode=cs1, element separator and terminal punctuation is a period (.); where appropriate, initial letters of certain words are capitalized ('Retrieved...'). For |mode=cs2, element separator is a comma (,); terminal punctuation is omitted; where appropriate, initial letters of certain words are not capitalized ('retrieved...'). To override default terminal punctuation use postscript.
  • author-mask: Replaces the name of the first author with em dashes or text. Set author-mask to a numeric value n to set the dash n em spaces wide; set author-mask to a text value to display the text without a trailing author separator; for example, "with". You must still include the values for all authors for metadata purposes. Primarily intended for use with bibliographies or bibliography styles where multiple works by a single author are listed sequentially such as shortened footnotes. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control of the order in which references are displayed. You can also use editor-mask and translator-mask in the same way. Mask parameters can take a number in the name of the parameter (e.g. |authorn-mask=) to specify which author the mask should apply to.
  • display-authors: Controls the number of author names that are displayed when a citation is published. To change the displayed number of authors, set display-authors to the desired number. For example, |display-authors=2 will display only the first two authors in a citation. By default, all authors are displayed. |display-authors=etal displays all authors in the list followed by et al. Aliases: displayauthors.
  • display-editors: Controls the number of editor names that are displayed when a citation is published. To change the displayed number of editors, set display-editors to the desired number. For example, |display-editors=2 will display only the first two editors in a citation. By default, all editors are displayed. |display-editors=etal displays all editors in the list followed by et al. Aliases: displayeditors.
  • last-author-amp: Switches the separator between the last two names of the author list to space ampersand space ( & ) when set to y, yes, or true. Example: |last-author-amp=yes
  • postscript: Controls the closing punctuation for a citation; defaults to a period (.); for no terminating punctuation, specify |postscript=none – leaving |postscript= empty is the same as omitting it, but is ambiguous. Additional text or templates beyond the terminating punctuation may generate an error message. |postscript= is ignored if quote is defined.

Link icons[edit source]

Link icons are not created by this template, but by CSS; see Help:External link icons.

See also[edit source]

External links[edit source]

 

This template produces COinS metadata; see COinS for background information.


Retrieved from "https://starfleetlogistics.shoutwiki.com/w/index.php?title=Template:Cite_newsgroup/doc&oldid=4060"