skilkis / tudelft-light Goto Github PK

tudelft-report.cls

Currently the background header_fill is hardcoded to tudelft-black. This needs to be changed to be conditional based on whether the light or dark mode is selected.

Currently abbreviations are not handled well using the nomencl package. The pros/cons of switching the glossaries package should be logged here.

Using \\ to create vertical space between paragraphs is bad practice according to 1. Therefore, it should be avoided and instead the \parskip length should be redefined in the template

https://opensource.org/licenses/LPPL-1.3c

Currently the class file hard-codes the bibliography file to references.bib which is not a desirable behavior. Instead the glob option of \addbibresource can be used.

Option to reduce margins on the outside of pages (non-binding side) instead of symmetric margins on inside and outside of the page. This would allow slightly more space for text and wide tables/images and reducing page count.

Using \include to add chapters results in an .aux file generated per chapter. This is beneficial when used with the \includeonly command that can render only the documents that one passes as arguments to that macro while keeping all of the required references intact without errors [1]. Another benefit to using \include over \import is the ability for the VS Code LaTeX extension to generate a report structure while writing.

Some professional prints show a text label in the page number field of the PDF:

The header logo text is written in black and is not visible in dark mode. A potential fix is to use the currentColor option in the SVG file.

Some useful packages for formatting LaTeX documents demonstrated in the examples can be helpful for users to get started. It should be decided what is the best way to include these in the template as too many packages included in the default package list could quickly get out of hand.

List of useful packages

• wrapfig

The error generated by TeXLive 2020 is as follows as per GitHub Actions:

/opt/texlive/texdir/texmf-dist/tex/latex/fontspec/fontspec-xetex.sty:479: LaTeX
 Error: The font size command \normalsize is not defined:
               there is probably something wrong with the class file.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...                                              

Upon inspection this is caused by tudelft-light/report.cls calling LoadClass on report.cls which leads to a namespace conflict. Furthermore, as a result, the \normalsize macro is never loaded from the LaTeX standard library report class file.

Adding \cdot as product to \si commands for better readability?

\sisetup{
inter-unit-product=\ensuremath{{\cdot}},
}

By moving everything in the tudelft-light directory to the main repository directory, the template itself could be directly used in other Git repositories as a sub-module. The pros/cons of doing this should be investigated and documented.

something as discussed here:
https://tex.stackexchange.com/questions/525921/ideas-for-presenting-the-research-question

something like this:

\newlist{questions}{enumerate}{2}
\setlist[questions,1]{label=\bf{RQ-\arabic*.},ref=RQ-\arabic*, leftmargin=*}
\setlist[questions,2]{label*=\indent \bf{\arabic*.},ref=\thequestionsi.\arabic*}
\let\origitem\item
\renewcommand{\item}{\normalfont\origitem}
\newcommand{\question}{\normalfont\origitem\em}
\crefname{questionsi}{research question}{research questions}
\crefname{questionsii}{research sub-question}{research sub-questions}

The current cover page that was generated with Adobe InDesign can be translated to TikZ due to it's simplicity. Make sure to include a version for light and dark backgrounds.

• Create \makecover command
• Add ability to position background picture
• Use correct TU-Delft Light font
• Add ability to rotate and scale background picture
• Add ability to switch between light and dark theme
• Add ability to change header background opacity (alpha)
• Correct date format with datetime package
• Document all makecoveroptions

Change \caption{a caption} to \caption[caption to show in list of tables/figures]{caption shown in document} so references and citations don't show up in the list.

Currently the PDF shows "Title" in the PDF number field of the compiled document wheras it should say "ToC"

The nomenclature grouping has a strange naming convention when it comes to the Roman symbols. It would make more sense to change it to use "R" instead of "B". This would however be a breaking change, and it is not clear how to deprecate use of the "B" nomenclature group without breaking backwards compatibility now.

Right now the nomenclature only allows units.
It would be nice to be able to also input values for listing constants, but right now this is not possible.
Alternatively, a separate nomenclature commance for constants which takes 2 arguments: value and unit.

The macro should take key, value pairs where the key is the abbreviation for a chapter in the front matter and the key is the name for that chapter. An example of the usage would be as follows:

\frontmatter{%
    toc=Table of Contents,
    los=List of Symbols,
    lof=List of Figures,
}

The key, value pairs should be false by default such that when they are omitted that section of the frontmatter is not created.

The declaration of an alternate geometry in the report.cls file when the twoside option is used prevents the user from
modifying the default geometry using the \PassOptionsToPackage macro. This is detrimental towards keeping the template as easily configurable as possible.

Testing can be handled by using the new l3build package

The setup.sty package deals with setting up the metadata of the document. However, the name "setup" is ambiguous and could be changed to "metadata" to be more descriptive.

Ability to set the maximum amount of lines the outer cover title may use and changes font size accordingly.
Disable word splitting when wrapping text.