summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/practicalreports/practicalreports.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-10-08 03:00:28 +0000
committerNorbert Preining <norbert@preining.info>2019-10-08 03:00:28 +0000
commite5ffc42ed260285f76383ae18dd0f4a603c07fa8 (patch)
tree7d901aebae17ed14f1c9812c9339a88d68dc74e4 /macros/latex/contrib/practicalreports/practicalreports.tex
parentba86549c94b1e8b6b19bc82b01e85a7e513e7586 (diff)
CTAN sync 201910080300
Diffstat (limited to 'macros/latex/contrib/practicalreports/practicalreports.tex')
-rw-r--r--macros/latex/contrib/practicalreports/practicalreports.tex31
1 files changed, 23 insertions, 8 deletions
diff --git a/macros/latex/contrib/practicalreports/practicalreports.tex b/macros/latex/contrib/practicalreports/practicalreports.tex
index de97a6c2f8..4ed5200f25 100644
--- a/macros/latex/contrib/practicalreports/practicalreports.tex
+++ b/macros/latex/contrib/practicalreports/practicalreports.tex
@@ -1,7 +1,6 @@
\documentclass[12pt]{article}
\usepackage[right=1in, top=1in, left=1in, bottom=1in]{geometry}
-\usepackage{amssymb,amsmath, mathtools}
\usepackage[parfill]{parskip}
@@ -13,9 +12,9 @@
\begin{titlepage}
\vspace*{\fill}
\begin{center}
-{\Huge Practical Reports Documentation}\\[0.5cm]
-{\Large Version: 2.0.2}\\[0.4cm]
-{\Large Date: $1^{st}$ of October 2019}\\[0.2cm]
+{\Huge \textbf{practicalreports} Documentation}\\[0.5cm]
+{\Large Version: 2.0.3}\\[0.4cm]
+{\Large Date: $7^{th}$ of October 2019}\\[0.2cm]
{\small Author: Justin Cawood}
\end{center}
\vspace*{\fill}
@@ -30,6 +29,22 @@ This package provides macros for displaying scientific notation, simple title pa
\section{Importing the Package}
Import the package by typing $\backslash$usepackage\{practicalreports\} at the top of the tex file.
+\section{Required Packages}
+All of the below packages are required for the macros within this package. They should be installed when you install this package
+
+\begin{itemize}
+\item \textbf{array}
+\item \textbf{mathtools}
+\item \textbf{longtable}
+\item \textbf{scrextend}
+\item \textbf{float}
+\item \textbf{fancyhdr}
+\item \textbf{lastpage}
+\item \textbf{pdfpages}
+\item \textbf{pdffor}
+\end{itemize}
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Exponent Macro}
@@ -94,12 +109,12 @@ $\backslash$newsfigure\{Caption\}\{Description\}\{file\_ name.jpg\}\{reference\}
\subsubsection{Shrink Example}
\reffigure{example-shrink-figure}, shows an example of decreasing the size of a figure.
-\newsfigure{Example Figure}{Result of using $\backslash$newfigure\{Caption\}\{Description\}\{file name\}\{reference\}\{0.4\}}{example_figure.jpeg}{example-shrink-figure}{0.4}
+\newsfigure{Example Figure}{Result of using $\backslash$newsfigure\{Caption\}\{Description\}\{file name\}\{reference\}\{0.4\}}{example_figure.jpeg}{example-shrink-figure}{0.4}
\subsubsection{Expand Example}
\reffigure{example-expand-figure}, shows an example of increasing the size of a figure.
-\newsfigure{Example Figure}{Result of using $\backslash$newfigure\{Caption\}\{Description\}\{file name\}\{reference\}\{1.6\}}{example_figure.jpeg}{example-expand-figure}{1.6}
+\newsfigure{Example Figure}{Result of using $\backslash$newsfigure\{Caption\}\{Description\}\{file name\}\{reference\}\{1.6\}}{example_figure.jpeg}{example-expand-figure}{1.6}
\subsection{Referencing a Figure}
This macro allows figures to be referenced by simply typing $\backslash$reffigure\{reference\}. If a figure is ever added or removed, this macro will take care of the numbering so the figures are always referenced correctly. An example is shown below.
@@ -313,9 +328,9 @@ Tables can be shifted.
The $\backslash$goodfoot macro will do the footer for you in the form "Page x of n". The page mus be set to fancy first though using the $\backslash$setpagefancy macro.
\subsection{Join Multiple Reports}
-To combine multiple pdf files together into one single pdf file use the macro $\backslash$joinreports\{\}. You don't need the file extension just list all the pdf files that you wish to join as follows.
+To combine multiple pdf files together into one single pdf file use the macro $\backslash$joinpdfs\{\}. You don't need the file extension just list all the pdf files that you wish to join as follows.
-$\backslash$joinreports\{pdf\_1, pdf\_2, pdf\_3, pdf\_4, .....\}.
+$\backslash$joinpdfs\{pdf\_1, pdf\_2, pdf\_3, pdf\_4, .....\}.
This macro should be used in a new tex file because the pdf files will be joined as one file with the name of the tex file this macro is used in.