summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/muling/muling.dtx
blob: e7a5ccf9d1911c4374e6fef69d25945fc9014cf4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
% \iffalse meta-comment
%
% File: muling.dtx
% ---------------------------------------------------------------------------
% Class:        muling
% Author:       Niranjan
% Description:  A class file for the Department of Linguistics, University of
%               Mumbai
% Repository:   https://gitlab.com/niranjanvikastambe/muling
% Bug tracker:  https://gitlab.com/niranjanvikastambe/muling/-/issues
% License:      The LaTeX Project Public License v1.3c or later.
% ---------------------------------------------------------------------------
% This work may be distributed and/or modified under the conditions of the 
% LaTeX Project Public License, either version 1.3c of this license or (at 
% your option) any later version.
% 
% The latest version of this license is in
% 
%     http://www.latex-project.org/lppl.txt.
% 
% This work has the LPPL maintenance status `maintained'.
% 
% The Current Maintainer of this work is Niranjan.
% 
% This work consists of the files muling.dtx
%                                 muling.ins
% and the derived file            muling.cls.
% \fi
% \iffalse
%<*internal>
\iffalse
%</internal>
%<*readme>
--------------------------------------------------------------------------
Class:        muling
Author:       Niranjan
Version:      0.1  (12 November, 2020)
Description:  A class file for the Department of Linguistics, University of
              Mumbai
Repository:   https://gitlab.com/niranjanvikastambe/muling
Bug tracker:  https://gitlab.com/niranjanvikastambe/muling/-/issues
License:      The LaTeX Project Public License v1.3c or later.
--------------------------------------------------------------------------
%</readme>
%<*internal>
\fi
%</internal>
%<*driver|class>
\def\mulingClassName{muling}
\def\mulingClassVersion{0.1}
\def\mulingClassDate{2020/11/12}
\def\mulingClassDescription{A class file for the Department of Linguistics,
  University of Mumbai
}
%</driver|class>
%<*driver>
\documentclass{l3doc}
\usepackage{hyperref}
\usepackage{xcolor}
\hypersetup{
  colorlinks,
  linkcolor=red!60!black,
  citecolor=green!60!black,
  urlcolor=blue!60!black
}
\usepackage{fontawesome5}
\begin{document}
\DocInput{\mulingClassName.dtx}
\end{document}
%</driver> 
% \fi
% \title{The \cls{\mulingClassName} class}
% \author{Niranjan}
% \date^^A
% {^^A
% Version \mulingClassVersion\ --- \mulingClassDate\\[1ex]
% {\small\faIcon{link}\quad\url{https://ctan.org/pkg/muling}}\\
% {\small\faIcon{gitlab}\quad\url{https://gitlab.com/niranjanvikastambe/muling}}
% }
%   \maketitle
%   \begin{abstract}
%     This is a class-file written for the students of the Department of
%     Linguistics, University of Mumbai. It uses the standard layout prescribed
%     by the university, loads some necessary packages for
%     typesetting a thesis in linguistics \textit{\&} adds the declaration
%     needed by the university from the submitter.
%   \end{abstract}
%   \tableofcontents
%   \begin{documentation}
%     \section{Package macros}
%     This package has the following commands. It is recommended to use all of
%     them in the preamble only.
%     \begin{function}{\subtitle}
%       \begin{syntax}
%         \cs{subtitle}\marg{a subtitle}
%       \end{syntax}
%       The subtitle is printed exactly under the title on the title page.
%     \end{function}
%     \begin{function}{\shorttitle}
%       \begin{syntax}
%         \cs{shorttitle}\marg{a short title}
%       \end{syntax}
%       The short title is printed on the top right corner of the page with the
%       year of submission.
%     \end{function}
%     \begin{function}{\supervisor}
%       \begin{syntax}
%         \cs{supervisor}\marg{name of the supervisor}
%       \end{syntax}
%       Name of the supervisor is printed on the title-page, in the declaration
%       text \textit{\&} under the name of the supervisor for the signature.
%     \end{function}
%     \section{Package options}
%     \begin{function}{digital}
%       This package option is developed for getting a read-only version of
%       the thesis. By default the thesis is formatted as a print-ready
%       document as the per the university requirements. If you want to submit a
%       digital copy of the thesis, use this option.
%     \end{function}
%     \begin{function}{lof}
%       This package option is developed for getting a list of figures after the
%       list of tables. Every thesis might not need a list of figures, therefore
%       it isn't added by default.
%     \end{function}
%     \section{Example code}
%     Try this sample document.
% \begin{verbatim}
% \documentclass[digital,lof]{muling} % Remove `digital' for a print-version.
% \title{Linguistic profile of Konkani}
% \author{Niranjan}
% \supervisor{Dr.\ Renuka Ozarkar}
% \shorttitle{Konkani}
% \subtitle{Phonological \& morphological description of the Konkani language}
% 
% \begin{document}
% \maketitle
%
% \chapter{Test chapter}
% \pex
% Department of linguistics
% \xe
% \begin{center}
%   \begin{forest}
%     [NP
%     [\head{N}\\
%     Department]
%     [PP
%     [\head{P}\\
%     of]
%     [NP
%     [\head{N}\\
%     linguistics]
%     ]
%     ]
%     ]
%   \end{forest}
% \end{center}
% \end{document}
% \end{verbatim}
%   \end{documentation}
%   \begin{implementation}
%     \section{Implementation}
%    \begin{macrocode}
%<*class>      
%    \end{macrocode}
%    \begin{macrocode}
\ProvidesClass{muling}[2020/11/12 v0.1
A class file for the Department of Linguistics,
University of Mumbai]
\DeclareOption{digital}{\PassOptionsToClass{oneside}{book}}
\newif\iflof
\DeclareOption{lof}{\loftrue}
\ProcessOptions
\iflof
\def\@printlof{%
  \thispagestyle{empty}%
  \phantomsection
  \addcontentsline{toc}{section}{List of figures}%
  \listoffigures
  \clearpage\pagebreak
}%
\else
\let\@printlof\@empty
\fi
\LoadClass{book}
%    \end{macrocode}
% This part of code loads the \cls{book} class \textit{\&} provides the option
% \verb|digital| for typesetting a document with read-only format \textit{\&}
% option \verb|lof| for automatically adding list of figures.
%    \begin{macrocode}
\RequirePackage{hyperref}
\hypersetup{
  colorlinks,
  linkcolor=red!60!black,
  citecolor=green!60!black,
  urlcolor=blue!60!black
}
\RequirePackage[backend=biber,style=apa]{biblatex}
\RequirePackage[linguistics]{forest}
\RequirePackage{tipa}
\RequirePackage{leipzig}
\RequirePackage{expex}
\RequirePackage{ling-macros}
%    \end{macrocode}
% This part of code loads some other essential packages for typesetting
% documents with linguistic content.
%    \begin{macrocode}
\makeatletter
\let\@supervisor\@empty
\def\supervisor#1{%
  \def\@supervisor{#1}%
}%
\let\@shorttitle\@empty
\def\shorttitle#1{%
  \def\@shorttitle{#1}%
}%
\let\@subtitle\@empty
\def\subtitle#1{%
  \def\@subtitle{#1}%
}%
%    \end{macrocode}
% This code enables three additional entries required in the title-page.
% \textit{\&} at various other places.
%    \begin{macrocode}
\RequirePackage{fancyhdr}
\pagestyle{fancy}
\cfoot{\thepage}
\rhead{}
\lhead{%
  \begin{tabular}{l}
    \@author\\%
    \textsc{%
    \footnotesize University of Mumbai%
    }%
  \end{tabular}%
  \hfill
  \@shorttitle
}%
%    \end{macrocode}
% This part of code adds the name of the author, the name of the university and
% a short-title with the year of submission at the top right corner of every
% page. \href{https://tex.stackexchange.com/a/525452/174620}{This} answer helped
% me for developing this code.
%    \begin{macrocode}
\newlength{\shift}
\setlength{\shift}{0.3in}
%    \end{macrocode}
% A new length is created for typesetting the title-page at the center of the
% page like in the \cls{article}
% class. \href{https://tex.stackexchange.com/a/514536/174620}{This} answer
% helped me for developing this code.
%    \begin{macrocode}
\renewcommand{\maketitle}{%
  \thispagestyle{empty}%
  \addtolength{\oddsidemargin}{\shift}%
  \fboxsep3em
  \noindent\fbox{%
    \begin{minipage}
      [c][\dimexpr\textheight-2\fboxsep-2\fboxrule]
      [c]{\dimexpr\linewidth-2\fboxsep-2\fboxrule}
      \begin{center}
        \bigskip
        \hrule
        \vspace{2ex}
        \textbf{%
          {\LARGE \@title}\\%
          \vspace{0.2cm}%
          {\textsc\@subtitle}%
        }
        \vspace{2ex}
        \hrule
        \vfill
        {\large
          \textsc{%
            \@author%
          }%
        }\\%
        \vspace{0.5in}%
        {\large
          \textsc{%
            supervisor : \@supervisor%
          }%
        }\\%
        \vspace{0.5in}%
        {\large
          \textsc{%
            a dissertation submitted in\\ the partial fulfillment of the
            requirements for the masters of linguistics%
          }%
        }\\%
        \vspace{0.5in}%
        \textsc{%
          department of linguistics\\%
          university of mumbai, kalina%
        }\\%
        \smallskip
        \bigskip
        \textsc{\@date}%
      \end{center}
    \end{minipage}
    \makeatother
    \addtolength{\oddsidemargin}{-\shift}
  }
  \clearpage\pagebreak
  \thispagestyle{empty}
  \tableofcontents
  \clearpage\pagebreak
  \thispagestyle{empty}
  \phantomsection
  \addcontentsline{toc}{section}{Abbreviations}
  \printglossary
  \clearpage\pagebreak
  \thispagestyle{empty}
  \phantomsection
  \addcontentsline{toc}{section}{List of tables}
  \listoftables
  \clearpage\pagebreak
  \thispagestyle{empty}
  \phantomsection
  \begin{center}
    \texttt{%
      \LARGE
      \textsc{%
        declaration%
      }%
    }%
  \end{center}
  \bigskip
  \texttt{%
    As required by the University Regulation No: R. 1972 I wish to state that the
    work embodied in this thesis titled \@title{} : \@subtitle{} forms my own
    contribution to the research work carried out under the guidance of
    \@supervisor{} at the University of Mumbai.\\
    \indent This work has not been submitted for any other degree of this or any
    other university. Whenever references have been made to previous works of
    others, it has been clearly indicated as such and included in the
    bibliography.\\
    \bigskip
    \texttt{%
      \flushright{%
        Date : \@date\\
        \vspace{0.5in}
      }%
      Signature of the candidate :\\
      \hfill Name : \@author
    }\\%
    \bigskip
    \flushleft{%
      Certified by -\\
      \vspace{0.5in}
      Signature of the guide :\\
      Name : \@supervisor
    }%
  }%
}%
%    \end{macrocode}
% This code typesets a customized title-page, adds a table of contents, list of
% tables\footnote{Having a list of figures is optional as seen earlier.} and the
% declaration text with all the details filled \textit{\&} some blank space left
% for the signature.
%    \begin{macrocode}
%</class>      
%    \end{macrocode}
% \end{implementation}
% \Finale