From f609ce41d3381ea3b7b6d3112206c47fd0140591 Mon Sep 17 00:00:00 2001 From: Joost van den Born <48867822+yosata@users.noreply.github.com> Date: Mon, 26 Apr 2021 09:10:35 +0200 Subject: [PATCH] Change references into tabular format --- main.tex | 60 ++++++++++++++++++++++-------- micado.sty | 32 +++++++++++++++- references/ApplicableDocuments.bib | 6 +-- references/ReferenceDocuments.bib | 33 +++++++++++++--- 4 files changed, 106 insertions(+), 25 deletions(-) diff --git a/main.tex b/main.tex index b41be43..5e852d8 100644 --- a/main.tex +++ b/main.tex @@ -7,6 +7,7 @@ % -Updated to use Helvetica font % % -Took inspiration from SRON document % % template (https://personal.sron.nl/~pault/) % +% -Update to include references in tables % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -30,13 +31,14 @@ \dmdTitle{Document title} % Document title \dmdDocId{XXX-XXX-XXX-XXXXX-XXXX} % Document number \dmdIssue{1.0} % Version number -\dmdDate{\today} % Date +\dmdDate{12.04.2021} % Issue Date \dmdPreparedBy{Author Name} % Author(s) -\dmdPreparedOn{\today} % Date to appear on the document? +\dmdPreparedOn{\today} % Date that document was signed % Change record \dmdChangeRecord{ % Change record table. Fill as a four column table. 1.0 & 09/03/2021 & All & Initial document \\ + 1.1 & 22/04/2021 & 2 & Update to place references in tabular environment.\\ } % Only for (draft)review @@ -49,7 +51,39 @@ \dmdReleasedSig{} % Signature of the person releasing the document %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Definition required to get references in tables +% A future update of TeX Live (more specifically, v.0.12b of biblatex-ext-tabular) will +% allow the definition of bibtabular to be moved to the micado.sty file. For now, it is +% necessary to have it in the main .tex file. +\makeatletter +\def\fixextblx@setrefcontext{% + \expandafter\blx@setdefaultrefcontext\expandafter{\abx@field@entrykey}} +% Defines the function that prints references in a table +\defbibtabular{bibtabular}{ + \begin{center} + % \setlength\LTleft{10pt} + % \setlength\LTright{0pt} + \begin{longtable}{@{\extracolsep{\fill}}|c|p{0.3\linewidth}|p{0.3\linewidth}|c|c|@{}} + \hline \textbf{RD Nr} & \textbf{Document Number} & \textbf{Document Title} & \textbf{Issue} & \textbf{Date}\endhead + \hline + } + { + \hline + \end{longtable} + \end{center}}{ + \anchorlang{% + \fixextblx@setrefcontext + \printtext[labelnumberwidth]{% + \printfield{labelprefix}% + \printfield{labelnumber}}} + & \plainlang{\printfield{label}} + & \plainlang{\usebibmacro{title}} \plainlang{\usebibmacro{author}} + & \plainlang{\printfield{issue}} + & \plainlang{\printdate}\\ \hline} +\makeatother +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \begin{document} @@ -84,23 +118,18 @@ % (ApplicableDocuments.bib) will be printed automatically. % For reference documents, only those documents that are cited in the text are printed. \subsection{Applicable Documents}\label{sec:AD} -The following \ac{AD} of the exact issue contain provisions (statements, instructions, -recommendations or requirements) that are ruling over - and implicate provisions in the -present document. +The following \ac{AD} of the exact issue contain provisions (statements, instructions, recommendations or requirements) that are ruling over - and implicate provisions in the present document. \nocite{*} % This nocite is necessary for printing all applicable documents! -\begin{refcontext}[labelprefix=AD] - \printbibliography[heading=none, notkeyword={RD}] -\end{refcontext} +\newrefcontext[labelprefix=AD] +% \printbibliography[heading=none, notkeyword={RD}] +\printbibtabular[heading=none, notkeyword={RD}] \subsection{Reference Documents}\label{sec:RD} -The following \ac{RD} contains useful information relevant to the subject of the present -document. -\begin{refcontext}[labelprefix=RD] - \printbibliography[heading=none, keyword={RD}] -\end{refcontext} +\defbibnote{RDnote}{The following \ac{RD} contains useful information relevant to the subject of the present document.} +\newrefcontext[labelprefix=RD] +\printbibtabular[prenote=RDnote, heading=none, keyword={RD}] -\newpage \subsection{Acronyms} % A list of Acronyms is often useful to go back to the meaning of an acronym. % Acronyms used in the text with \ac{}, \acs{}, \acl{} or anything similar @@ -120,8 +149,7 @@ document. There is no reference to AD1, but there is a reference to \cite{old-stuff}. Nonetheless, both get printed in Section~\ref{sec:AD}! -This is a reference to a Reference Document: \cite{MICADO-operational_concept}. Only -reference documents that are cited in the text are printed in Section~\ref{sec:RD}. +This is a reference to a Reference Document: \cite{MICADO-operational_concept, MICADO_template, Matsushima2003}. Only reference documents that are cited in the text are printed in Section~\ref{sec:RD}. The \ac{MICADO} is an upcoming instrument for the \ac{ELT}. \acs{PSF} is shorthand for \acl{PSF}. A quick way to say the same, would have been to write: \ac{PSF}. diff --git a/micado.sty b/micado.sty index 40203ef..d2cc60f 100644 --- a/micado.sty +++ b/micado.sty @@ -79,7 +79,9 @@ %BIBLIOGRAPHY % relies on .bib files of the applicable documents and the reference documents to be in the right place. -\usepackage[backend=biber,citestyle=numeric-comp,bibstyle=numeric,sorting=none,url=false,eprint=false,isbn=true,doi=true,defernumbers=true]{biblatex} +% \usepackage[backend=biber,style=numeric,citestyle=numeric-comp,bibstyle=numeric,sorting=none,url=false,eprint=false,isbn=true,doi=true,defernumbers=true, date=short]{biblatex} +\usepackage[backend=biber, style=numeric, sorting=none, defernumbers=true, date=short]{biblatex} +\usepackage{biblatex-ext-tabular} % For generating references in a table. \addbibresource{references/ApplicableDocuments.bib} \addbibresource{references/ReferenceDocuments.bib} @@ -103,6 +105,34 @@ } } +% % \makeatletter +% % \def\fixextblx@setrefcontext{% +% % \expandafter\blx@setdefaultrefcontext\expandafter{\abx@field@entrykey}} + +% % Defines the function that prints references in a table +% \defbibtabular{bibtabular}{ +% \begin{center} +% % \setlength\LTleft{10pt} +% % \setlength\LTright{0pt} +% \begin{longtable}{@{\extracolsep{\fill}}|c|p{0.3\linewidth}|p{0.3\linewidth}|c|c|@{}} +% \hline \textbf{RD Nr} & \textbf{Document Number} & \textbf{Document Title} & \textbf{Issue} & \textbf{Date}\endhead +% \hline +% } +% { +% \hline +% \end{longtable} +% \end{center}}{ +% \anchorlang{% +% % \fixextblx@setrefcontext +% \printtext[labelnumberwidth]{% +% \printfield{labelprefix}% +% \printfield{labelnumber}}} +% & \plainlang{\printfield{label}} +% & \plainlang{\usebibmacro{title}} \plainlang{\usebibmacro{author}} +% & \plainlang{\printfield{issue}} +% & \plainlang{\printdate}\\ \hline} +% % \makeatother + % OTHER \usepackage{blindtext} %to print filler text \usepackage[printonlyused]{acronym} %for defining acronyms. Only acronyms used at least once will appear in the list. diff --git a/references/ApplicableDocuments.bib b/references/ApplicableDocuments.bib index 2a5a404..59b965d 100644 --- a/references/ApplicableDocuments.bib +++ b/references/ApplicableDocuments.bib @@ -2,10 +2,10 @@ @Manual{611, title = {Dataflow for ESO Observatories Deliverables Standard}, - version = 4, - number = {ESO-037611}, + issue = 4, + label = {ESO-037611}, keywords = {applicable}, - note = {2020-03-02}, + date = {2020-03-02}, organization = {ESO} } diff --git a/references/ReferenceDocuments.bib b/references/ReferenceDocuments.bib index 96500a0..2db9e40 100644 --- a/references/ReferenceDocuments.bib +++ b/references/ReferenceDocuments.bib @@ -2,8 +2,31 @@ @Manual{MICADO-operational_concept, - title = {MICADO Operational Concept Description}, - version = {2-0}, - number = {ELT-PLA-MCD-56301-0004}, - keywords = {reference}, - note = {2018-03-09}} + title = {MICADO Operational Concept Description}, + issue = {2.0}, + label = {ELT-PLA-MCD-56301-0004}, + keywords = {reference}, + date = {2018-03-09}} + +@misc{MICADO_template, + title = "{MICADO Document Template with a long title}", + author = {{van den Born}, J.A.}, + date = {2021-03-09}, + issue = {1.0}, + label = {ELT-MCD-TEM-563XX-YYYY}, +} + +@ARTICLE{Matsushima2003, + author = {{Matsushima}, Kyoji and {Schimmel}, Hagen and {Wyrowski}, Frank}, + title = "{Fast calculation method for optical diffraction on tilted planes by use of the angular spectrum of plane waves}", + journal = {Journal of the Optical Society of America A}, + keywords = {electromagnetic wave diffraction, light diffraction, Fourier transform optics, interpolation, fast Fourier transforms, electromagnetic wave propagation, light propagation}, + year = 2003, + month = 09, + volume = {20}, + number = {9}, + pages = {1755-1762}, + doi = {10.1364/JOSAA.20.001755}, + adsurl = {https://ui.adsabs.harvard.edu/abs/2003JOSAA..20.1755M}, + adsnote = {Provided by the SAO/NASA Astrophysics Data System} +} \ No newline at end of file