From ecbaadcc88ae38adb34e08755459318372ec13b8 Mon Sep 17 00:00:00 2001
From: Mohammad Akhlaghi <mohammad@akhlaghi.org>
Date: Tue, 12 Jan 2021 16:15:47 +0000
Subject: Default LaTeX preamble: some packages moved to preamble-project.tex

Until now, important LaTeX packages like 'caption' (for managing figure
captions), 'hyperref' (for managing links) and 'xcolor' (for managing
colors) were being loaded inside the optional
'tex/src/preamble-maneagge-defualt-style.tex' file. We recommend to remove
this file from loading when you use custom journal sytels. However, these
packages will often be necessary after loading special journal styles also.

With this commit, these packages are now loaded into LaTeX as part of the
'tex/src/preamble-project.tex' file. This file is in charge of LaTeX
settings that are custom to the project and independent of its style.

Several other small corrections are made with this commit:

 - I noticed that './project make texclean' crashes if no PDF exists in the
   working directory! So a '-f' was added to the 'rm' command of the
   'texclean' rule.

 - As part of the LaTeX Hyperref, we can set general metadata or properties
   for the PDF (that aren't written into the printable PDF, but into the
   file metadata). They can be viewed in many PDF viewers as PDF
   properties. Until now, we were only using the '\projecttitle' macro here
   to write the paper's title. However, thanks to the recently added
   'reproduce/analysis/config/metadata.conf', we now have a lot of useful
   information that can also go here. So the 'metadata-copyright-owner' is
   now used to define the PDF author, and the project's
   'metadata-git-repository' and commit hash are written into the PDF
   subject. But to import these, it was necessary to define them as LaTeX
   macros, hence the addition of these macros in 'initialize.mk'.

 - Some extra packages that aren't necessary to build the default PDF were
   removed in 'preamble-project.tex'.
---
 tex/src/preamble-project.tex | 54 ++++++++++++++++++++++++++++++++------------
 1 file changed, 39 insertions(+), 15 deletions(-)

(limited to 'tex/src/preamble-project.tex')

diff --git a/tex/src/preamble-project.tex b/tex/src/preamble-project.tex
index 2a3dd0e..98e797d 100644
--- a/tex/src/preamble-project.tex
+++ b/tex/src/preamble-project.tex
@@ -24,27 +24,51 @@
 
 
 
-%% Packages you need in your project
-%% ---------------------------------
+%% Packages you may need in your project
+%% -------------------------------------
 %
 %% Here you can add/remove any custom LaTeX package that you need for this
 %% project that aren't provided by the journal's style.
 
-% Better than verbatim for displaying typed text.
-\usepackage{alltt}
-
-% For arithmetic opertions within LaTeX
-\usepackage[nomessages]{fp}
-
-%To add a code font to the text:
-\usepackage{courier}
-
-%To add some enumerating styles
-\usepackage{enumerate}
-
-%Including images if necessary
+%% For loading images into the output (with '\includegraphics').
 \usepackage{graphicx}
 
+%% Ordering correction between 'figure' and 'figure*' ('figure*' is
+%% commonly used in two-column documents, where the figure should span both
+%% columns).
+\usepackage{fixltx2e}
+
+%% Color management.
+\usepackage{xcolor}
+\color{black} % Color of main text.
+\definecolor{DarkBlue}{RGB}{0,0,90}
+
+%% Caption management: The `setspace' package defines the `stretch'
+%% variable. `abovecaptionskip' is the distance between the figure and the
+%% caption. You can use 'captionof{figure}{...}' to use these custom
+%% 'figure' caption that is defined here.
+\usepackage{setspace, caption}
+\captionsetup{font=footnotesize, labelfont={color=DarkBlue,bf}, skip=1pt}
+\captionsetup[figure]{font={stretch=1, small}}
+\setlength{\abovecaptionskip}{3pt plus 1pt minus 1pt}
+\setlength{\belowcaptionskip}{-1.25em}
+
+%% Manage links in the produced paper (for example their colors), and
+%% include document information in the "Properties" of the PDF.
+\usepackage[
+  colorlinks,
+  urlcolor=blue,
+  citecolor=blue,
+  linkcolor=blue,
+  linktocpage]{hyperref}
+\renewcommand\UrlFont{\rmfamily}
+\hypersetup{
+    pdftitle={\projecttitle},
+    pdfauthor={\projectcopyrightowner},
+    pdfsubject={\projectgitrepo{} (commit \projectversion)},
+    pdfkeywords={Reproducible research, Maneage, ADD YOUR OWN}
+}
+
 
 
 
-- 
cgit v1.2.1

