Debian Codegraph @

texmf-dist/source/latex/muling/muling.dtx

raw
1 % \iffalse meta-comment
2 %
3 % File: muling.dtx
4 % ----------------------------------------------------------
5 % Class: muling
6 % Author: निरंजन
7 % Description: A class file for the Department of
8 % Linguistics University of Mumbai
9 % Repository: https://git.gnu.org.ua/marathi.git
10 % Bugs: https://puszcza.gnu.org.ua/bugs/?group=muling
11 % Licenses: GPLv3+, GFDLv1.3+
12 % ----------------------------------------------------------
13 % LaTeX Package muling v0.5
14 % Copyright © 2020, 2021, 2023 निरंजन
15 %
16 % This program is free software: you can redistribute it
17 % and/or modify it under the terms of the GNU General Public
18 % License as published by the Free Software Foundation,
19 % either version 3 of the License, or (at your option) any
20 % later version.
21 %
22 % This program is distributed in the hope that it will be
23 % useful, but WITHOUT ANY WARRANTY; without even the implied
24 % warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
25 % PURPOSE. See the GNU General Public License for more
26 % details.
27 %
28 % You should have received a copy of the GNU General Public
29 % License along with this program. If not, see
30 % <https://www.gnu.org/licenses/>.
31 % ---------------------------------------------------------
32 % arara: lualatex
33 % arara: lualatex
34 % arara: clean: {
35 % arara: --> extensions: [
36 % arara: --> log,aux,glo,idx,ist,
37 % arara: --> out,toc,hd
38 % arara: --> ]
39 % arara: --> }
40 % ---------------------------------------------------------
41 % \fi
42 % \iffalse
43 %<*internal>
44 \iffalse
45 %</internal>
46 %<*readme>
47 -----------------------------------------------------------
48 Class: muling
49 Author: निरंजन
50 Version: 0.5 (2 April, 2023)
51 Description: A class file for the Department of
52 Linguistics, University of Mumbai
53 Repository: https://git.gnu.org.ua/muling.git
54 Bug tracker: https://puszcza.gnu.org.ua/bugs/?group=muling
55 License: GPLv3+, GFDLv1.3+
56 -----------------------------------------------------------
57 %</readme>
58 %<*internal>
59 \fi
60 %</internal>
61 %<*driver>
62 \documentclass{l3doc}
63 \usepackage{xcolor}
64 \usepackage{leipzig}
65 \usepackage{fontspec}
66 \newfontfamily{\sho}[%
67 Script = {Devanagari},%
68 Scale = {0.8}%
69 ]{Shobhika}
70 \usepackage{fontawesome5}
71 \usepackage{gfdl}
72 \colorlet{myblue}{blue!60!black}
73 \colorlet{myred}{red!60!black}
74 \colorlet{mygreen}{green!60!black}
75 \hypersetup{%
76 unicode,%
77 colorlinks,%
78 linkcolor = {myred},%
79 citecolor = {mygreen},%
80 urlcolor = {myblue},%
81 pdftitle = {The muling package},%
82 pdfauthor = {निरंजन},%
83 pdfcreator = {निरंजन},%
84 pdfsubject = {%
85 A convenient LaTeX class for the masters students of
86 linguistics at the department of linguistics, university
87 of Mumbai%
88 },%
89 pdfkeywords = {%
90 LaTeX, Mumbai University, Thesis%
91 }%
92 }
93 \gfdlcopyrightholders{%
94 \texorpdfstring{{\sho निरंजन}}%
95 {निरंजन}%
96 }
97 \gfdlcopyrightdescription{%
98 \texorpdfstring{The \LaTeX\ package \pkg{muling}}%
99 {The LaTeX package muling}%
100 }
101 \gfdlcopyrightableyears{2020, 2021, 2023}
102
103 \begin{document}
104 \DocInput{muling.dtx}
105 \end{document}
106 %</driver>
107 % \fi
108 % \title{The \cls{muling} class}
109 % \author{{\sho निरंजन}}
110 % \date{^^A
111 % Version 0.5---2 April, 2023\\[1ex]^^A
112 % {^^A
113 % \small\faIcon{link}\quad
114 % \url{https://ctan.org/pkg/muling}^^A
115 % }\\^^A
116 % {^^A
117 % \small\faIcon{bug}\quad
118 % \url{https://puszcza.gnu.org.ua/bugs/?group=muling}^^A
119 % }^^A
120 % }
121 %
122 % \maketitle
123 %
124 % \begin{abstract}
125 % This is a class-file written for the students of the
126 % Department of Linguistics, University of Mumbai. It
127 % uses the standard layout prescribed by the university,
128 % loads some necessary packages for typesetting a thesis
129 % in linguistics \textit{\&} adds the declaration needed
130 % by the university from the submitter.
131 % \end{abstract}
132 %
133 % \tableofcontents
134 %
135 % \newpage
136 %
137 % \begin{documentation}
138 % \section{Provisions}
139 %
140 % With this class, a few essential packages are already
141 % loaded. If you have a full installation of \TeX\ Live
142 % 2023 (or later), you should be able to compile everything
143 % without any problem. This package has the following
144 % provisions which will make the thesis-writing easier.
145 %
146 % \begin{enumerate}
147 % \item With this class, we load the |NewCM10-Regular.otf|
148 % font which is a fork of Latin Modern with extended
149 % support for Unicode IPA. Using this font enables us to
150 % print IPA directly from the input text. An additional
151 % advantage of using this font is that it matches with the
152 % TIPA typeface exactly. So whether you use Unicode or
153 % TIPA visually won't make any difference.
154 % \item The class pre-loads the following packages commonly
155 % used in linguistics.
156 % \begin{description}
157 % \item[\pkg{leipzig}:] Used for inter-linear glossing.
158 % Using |\Nom| will produce \Nom. While glossing, it is
159 % advised that you use these macros so that all of them
160 % get printed correctly with the |\printglossary|
161 % command pre-loaded by the class. Of course you will be
162 % required to compile the code with the |makeglossaries|
163 % program.
164 % \item[\pkg{biblatex}:] Used for citations. The |apa|
165 % style, required by the department, is used by default.
166 % \item[\pkg{forest}:] Used for syntactic trees.
167 % \item[\pkg{expex}:] Used for finest typesetting of
168 % linguistic examples.
169 % \item[\pkg{csquotes}:] For quoting text. One can use
170 % \cs{enquote}\marg{some text} to produce
171 % \emph{\enquote{some text}}.
172 % \end{description}
173 % \end{enumerate}
174 %
175 % It is advised that you use the following order on a bash
176 % terminal for compiling your code:
177 %
178 % \medskip
179 % \begin{minipage}{\linewidth}
180 % \begin{verbatim}
181 % lualatex document # for Unicode text
182 % biber document # for citations
183 % makeglossaries document # for glossaries
184 % lualatex document
185 % lualatex document
186 % \end{verbatim}
187 % \end{minipage}
188 %
189 % \medskip
190 % If you use \pkg{arara}, then you can use the following
191 % code somewhere in your document and just compile the code
192 % with \pkg{arara}.
193 %
194 % \medskip
195 % \begin{minipage}{\linewidth}
196 % \begin{verbatim}
197 % % arara: lualatex
198 % % arara: biber
199 % % arara: makeglossaries
200 % % arara: lualatex
201 % % arara: lualatex
202 % \end{verbatim}
203 % \end{minipage}
204 %
205 % \section{Package macros}
206 %
207 % This package has the following commands.
208 %
209 % \begin{function}{\subtitle}
210 % \begin{syntax}
211 % \cs{subtitle}\marg{a subtitle}
212 % \end{syntax}
213 % The subtitle is printed exactly under the title on the
214 % title-page.
215 % \end{function}
216 %
217 % \begin{function}{\shorttitle}
218 % \begin{syntax}
219 % \cs{shorttitle}\marg{a short title}
220 % \end{syntax}
221 % The short title is printed on the top right corner of
222 % the page with the year of submission.
223 % \end{function}
224 %
225 % \begin{function}{\supervisor}
226 % \begin{syntax}
227 % \cs{supervisor}\marg{name of the supervisor}
228 % \end{syntax}
229 % Name of the supervisor is printed on the title-page, in
230 % the declaration text and under the name of the
231 % supervisor for the signature.
232 % \end{function}
233 %
234 % \section{Package options}
235 %
236 % \begin{function}{digital}
237 % This package option is developed for getting a read-only
238 % version of the thesis. By default the thesis is
239 % formatted as a print-ready document as the per the
240 % university requirements. If you want to submit a digital
241 % copy of the thesis, use this option.
242 % \end{function}
243 %
244 % \begin{function}{lof}
245 % This package option is developed for getting a list of
246 % figures after the list of tables. Every thesis might not
247 % need a list of figures, therefore it isn't added by
248 % default.
249 % \end{function}
250 %
251 % \section{Example code}
252 %
253 % Try this sample document.
254 %
255 % \begin{verbatim}
256 % \documentclass[digital,lof]{muling}
257 % \title{Linguistic profile of Konkani}
258 % \author{Niranjan}
259 % \supervisor{Dr.\ Renuka Ozarkar}
260 % \shorttitle{Konkani}
261 % \subtitle{%
262 % Phonological \& morphological description of the Konkani
263 % language%
264 % }
265 %
266 % \begin{document}
267 % \maketitle
268 %
269 % \chapter{Test chapter}
270 % \pex
271 % Department of linguistics
272 % \xe
273 %
274 % \begin{center}
275 % \begin{forest}
276 % [NP%
277 % [\head{N}\\
278 % Department%
279 % ]%
280 % [PP%
281 % [\head{P}\\%
282 % of%
283 % ]%
284 % [NP%
285 % [\head{N}\\%
286 % linguistics%
287 % ]%
288 % ]%
289 % ]%
290 % ]%
291 % \end{forest}
292 % \end{center}
293 % \end{document}
294 % \end{verbatim}
295 % \end{documentation}
296 %
297 % \begin{implementation}
298 % \section{Implementation}
299 % \begin{macrocode}
300 %<*class>
301 % \end{macrocode}
302 % \begin{macrocode}
303 \ProvidesClass{muling}[2023/04/02 v0.5
304 Department of Linguistics, University of Mumbai]
305 \DeclareOption{digital}{\PassOptionsToClass{oneside}{book}}
306 \newif\iflof
307 \DeclareOption{lof}{\loftrue}
308 \ProcessOptions
309 \iflof
310 \def\@printlof{%
311 \thispagestyle{empty}%
312 \phantomsection
313 \addcontentsline{toc}{section}{List of figures}%
314 \listoffigures
315 \clearpage\pagebreak
316 }%
317 \else
318 \let\@printlof\@empty
319 \fi
320 \LoadClass{book}
321 % \end{macrocode}
322 % This part of code loads the \cls{book} class \textit{\&}
323 % provides the option \verb|digital| for typesetting a
324 % document with read-only format \textit{\&} option
325 % \verb|lof| for automatically adding list of
326 % figures. \href{https://topanswers.xyz/tex?q=1500#a1728}{Phelype's
327 % answer} helped me for developing this code.
328 % \begin{macrocode}
329 \let\@supervisor\@empty
330 \def\supervisor#1{%
331 \def\@supervisor{#1}%
332 }
333 \let\@shorttitle\@empty
334 \def\shorttitle#1{%
335 \def\@shorttitle{#1}%
336 }
337 \let\@subtitle\@empty
338 \def\subtitle#1{%
339 \def\@subtitle{#1}%
340 }
341 % \end{macrocode}
342 % This code enables three additional entries required in the
343 % title-page \& in the declaration \textit{\&} at various
344 % other places.
345 % \begin{macrocode}
346 \RequirePackage{csquotes}
347 \RequirePackage[backend=biber,style=apa]{biblatex}
348 \RequirePackage[linguistics]{forest}
349 \RequirePackage{tipa}
350 \RequirePackage{leipzig}
351 \RequirePackage{expex}
352 \RequirePackage{fancyhdr}
353 \RequirePackage{fontspec}
354 \RequirePackage{hyperref}%
355 \makeglossaries
356 \setmainfont[%
357 % Courtesy: https://topanswers.xyz/tex?q=3042#a3083
358 IgnoreFontspecFile,%
359 StylisticSet = {5},%
360 Renderer = {Harfbuzz},%
361 ItalicFont = {NewCM10-Italic.otf},%
362 BoldFont = {NewCM10-Bold.otf},%
363 BoldItalicFont = {NewCM10-BoldItalic.otf},%
364 SmallCapsFeatures = {%
365 % Courtesy: https://tex.stackexchange.com/a/107246
366 Numbers = {Lining,Monospaced},%
367 Letters = {SmallCaps}%
368 }%
369 ]{NewCM10-Regular.otf}
370 \pagestyle{fancy}
371 \cfoot{\thepage}
372 \rhead{}
373 \lhead{%
374 \begin{tabular}{l}%
375 \@author\\%
376 \textsc{%
377 \footnotesize University of Mumbai%
378 }%
379 \end{tabular}%
380 \hfill
381 \@shorttitle, \the\year
382 }%
383 \AddToHook{begindocument/before}{%
384 \colorlet{mulingred}{red!60!black}
385 \colorlet{mulinggreen}{green!60!black}
386 \colorlet{mulingblue}{blue!60!black}
387 \hypersetup{%
388 unicode,%
389 colorlinks,%
390 linkcolor = {mulingred},%
391 citecolor = {mulinggreen},%
392 urlcolor = {mulingblue},%
393 pdftitle = {\@title},%
394 pdfauthor = {\@author},%
395 pdfcreator = {\@author},%
396 pdfsubject = {\@subtitle},%
397 pdfkeywords = {\@shorttitle}%
398 }%
399 }
400 % \end{macrocode}
401 % This part of code loads some other essential packages for
402 % typesetting documents with linguistic content \textit{\&}
403 % the name of the author, the name of the university and a
404 % short-title with the year of submission at the top right
405 % corner of every page.
406 % \href{https://tex.stackexchange.com/a/525452/174620}^^A
407 % {This} answer helped me for developing this code.
408 % \begin{macrocode}
409 \newlength{\shift}
410 \setlength{\shift}{0.3in}
411 % \end{macrocode}
412 % A new length is created for typesetting the title-page at
413 % the center of the page like in the \cls{article}
414 % class. \href{https://tex.stackexchange.com/a/514536/174620}%
415 % {This} answer helped me for developing this code.
416 % \begin{macrocode}
417 \renewcommand{\maketitle}{%
418 \thispagestyle{empty}%
419 \addtolength{\oddsidemargin}{\shift}%
420 \fboxsep3em
421 \noindent\fbox{%
422 \begin{minipage}%
423 [c][\dimexpr\textheight-2\fboxsep-2\fboxrule]%
424 [c]{\dimexpr\linewidth-2\fboxsep-2\fboxrule}%
425
426 \begin{center}%
427 \bigskip
428 \hrule
429 \vspace{2ex}%
430 \textbf{%
431 {\LARGE \@title}\\%
432 \vspace{0.2cm}%
433 {\textsc\@subtitle}%
434 }%
435 \vspace{2ex}%
436 \hrule
437 \vfill
438 {%
439 \large
440 \textsc{%
441 \@author
442 }%
443 }\\%
444 \vspace{0.5in}%
445 {%
446 \large
447 \textsc{%
448 Supervisor: \@supervisor
449 }%
450 }\\%
451 \vspace{0.5in}%
452 {%
453 \large
454 \textsc{%
455 A dissertation submitted in\\ the partial
456 fulfillment of the requirements for the masters
457 of linguistics%
458 }%
459 }\\%
460 \vspace{0.5in}%
461 \textsc{%
462 Department of Linguistics\\%
463 University of Mumbai, Kalina%
464 }\\%
465 \smallskip
466 \bigskip
467 \textsc{\@date}%
468 \end{center}%
469 \end{minipage}%
470 \addtolength{\oddsidemargin}{-\shift}%
471 }
472 \clearpage\pagebreak
473 \thispagestyle{empty}%
474 \tableofcontents
475 \clearpage\pagebreak
476 \thispagestyle{empty}%
477 \phantomsection
478 \addcontentsline{toc}{section}{Abbreviations}%
479 \printglossary[style=mcolblock]
480 \clearpage\pagebreak
481 \thispagestyle{empty}%
482 \phantomsection
483 \addcontentsline{toc}{section}{List of tables}%
484 \listoftables
485 \clearpage\pagebreak
486 \thispagestyle{empty}%
487 \phantomsection
488 \begin{center}%
489 {%
490 \LARGE
491 Declaration%
492 }
493 \end{center}%
494
495 \bigskip
496 As required by the University Regulation no.: R.\ 1972 I
497 wish to state that the work embodied in this thesis
498 titled \enquote{\@title: \@subtitle{}} forms my own
499 contribution to the research work carried out under the
500 guidance of \@supervisor{} at the University of Mumbai.
501
502 This work has not been submitted for any other
503 degree of this or any other university. Whenever
504 references have been made to previous works of others,
505 it has been clearly indicated as such and included in
506 the bibliography.
507
508 \bigskip
509 \flushright{%
510 Date: \@date\\%
511 \vspace{0.5in}%
512 }%
513
514 \noindent Signature of the candidate:\\%
515 \hfill Name: \@author
516 \\%
517
518 \bigskip
519 \flushleft{%
520 Certified by:\\%
521 \vspace{0.5in}%
522 Signature of the guide:\\%
523 Name: \@supervisor
524 }%
525 }%
526 % \end{macrocode}
527 % This code typesets a customized title-page, adds a table
528 % of contents, list of tables\footnote{Having a list of
529 % figures is optional as seen earlier.} and the declaration
530 % text with all the details filled \textit{\&} some blank
531 % space left for the signature.
532 % \begin{macrocode}
533 %</class>
534 % \end{macrocode}
535 % \end{implementation}
536 % \Finale