<br/>
A bibTEX file looks like this:
<pre detail='typing'> @Article{sometag, author = "An Author and Another One", title = "A hopefully meaningful title", journal = maps, volume = "25", number = "2", pages = "5--9", month = mar, year = "2013", ISSN = "1234-5678", }
</pre>
<br/>
<br/>
In the old MkII setup we have two kinds of entries: the ones that come from the bibTEX run and user supplied ones. We no longer rely on bibTEX output but we do still support the user supplied definitions. These were in fact prepared in a way that suits the processing of bibTEX generated entries. The next variant reflects the ConTEXt recoding of the old bibTEX output.
<pre detail='typing'> \startpublication[k=Hagen:Second,t=article,a={Hans Hagen},y=2013,s=HH01] \artauthor[]{Hans}[H.]{}{Hagen} \arttitle{Who knows more?} \journal{MyJournal} \pubyear{2013} \month{8} \volume{1} \issue{3} \issn{1234-5678} \pages{123--126} \stoppublication
</pre>
<br/>
<br/>
In the new setup we support these variants as well:
<pre detail='typing'> \startpublication[k=Hagen:Third,t=article] \author{Hans Hagen} \title{Who knows who?} ... \stoppublication
</pre>
<br/>
and
<pre detail='typing'> \startpublication[tag=Hagen:Third,category=article] \author{Hans Hagen} \title{Who knows who?} ... \stoppublication </pre><br/>
and
<pre detail='typing'> \startpublication \tag{Hagen:Third} \category{article} \author{Hans Hagen} \title{Who knows who?} ... \stoppublication
</pre>
<br/>
Because internally the entries are Lua tables, we also support loading of Lua based definitions:
<pre detail='typing'> return { ["Hagen:First"] = { author = "Hans Hagen", category = "article", issn = "1234-5678", issue = "3", journal = "MyJournal", month = "8", pages = "123--126", tag = "Hagen:First", title = "Who knows nothing?", volume = "1", year = "2013", }, }
</pre>
<br/>
Files set up like this can be loaded too. The following xml input is rather close to this, and is also accepted as input.
<pre detail='typing'> <?xml version="2.0" standalone="yes" ?>
<bibtex>
<entry tag="Hagen:First" category="article">
<field name="author">Hans Hagen</field>
<field name="category">article</field>
<field name="issn">1234-5678</field>
<field name="issue">3</field>
<field name="journal">MyJournal</field>
<field name="month">8</field>
<field name="pages">123--126</field>
<field name="tag">Hagen:First</field>
<field name="title">Who knows nothing?</field>
<field name="volume">1</field>
<field name="year">2013</field>
</entry>
</bibtex>
</pre>
<br/>
One unfortunate aspect commonly found in bibTEX files is that they often contain TEX commands. Even worse is that there is no standard on what these commands can be and what they mean, at least not formally, as bibTEX is a program intended to be used with many variants of TEX style: plain, LATEX, and others. This means that we need to define our use of these typesetting commands. However, in most cases, they are just abbreviations or font switches and these are often known. Therefore, ConTEXt will try to resolve them before reporting an issue. In the log file there is a list of commands that has been seen in the loaded databases. For instance, loading <tt>tugboat.bib</tt> gives a long list of commands of which we show a small set here:
<pre detail='typing'> publications > start used btx commands publications > standard CONTEXT 1 known publications > standard ConTeXt 4 known publications > standard TeXLive 3 KNOWN publications > standard eTeX 1 known publications > standard hbox 6 known publications > standard sltt 1 unknown publications > stop used btxcommands
</pre>
<br/>
You can define unknown commands, or overload existing definitions in the following way:
<pre detail='typing'> \definebtxcommand\TUB {TUGboat} \definebtxcommand\sltt{\tt} \definebtxcommand\<#1>{\type{#1}}
</pre>
<br/>
Unknown commands do not stall processing, but their names are then typeset in a mono- spaced font so they probably stand out for proofreading. You can access the commands with <tt>\btxcommand{...}</tt>, as in:
<pre detail='buffer'> commands like \btxcommand{MySpecialCommand} are handled in an indirect way
</pre>
<br/>
Normally in a document you will use only one bibliographic database, whether or not distributed over multiple files. Nevertheless we support multiple databases as well which is why we talk of datasets instead. A dataset is loaded with the <tt>\usebtxdataset</tt> command. Although currently it is not necessary to define a (default) dataset you can best do this because in the future we might provide more options. Here are some examples:
<pre detail='typing'> \definebtxdataset[standard] \usebtxdataset[standard][tugboat.bib] \usebtxdataset[standard][mtx-bibtex-output.xml] \usebtxdataset[standard][test-001-btx-standard.lua]
</pre>
<br/>
<br/>
In this document we use some example databases, so let’s load one of them now:
<pre detail='buffer'> \definebtxdataset[example]
</pre>
\usebtxdataset[example][mkiv-publications.bib]
<br/>
You can ask for an overview of entries in a dataset with:
<pre detail='buffer'> \showbtxdatasetfields[example]
</pre>
this gives:
<br/>
You can set the current active dataset with
<pre detail='typing'> \setbtxdataset[standard]
</pre>
<br/>
<br/>
If you want to see what publications are in the database, the easiest way is to ask for a complete list:
<pre detail='buffer'> \definebtxrendering [example] [dataset=example, method=local, alternative=apa] \placelistofpublications % \placebtxrendering [example] [criterium=all]
</pre>
<br/>
<br/>
There are a couple of accessors and helpers to get the job done. When you want to fetch a field from the current entry you use <tt>\btxfield</tt>. In most cases you want to make sure this field has a value, for instance because you don’t want fences or punctuation that belongs to a field.
<pre detail='typing'> \btxdoif {title} { \bold{\btxfield{title}}, }
</pre>
<br/>
There are three test macros:
<pre detail='typing'> \btxdoifelse{fieldname}{action when found}{action when not found} \btxdoif {fieldname}{action when found} \btxdoifnot {fieldname} {action when not found}
</pre>
<br/>
An extra conditional is available for testing interactivity:
<pre detail='typing'> \btxdoifelseinteraction{action when true}{action when false}
</pre>
<br/>
<br/>
You can improve readability by using setups, for instance:
<pre detail='typing'> \btxdoifelse {author} { \btxsetup{btx:apa:author:yes} } { \btxsetup{btx:apa:author:nop} }
</pre>
<br/>
<br/>
So, the previous example setup can be rewritten as:
<pre detail='typing'> \btxdoif {title} { \bold{\btxfield{title}} \btxcomma }
</pre>
<br/>
There is a special command for rendering a (combination) of authors:
<pre detail='typing'> \btxflushauthor{author} \btxflushauthor{editor} \btxflushauthor[inverted]{editor}
</pre>
<br/>
Instead of the last one you can also use:
<pre detail='typing'> \btxflushauthorinverted{editor}
</pre>
<br/>
Citations are references to bibliographic entries that normally show up in lists someplace in the document: at the end of a chapter, in an appendix, at the end of an article, etc. We discussed the rendering of these lists in the previous chapter. A citation is normally pretty short as its main purpose is to refer uniquely to a more detailed description. But, there are several ways to refer, which is why the citation subsystem is configurable and extensible. Just look at the following commands:
<pre detail='buffer'> \cite[author][example::demo-003] \cite[authoryear][example::demo-003] \cite[authoryears][example::demo-003] \cite[author][example::demo-003,demo-004] \cite[authoryear][example::demo-003,demo-004] \cite[authoryears][example::demo-003,demo-004] \cite[author][example::demo-004,demo-003] \cite[authoryear][example::demo-004,demo-003] \cite[authoryears][example::demo-004,demo-003]
</pre>
<br/>
You can tune the way a citation shows up:
<pre detail='buffer'> \setupbtxcitevariant[author] [sorttype=author,color=darkyellow] \setupbtxcitevariant[authoryear] [sorttype=author,color=darkyellow] \setupbtxcitevariant[authoryears][sorttype=author,color=darkyellow]
</pre>
\cite[author][example::demo-004,demo-003] \cite[authoryear][example::demo-004,demo-003] \cite[authoryears][example::demo-004,demo-003]
<br/>Here we sort the authors and color the citation:
(Hans Hagen and Ton Otten, Luigi Scarso)
<br/>
The <tt>\citation</tt> command is synonymous but is more flexible with respect to spacing of its arguments:
<pre detail='typing'> \citation[author] [example::demo-004,demo-003] \citation[authoryear] [example::demo-004,demo-003] \citation[authoryears][example::demo-004,demo-003]
</pre>
<br/>
A citation variant is defined in several steps and if you really want to know the dirty details, you should look into the <tt>publ-imp-*.mkiv</tt> files. Here we stick to the concept.
<pre detail='typing'> \startsetups btx:cite:author \btxcitevariant{author} \stopsetups
</pre>
<br/>
You can overload such setups if needed, but that only makes sense when you cannot configure the rendering with parameters. The <tt>\btxcitevariant</tt> command is one of the build in accessors and it calls out to Lua where more complex manipulation takes place if needed. If no manipulation is known, the field with the same name (if found) will be flushed. A command like <tt>\btxcitevariant</tt> assumes that a dataset and specific tag has been set. This is normally done in the wrapper macros, like <tt>\cite</tt>. For special purposes you can use these commands
<pre detail='typing'> \setbtxdataset[example] \setbtxentry[hh2013]
</pre>
<br/>
<br/>
Unless you use <tt>criterium=all</tt> only publications that are cited will end up in the lists. You can force a citation into a list using <tt>\usecitation</tt>, for example:
<pre detail='typing'> \usecitation[example::demo-004,demo-003]
</pre>
<br/>
<br/>
The entries are collected in datasets and each set has a unique name. In this document we have the set named <tt>example</tt>. A dataset table has several fields, and probably the one of most interest is the <tt>luadata</tt> field. Each entry in this table describes a publication:
<pre detail='typing'>t={["author"]="Hans Hagen",["category"]="book",["index"]=1,["tag"]="demo-001",["title"]="\\btxcmd{BIBTEX}, the \\btxcmd{CONTEXT}\\ way",["year"]="2013",}</pre> This is <tt>publications.datasets.example.luadata["demo-001"]</tt>. There can be a companion entry in the parallel <tt>details</tt> table. <pre detail='typing'>t={["author"]={{["firstnames"]={ "Hans" },["initials"]={ "H" },["original"]="Hans Hagen",["surnames"]={ "Hagen" },["vons"]={},},},["short"]="Hag13",}</pre>These details are accessed as <tt>publications.datasets.example.details["demo-001"]</tt> and by using a separate table we can overload fields in the original entry without losing the original.<br/>You can loop over the entries using regular Lua code combined with MkIV helpers: <pre detail='buffer'>local dataset = publications.datasets.example</pre> context.starttabulate { "|l|l|l|" }for tag, entry in table.sortedhash(dataset.luadata) dolocal detail = dataset.details[tag] or { }context.NC() context.type(tag)context.NC() context(detail.short)context.NC() context(entry.title)context.NC() context.NR()endcontext.stoptabulate()
["author"]="Hans Hagen",<br/>This results in: {|
["category"]="book", ["index"]=1, ["tag"]="demo-001", ["title"]="\\btxcmd{BIBTEX}, the \\btxcmd{CONTEXT}\\ way", ["year"]="2013", } </pre>This is <tt>publications.datasets.example.luadata["demo-001"]</tt>. There can be a companion entry in the parallel <tt>details</tt> table. <pre detail='typing'> t={ ["author"]={ { ["firstnames"]={ "Hans" }, ["initials"]={ "H" }, ["original"]="Hans Hagen", ["surnames"]={ "Hagen" }, ["vons"]={}, }, }, ["short"]="Hag13", } </pre>These details are accessed as <tt>publications.datasets.example.details["demo-001"]</tt> and by using a separate table we can overload fields in the original entry without losing the original.<br/>You can loop over the entries using regular Lua code combined with MkIV helpers: <pre detail='buffer'> local dataset = publications.datasets.example </pre> context.starttabulate { "|l|l|l|" } for tag, entry in table.sortedhash(dataset.luadata) do local detail = dataset.details[tag] or { } context.NC() context.type(tag) context.NC() context(detail.short) context.NC() context(entry.title) context.NC() context.NR() end context.stoptabulate() <br/>This results in: {| |+
<br/>
Once a dataset is accessible as xml tree, you can use the regular <tt>\xml...</tt> commands. We start with loading a dataset, in this case from just one file.
<pre detail='buffer'> \usebtxdataset[tugboat][tugboat.bib]
</pre>
<br/>
The dataset has to be converted to xml:
<pre detail='buffer'> \convertbtxdatasettoxml[tugboat]
</pre>
<br/>
The tree is now accessible by its root reference <tt>btx:tugboat</tt>. If we want simple field access we can use a few setups:
<pre detail='buffer'> \startxmlsetups btx:initialize \xmlsetsetup{#1}{bibtex|entry|field}{btx:*} \xmlmain{#1} \stopxmlsetups
</pre>
\startxmlsetups btx:field\xmlflushcontext{#1}\stopxmlsetups
\xmlflushcontext{#1} \stopxmlsetups \xmlsetup{btx:tugboat}{btx:initialize}
<br/>
The two setups are predefined in the core already, but you might want to change them. They are applied in for instance:
<pre detail='buffer'> \starttabulate[|||] \NC \type {tag} \NC \xmlfirst {btx:tugboat} {/bibtex/entry[string.find(@tag,'Hagen')]/attribute('tag')} \NC \NR \NC \type {title} \NC \xmlfirst {btx:tugboat} {/bibtex/entry[string.find(@tag,'Hagen')]/field[@name='title']} \NC \NR \stoptabulate
</pre>
|}
<pre detail='buffer'> \startxmlsetups btx:demo \xmlcommand {#1} {/bibtex/entry[string.find(@tag,'Hagen')][1]}{btx:table} \stopxmlsetups
</pre>
\startxmlsetups btx:table \starttabulate[|||] \NC \type {tag} \NC \xmlatt{#1}{tag} \NC \NR \NC \type {title} \NC \xmlfirst{#1}{/field[@name='title']} \NC \NR\stoptabulate\stopxmlsetups
\stoptabulate \stopxmlsetupsxmlsetup{btx:tugboat}{btx:demo}
\xmlsetup{btx:tugboat}{btx:demo}
{|
<br/>
Here is another example:
<pre detail='buffer'> \startxmlsetups btx:row \NC \xmlatt{#1}{tag} \NC \xmlfirst{#1}{/field[@name='title']} \NC \NR \stopxmlsetups
</pre>
\startxmlsetups btx:demo \xmlfilter {#1} { /bibtex /entry[@category='article'] /field[@name='author' and (find(text(),'Knuth') or find(text(),'DEK'))] /../command(btx:row)} }\stopxmlsetups
\stopxmlsetupsstarttabulate[|||]\xmlsetup{btx:tugboat}{btx:demo}\stoptabulate
\starttabulate[|||]
\xmlsetup{btx:tugboat}{btx:demo}
\stoptabulate
{|
<br/>
A more extensive example is the following. Of course this assumes that you know what xml support mechanisms and macros are available.
<pre detail='buffer'> \startxmlsetups btx:getkeys \xmladdsortentry{btx}{#1}{\xmlfilter{#1}{/field[@name='author']/text()}} \xmladdsortentry{btx}{#1}{\xmlfilter{#1}{/field[@name='year' ]/text()}} \xmladdsortentry{btx}{#1}{\xmlatt{#1}{tag}} \stopxmlsetups
</pre>
\startxmlsetups btx:sorter \xmlresetsorter{btx} % \xmlfilter{#1}{entry/command(btx:getkeys)} \xmlfilter{#1}{ /bibtex /entry[@category='article'] /field[@name='author' and find(text(),'Knuth')] /../command(btx:getkeys)} \xmlsortentries{btx} \starttabulate[||||] \xmlflushsorter{btx}{btx:entry:flush} \stoptabulate \stopxmlsetups \startxmlsetups btx:entry:flush \NC \xmlfilter{#1}{/field[@name='year' ]/context()}
\startxmlsetups btx:entry:flush\NC \xmlfilter{#1}{/field[@name='year' ]/context()}\NC \xmlatt{#1}{tag}\NC \xmlfilter{#1}{/field[@name='author']/context()}\NC \NR\stopxmlsetups
\NC \xmlfilterxmlsetup{#1btx:tugboat}{/field[@name='author']/context()btx:sorter} \NC \NR \stopxmlsetups
\xmlsetup{btx:tugboat}{btx:sorter}
{|
In the original bibliography support module usage was as follows (example taken from the contextgarden wiki):
<pre detail='typing'> % engine=pdftex \usemodule[bib] \usemodule[bibltx] \setupbibtex [database=xampl] \setuppublications [numbering=yes] \starttext As \cite [article-full] already indicated, bibtex is a \LATEX||centric program. \completepublications \stoptext
</pre>
<br/>
<br/>
In the new approach we no longer use bibTEXso we don’t need to setup bibTEX. Instead we define dataset(s). We also no longer set up publications with one command, but have split that up in rendering-, list-, and cite-variants. The basic <tt>\cite</tt> command remains. The above example becomes:
<pre detail='typing'> \definebtxdataset [document] \usebtxdataset [document] [mybibfile.bib] \definebtxrendering [document] \setupbtxrendering [document] [numbering=yes] \starttext As \cite [article-full] already indicated, bibtex is a \LATEX||centric program. \completebtxrendering[document] \stoptext
</pre>
<br/>
So, we have a few more commands to set up things. If you intend to use just a single dataset and rendering, the above preamble can be simplified to:
<pre detail='typing'> \usebtxdataset [mybibfile.bib] \setupbtxrendering [numbering=yes]
</pre>
<br/>
As TEX and Lua are both open and accessible in ConTEXt it is possible to extend the functionality of the bibliography related code. For instance, you can add extra loaders.
<pre detail='typing'> function publications.loaders.myformat(dataset,filename) local t = { } -- Load data from 'filename' and convert it to a Lua table 't' with -- the key as hash entry and fields conforming the luadata table -- format. loaders.lua(dataset,t) end
</pre>
<br/>
This then permits loading a database (into a dataset) with the command:
<pre detail='typing'> \usebtxdataset[standard][myfile.myformat]
</pre>
<br/>
The <tt>myformat</tt> suffix is recognized automatically. If you want to use another suffix, you can do this:
<pre detail='typing'> \usebtxdataset[standard][myformat::myfile.txt]
</pre>