exaexa / better-mff-thesis Goto Github PK

After a few years, I decided to update the official thesis template. Partly because regulations have changed and the old version does not satisfy them any longer. And partly because the old version is showing its age and using TeX in ancient ways -- e.g., nobody needs non-UTF-8 encodings any more.

Your template attracted my curiosity and if you don't mind, I would like to draw some inspiration from it. I like some of your design decisions (putting metadata to a separate file, switching to biblatex and latexmk), while disliking some other (most of all, the language switches all over the place).

For a moment, I considered merging your changes into my tree, but after pondering on it for a while, I decided to keep my template split to Czech and English version. I think that students outside computer science will still appreciate Czech comments in the source files and Czech file names.

Also, I discussed the licence of the the original template with the other contributors and we decided to publish it under CC-0. This should enable you to choose whatever licence you want (even though I would be in favor of CC-0 too).

Finally, I plan to move the public repository of my template to faculty instance of GitLab to make it easier for students to contribute (compared with my current private repository with a public read-only view). I will be happy to mention your project in my README along with another template by Petr Olšák.

If you have any other idea how to cooperate, please let me know.

Thanks for your work!

It should fail, e.g. by grepping for failedJobs="[^0]" or exceptions.

...
   <name>/__w/bsc-thesis/bsc-thesis/Thesis/thesis.pdf</name>
      </item>
      <taskResult type="VALIDATE" isExecuted="true" isSuccess="false">
        <duration start="1714930315986" finish="1714930417864">00:01:41.878</duration>
        <exceptionMessage>Exception: OutOfMemory caught when validaing item caused by exception: Java heap space</exceptionMessage>
      </taskResult>
      <duration start="1714930315986" finish="1714930417864">00:01:41.878</duration>
    </job>
  </jobs>
  <batchSummary totalJobs="3" failedToParse="0" encrypted="0">
    <validationReports compliant="2" nonCompliant="0" failedJobs="1">3</validationReports>
    <featureReports failedJobs="0">0</featureReports>
    <repairReports failedJobs="0">0</repairReports>
    <duration start="1714930314671" finish="1714930417884">00:01:43.213</duration>
  </batchSummary>
...

✔️

In publications, the standard is to have table captions positioned above, and figure captions below. However, the floatrow package overrides the behavior by always positioning the table caption below.

Possible solution is to add \floatsetup[table]{capposition=top} to thesis.tex. The floatrow package is used in macros.tex for the definition of some caption styles, and also code and code listing, so it cannot be simply removed.

Will make an PR for the optional \floatsetup after the deadline (I'm writing this issue mainly in case somebody else had the same problem as me).

While debugging PDF/A compliance, I noticed that the provided Dockerfile misses some dependencies needed for compiling the template. Most importantly, it lacks latexmk, although there may be other missing packages. The recommended prebuilt image aergus/latex works as expected.

Hi,

due to the new verification profile, I am not able to pass the verification with pdfLatex and the font Libertinus. I know the Makefile and so on use LuaLatex, but I was not aware of that and built the thesis while using pdfLatex on Overleaf and now I need to change, which is highly unpleasant. Also, I ended up using XeLaTeX in the end.

I suggest highlighting the need to use LuaLaTeX (or XeLaTeX) in the readme.

Thanks,
Peter

After using this thesis template, I got feedback from my Reviewer regarding the bibliography style; I set out to discover the requirements prescribed by MFF and found a potential conflict. This applies to both Czech and English language versions.
[Czech language details only]

Problém

Oponent (Fyzika) mi (u anglicky psané práce) vytkl, že v bibliografii, nejsou uvedena všechna jména autorů ale jsou zkracovány na et al..
Prošel jsem vnitřní předpisy fakulty, a myslím si, že existuje argument pro to, že je citační styl jasně definován jako "ten styl obsažený v oficiální šabloně".

Relevantní dokumenty

Konkrétní citační styl není explicitně definován ani ve Směrnici děkana (SD) č. 1/2015 ani v
SD č. 4/2019.

SD č. 4/2019 však obsahuje článek 4.2:

Typografická úprava závěrečné práce musí odpovídat šabloně, která definuje požadovanou úpravu závěrečné práce. Tato šablona ve formátu RTF/LaTeX a ukázka jejího použití ve formátu PDF/A je studentům k dispozici ke stažení na webových stránkách fakulty.

Oficiální TeXová šablona, tak jak je nakonfigurovaná v angličtině, tiskne všechna jména autorů (i 6+).
Česká rtf šablona obsahuje:

Povinnou citační normou pro bakalářskou práci je ISO 690,

Anglická rtf šablona pak:

A recommended citation standard for the bachelor thesis is ISO 690.

Podle referenčního stylu ISO 690:2021 se autoři mohou zkracovat jako "et. al." [sic!] nebo "and others" pro 6 a více autorů.

Situace je tedy značně nejednotná a nejasná. Existuje ale podle mě validní interpretace, že pro práce sázené v LaTeXu je podle SD č. 4/2019 je natbib plainnat/ czplainnat styl bibliografie a citací závazný.

Návrh řešení

• Změnit šablonu tak, aby tisk všech autorů byl defaultní chování (minimálně do doby než se situace vyjasní).
• Iniciovat diskusi na úrovni vedení fakulty o upřesnění a lepší specifikaci "tvrdých" požadavků na úpravu kvalifikačních prací, neboť současná situace, kdy jsou studenti odkázáni na šablony, kde se mísí doporučené a nutné požadavky, navíc zcela nekonzistentně, není žádoucí.

PS:

Určitě při řešení problému rád pomohu, ale nevím, na koho se obrátit, aby došlo k pozitivnímu posunu.
Rozhodně bych nerad, aby to vyústilo v deklaraci, že jiné, než oficiální šablony nejsou přípustné.
Better-mff-thesis mi ušetřila mnoho šedivých vlasů.
Studuji zároveň PFUK a "právní" analýza problému pochází čistě ode mě.

I think that the type of this repository could be changed to a GitHub's "template repository".

This allows usage of this template without forking the entire repository including all past commits, does not show the fork's commits in the original repo's contribution graph etc. More information about GitHub's template repos including all differences may be found here and here.

In short, repositories derived from the "templates" are more independent of the original repo. I think that the GitHub's description pretty much satisfies the goals of this repository.

Thanks in advance for consideration of this change.