summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/oup-authoring-template/doc/oup-authoring-template-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/oup-authoring-template/doc/oup-authoring-template-doc.tex')
-rw-r--r--macros/latex/contrib/oup-authoring-template/doc/oup-authoring-template-doc.tex85
1 files changed, 61 insertions, 24 deletions
diff --git a/macros/latex/contrib/oup-authoring-template/doc/oup-authoring-template-doc.tex b/macros/latex/contrib/oup-authoring-template/doc/oup-authoring-template-doc.tex
index d4e6eedc8a..8e118966b4 100644
--- a/macros/latex/contrib/oup-authoring-template/doc/oup-authoring-template-doc.tex
+++ b/macros/latex/contrib/oup-authoring-template/doc/oup-authoring-template-doc.tex
@@ -38,9 +38,21 @@ OUP Journals---Authoring template}
\tableofcontents
\section{Introduction }
-Oxford University Press has developed this authoring template to help authors in preparing articles. Authors are encouraged to use this template to produce \LaTeX\ manuscripts which conform to OUP Journal styles. This document is a manual for authors to help using this template during article preparation. It features general guidelines and contains descriptions regarding various elements that can be used while preparing manuscripts. Authors are requested to refer to the file ``readme.pdf'' for details of files available for reference.
-
-Please utilize the OUP authoring template to the maximum, rather than adding further packages. If you need extra structural mark-up, please provide a note to the compositor on the same. Packages that only ``enhance'' the layout are not recommended. The same applies to newly introduced macros. Please concentrate on logical mark-up instead of formatting. This will ease the production process and avoids misinterpretation of your \LaTeX\ code.
+Oxford University Press has developed this authoring template to
+help authors in preparing articles. Authors are encouraged to use
+this template to produce \LaTeX\ manuscripts which conform to OUP
+Journal styles. This document is a manual for authors to help using
+this template during article preparation. It features general
+guidelines and contains descriptions regarding various elements that
+can be used while preparing manuscripts. Authors are requested to
+refer to the file ``readme'' for details of files available for
+reference.
+
+Please utilize the OUP authoring template to the maximum, rather
+than adding further packages or macros if possible. Please use
+semantic mark-up instead of formatting markup where there is a
+choice, for instance using \verb+\emph+ rather than \verb+\it+ or
+\verb+\textit+ to indicate emphasis.
This documentation is not intended to give an introduction to \LaTeX. For questions concerning \TeX\ systems/installations or the \LaTeX\ mark-up language in general, please visit \url{http://tug.ctan.org/} or any other \TeX\ user group worldwide. The essential reference for \LaTeX\ is Mittelbach F., Goossens M. (2004) \textit{The \LaTeX\ Companion. 2nd edn.}, but there are many other good books about \LaTeX.
@@ -53,8 +65,17 @@ This documentation is not intended to give an introduction to \LaTeX. For questi
\url{https://www.overleaf.com/learn}
\end{itemize}
-\section{How to start and prepare your article }
-It is assumed that you possess basic knowledge of \LaTeX. Unless using \LaTeX\ online (for example via Overleaf.com) ensure that you have \LaTeX2e version installed on your computer. We suggest employing a recent \TeX installation: the most important distribution at the time of writing being MiK\TeX\ 2.9. You are provided with a class file ``oup-authoring-template.cls''. This template can be kept with your manuscript files. Note that the class file depends on the following packages which are standard and are available along with \LaTeX installation:
+\vfill\eject
+
+\section{How to start and prepare your article}
+It is assumed that you possess basic knowledge of \LaTeX. Unless
+using \LaTeX\ online (for example via Overleaf.com) ensure that you
+have \LaTeX2e version installed on your computer. We suggest
+employing a recent \TeX installation. You are provided with a class
+file ``oup-authoring-template.cls''. This template can be kept with
+your manuscript files. Note that the class file depends on the
+following packages which are standard and are available along with
+\LaTeX installation:
\begin{center}\begin{tabular}{|l|l|l|l|l|}\hline
graphicx & multirow & amsmath & amssymb & amsfonts \\\hline
@@ -66,7 +87,7 @@ algorithmicx & algpseudocode & listings & url & crop \\\hline
Apart from the above-listed packages, the following additional packages are used in the class file for providing add-on functionalities to the template:
\begin{center}\begin{tabular}{|c|c|c|c|c|}\hline
-subfloat & subfig & appendix & hyperref & footnote \\\hline
+subfloat & subfig & tikz & hyperref & footnote \\\hline
mathrsfs & natbib & wrapfig & amsthm & apacite \\\hline
\end{tabular}\end{center}
@@ -81,10 +102,15 @@ To learn more about the underlying packages, please read the respective document
Based on your journal style, we would suggest you to use the corresponding sample template file to start your manuscript preparation; other templates available in the package can be removed. Please save a copy of the template file before you start editing the file as per your requirement. These samples contain the lines for calling class files, the preamble area, and the start/end of document where major sample elements required for an article are placed. Comments are included for each element and are self-explanatory. You can add your actual manuscript content in place of these sample elements. The standard structure of each element for an article is explained in detail in the following sections.
-To use OUP authoring template, put all the package files in your working directory, edit the file ``sample template file'' in your preferred text editor, and run \LaTeX\ as usual. The resulting layout is similar but not identical to the layout of the final article.
+To use the OUP authoring template, put all the package files in your
+working directory, edit the file ``sample template file'' in your
+preferred text editor, and run \LaTeX\ as usual. The resulting
+layout is similar but not identical to the layout of the final
+article.
Please note that you are not responsible for any final page layout. It is not necessary (and is even sometimes undesirable) to do any fine-tuning with commands like \verb+\break+, \verb+\pagebreak+, \verb+\vspace+, \verb+\clearpage+, etc. Please use semantic mark-up as far as possible and avoid additional formatting commands.
+\vfill\eject
\section{Package features and some important settings}
@@ -174,12 +200,17 @@ This tag contains two parameters, first one is optional and the second argument
\item The other tags listed below are self-explanatory. Note the `received', `revised' and `accepted' dates are placeholders for the final publication: these can be left blank:
-{\tabcolsep3pt\fontsize{7}{10}\selectfont\begin{tabular}{|l|l|l|l|l|} \hline
-\verb+\orgdiv{. . .}+ & \verb+\orgname{. . .}+ & \verb+\orgaddress{. . .}+ & \verb+\country{. . .}+ & \verb+\postcode{. . .}+ \\ \hline
-\verb+\street{. . .}+ & \verb+\city{. . .}+ & \verb+\state{. . .}+ & \verb+\abstract{. . .}+ & \verb+\keywords{. . .}+ \\ \hline
-\verb+\received{. . .}+ & \verb+\revised{. . .}+ & \verb+\accepted{. . .}+ & & \\ \hline
+{\tabcolsep3pt\fontsize{7}{10}\selectfont\begin{tabular}{|l|l|l|l|l|}
+\hline \verb+\orgdiv{. . .}+ & \verb+\orgname{. . .}+ &
+\verb+\orgaddress{. . .}+ & \verb+\country{. . .}+ &
+\verb+\postcode{. . .}+ \\ \hline \verb+\street{. . .}+ &
+\verb+\city{. . .}+ & \verb+\state{. . .}+ & \verb+\abstract{. . .}+
+& \verb+\keywords{. . .}+ \\ \hline \verb+\received{. . .}+ &
+\verb+\revised{. . .}+ & \verb+\accepted{. . .}+ & & \\ \hline
\end{tabular}}
+\item \verb+\ORCID{...}+-- provide ORCID link with logo inside this tag.
+
\item \verb+\maketitle+---this tag is mandatory to print the front matter elements in the output.
\end{enumerate}
@@ -205,10 +236,13 @@ The template allows four levels of headings in different styles:
\subsection{Mathematical formulae}
-As ``amsmath'' package provides various features for displayed equations and other mathematical constructs and you are strongly encouraged to use the mark-ups provided by this package. If possible, avoid using manual skips to align an equation.
+As the ``amsmath'' package provides various features for displayed
+equations and other mathematical constructs and you are strongly
+encouraged to use the mark-ups provided by this package. If
+possible, avoid using manual skips to align an equation.
\subsection{Figures and Tables}
-The standard interface for graphic inclusion is the \verb+\includegraphics+ command provided by the graphicx package. The ``draft'' option provided by this package locally switches to draft mode, i.e. does not include the graphic, but leaves the correct space, and prints the filename. This option may be used to save the processing time during compilation. Note that the \verb+\graphicspath+ command allows you to declare one or more folders where the graphicx package looks for the image files; hence, it is not necessary to write the path into each \verb+\includegraphics+ command.
+The standard interface for graphic inclusion is the \verb+\includegraphics+ command provided by the graphicx package. The ``draft'' option provided by this package locally switches to draft mode, i.e. does not include the graphic, but leaves the correct space, and prints the filename. This option may be used to save the processing time during compilation. Note that the \verb+\graphicspath+ command allows you to declare one or more folders where the graphicx package looks for the image files; hence, it is not necessary to write the path into each \verb+\includegraphics+ command.
The format used for numbered ``figures/tables'' is similar to the basic \LaTeX\ format:
@@ -285,20 +319,23 @@ To span rotated tables across columns in double column layout:
The default list commands available in \LaTeX\ can be used to set different types of lists:
\begin{enumerate}
-\item numbered: \verb+\begin{enumerate}...\end{enumerate}+
-\item[] first level—Arabic numerals;
-\item[]second level—lowercase alphabet;
-\item[]third level—lowercase roman numerals;
-\item unnumbered: \verb+\begin{unlist}...\end{unlist}+
-\item custom list: \verb+\begin{itemize}...\end{itemize}+
-\item[]first level—bulleted;
-\item[]second level—bulleted.
+\item numbered: \verb+\begin{enumerate}...\end{enumerate}+
+\item[] first level Arabic numerals;
+\item[]second level lowercase alphabet;
+\item[]third level lowercase roman numerals;
+\item unnumbered: \verb+\begin{unlist}...\end{unlist}+
+\item custom list: \verb+\begin{itemize}...\end{itemize}+
+\item[]first level bulleted;
+\item[]second level bulleted.
\end{enumerate}
Nested lists are allowed for numbered and custom lists.
\subsection{Theorem-like environments}
-For theorem like environments, we require ``amsthm'' package. There are three types of predefined theorem styles—thmstyleone, thmstyletwo, and thmstylethree. The below table shows the output details for each style:
+For theorem-like environments, we require the ``amsthm'' package.
+There are three types of predefined theorem styles: thmstyleone,
+thmstyletwo, and thmstylethree. The below table shows the output
+details for each style:
\begin{center}\begin{tabular}{|l|p{22pc}|}
\hline thmstyleone &Numbered, theorem head in bold font and theorem text in italic style\\
\hline
@@ -416,9 +453,9 @@ Revision State & Revision Date & Version Number & Revision History\\
\hline
00 & 16 March, 2020 & Version 1.0 & \\
\hline
+ 01 & 18 March, 2022 & Version 1.1 & \\
+ \hline
\end{tabular}
-
-
\end{document}