Skip to content

Beta Release of V2

Pre-release
Pre-release
Compare
Choose a tag to compare
@ES-Alexander ES-Alexander released this 14 Apr 02:02
· 49 commits to master since this release

WARNING: This release is not backwards-compatible due to modifications of pre-existing referencing commands.

Introducing a modified referencing system and simplified basic table functionality.

File Inclusion

Changed the default setup file inclusions to be absolute referenced rather than relative. This means the repo can be stored in one location and only the template files and image/code folders need to be duplicated and moved.

This presently must be set up manually - please update the file-paths as appropriate when you clone/download the repo, as the location of your LaTeX templates folder will likely not be the same as mine.

Labels/References

Sections, figures, code, and tables are now auto-labelled, and are referenced by their names/caption names using specific referencing commands. For figures and code where a file is inputted, references are by filename rather than caption.

Normal Referencing

\tabref{table_caption} --> Table N
\figref{figure_filename} --> Figure N
\figref[s]{subfigure_filename} --> Figure a)
\secref{section_name} --> Section N
\secref[s]{subsection_name} --> Section N.M
\secref[ss]{subsubsection_name} --> Section N.M.L
\coderef{listing_caption} --> Listing N (if typed inputted code)
\coderef{listing_filename} --> Listing N (if inputted code file using \python or \matlab)
\appref{appendix_name} --> Appendix A
\appref[s]{appendix_subsection_name} --> Appendix A.B
\appref[ss]{appendix_subsubsection_name} --> Appendix A.B.C

Just The Number

\reftab{table_caption} --> N
\reffig{figure_filename} --> N
\reffig[s]{subfigure_filename} --> a)
\refsec{section_name} --> N
\refsec[s]{subsection_name} --> N.M
\refsec[ss]{subsubsection_name} --> N.M.L
\refcode{listing_caption} --> N (if typed inputted code)
\refcode{listing_filename} --> N (if inputted code file using \python or \matlab)
\refapp{appendix_name} --> A
\refapp[s]{appendix_subsection_name} --> A.B
\refapp[ss]{appendix_subsubsection_name} --> A.B.C

Sections/Appendices

To achieve automatic labelling of sections and appendices, append an 'l' to the standard section commands, and an 'al' for appendix sections (e.g. \sectionl{Section Name} instead of \section{Section Name}, and \subsectional{Appendix Subsection} instead of \subsection{Appendix Subsection}).

Easier Basic Tables

The following commands have been added for simplification purposes
\easytable{Table Name}{Column Styles}{Contents}
\row --> \\\\ \hline
\headingrow --> \hline\rowcolor{tableHeadColour}

e.g.

\easytable{My Table}{|c|p{0.25\linewidth}|}{
  \headingrow \textbf{Column 1} & \textbf{Column 2} \row
  \textbf{Side Heading} & data 1 \row
  \textbf{Side Heading 2} & data 2 \row
}