summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/biblatex-oxref/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/biblatex-oxref/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-oxref/README.md112
1 files changed, 112 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/biblatex-oxref/README.md b/Master/texmf-dist/doc/latex/biblatex-oxref/README.md
new file mode 100644
index 00000000000..a33b1d690b7
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/biblatex-oxref/README.md
@@ -0,0 +1,112 @@
+# biblatex-oxref: Biblatex styles inspired by the *Oxford Guide to Style*
+
+This bundle provides two [biblatex] styles that implement (some of) the
+stipulations and examples provided by the 2014 *New Hart's Rules* and the 2002
+*Oxford Guide to Style*:
+
+ * `oxnotes` is a style similar to the standard `verbose`,
+ intended for use with footnotes;
+ * `oxyear` is a style similar to the standard `authoryear`,
+ intended for use with parenthetical in-text citations.
+
+Both styles should be considered experimental. In particular, the ways in which
+the styles handle certain tricky references are subject to change.
+
+[biblatex]: http://ctan.org/pkg/biblatex
+
+## Installation
+
+### Dependencies
+
+To compile the documentation you will need to have the [minted] package working,
+which in turn relies on Python 2.6+ and Pygments. See the documentation of that
+package for details.
+
+### Automated way
+
+A makefile is provided which you can use with the Make utility on
+UNIX-like systems:
+
+ * Running `make source` generates the derived files
+ - README.md
+ - oxref.bbx, oxnotes.bbx, oxyear.bbx
+ - oxnotes.cbx, oxyear.cbx
+ - american-oxref.lbx, british-oxref.lbx, english-oxref.lbx
+ - oxnotes.dbx, oxyear.dbx
+ - oxref.bib
+ - oxref.ins
+ - oxnotes-doc.tex, oxyear-doc.tex
+
+ * Running `make` generates the above files and also oxref.pdf,
+ oxnotes-doc.pdf, and oxyear-doc.pdf.
+
+ * Running `make inst` installs the files in the user's TeX tree.
+ You can undo this with `make uninst`.
+
+ * Running `make install` installs the files in the local TeX tree.
+ You can undo this with `make uninstall`.
+
+ * Running `make clean` removes auxiliary files from the working directory.
+
+ * Running `make distclean` removes the generated files from the working
+ directory as well.
+
+### Manual way
+
+To install the bundle from scratch, follow these instructions. If you have
+downloaded the zip file from the [Releases] page on GitHub, you can skip the
+first two steps.
+
+ 1. Run `luatex oxref.dtx` to generate the source files. (You can safely skip
+ this step if you are confident about step 2.)
+
+ 2. Compile oxref.dtx, oxnotes-doc.tex and oxyear-doc.tex with LuaLaTeX and
+ Biber to generate the documentation. You will need to enable shell escape
+ so that [minted] can typeset the listings.
+
+ 3. Move the files to your TeX tree as follows:
+ - `source/latex/biblatex-oxref`:
+ oxref.dtx,
+ (oxref.ins)
+ - `tex/latex/biblatex-oxref`:
+ american-oxref.lbx,
+ british-oxref.lbx,
+ english-oxref.lbx,
+ oxnotes.bbx,
+ oxnotes.cbx,
+ oxnotes.dbx,
+ oxref.bbx,
+ oxyear.bbx,
+ oxyear.cbx,
+ oxyear.dbx
+ - `doc/latex/biblatex-oxref`:
+ README.md,
+ oxnotes-doc.pdf,
+ oxnotes-doc.tex,
+ oxref.bib,
+ oxref.pdf,
+ oxyear-doc.pdf,
+ oxyear-doc.tex
+
+ 4. You may then have to update your installation's file name database
+ before TeX and friends can see the files.
+
+[Releases]: https://github.com/alex-ball/biblatex-oxref/releases
+[minted]: http://ctan.org/pkg/minted
+
+## Licence
+
+Copyright 2016–7 Alex Ball.
+
+This work consists of the documented LaTeX file oxref.dtx and a Makefile.
+
+The text files contained in this work may be distributed and/or modified
+under the conditions of the [LaTeX Project Public License (LPPL)][lppl],
+either version 1.3c of this license or (at your option) any later
+version.
+
+This work is ‘maintained’ (as per LPPL maintenance status) by [Alex Ball][me].
+
+[lppl]: http://www.latex-project.org/lppl.txt "LaTeX Project Public License (LPPL)"
+[me]: https://alexball.me.uk/ "Alex Ball"
+