summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/dccpaper/dccpaper.dtx
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-08-05 22:32:58 +0000
committerKarl Berry <karl@freefriends.org>2016-08-05 22:32:58 +0000
commit480580fec13891a80df5703594143afc5580dd61 (patch)
treef892f633de77f118f113fb635f60ef174ebf546e /Master/texmf-dist/source/latex/dccpaper/dccpaper.dtx
parent010ac20bb5ed264d97d78d38c27a28232f9e8836 (diff)
dccpaper (5aug16)
git-svn-id: svn://tug.org/texlive/trunk@41804 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/dccpaper/dccpaper.dtx')
-rw-r--r--Master/texmf-dist/source/latex/dccpaper/dccpaper.dtx190
1 files changed, 97 insertions, 93 deletions
diff --git a/Master/texmf-dist/source/latex/dccpaper/dccpaper.dtx b/Master/texmf-dist/source/latex/dccpaper/dccpaper.dtx
index 0c909381d83..5d9c97f6020 100644
--- a/Master/texmf-dist/source/latex/dccpaper/dccpaper.dtx
+++ b/Master/texmf-dist/source/latex/dccpaper/dccpaper.dtx
@@ -1,111 +1,101 @@
% \iffalse meta-comment
%<*internal|ijdc9|idcc|base>
-\def\Version{2015/06/22 v1.4.1}
+\def\Version{2016/08/05 v1.5}
%</internal|ijdc9|idcc|base>
%<*internal>
\iffalse
%</internal>
%<*readme>
-The dccpaper bundle: LaTeX classes for submissions to IJDC and IDCC
-===================================================================
+# The dccpaper bundle: LaTeX classes for submissions to IJDC and IDCC
The dccpaper bundle consists of two very similar classes.
-ijdc-v9.cls corresponds to the template used by the `International
-Journal of Digital Curation`_, beginning with volume 9.
+ijdc-v9.cls corresponds to the template used by the [International
+Journal of Digital Curation], beginning with volume 9.
-idcc.cls corresponds to the template used for the `International Digital
-Curation Conference`_, beginning with IDCC15.
+idcc.cls corresponds to the template used for the [International Digital
+Curation Conference], beginning with IDCC15.
As the classes are so similar, their common features are abstracted out
-into dccpaper-base.tex, which should be installed in the runtime tex
-directory, rather than with the documentation.
+into dccpaper-base.sty; please do not attempt to use this package
+independently of the above classes.
The classes are suitable for submissions to the respective review
boards, but can also be used to produce the final camera-ready papers.
-Installation
-------------
+## Installation
-Managed way
-~~~~~~~~~~~
+### Managed way
The latest stable release of the dccpaper bundle has been packaged for
-TeX Live and MiKTeX. If you are running TeX Live and have ``tlmgr``
+TeX Live and MiKTeX. If you are running TeX Live and have `tlmgr`
installed, you can install the bundle simply by running
-``tlmgr install dccpaper``. If you are running MiKTeX, you can install
-the bundle by running ``mpm --install=dccpaper``. Both ``tlmgr`` and
-``mpm`` have GUI versions that you might find friendlier.
+`tlmgr install dccpaper`. If you are running MiKTeX, you can install the
+bundle by running `mpm --install=dccpaper`. Both `tlmgr` and `mpm` have
+GUI versions that you might find friendlier.
-Automated way
-~~~~~~~~~~~~~
+### Automated way
A makefile is provided which you can use with the Make utility:
-- Running ``make`` generates the derived files
-
- - README
- - dccpaper.pdf
- - ijdc-v9.cls
- - idcc.cls
- - dccpaper-base.tex
- - dccpaper-apacite.bib
- - dccpaper-biblatex.bib
-
-- Running ``make inst`` installs the files in the user's TeX tree.
-- Running ``make install`` installs the files in the local TeX tree.
-
-Manual way
-~~~~~~~~~~
-
-1. Compile dccpaper.dtx just as you would a normal LaTeX file. Bear in
- mind the documentation requires the Biblatex package and the Biber
- tool rather than regular BibTeX. As well as the usual PDF (or DVI)
- and auxiliary files, several others are generated.
-2. Rename README.txt to README (if you like).
-3. Move the files to your TeX tree as follows:
-
- - ``source/latex/dccpaper``: dccpaper.dtx, dccpaper.ins
- - ``tex/latex/dccpaper``: ijdc-v9.cls, idcc.cls, dccpaper-base.tex,
- dccpaper-by.eps, dccpaper-by.pdf
- - ``doc/latex/dccpaper``: dccpaper.pdf, dccpaper-apacite.bib,
- dccpaper-biblatex.bib, README
-
-4. You may then have to update your installation's file name database
- before TeX and friends can see the files.
-
-Licence
--------
-
-Copyright 2015 Digital Curation Centre, University of Edinburgh.
+ * Running `make` generates the derived files
+ - README.md
+ - dccpaper.pdf
+ - ijdc-v9.cls
+ - idcc.cls
+ - dccpaper-base.sty
+ - dccpaper-apacite.bib
+ - dccpaper-biblatex.bib
+ * Running `make inst` installs the files in the user's TeX tree.
+ * Running `make install` installs the files in the local TeX tree.
+
+### Manual way
+
+ 1. Compile dccpaper.dtx just as you would a normal LaTeX file. Bear in
+ mind the documentation requires the Biblatex package and the Biber
+ tool rather than regular BibTeX. As well as the usual PDF (or DVI)
+ and auxiliary files, several others are generated.
+ 2. Move the files to your TeX tree as follows:
+ - `source/latex/dccpaper`: dccpaper.dtx, dccpaper.ins
+ - `tex/latex/dccpaper`: ijdc-v9.cls, idcc.cls, dccpaper-base.sty,
+ dccpaper-by.eps, dccpaper-by.pdf
+ - `doc/latex/dccpaper`: dccpaper.pdf, dccpaper-apacite.bib,
+ dccpaper-biblatex.bib, README.md
+
+ 3. You may then have to update your installation's file name database
+ before TeX and friends can see the files.
+
+## Licence
+
+Copyright 2016 Digital Curation Centre, University of Edinburgh.
This work consists of the image files dccpaper-by.eps and
dccpaper-by.pdf, the documented LaTeX file dccpaper.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)`_,
+under the conditions of the [LaTeX Project Public License (LPPL)],
either version 1.3c of this license or (at your option) any later
version.
The image files distributed with this bundle derive from the file
-`by.eps`_ distributed by Creative Commons. The image is a trademark of
-Creative Commons and is subject to the `Creative Commons trademark
-policy`_.
-
-This work is "maintained" (as per LPPL maintenance status) by `Alex
-Ball`_.
-
-.. _International Journal of Digital Curation: http://www.ijdc.net/index.php/ijdc
-.. _International Digital Curation Conference: http://www.dcc.ac.uk/events/international-digital-curation-conference-idcc
-.. _LaTeX Project Public License (LPPL): http://www.latex-project.org/lppl.txt
-.. _by.eps: http://mirrors.creativecommons.org/presskit/buttons/88x31/eps/by.eps
-.. _Creative Commons trademark policy: http://creativecommons.org/policies
-.. _Alex Ball: http://alexball.me.uk/
+[by.eps] distributed by Creative Commons. The image is a trademark of
+Creative Commons and is subject to the [Creative Commons trademark
+policy].
+
+This work is "maintained" (as per LPPL maintenance status) by [Alex
+Ball].
+
+[International Journal of Digital Curation]: http://www.ijdc.net/index.php/ijdc
+[International Digital Curation Conference]: http://www.dcc.ac.uk/events/international-digital-curation-conference-idcc
+[LaTeX Project Public License (LPPL)]: http://www.latex-project.org/lppl.txt
+[by.eps]: http://mirrors.creativecommons.org/presskit/buttons/88x31/eps/by.eps
+[Creative Commons trademark policy]: http://creativecommons.org/policies
+[Alex Ball]: http://alexball.me.uk/
%</readme>
%<ijdc9|idcc>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<ijdc9>\ProvidesClass{ijdc-v9}
%<idcc>\ProvidesClass{idcc}
-%<base>\ProvidesFile{dccpaper-base.tex}
+%<base>\ProvidesPackage{dccpaper-base.sty}
%<*ijdc9>
[\Version\space Class for submissions to the International Journal of Digital Curation, volume 9 onwards.]
%</ijdc9>
@@ -142,7 +132,7 @@ Ball`_.
%
% These definitions are used to fill out the headers and footers. They include
-% some details that are defined in \textsf{dccpaper-base.tex} and provided by
+% some details that are defined in \textsf{dccpaper-base.sty} and provided by
% the user: |\thedate|, |\thevolume|, |\theissue|, |\thelastpage|, |\thedoi|.
%
\def\dccp@publ@long{International Journal of Digital Curation}
@@ -168,9 +158,14 @@ the University of Edinburgh on behalf of the Digital Curation Centre. ISSN:
\def\dccp@subject{\dccp@publ@long, \thedate, Vol.\ \thevolume, Iss.\ \theissue}
%
+% The class is based on the \textsf{article} class, and uses A4 paper.
+%
+\LoadClass[a4paper,12pt,twoside]{article}
+
+%
% The rest of the formatting happens in the following file.
%
-\input{dccpaper-base}
+\usepackage{dccpaper-base}
%LITERATE
%</ijdc9>
%<*idcc>
@@ -223,6 +218,12 @@ the University of Edinburgh on behalf of the Digital Curation Centre. ISSN:
2016 in Amsterdam. URL: \url{http://www.dcc.ac.uk/events/idcc16/}}
\def\dccp@subject{11th \dccp@publ@long, 2016}
}
+\DeclareOption{17}{%
+ \def\dccp@publ@short{IDCC17}
+ \def\dccp@publ@msg{The 12th \dccp@publ@long\ takes place on 20--23 February
+ 2017 in Edinburgh. URL: \url{http://www.dcc.ac.uk/events/idcc17/}}
+ \def\dccp@subject{12th \dccp@publ@long, 2017}
+}
\ProcessOptions\relax
%
@@ -249,20 +250,21 @@ the University of Edinburgh on behalf of the Digital Curation Centre. ISSN:
\@clearglobaloption{demo}
%
+% The class is based on the \textsf{article} class, and uses A4 paper.
+%
+\LoadClass[a4paper,12pt,twoside]{article}
+
+%
% The rest of the formatting happens in the following file.
%
-\input{dccpaper-base}
+\usepackage{dccpaper-base}
%LITERATE
%</idcc>
%<*base>
%<<LITERATE
%
-% The \textsf{dccpaper} classes are deliberately very similar. This file
-% contains the common code. All the classes are based on the \textsf{article}
-% class, and use A4 paper.
-%
-\LoadClass[a4paper,12pt,twoside]{article}
-
+% The \textsf{dccpaper} classes are deliberately very similar. This package
+% contains the common code.
%
% We use British English orthography.
%
@@ -1646,7 +1648,7 @@ Copyright (C) 2015 Digital Curation Centre, University of Edinburgh
\generate{
\file{ijdc-v9.cls}{\from{\jobname.dtx}{ijdc9}}
\file{idcc.cls}{\from{\jobname.dtx}{idcc}}
- \file{dccpaper-base.tex}{\from{\jobname.dtx}{base}}
+ \file{dccpaper-base.sty}{\from{\jobname.dtx}{base}}
}
%</install>
%<install>\endbatchfile
@@ -1658,7 +1660,7 @@ Copyright (C) 2015 Digital Curation Centre, University of Edinburgh
\nopreamble\nopostamble
\usedir{doc/latex/dccpaper}
\generate{
- \file{README.txt}{\from{\jobname.dtx}{readme}}
+ \file{README.md}{\from{\jobname.dtx}{readme}}
\file{dccpaper-biblatex.bib}{\from{\jobname.dtx}{biblatex}}
\file{dccpaper-apacite.bib}{\from{\jobname.dtx}{apacite}}
}
@@ -1792,7 +1794,7 @@ This is the documentation for the \textsf{dccpaper} bundle, consisting of the fo
\item\textsf{idcc}, which corresponds to the template used for the International Digital Curation Conference, beginning with IDCC15.
\end{itemize}
-The version to which it relates is \UseVersionOf{dccpaper-base.tex}, last revised\printdateTeX{\UseDateOf{dccpaper-base.tex}}.
+The version to which it relates is \UseVersionOf{dccpaper-base.sty}, last revised\printdateTeX{\UseDateOf{dccpaper-base.sty}}.
The code for this bundle is maintained at \url{https://github.com/DigitalCurationCentre/dccpaper}.
@@ -1874,6 +1876,8 @@ The second type of option relates to the conference to which the submission will
Use this for the 2015 conference.
\item[16]
Use this for the 2016 conference.
+\item[17]
+Use this for the 2017 conference.
\end{description}
\section{Preamble Commands}
@@ -2135,7 +2139,9 @@ Any acknowledgements should be placed in a section immediately before the refere
\section{Appendix A: Change History}
\begin{description}
-\item[v1.4.1] 2014-06-22\\
+\item[v1.5] 2016-08-05\\
+Added details of IDCC 2017. Slightly refactored code to convert dccpaper-base.tex into a package, dccpaper-base.sty.
+\item[v1.4.1] 2015-06-22\\
Fixed bug preventing compilation in DVI mode.
\item[v1.4] 2015-05-22\\
Added details of IDCC 2016. Improved whitespace handling. Fixed bug triggered by \texttt{demo} option. Fixed missing use of \lstinline|\Authfont|. Added missing DOI tweak for \textsf{biblatex-apa}.
@@ -2178,10 +2184,10 @@ First public release of \textsf{ijdc-v9} class.
\renewcommand*{\mdJobName}{idcc}
\MakeInputJobDoc[cls]{0}{\ProcessInputWith{PScomment}}
-\subsection{dccpaper-base.tex}
+\subsection{dccpaper-base.sty}
\renewcommand*{\mdJobName}{dccpaper-base}
-\MakeInputJobDoc[tex]{0}{\ProcessInputWith{PScomment}}
+\MakeInputJobDoc[sty]{0}{\ProcessInputWith{PScomment}}
\noNiceVerb
@@ -2208,7 +2214,7 @@ A makefile is provided which you can use with the Make utility:
\begin{itemize}
\item
- README
+ README.md
\item
dccpaper.pdf
\item
@@ -2216,7 +2222,7 @@ A makefile is provided which you can use with the Make utility:
\item
idcc.cls
\item
- dccpaper-base.tex
+ dccpaper-base.sty
\item
dccpaper-apacite.bib
\item
@@ -2238,8 +2244,6 @@ A makefile is provided which you can use with the Make utility:
tool rather than regular Bib\TeX. As well as the usual PDF (or DVI) and
auxiliary files, several others are generated.
\item
- Rename README.txt to README (if you like).
-\item
Move the files to your \TeX\ tree as follows:
\begin{itemize}
@@ -2247,10 +2251,10 @@ A makefile is provided which you can use with the Make utility:
\path{source/latex/dccpaper}: dccpaper.dtx, dccpaper.ins
\item
\path{tex/latex/dccpaper}: ijdc-v9.cls, idcc.cls,
- dccpaper-base.tex, dccpaper-by.eps, dccpaper-by.pdf
+ dccpaper-base.sty, dccpaper-by.eps, dccpaper-by.pdf
\item
\path{doc/latex/dccpaper}: dccpaper.pdf, dccpaper-apacite.bib,
- dccpaper-biblatex.bib, README
+ dccpaper-biblatex.bib, README.md
\end{itemize}
\item
You may then have to update your installation's file name database
@@ -2303,7 +2307,7 @@ Any acknowledgements should be placed here\dots
\newpage
\section{Appendix E: Licence}
-Copyright \textcopyright\ 2015 Digital Curation Centre, University of Edinburgh.
+Copyright \textcopyright\ 2016 Digital Curation Centre, University of Edinburgh.
This work consists of the image files dccpaper-by.eps and
dccpaper-by.pdf, the documented LaTeX file dccpaper.dtx and a Makefile.
@@ -2329,4 +2333,4 @@ The file dccpaper.pdf, generated by this work, is licensed as shown on page 1.
%</driver>
% \fi
%
-\endinput \ No newline at end of file
+\endinput