Some improvements to AUTthesis.cls

ghost commented 5 years ago

I understand that this is not an official repo for AUTthesis.cls and you are just typesetting your own thesis. If your other friends also typeset their theses with this class, please also let them know or even better, if you are in touch with the library of the university, please let them know about this so they can fix things upstream.

Disclaimer You will find my name in AUTthesis.cls but I never took part in writing it. It just turns out that my name was included because I only answered few modest question about xepersian but I had nothing to do with this class in reality.

A few changes needs to be made to make this thesis class up to date with the current state of the xepersian package. At the moment, all these changes is about the file commands.tex

Change number 1

Lines 11 and 12 of the file commands.tex which is

\usepackage{setspace}
\setstretch{1.3}

are unnecessary. This functionality is provided by the xepersian package in a much nicer and cleaner way. Just remove the two lines above, and change line 66 of the same file which is

\usepackage{xepersian}%[extrafootnotefeatures]

to

\usepackage[%
  fontsize={10,13}%
]{xepersian}

This will allow the font size 10pt and base line skip of 13pt. You can change either values to whatever works better for you.

Change number 2

The line 22 in the same file which is

%\usepackage[perpage]{footmisc}

is not needed. Again, this functionality is provided by the package itself. If you ever decide that you want to reset footnote counters per page so that footnotes start from 1 on every page, then change line 66 of the same file which is

\usepackage{xepersian}%[extrafootnotefeatures]

to

\usepackage[%
  perpagefootnote=on%
]{xepersian}

Change number 3

The line 75 which is

%\setdigitfont[Scale=1.1]{PGaramond}

has some issues.

The control sequence \setdigitfont is changed to \setmathdigitfont which will only change digits font in math mode. However, the control sequence \setdigitfont changes digits in both math and text modes;
The use of PGaramond is problematic. This particular font does not contain U+066A. In fact, if you use at least version 22.4 of the xepersian package, it will be checked if the font contain the necessary characters and if not, then you will get an error and be asked to select another font.
If you ever typeset a decimal number like $1.2$ , you will see that in both PGaramond and Yas font, the spacing is quite tight. This is because there was a bug in xepersian package 10 years ago which produced too much space and these fonts were created back then to compensate for this bug but now that there is no bug in the xepersian package, these fonts just give wrong spacing.

So just change line 75 to something like

\setmathdigitfont{IRXLotus}[Scale=1.1]

1995parham commented 5 years ago

Thanks for your points. We have a de-facto repository for our faculty that you have already seen. I can create a repository there for thesis template. What do you think? About the library, I will ask them in the next few days.

ghost commented 5 years ago

I think having an official GitHub repo for the thesis class is critical because once there is a central place, people can report issues there.

I have created a repository here; I will basically rewrite the whole class from scratch using the one provided by the library and when it is ready, I will push it to CTAN so that it makes its way into TeX distributions like TeXLive and MiKTeX. This way, I can update it anytime I make changes to the xepersian package. The copyright owner will still be the university not me.

When it is on CTAN, perhaps we can make the university know.

1995parham commented 5 years ago

Thanks for your works. 🙌

ghost commented 5 years ago

The thesis class provided by the university is quite small so I should finish it by the end of the weekend.

reinnet / RoadToMSc