Help:BibTeX format

From semantic-mediawiki.org
(Redirected from Help:BibTeX format)
Help:BibTeX formatBibTeX format/zh-hans
BibTeX format
Produces a link to a file for downloading data in BibTeX format.
Scenarios, examples, demos
Example: BibTeX scenario, Demo:Bibliographic records
Further Information
Provided by: Extension "Semantic Result Formats"
Added: 1.4.3
Removed: still supported
Requirements: none
Format name: bibtex
Enabled? Indicates whether the result format is enabled by default upon installation of the respective extension. yes
Authors: Steren Giannini , Frank Dengler
Categories: export
Table of Contents

The result format bibtex, part of extension "Semantic Result Formats"Provides additional formats for semantic queries, is used to produce links for downloading data from a wiki in BibTeX format. It is a special format for data export and therefore properties must use known labels to specify how the wiki data relates to the BibTeX format.

Starting with Semantic MediaWiki 3.1.0Released on 23 September 2019 and compatible with MW 1.31.0 - 1.33.x. it is possible to define a specific order for the values of properties queried for this result format ("sequence mapping").1 See the help page on sequence mapping for further information.

Parameters

Parameter Type Default Description
filename text bibtex.bib The name for the output file

Data fields[edit]

Properties printout statements should use one of the following labels, or otherwise are ignored in the resulting BibTeX. The available fields are:

  • address: Publisher's address (usually just the city, but can be the full address for lesser-known publishers)
  • annote: An annotation for annotated bibliography styles (not typical)
  • author: The name(s) of the author(s) (in the case of more than one author, separated by and)
  • booktitle: The title of the book, if only part of it is being cited
  • chapter: The chapter number
  • crossref: The key of the cross-referenced entry
  • date: The date of publication, is converted to "month" and "year" when exported to BibTeX
  • doi: The DOI number of the entry
  • edition: The edition of a book, long form (such as "first" or "second")
  • editor: The name(s) of the editor(s)
  • eprint: A specification of an electronic publication, often a preprint or a technical report
  • howpublished: How it was published, if the publishing method is nonstandard
  • institution: The institution that was involved in the publishing, but not necessarily the publisher
  • journal: The journal or magazine the work was published in
  • key: A hidden field used for specifying or overriding the alphabetical order of entries (when the "author" and "editor" fields are missing). Note that this is very different from the key (mentioned just after this list) that is used to cite or cross-reference the entry.
  • month: The month of publication (or, if unpublished, the month of creation)
  • note: Miscellaneous extra information
  • number: The "number" of a journal, magazine, or tech-report, if applicable. (Most publications have a "volume", but no "number" field.)
  • organization: The conference sponsor
  • pages: Page numbers, separated either by commas or double-hyphens. For books, the total number of pages.
  • publisher: The publisher's name
  • school: The school where the thesis was written
  • series: The series of books the book was published in (e.g. "The Hardy Boys" or "Lecture Notes in Computer Science")
  • title: The title of the work
  • type: The type of tech-report, for example, "Research Note" (defaults to "Book")
  • url: The WWW address
  • volume: The volume of a journal or multi-volume book
  • year: The year of publication (or, if unpublished, the year of creation)

Examples[edit]

Example 1 - general
{{#ask:
 [[Has title::{{PAGENAME}}]]
 |?author
 |?volume
 |?date
 |?title
 |?type
 |?journal
 |?URL
 |?DOI
 |format=bibtex
 |searchlabel=BibTeX
}}

An example that uses the above notion has been prepared here displaying a link to download the BibTeX information.

Example 2 - wiki page
{{#ask:
 [[Has title::{{PAGENAME}}]]
 |?Has bibtex type=type
 |?Has bibtex author=author
 |?Has bibtex title=title
 |?Has bibtex year=year
 |?Has bibtex url=url
 |?Has bibtex note=note
 |format=bibtex
 |searchlabel=BibTeX
}}

Naming convention[edit]

Output field names can follow a different naming convention (see example 2). For example the MediaWiki field reference will be renamed to crossref in the BibTex output file.

{{#ask:
 [[Has title::{{PAGENAME}}]]
 |?reference=crossref 
 |format=bibtex
 |searchlabel=BibTeX
}}

Limitations[edit]

  • Certain special characters such as diacritics (e.g. umlaut on ü, etc.) are not masked as LaTeX-style characters.
    • Example 1: á may result in á (not \´{a})
    • Example 2: É may result in É
  • Italics, which are indicated in wiki syntax by placing two apostrophes on either side of the italicized phrase, are not converted either.
  • There is no field for the number of volumes.

Remarks[edit]

  • In addition, each entry contains a key (Bibtexkey) that is used to cite or cross-reference the entry. This key gets generated automatically and is the first item in a BibTeX entry. It is not part of any field and should be used when referencing the publication in a LaTeX file.
  • There are no official BibTeX format specifications, so this extension has been written from the common use of BibTeX. See the Wikipedia article on BibTeX for more information.

See also[edit]

References

  1. ^  Semantic Result Formats: GitHub issue comment gh:srf:536:524522750