Jump to content

User:Jpacobb/Silrbib/doc

From Wikipedia, the free encyclopedia

This is the bibliographical template of the {{User:Jpacobb/Silr}} family corresponding to the {{citation}} and the various {{cite ....}} templates except the citation of patents. {{User:Jpacobb/Silrbib/core}} was intended to be compatible with {{citation/core}}, but the reprogramming of this in Lua means that this is no longer practicable. Even so, for the sake of convenience, many parameters used in those templates should work. A list of those that have been discontinued can be found here. {{User:Jpacobb/Silrbib}} generates a link based on the author last-names and the suffix used in-line. The displayed text shows the year of publication after the name of the publisher.

Simple syntax (unnamed parameters)

[edit]

This is intended to simplify the input of data in the majority case of a single author. The order is as intuitive as possible: what the author(s) wrote is named in third place. If it is an article included in a larger work, the main title is placed near the end of the list and its presence means the earlier title is taken as being that of an article.

{{User:Jpacobb/Silrbib|author-last-name|author-first-name|Name of article/work†| place|publisher|year|editor(s)| if different, name of major work†|suffix}}

† see below Care must be taken to supply blank parameters for any missing value or to use named variables after the omission, chiefly place ed(itor)(s) and suf(fix).

Basic syntax with named parameters

[edit]

Many parameters are the same as in the cite/citation families and there is a list below of those considered unnecessary.

{{User:Jpacobb/Silrbib|last=...|first=...|Name of article/work=...†|place=...|pub(lisher)=...|year=... |ed(itor)(s)|major work (if different)=...†|suffix}}

† see below

last = Last-name of Author1
first = First-name(s) of Author1
lastX = Last-name of Author2
firstX = First-name(s) of Author2
where X runs from 2 to 4
title/work = title of book/encyclopedia
[nb title is nearly always that of the complete work, use art or contribution for the sub-unit.† see below]
suf(fix) = suffix additional identifier as in {{User:Jpacobb/Silr}}
place/location = place of publication
pub(lisher) = name of publisher
year = year of publication
edition = additional information about title/work
url = web site reference
accessdate = date url accessed

If article in collection of any type sort including newspapers or periodicals:

art/article = name of article (author-names are referred to this)
ed/eds/editor/editors = name(s) of editor(s) of book, encyclopaedia etc. as a formatted text or full syntax editorx type

Title, article etc.

[edit]

The fact that there is no standard terminology in Wikipedia for the case of an article/essay or the like included in a dictionary, encyclopaedia or collaborative production complicates the syntax here. (In different templates, "chapter", "contribution", "article", "title" are used for the included item, and "work", "encyclopedia" and "title" for the name of the major one.) If using named parameters, it is simplest to use art(icle) for the included item and work for the major one. If title is supplied it is ignored unless either of these parameters is missing, in which case it replaces it.

Examples

[edit]

These are found on a specific examples page

Parameters: full listing

[edit]

Note: {{User:Jpacobb/Silrbib}} correctly interpret some other parameters, such as surname and given, which are retained to facilitate conversion. During development some parameters have been left pending. When relevant, they should be included in any use of the template even though they do not appear on screen for the moment.

Authors, editors etc.

[edit]
author = depreciated
last = author last name
first = author first name
author2 = depreciated
last2 = ...3 & ...4 also available
first2 = ...3 & ...4 also available
author-link =
author2-link = ...3 & ...4 also available
coauthors = depreciated
editor =
editor-last =
editor-first =
editor2 = ...3 & ...4 also available
editor2-last = ...3 & ...4 also available
editor2-first = ...3 & ...4 also available
editor-link =
editor2-link = ...3 & ...4 also available
others = illustrator, translator or similar contributor specify role

Publishing details

[edit]
title = usually title of book or work as a whole if work is used, interpreted as art(icle) if this is empty
art(icle) = title of sub-unit of work
work = title of work as whole preempts title, which may then be taken as art(icle)
chapter = title of sub-unit of work depreciated, use art(icle)
chapter-url =url for sub-unit of work depreciated, use art-url
contribution = title of sub-unit of work depreciated, use art(icle)
contribution-url = depreciated, use art-url
page = discontinued, use at
pages = discontinued, use at
at = page or other indication of location displays exactly as set, not normally needed([n 1])
publisher = name of publisher Omit C°, Ltd, Inc etc.
publication-place = depreciated
place/location = place of publication of work cited
language = pending:use complete word for language e.g. "French"
publication-date = depreciated, use date or year for publication cited and origyear for original
date = must contain day, month and year in a standard format do not use month or year with this
year = year of publication of work cited
month = month of publication, optional but use only with year
origyear = date when original was written produces original dated: XXXX
type = e.g.Thesis, Booklet, CD liner, Press release.
journal = name of publication as a whole pending
periodical = name of publication as a whole pending
newspaper = name of publication as a whole pending
magazine = name of publication as a whole pending
work = name of publication as a whole
edition = details such as Volume, Series, Number etc. prints as set after title exactly as set
series = pending, use edition
volume = pending, use edition
issue = pending, use edition
url = URL where text of publication can be found do not link to Amazon etc.
accessdate = date when URL was accessed the various depreciated alternatives do not work
archiveurl = URL of archived copy at a holding site such as WebCite
archivedate = use YYYY-MM-DD for date of storage may well be a required field to find file later
ref = defaults to SILR type = harv produces a harvard type ref

Identifiers

[edit]

The full range of identifiers is handled. The most commonly used is isbn= ....

Identifiers accepted by {{User:Jpacobb/Silrbib}}
  • id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use an external link 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.

The following 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.

  • 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". Aliases: eprint.
  • 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. Aliases: ASIN.
    • asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values: ae, au, br, ca, cn, de, es, fr, in, it, jp, mx, nl, pl, sa, se, sg, tr, uk. Aliases: none.
  • bibcode: bibcode; used by a number of astronomical data systems; for example: 1974AJ.....79..819H. Aliases: none.
  • biorxiv: bioRxiv id, as in the entire DOI (e.g. 10.1101/078733 for http://biorxiv.org/content/early/2016/10/01/078733 or https://doi.org/10.1101/078733; 10.1101/2020.07.24.220400 for https://doi.org/10.1101/2020.07.24.220400). Aliases: none.
  • citeseerx: CiteSeerX id, a string of digits and dots found in a CiteSeerX URL (e.g. 10.1.1.176.341 for https://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.176.341). Aliases: none.
  • doi: Digital object identifier; for example: 10.1038/news070508-7. It is checked to ensure it begins with (10.). Aliases: DOI.
    • Supports accept-this-as-written markup to indicate valid DOIs using a non-standard format, see below.
    • doi-broken-date: Date a valid DOI was found to be non-working/inactive at https://doi.org. Use the same format as other dates in the article. Aliases: none.
  • 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. Aliases: EISSN.
    • Supports accept-this-as-written markup to indicate valid eISSNs using a non-standard format, see below.
  • hdl: Handle System identifier for digital objects and other resources on the Internet; example |hdl=20.1000/100. Aliases: HDL.
  • isbn: International Standard Book Number; for example: 978-0-8126-9593-9. (See Wikipedia: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, use sbn. 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. Aliases: ISBN.
    • Use the {{Format ISBN}} template within the parameter – in the form |isbn={{Format ISBN|9780812695939}} – if you are unsure of how any particular ISBN should be hyphenated, as the pattern varies by country and publisher.
    • Supports accept-this-as-written markup to indicate valid ISBNs using a non-standard format, see below.
  • 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. Aliases: 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. Aliases: ISSN.
    • Supports accept-this-as-written markup to indicate valid ISSNs using a non-standard format, see below.
  • jfm: Jahrbuch über die Fortschritte der Mathematik; do not include "JFM" in the value; example |jfm=53.0144.01. Aliases: JFM.
  • jstor: JSTOR reference number; for example: |jstor=3793107. Aliases: JSTOR.
  • lccn: Library of Congress Control Number. When present, alphabetic prefix characters are to be lower case and without a space; example |lccn=79-57364 or |lccn=2004042477 or |lccn=e09001178. Aliases: LCCN.
  • mr: Mathematical Reviews; example |mr=630583. Aliases: MR.
  • oclc: OCLC Number for looking up publications in the WorldCat union catalog; example |oclc=9355469. Aliases: OCLC.
  • ol: Open Library identifier; do not include "OL" in the value; example |ol=7030731M. Aliases: OL.
  • osti: Office of Scientific and Technical Information; example |osti=4367507. Aliases: OSTI.
  • 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. Aliases: PMC.
    • pmc-embargo-date: Date that pmc goes live; if this date is in the future, then pmc is not linked until that date. Aliases: none.
  • pmid: PubMed; use unique identifier; example |pmid=17322060 See also the pmc parameter, above; these are two different identifiers. Aliases: PMID.
  • rfc: Request for Comments; example |rfc=3143. Aliases: RFC.
  • sbn: Standard Book Number; example |sbn=356-02201-3. Aliases: SBN.
    • Supports accept-this-as-written markup to indicate valid SBNs using a non-standard format, see below.
  • ssrn: Social Science Research Network; example |ssrn=1900856. Aliases: SSRN.
  • s2cid: Semantic Scholar corpus ID; example |s2cid=37220927. Aliases: S2CID.
  • zbl: Zentralblatt MATH; example |zbl=0472.53010 For zbMATH search results like JFM 35.0387.02 use |jfm=35.0387.02. Aliases: ZBL.

In very rare cases, identifiers are published which do not follow their defined standard format or use non-conforming checksums. These would typically cause an error message to be shown. Do not alter them to match a different checksum. In order to suppress the error message, some identifiers (|doi=, |eissn=, |isbn=, |issn=, and |sbn=) support a special accept-this-as-written markup which can be applied to disable the error-checking (as |<param>=((<value>))). If the problem is down to a mere typographical error in a third-party source, correct the identifier value instead of overriding the error message.

For some identifiers, it is possible to specify the access status using the corresponding |<param>-access= parameter.

For {{cite journal}}, some identifiers (specifying free resources) will automatically be linked to the title when |url= and |title-link= are not used to specify a different link target. This behaviour can be overridden by one out of a number of special keywords for |title-link= to manually select a specific source (|title-link=pmc or |title-link=doi) for auto-linking or to disable the feature (|title-link=none).

It is not necessary to specify a URL to a link identical to a link also produced by an identifier. The |url= parameter (or |title-link=) can then be used for providing a direct deep link to the corresponding document or a convenience link to a resource that would not otherwise be obviously accessible.

Discontinued parameters

[edit]

The following parameters used in templates of the cite family do not function in this template:

author-mask, author-name-separator, author-separator, display-authors, encyclopedia, format, issue (use edition), laysource, laydate, layurl, nopp, postscript, quote, separator, series (use edition), volume (use edition).

Extended notes

[edit]
  1. ^ This information is normally supplied in-line: it may be useful here when source is a newspaper or if the silbib were used inside <ref>...</ref>