ekspek / ist-thesis Goto Github PK

A basic thesis example should be added with complete sections and examples for all the different implemented features like the cover and basic examples of implementations of other features, such as math, figures, tables, plots, glossaries, bibliography.

This thesis example should be written as generic as possible, using lorem ipsum text and other variants.

An extra possible feature is the implementation of an external cover as defined at the end of page 3 of this document.

Essentially, the original document cover needs to be complemented with a spine that must contain specific data as mentioned in the linked document. This can be implemented additionally using the class file and the macros used to make the original cover.

Some changes need to be made to the personnel listing on the cover.

• Supervisors can be singular or plural, cover needs to account for both cases either manually or automatically
• Thesis supervisors != supervisors in the jury, cover needs another variable

Write and compile a full documentation of the class file.

The README file needs to be translated to english for any foreign students looking to make use of the class file. While the main page should show the portuguese version, the english could be linked right at the start.

Although it's a mighty lot to ask, the next step is adding an english translation of the documentation for any foreign students who might need it.

Add a basic cover implementing all the information listed in section 1.2 of this document.

Ideally, this cover could be implemented using a separate \makecover command, and all its data could be filled using separate macros.

Following up on my comment in #16 I think it makes sense to add the possibility of not including a cover image at all.

In my document what I did was \setcoverimage[0]{IST_A_CMYK_POS.pdf} to have an image with 0 width, i.e. no image shows up at all.
IMO, the least one could do is to make a note in the docs that a user can pretend to not include any cover image by doing what I did. The next step would be to have the class not include an image by default and the icing on the cake would be for the class to adjust vertical spacing slightly if no image is included. (Again, IMO I don't even think the spacing is that awkward with no image, just slightly unbalanced.)

For thesis written in english by portuguese students, it is usual to have the abstract written in both languages.
The tabstract environment currently uses the document language. Suggest to take an optional parameter to configure the language for that environment only, which can default to the document main language.
The following should be possible:

\begin{tabstract}{english}{Keyord1, Keyword2}
    My abstract in english.
\end{tabstract}

\begin{tabstract}{portuguese}{Palavra-chave 1, Palavra-chave 2}
    O meu resumo em português.
\end{tabstract}

The main README file should include basic directions on what to download, the current state of the class file and directions to the available documentation.

The thesis example is still missing some special pre- and post-main text pages, which I'm still not entirely familiar with the workings of. The full list of special pages is

• Glossary
• Nomenclature
• List of symbols
• Index
• Bibliography

The most notable special page here is the bibliography, which is already included in the thesis example but not in the class file itself.

More important than working on implementing the features above is debating which ones are actually necessary, and within those which ones can be implemented into the class file and which ones are better left to the thesis example alone. This will depend on the difficulty of implementation and usage and should be fully thought through.

Using more than one author with the \setauthor command (separating them using \tand) currently breaks \makecover, which denounces a misplaced alignment tab. Will look further into it when I have time.