Debian Codegraph @

texmf-dist/source/latex/sshrc-insight/sshrc-insight.dtx

raw
1 % \iffalse meta-comment
2 %
3 % Copyright 2024, 2025 Tristan Miller
4 % -----------------------------------
5 %
6 % This work may be distributed and/or modified under the
7 % conditions of the LaTeX Project Public License, either version 1.3c
8 % of this license or (at your option) any later version.
9 % The latest version of this license is in
10 % https://www.latex-project.org/lppl.txt
11 % and version 1.3c or later is part of all distributions of LaTeX
12 % version 2008 or later.
13 %
14 % \fi
15 %
16 % \iffalse
17 %<*driver>
18 \ProvidesFile{sshrc-insight.dtx}
19 %</driver>
20 %<*class>
21 %% Copyright 2024, 2025 Tristan Miller
22 %% Copyright 2021 Steven B. Segletes
23 %%
24 %% This work may be distributed and/or modified under the
25 %% conditions of the LaTeX Project Public License, either version 1.3c
26 %% of this license or (at your option) any later version.
27 %% The latest version of this license is in
28 %% https://www.latex-project.org/lppl.txt
29 %% and version 1.3c or later is part of all distributions of LaTeX
30 %% version 2008 or later.
31 %%
32 %</class>
33 %<class>\NeedsTeXFormat{LaTeX2e}[2018-04-01]
34 %<class>\DeclareRelease{2024}{2024-10-12}{sshrc-insight-2024-10-12.cls}
35 %<class>\DeclareRelease{v2024}{2024-10-12}{sshrc-insight-2024-10-12.cls}
36 %<class>\DeclareRelease{v2024.1.0}{2024-10-12}{sshrc-insight-2024-10-12.cls}
37 %<class>\DeclareRelease{2025}{}{sshrc-insight.cls}
38 %<class>\DeclareRelease{v2025}{}{sshrc-insight.cls}
39 %<class>\DeclareCurrentRelease{v2025.0.0}{2025-08-14}
40 %<class>\ProvidesClass{sshrc-insight}
41 %<*class>
42 [2025-08-14 v2025.0.0 Class for SSHRC Insight Grant proposals]
43 %</class>
44 %
45 %<*driver>
46 \documentclass{ltxdoc}
47 \DisableCrossrefs
48 \CodelineIndex
49 \RecordChanges
50 \addtolength\marginparwidth{5ex}
51 \addtolength\oddsidemargin{6ex}
52 \addtolength\evensidemargin{6ex}
53 \usepackage[T1]{fontenc}
54 \usepackage{hologo}
55 \begin{document}
56 \DocInput{sshrc-insight.dtx}
57 \end{document}
58 %</driver>
59 % \fi
60 %
61 % \CheckSum{220}
62 %
63 % \CharacterTable
64 % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
65 % Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
66 % Digits \0\1\2\3\4\5\6\7\8\9
67 % Exclamation \! Double quote \" Hash (number) \#
68 % Dollar \$ Percent \% Ampersand \&
69 % Acute accent \' Left paren \( Right paren \)
70 % Asterisk \* Plus \+ Comma \,
71 % Minus \- Point \. Solidus \/
72 % Colon \: Semicolon \; Less than \<
73 % Equals \= Greater than \> Question mark \?
74 % Commercial at \@ Left bracket \[ Backslash \\
75 % Right bracket \] Circumflex \^ Underscore \_
76 % Grave accent \` Left brace \{ Vertical bar \|
77 % Right brace \} Tilde \~}
78 %
79 %
80 % \GetFileInfo{sshrc-insight.dtx}
81 %
82 % \DoNotIndex{\newcommand,\newenvironment}
83 %
84 %
85 % \title{\textsf{sshrc-insight}: A \LaTeX\ class for\\ SSHRC Insight
86 % Grant proposals\thanks{This document corresponds to
87 % \textsf{sshrc-insight}~\fileversion, dated \filedate. See
88 % §\ref{sec:version} for an explanation of the versioning scheme.}}
89 %
90 % \author{Tristan Miller\\
91 % Department of Computer Science\\
92 % University of Manitoba\\
93 % \texttt{[email protected]}}
94 %
95 % \maketitle
96 % \tableofcontents
97 % \newpage
98 %
99 % \section{Introduction}\label{sec:introduction}
100 %
101 % This document describes the usage of \textsf{sshrc-insight}, a
102 % \LaTeX\ class and template that facilitate the preparation of
103 % funding proposals for the Insight
104 % Grants\footnote{\url{https://sshrc-crsh.canada.ca/en/funding/opportunities/insight-grants.aspx}}
105 % program of Canada's Social Sciences and Humanities Research Council
106 % (SSHRC). SSHRC requires these proposals to be submitted through an
107 % online application form that consists of various short- and
108 % long-answer fields, as well as file submission fields where the
109 % applicant must attach various PDF documents structured and formatted
110 % according to certain specifications. \textsf{sshrc-insight} allows
111 % you to compose the long-answer fields and PDF documents with \LaTeX,
112 % \hologo{XeLaTeX}, or \hologo{LuaLaTeX}, with the following principal
113 % benefits:
114 %
115 % \begin{itemize}
116 % \item Formats the PDF documents according to the SSHRC's
117 % specifications.
118 %
119 % \item Allows parts of the proposal to be compiled into separate PDFs
120 % to attach to the appropriate places in the online application
121 % form.
122 %
123 % \item Alternatively, allows the proposal to be compiled into a
124 % single PDF in order to facilitate the writing and pre-submission
125 % reviewing process.
126 %
127 % \item Ensures that citation numbering remains consistent regardless
128 % whether the proposal is compiled as separate PDFs or a single PDF.
129 %
130 % \item Provides character counts for long-answer form fields.
131 %
132 % \item Supports preparation of proposals in either English or French.
133 % \end{itemize}
134 %
135 % The current version of \textsf{sshrc-insight} structures and formats
136 % proposals according to SSHRC's 2024 call. It is expected that
137 % future versions of the class will support the structure and format
138 % of future calls, while maintaining backward compatibility.
139 %
140 % \section{Usage}
141 %
142 % SSHRC provides instructions for structuring and formatting the PDF
143 % documents to attach to the online application form. Since form and
144 % content cannot be entirely separated, the best way of starting a new
145 % proposal is to make a copy of the template proposal distributed with
146 % this class and then adapt it to your project. This template
147 % includes the following files:
148 %
149 % \begin{itemize}
150 % \item \texttt{budget\_justification.tex}
151 % \item \texttt{career\_interruptions.tex}
152 % \item \texttt{detailed\_description.tex}
153 % \item \texttt{exclusion\_of\_potential\_reviewers.tex}
154 % \item \texttt{expected\_outcomes.tex}
155 % \item \texttt{knowledge\_mobilization\_plan.tex}
156 % \item \texttt{list\_of\_references.tex}
157 % \item \texttt{multi-interdisciplinary\_evaluation.tex}
158 % \item \texttt{previous\_critiques.tex}
159 % \item \texttt{research\_contributions.tex}
160 % \item \texttt{research-creation\_support\_material.tex}
161 % \item \texttt{research\_team.tex}
162 % \item \texttt{summary.tex}
163 % \item \texttt{insight\_proposal.tex}
164 % \item \texttt{insight\_proposal.bib}
165 % \end{itemize}
166 %
167 % The \texttt{insight\_proposal.tex} file is the \emph{main document}.
168 % Compile this file to get a complete draft of your proposal (minus
169 % the short-answer fields from the online application form) in a
170 % single PDF, including a table of contents. This makes it convenient
171 % for you (and anyone helping you review your proposal before
172 % submission) to read all the long-form proposal text.
173 %
174 % The complete proposal is generated from the other \texttt{.tex}
175 % files---the \emph{subfiles}---which are the individual documents and
176 % long-answer form fields to be attached to or copied into the online
177 % application form. They can be compiled separately for when you want
178 % to work on one part of the proposal at a time, or for when you are
179 % ready to attach the individual PDFs to the online application form.
180 %
181 % The file \texttt{insight\_proposal.bib} is a sample bibliography
182 % demonstrating \textsf{sshrc-insight}'s features for marking
183 % publications according to the application instructions---see
184 % §\ref{sec:bibliographic} for further details.
185 %
186 % The following two subsections describe the structure of the main
187 % document and subfiles, as well as the various macros and
188 % environments provided by \textsf{sshrc-insight}.
189 %
190 % \subsection{Main document}
191 %
192 % \subsubsection{Preamble}\label{sec:mainpreamble}
193 %
194 % Your main proposal document should begin with the following line:
195 % \begin{quote}\verb|\documentclass{sshrc-insight}[=2025]|\end{quote}
196 % The optional argument, \texttt{=2025}, indicates that the class
197 % should use the specifications from SSHRC's 2025 call for proposals.
198 % At present, the only supported specification years are 2024 and
199 % 2025, and future versions of this class may support specifications
200 % for future years' calls. The class will use the most recent
201 % supported specification in the event that you omit the optional
202 % argument; however, this is not recommended because if you later
203 % upgrade \textsf{sshrc-insight} to a version that supports a later
204 % specification year, re-compiling your old proposal may result in
205 % compilation errors, or incorrect or unexpected formatting.
206 %
207 % The \verb|sshrc-insight| class is based on the default \LaTeX\
208 % \verb|article| class, so (with a few modifications and exceptions
209 % documented below) all of the macros and environments from the latter
210 % are available for you to use.
211 %
212 % The class automatically sets the page size and margins mandated by
213 % the official application instructions. If compiling with
214 % \hologo{XeLaTeX} or \hologo{LuaLaTeX}, the class sets the font to
215 % Times New Roman, which you are expected to have installed on your
216 % system. If compiling with \hologo{pdfLaTeX}, the class uses the
217 % free Times clone provided by the \textsf{newtxtext} and
218 % \textsf{newtxmath} packages. (Although this is not strictly in
219 % accordance with the application instructions, this is unlikely to
220 % cause any problems with the funding agency, since the font metrics
221 % are virtually identical to the proprietary Times New Roman.)
222 %
223 % Following \cs{documentclass} you can include whatever \LaTeX\
224 % packages and macros you wish; these will apply to both the main
225 % document and the subfiles. The template proposal includes some
226 % sensible defaults that set the document language and the behaviour
227 % and appearance of hyperlinks, section headings, and lists, though
228 % you are free to remove or adjust these to taste. (In particular,
229 % you may wish to use the \textsf{titlesec} package to further reduce
230 % the size of and spacing around section headings.) The template also
231 % sets up the bibliographic referencing and citation system to use
232 % \textsf{biblatex} and Biber, for which \textsf{sshrc-insight} has
233 % built-in support. (See §\ref{sec:bibliographic} for further
234 % details.)
235 %
236 % You should then provide the proposal metadata using the \cs{title}
237 % macro, and optionally also the \cs{author} and \cs{date} macros,
238 % which behave as they do in the \verb|article| class.
239 %
240 % \subsubsection{Document body}
241 %
242 % As in the \verb|article| class, the main body of the document must
243 % be placed in the \verb|document| environment.
244 %
245 % \DescribeMacro{\maketitle}\DescribeMacro{\tableofcontents}
246 % These are generally the first macros that should be called in the
247 % main body of the document. As with the standard \verb|article|
248 % class, they typeset the title and table of contents.
249 %
250 % \DescribeMacro{\subfile}
251 % This macro is used to include the subfiles in the main document; it
252 % takes the subfile's filename (optionally excluding the \texttt{.tex}
253 % extension) as its sole argument. Each subfile corresponds to a
254 % long-answer field that must be filled in the online application
255 % form, or a document that must be attached as a PDF to the online
256 % application form. The template proposal includes a list of
257 % \cs{subfile} commands (as well as the corresponding template files)
258 % for fields and documents that are required by most or all proposals;
259 % you should comment out or remove any entries that do not apply to
260 % your proposal.
261 %
262 % You may also wish to include among the \cs{subfile} commands further
263 % information or documents that you will be submitting in the
264 % application form. For externally generated PDFs, such as a STRAC
265 % attestation form, you may wish to do this via the \textsf{pdfpages}
266 % package's \cs{includepdf} command. Here is an example of how you
267 % can do this and have the file appear in the table of contents:
268 % \begin{quote}
269 % \begin{verbatim}
270 % \includepdf[
271 % pages=-,
272 % addtotoc={1,section,1,STRAC Attestation,STRAC}
273 % ]{attestation}
274 % \end{verbatim}
275 % \end{quote}
276 %
277 % \subsection{Subfiles}
278 %
279 % \subsubsection{Preamble}
280 %
281 % Each subfile must start with the following line:
282 % \begin{quote}\cs{documentclass}\oarg{filename}\verb|{subfiles}|\end{quote}
283 % Here \meta{filename} must be the filename (\emph{without} the
284 % \texttt{.tex} extension) of the main document.
285 %
286 % The preamble of the subfiles should normally be empty; if you need
287 % to import any packages or define any macros, this should be done
288 % instead in the preamble of the main document.
289 %
290 % \subsubsection{Document body}
291 %
292 % \DescribeMacro{\subfiletitle}
293 % In subfiles, this macro should be used in place of the standard
294 % \cs{maketitle} macro. It takes as its sole argument the title of
295 % the subfile. It prints this title, in a relatively compact format,
296 % at the top of the first page of the subfile, and also adds the title
297 % to the table of contents of the main document. If using the
298 % \textsf{hyperref} package, the title will also appear in the PDF
299 % metadata when the subfile is compiled as a separate file. As
300 % described in §\ref{sec:localization}, English titles that exactly
301 % match those specified in the official application instructions will
302 % be automatically localized into French when the document language is
303 % set to \verb|french|.
304 %
305 % \DescribeMacro{\subfilesection}\DescribeMacro{\subfilesubsection}
306 % These two macros can be used to print an unnumbered (sub)section
307 % heading in a subfile. They function identically to the
308 % \verb|article| class's \cs{section*} and \cs{subsection*} except
309 % that the arguments are automatically localized, as they are with
310 % \cs{subfiletitle}.
311 %
312 % \DescribeMacro{\countchars} This macro can be used for writing
313 % long-answer form data, such as the proposal summary and the response
314 % to previous critiques. Its principal benefit is that, in addition
315 % to printing the answer text, it outputs its total character count,
316 % thereby helping you keep your text within the length limit specified
317 % in the application form. The macro takes one mandatory argument,
318 % which is the text of the answer, and one optional argument, which is
319 % the field's length limit in characters:
320 % \begin{quote}\cs{countchars}\oarg{length}\marg{text}\end{quote}
321 % If the length limit is not specified, it defaults to 3800, which is
322 % the limit for all long-answer fields in the 2025 application form.
323 %
324 % Note that the PDF output of \cs{countchars} is not intended to be
325 % used as-is in your final application. Rather, you should copy and
326 % paste its text argument directly from the \LaTeX\ source code into
327 % the online application form. For this reason, please ensure that
328 % you write the argument as plain text rather than as \LaTeX\ markup.
329 %
330 % \subsection{Bibliographic references and research contributions}\label{sec:bibliographic}
331 %
332 % It is recommended to use \textsf{biblatex} and Biber for your
333 % bibliographic references and citations, and the template proposal
334 % assumes that this is how you have things set up. Put all your
335 % \textsf{biblatex} configuration, and all your \cs{addbibresource}
336 % macros, in your main document. You can then use the usual
337 % \textsf{biblatex} commands for citing references and printing
338 % bibliographies in the subfiles. The
339 % \texttt{list\_of\_references.tex} file of the template proposal
340 % gives an example of how to print a master bibliography for citations
341 % across the various subfiles, and the
342 % \texttt{research\_contributions.tex} file shows how to print
343 % self-contained bibliographies for one's own research contributions,
344 % broken down according to the categories specified in the application
345 % instructions.
346 %
347 % \subsubsection{Citation numbering}
348 %
349 % When using \textsf{biblatex} as described above,
350 % \textsf{sshrc-insight} ensures that the numbering of the citations
351 % is consistent regardless whether you compile the main proposal file
352 % or the individual subfiles. It does this by having the subfiles
353 % read in the main document's Biber-generated \texttt{.bbl} file when
354 % the subfiles are compiled individually. For this reason, it is
355 % important that, whenever you add, change, or remove citations and
356 % references, you (re)compile the main document \emph{before} you
357 % (re)compile the subfiles. It also means that, despite log messages
358 % to the contrary, you never need to run Biber on the subfiles.
359 %
360 % \subsubsection{Hyperlinks}
361 %
362 % When \textsf{biblatex} is used in conjunction with
363 % \textsf{hyperref}, it hyperlinks each citation to the corresponding
364 % entry in the list of references. While this works well when
365 % compiling the main document into a single PDF, when compiling the
366 % subfiles individually, there is no list of references to link to
367 % (since the list of references is itself one of the subfiles). For
368 % this reason, \textsf{sshrc-insight} automatically disables
369 % \textsf{biblatex}'s hyperlinks when compiling the subfiles
370 % individually.
371 %
372 % \subsubsection{Marking student authors}
373 %
374 % The official application instructions for the ``Research
375 % Contributions'' document indicate that student authors should be
376 % identified with a plus sign. \textsf{sshrc-insight} takes care of
377 % this when printing bibliographic references by means of a
378 % \textsf{biblatex} data annotation, \texttt{student}. To use this
379 % feature, simply add a \hologo{BibTeX} field in the following format
380 % to any entry with a student author:
381 % \begin{quote}
382 % \texttt{author+an = \{}\meta{n}\texttt{=student} $\big [$
383 % \texttt{;}\meta{n}\texttt{=student} $\big ]$ \dots\ \texttt{\},}
384 % \end{quote}
385 % where each \meta{n} is the position of a student in the author list.
386 % For example, the \hologo{BibTeX} entry
387 % \begin{quote}
388 % \begin{verbatim}
389 % @article{art1,
390 % author = {Ferenc Farkas and Lili Lakatos and Fruzsina Fekete},
391 % author+an = {1=student;3=student},
392 % title = {A new approach to underwater basket-weaving},
393 % journal = {Journal of Underwater Basket-weaving},
394 % pages = {107--113},
395 % year = 2024,
396 % }\end{verbatim}
397 % \end{quote}
398 % will be formatted in the reference lists as follows (modulo whatever
399 % bibliography styles you may have applied):
400 % \begin{quote}
401 % Ferenc Farkas\textsuperscript{+}, Lili Lakatos, and Fruzsina
402 % Fekete\textsuperscript{+}. ``A new approach to underwater
403 % basket-weaving''. In: \emph{Journal of Underwater Basket-weaving}
404 % (2024), pp.\,107--113.
405 % \end{quote}
406 % Note that student authors will be marked not just in the reference
407 % lists but also in the citations: a citation to the entry above might
408 % appear as ``(Farkas\textsuperscript{+} et al., 2024)''.
409 %
410 % \DescribeMacro{\sshrcstudent}
411 % Outside bibliographies, the \cs{sshrcstudent} macro can be used for
412 % the same effect; it simply outputs a superscripted plus sign.
413 %
414 % \subsubsection{Marking SSHRC-supported research contributions}
415 %
416 % The official application instructions for the ``Research
417 % Contributions'' document indicate that research contributions
418 % resulting from previous SSHRC support should be identified with an
419 % asterisk in the left margin. \textsf{sshrc-insight} takes care of
420 % this when printing bibliographic references by means of a
421 % \textsf{biblatex} keyword, \texttt{sshrc}. To use this feature,
422 % simply add the following \hologo{BibTeX} field to any entry that
423 % resulted from previous SSHRC support:
424 % \begin{quote}
425 % \texttt{keywords = \{sshrc\},}
426 % \end{quote}
427 % (If the entry already contains a \texttt{keywords} field, you can
428 % simply add \texttt{sshrc} to its list of values, which are normally
429 % separated with commas.) For example, the \hologo{BibTeX} entry
430 % \begin{quote}
431 % \begin{verbatim}
432 % @article{art2,
433 % author = {Lili Lakatos},
434 % title = {An old approach to underwater basket-weaving},
435 % journal = {Journal of Underwater Basket-weaving},
436 % pages = {21--35},
437 % year = 2021,
438 % keywords = {sshrc},
439 % }\end{verbatim}
440 % \end{quote}
441 % will be formatted in the reference lists as follows (modulo whatever
442 % bibliography styles you may have applied):
443 % \begin{quote}
444 % \makebox[0pt][r]{\textasteriskcentered~}Lili Lakatos. ``An old
445 % approach to underwater basket-weaving''. In: \emph{Journal of
446 % Underwater Basket-weaving} (2021), pp.\,21--35.
447 % \end{quote}
448 %
449 % \DescribeMacro{\sshrcsupported}
450 % Outside bibliographies, the \cs{sshrcsupported} macro can be used
451 % for the same effect; it simply outputs an asterisk in the left
452 % margin.
453 %
454 % \subsection{Localization}\label{sec:localization}
455 %
456 % \textsf{sshrc-insight} supports preparation of proposals in either
457 % English or French. Although the document and section titles used by
458 % the template proposal are in English, setting the document language
459 % to \texttt{french} (via the \textsf{babel} or \textsf{polyglossia}
460 % packages) will automatically substitute these with the French
461 % equivalents in the PDF output.
462 %
463 % \section{Class development}
464 %
465 % \subsection{Source repository and bug tracker}
466 %
467 % For now, the class's source code is hosted on GitHub at
468 % \url{https://github.com/logological/sshrc-insight}. There you will
469 % also find an issue tracker for reporting bugs and feature requests.
470 %
471 % \subsection{Versioning scheme}\label{sec:version}
472 %
473 % Each release of the \textsf{sshrc-insight} class carries a version
474 % number in the format \textit{year.\allowbreak maj.\allowbreak
475 % min}. Here \textit{year} is the latest year of SSHRC's call for
476 % proposals whose application specifications are implemented by the
477 % class, and \textit{maj} and \textit{min} represent, respectively,
478 % major and minor revisions to the class (including any ancillary
479 % files, such as the template proposal and documentation). A major
480 % revision is one that includes potentially breaking changes or
481 % significant new features; minor revisions are for all other changes.
482 % As documented in §\ref{sec:mainpreamble}, the class provides a
483 % mechanism that preserves compatibility with earlier versions of the
484 % application specifications.
485 %
486 % \subsection{Version history}
487 %
488 % \begin{description}
489 % \item[v2025.0.0 (2025-08-14)] Added support for the 2025
490 % specification year.
491 % \item[v2024.1.0 (2024-10-21)] Added support for marking research
492 % contributions according to the official application instructions.
493 % \item[v2024.0.1 (2024-10-17)] Refactored files for CTAN.
494 % \item[v2024.0.0 (2024-10-16)] Initial release.
495 % \end{description}
496 %
497 % \section{Disclaimer}
498 %
499 % The \textsf{sshrc-insight} class is distributed in the hope that it
500 % will be useful, but WITHOUT ANY WARRANTY; without even the implied
501 % warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
502 % PURPOSE. (See the \LaTeX\ Project Public License for further
503 % details.) In particular, users should understand that the
504 % \textsf{sshrc-insight} proposal template is wholly unofficial, and
505 % its author(s) accept no responsibility for any omissions, errors, or
506 % discrepancies with respect to the requirements set forth in the
507 % official SSHRC application form, application instructions, and
508 % associated documentation. If you produce a proposal with this
509 % template, then you alone are responsible for ensuring that it
510 % matches all the official requirements before submitting it to the
511 % funding body.
512 %
513 % \appendix
514 %
515 % \section{Implementation}
516 %
517 % \StopEventually{}
518 %
519 % \subsection*{Basic setup}
520 %
521 % Import the \textsf{article} class and define some conditionals for
522 % detecting the typesetting engine.
523 %
524 %\iffalse
525 %<*class>
526 %\fi
527 % \begin{macrocode}
528 \LoadClass[12pt,letterpaper]{article}
529
530 %% Conditionals for detecting the typesetting engine
531 \RequirePackage{ifxetex,ifluatex}
532 \newif\ifxetexorluatex
533 \ifxetex
534 \xetexorluatextrue
535 \else
536 \ifluatex
537 \xetexorluatextrue
538 \else
539 \xetexorluatexfalse
540 \fi
541 \fi
542
543 % \end{macrocode}
544 %
545 % The \textsf{subfiles} package is what allows a proposal to be compiled
546 % either into a single PDF or into separate files for each part. It
547 % takes care of most of the work, though later on we need to apply our
548 % own extensions.
549 %
550 % \begin{macrocode}
551 \RequirePackage{subfiles}
552 % \end{macrocode}
553 %
554 % \subsection*{Font setup}
555 %
556 % If compiling with \hologo{LuaLaTeX} or \hologo{XeLaTeX}, configure
557 % \textsf{fontspec} to use Times New Roman, which is the font
558 % specified in the official application instructions. If compiling
559 % with \hologo{pdfLaTeX}, use the Times clone provided by
560 % \textsf{newtxtext} and \textsf{newtxmath}.
561 %
562 % \begin{macrocode}
563 \ifxetexorluatex
564 \RequirePackage{fontspec}
565 \defaultfontfeatures{Mapping=tex-text}
566 \setromanfont{Times New Roman}
567 \else
568 \RequirePackage[T1]{fontenc} % T1 font encoding
569 \RequirePackage{newtxtext} % Use Times for main text
570 \RequirePackage{newtxmath} % Use Times for math
571 \fi
572 % \end{macrocode}
573 %
574 % \subsection*{Basic page layout, titles, and headings}
575 %
576 % Set the page size and margins and disable page numbers.
577 %
578 % \begin{macrocode}
579 \RequirePackage[letterpaper,
580 left=0.75in,
581 top=0.75in,
582 bottom=0.75in,
583 right=0.75in,
584 ]{geometry}
585 \RequirePackage{nopageno} % No page numbers
586 % \end{macrocode}
587 %
588 % Compactly format the titles for the individual parts of the
589 % proposal, and add them as unnumbered entries to the main document's
590 % table of contents.
591 %
592 % \begin{macrocode}
593 %% Compact title for subfiles
594 \RequirePackage[normalem]{ulem}
595 \NewDocumentCommand{\subfiletitle}
596 {m}
597 {%
598 \newpage
599 \ifSubfilesClassLoaded{
600 \@ifpackageloaded{hyperref}
601 {\hypersetup{pdftitle=\GetTranslation{#1}}}
602 {}
603 }
604 {\phantomsection\addcontentsline{toc}{section}{\GetTranslation{#1}}}
605 \begingroup
606 \centering\bfseries\MakeUppercase{\uline{\GetTranslation{#1}}}
607 \par
608 \vskip 1.5em%
609 \endgroup
610 \par\@afterindentfalse\@afterheading
611 }
612
613 %% Suppress section numbers in table of contents
614 \addtocontents{toc}{\protect\renewcommand{\protect\numberline}[1]{}}
615
616 %% Localized (sub)section headings
617 \NewDocumentCommand{\subfilesection}
618 {m}
619 {\section*{\GetTranslation{#1}}}
620 \NewDocumentCommand{\subfilesubsection}
621 {m}
622 {\subsection*{\GetTranslation{#1}}}
623 % \end{macrocode}
624 %
625 % Provide a mechanism for counting the number of characters in the
626 % long-answer form fields so that we know when we've reached the
627 % character limit specified in the official application instructions.
628 %
629 % \begin{macrocode}
630 %% Count characters, adapted from code by Steven B. Segletes at
631 %% https://tex.stackexchange.com/a/587567/22603
632 \RequirePackage{tokcycle}[2021-03-10]
633 \RequirePackage{xcolor}
634 \newcounter{wordcount}
635 \newcounter{lettercount}
636 \newcounter{wordlimit}
637 \newif\ifinword
638 %% USER PARAMETERS
639 \newif\ifrunningcount
640 \newif\ifsummarycount
641 \def\limitcolor{red}
642 \setcounter{wordlimit}{0}
643 %%%
644 %% \tc@defx is like \def, but expands the replacement text once prior
645 %% to assignment
646 \newcommand\addtomacro[2]{\tc@defx#1{#1#2}}
647 \newcommand\changecolor[1]
648 {\tctestifx{.#1}{}{\addcytoks{\color{#1}{}}%
649 \tc@defx\currentcolor{#1}}}
650 \newcommand\dumpword{%
651 \addcytoks[1]{\accumword}%
652 \ifinword\stepcounter{wordcount}\stepcounter{lettercount}
653 \ifrunningcount\addcytoks[x]{$^{\thewordcount,\thelettercount}$}\fi
654 \ifnum\thewordcount=\value{wordlimit}\relax%
655 \changecolor{\limitcolor}\fi
656 \fi%
657 \inwordfalse
658 \def\accumword{}}
659 \newcommand\addletter[1]{%
660 \stepcounter{lettercount}%
661 \tctestifcatnx A#1{\inwordtrue}{\dumpword}%
662 \addtomacro\accumword{#1}}
663 \xtokcycleenvironment\countem
664 {\addletter{##1}}
665 {\dumpword\groupedcytoks{\processtoks{##1}%
666 \dumpword\expandafter}\expandafter
667 \changecolor\expandafter{\currentcolor}}
668 {\dumpword\addcytoks{##1}}
669 {\dumpword\addcytoks{##1}}
670 {\stripgroupingtrue\def\accumword{}\def\currentcolor{.}
671 \setcounter{wordcount}{0}\setcounter{lettercount}{0}}
672 {\dumpword\ifsummarycount\tcafterenv{%
673 \par(Wordcount=\thewordcount, Lettercount=\thelettercount)}\fi}
674
675 \def\characterlimit{3800}
676 \newcommand{\countchars}[2][\characterlimit]
677 {\countem #2\endcountem\par\hfill
678 \GetTranslation{Character count:}
679 \thelettercount\ \GetTranslation{of} #1
680 }
681 % \end{macrocode}
682 %
683 % A command for marking SSHRC-supported contributions (outside of
684 % bibliographies) with an asterisk in the left margin:
685 %
686 % \begin{macrocode}
687 \reversemarginpar
688 \NewDocumentCommand{\sshrcsupported}
689 {}
690 {%
691 \leavevmode%
692 \marginparsep=0pt%
693 \marginpar{\raggedleft\mbox{\textasteriskcentered~}}%
694 }
695 % \end{macrocode}
696 %
697 % \subsection*{Bibliography}
698 %
699 % A command for marking student authors in the bibliography (or
700 % elsewhere):
701 %
702 % \begin{macrocode}
703 \NewDocumentCommand{\sshrcstudent}
704 {}
705 {\textsuperscript{+}}
706 % \end{macrocode}
707 %
708 % If \textsf{biblatex} is used, we provide some convenient features.
709 %
710 % \begin{macrocode}
711 \AtBeginDocument{
712 \@ifpackageloaded{biblatex}
713 {
714 % \end{macrocode}
715 %
716 % To enforce consistency in the labelling/numbering of citations when
717 % the proposal is compiled into a single PDFs vs.\ multiple PDFs, use
718 % \textsf{biblatex-readbbl} to force subfiles to use the \texttt{bbl}
719 % file generated for the main file.
720 %
721 % \begin{macrocode}
722 \ifSubfilesClassLoaded
723 {
724 % Force subfiles to read the main file's bibliography
725 \RequirePackage[bblfile=\preamble@file]{biblatex-readbbl}
726 }
727 {}
728 % \end{macrocode}
729 %
730 % Provide a mechanism to mark student authors with a plus, per the
731 % official application instructions.
732 %
733 % \begin{macrocode}
734 \renewcommand*{\mkbibnamefamily}[1]{%
735 \ifitemannotation{student}
736 {#1\sshrcstudent}
737 {#1}%
738 }
739 % \end{macrocode}
740 %
741 % Provide a mechanism to mark previous SSHRC-supported contributions
742 % with an asterisk in the left margin, per the official application
743 % instructions.
744 %
745 % \begin{macrocode}
746 \renewbibmacro*{begentry}
747 {%
748 \ifkeyword{sshrc}
749 {\makebox[0pt][r]{\textasteriskcentered~}}
750 {}%
751 }
752 }
753 {}
754 }
755 % \end{macrocode}
756 %
757 % When \textsf{biblatex} is used with \textsf{hyperref}, it hyperlinks
758 % each citation to the corresponding entry in the list of references.
759 % This is fine when compiling the proposal into a single PDF, but when
760 % compiling the proposal parts individually, there is no list of
761 % references to link to. So when compiling the subfiles individually,
762 % we disable the hyperlinks.
763 %
764 % \begin{macrocode}
765 %% Disable citation hyperlinks in subfiles
766 \ifSubfilesClassLoaded{
767 \PassOptionsToPackage{hyperref=false}{biblatex}
768 }{}
769 % \end{macrocode}
770 %
771 % \subsection*{Localizations}
772 %
773 % Provide French versions of the document titles and section headings
774 % specified in the application instructions, as well as a few other
775 % user-visible strings emitted by \textsf{sshrc-insight}.
776 %
777 % \begin{macrocode}
778 %% Localizations
779 \RequirePackage{translations}
780 \DeclareTranslation{french}{1. Relevant research contributions over the last six years}{1. Contributions pertinentes à la recherche faites au cours des six dernières années}
781 \DeclareTranslation{french}{2. Other research contributions}{2. Autres contributions à la recherche}
782 \DeclareTranslation{french}{3. Most significant career research contributions}{3. Plus importantes contributions à la recherche faites au cours d'une carrière}
783 \DeclareTranslation{french}{4. Contributions to training}{4. Contributions à la formation}
784 \DeclareTranslation{french}{Budget Justification}{Justification du budget}
785 \DeclareTranslation{french}{Career Interruptions and Special Circumstances}{Interruptions de carrière et circonstances spéciales}
786 \DeclareTranslation{french}{Context}{Contexte}
787 \DeclareTranslation{french}{Creative outputs}{Réalisations artistiques}
788 \DeclareTranslation{french}{Description of previous and ongoing research results}{Description des résultats de recherche les plus récents ou en cours}
789 \DeclareTranslation{french}{Description of proposed student training strategies}{Description des stratégies proposées de formation des étudiants}
790 \DeclareTranslation{french}{Description of the research team}{Description de l'équipe de recherche}
791 \DeclareTranslation{french}{Detailed Description}{Description détaillée}
792 \DeclareTranslation{french}{Exclusion of Potential Reviewers}{Exclusion d'évaluateurs éventuels}
793 \DeclareTranslation{french}{Expected Outcomes}{Résultats escomptés}
794 \DeclareTranslation{french}{Forthcoming contributions}{Contributions à venir}
795 \DeclareTranslation{french}{Knowledge Mobilization Plan}{Plan de mobilisation des connaissances}
796 \DeclareTranslation{french}{List of References}{Liste des références}
797 \DeclareTranslation{french}{Methodology}{Méthodologie}
798 \DeclareTranslation{french}{Nonrefereed contributions}{Contributions non soumises à des comités de lecture}
799 \DeclareTranslation{french}{Objectives}{Objectifs}
800 \DeclareTranslation{french}{Other refereed contributions}{Autres contributions soumises à des comités de lecture}
801 \DeclareTranslation{french}{Previous Critiques}{Réponse à des critiques précédentes}
802 \DeclareTranslation{french}{Refereed contributions}{Publications soumises à des comités de lecture}
803 \DeclareTranslation{french}{Request for Multi/Interdisciplinary Evaluation}{Demande d'évaluation interdisciplinaire ou multidisciplinaire}
804 \DeclareTranslation{french}{Research Contributions}{Contributions à la recherche}
805 \DeclareTranslation{french}{Research Team, Student Training, Previous Output}{Équipe de recherche, résultats les plus récents et formation des étudiants}
806 \DeclareTranslation{french}{Research-creation Support Material}{Documents d'appui liés à la recherche-création}
807 \DeclareTranslation{french}{Response to Previous Critiques}{Réponse à des critiques précédentes}
808 \DeclareTranslation{french}{Summary of Proposal}{Résumé de la proposition}
809 \DeclareTranslation{french}{Character count:}{Nombre de caractères:}
810 \DeclareTranslation{french}{of}{sur}
811 % \end{macrocode}
812 %\iffalse
813 %</class>
814 %<*budgetjustification>
815 \documentclass[insight_proposal]{subfiles}
816 \begin{document}
817 \subfiletitle{Budget Justification}
818
819 %% Enter document text here.
820
821 \end{document}
822 %</budgetjustification>
823 %<*careerinterruptions>
824 \documentclass[insight_proposal]{subfiles}
825 \begin{document}
826 \subfiletitle{Career Interruptions and Special Circumstances}
827
828 %% Enter document text here.
829
830 \end{document}
831 %</careerinterruptions>
832 %<*detaileddescription>
833 \documentclass[insight_proposal]{subfiles}
834 \begin{document}
835 \subfiletitle{Detailed Description}
836
837 \subfilesection{Objectives}
838
839 %% Enter section text here.
840
841 \subfilesection{Context}
842
843 %% Enter section text here.
844
845 \subfilesection{Methodology}
846
847 %% Enter section text here.
848
849 \end{document}
850 %</detaileddescription>
851 %<*exclusionofpotentialreviewers>
852 \documentclass[insight_proposal]{subfiles}
853 \begin{document}
854 \subfiletitle{Exclusion of Potential Reviewers}
855
856 %% Enter document text here.
857
858 \end{document}
859 %</exclusionofpotentialreviewers>
860 %<*expectedoutcomes>
861 \documentclass[insight_proposal]{subfiles}
862 \begin{document}
863 \subfiletitle{Expected Outcomes}
864
865 %% Enter form text in the command argument below.
866 \countchars{}
867
868 \end{document}
869 %</expectedoutcomes>
870 %<*knowledgemobilizationplan>
871 \documentclass[insight_proposal]{subfiles}
872 \begin{document}
873
874 \subfiletitle{Knowledge Mobilization Plan}
875
876 %% Enter document text here.
877
878 \end{document}
879 %</knowledgemobilizationplan>
880 %<*listofreferences>
881 \documentclass[insight_proposal]{subfiles}
882 \begin{document}
883 \subfiletitle{List of References}
884
885 \begin{sloppypar}
886 \printbibliography[heading=none]
887 \end{sloppypar}
888
889 \end{document}
890 %</listofreferences>
891 %<*multi-interdisciplinaryevaluation>
892 \documentclass[insight_proposal]{subfiles}
893 \begin{document}
894 \subfiletitle{Request for Multi/Interdisciplinary Evaluation}
895
896 %% Enter document text here.
897
898 \end{document}
899 %</multi-interdisciplinaryevaluation>
900 %<*previouscritiques>
901 \documentclass[insight_proposal]{subfiles}
902 \begin{document}
903 \subfiletitle{Response to Previous Critiques}
904
905 %% Enter form text in the command argument below.
906 \countchars{}
907
908 \end{document}
909 %</previouscritiques>
910 %<*insightproposal>
911 \documentclass{sshrc-insight}[=2025]
912
913 %% This is the main file for a skeleton SSHRC Insight Grant proposal
914 %% using the sshrc-insight class. Compile this file to get a complete
915 %% draft of your proposal (minus the short-answer fields from the
916 %% online application form) in a single PDF, including a table of
917 %% contents. This makes it convenient for you (and anyone helping you
918 %% review your proposal before submission) to read all the long-form
919 %% proposal text.
920 %%
921 %% The complete proposal is generated from the other tex files in this
922 %% directory, which are the individual documents and long-answer form
923 %% fields to be attached to or copied into the online application form.
924 %% They can be compiled separately for when you want to work on one
925 %% part of the proposal at a time, or for when you are ready to attach
926 %% the individual PDFs to the online application form.
927
928 %% Use one of the following two commands to set the hyphenation
929 %% patterns, document and section headings, bibliography strings,
930 %% etc. to Canadian English or French.
931 \usepackage[canadian]{babel}
932 %% \usepackage[french]{babel}
933
934 %% It is recommended to use biblatex + biber for your references; the
935 %% skeleton proposal assumes that this is how you have things set up.
936 %% (It may be possible to use bibunits + bibtex instead but this has
937 %% not been tested.) Modify the following lines to configure
938 %% biblatex's citation and reference styles to your taste and to
939 %% specify the bibliography file(s) you want to use.
940 \usepackage{csquotes}
941 \usepackage[style=authoryear]{biblatex}
942 \addbibresource{insight_proposal.bib}
943
944 %% The following (optional) block of commands enables hyperlinks and
945 %% PDF metadata, and ensures URLs are set in Times (New Roman). Remove
946 %% or tweak if desired.
947 \usepackage[pdfusetitle]{hyperref}
948 \hypersetup{%
949 colorlinks=true,
950 breaklinks=true,
951 urlcolor=black,
952 linkcolor=black,
953 citecolor=black,
954 linktoc=all,
955 }
956 \urlstyle{rm}
957
958 %% The following (optional) block of commands tightens up the layout to
959 %% save space. Remove or tweak if desired.
960 \usepackage{microtype}
961 \usepackage[inline]{enumitem}
962 \setlist{noitemsep,topsep=0pt,parsep=0pt,partopsep=0pt}
963 \usepackage[compact]{titlesec}
964
965 %% Enter the title and author(s) of your proposal here.
966 \title{My SSHRC Insight proposal}
967 \author{My name}
968
969 \begin{document}
970
971 \maketitle
972 \tableofcontents
973
974 %% Remove or comment out any of the following sections that don't apply
975 %% to your proposal.
976 \subfile{previous_critiques}
977 \subfile{multi-interdisciplinary_evaluation}
978 \subfile{summary}
979 \subfile{detailed_description}
980 \subfile{knowledge_mobilization_plan}
981 \subfile{list_of_references}
982 \subfile{research-creation_support_material}
983 \subfile{research_team}
984 \subfile{budget_justification}
985 \subfile{expected_outcomes}
986 \subfile{exclusion_of_potential_reviewers}
987 \subfile{research_contributions}
988 \subfile{career_interruptions}
989
990 %% If you wish, you could include further documents you will be
991 %% attaching to the final submission. For externally generated PDFs,
992 %% you should add \usepackage{pdfpages} to the document preamble. Here
993 %% is an example of how you might include your STRAC attestation (from
994 %% a file named attestation.pdf) and add it to the table of contents:
995 %%
996 %% \includepdf[
997 %% pages=-,
998 %% addtotoc={1,section,1,STRAC Attestation,STRAC}
999 %% ]{attestation}
1000
1001 \end{document}
1002 %</insightproposal>
1003 %<*researchcontributions>
1004 \documentclass[insight_proposal]{subfiles}
1005 \begin{document}
1006 \subfiletitle{Research Contributions}
1007
1008 \subfilesection{1. Relevant research contributions over the last six years}
1009
1010 %% Delete any of the subsections below that do not apply to your
1011 %% research contributions.
1012
1013 \subfilesubsection{Refereed contributions}
1014
1015 \begin{refcontext}[sorting=ydnt]
1016 \begin{refsection}{}
1017 \nocite{% Add citation keys to your "refereed contributions" here.
1018 }
1019 \begin{sloppypar}
1020 \printbibliography[heading=none]
1021 \end{sloppypar}
1022 \end{refsection}{}
1023 \end{refcontext}
1024
1025 \subfilesubsection{Other refereed contributions}
1026
1027 \begin{refcontext}[sorting=ydnt]
1028 \begin{refsection}{}
1029 \nocite{% Add citation keys to your "other refereed contributions" here.
1030 }
1031 \begin{sloppypar}
1032 \printbibliography[heading=none]
1033 \end{sloppypar}
1034 \end{refsection}{}
1035 \end{refcontext}
1036
1037 \subfilesubsection{Nonrefereed contributions}
1038
1039 \begin{refcontext}[sorting=ydnt]
1040 \begin{refsection}{}
1041 \nocite{% Add citation keys to your "nonrefereed contributions" here.
1042 }
1043 \begin{sloppypar}
1044 \printbibliography[heading=none]
1045 \end{sloppypar}
1046 \end{refsection}{}
1047 \end{refcontext}
1048
1049 \subfilesubsection{Forthcoming contributions}
1050
1051 \begin{refcontext}[sorting=ydnt]
1052 \begin{refsection}{}
1053 \nocite{% Add citation keys to your "forthcoming contributions" here.
1054 }
1055 \begin{sloppypar}
1056 \printbibliography[heading=none]
1057 \end{sloppypar}
1058 \end{refsection}{}
1059 \end{refcontext}
1060
1061 \subfilesubsection{Creative outputs}
1062
1063 \begin{refcontext}[sorting=ydnt]
1064 \begin{refsection}{}
1065 \nocite{% Add citation keys to your "creative outputs" here.
1066 }
1067 \begin{sloppypar}
1068 \printbibliography[heading=none]
1069 \end{sloppypar}
1070 \end{refsection}{}
1071 \end{refcontext}
1072
1073 \subfilesection{2. Other research contributions}
1074
1075 %% Enter section text here.
1076
1077 \subfilesection{3. Most significant career research contributions}
1078
1079 %% Enter section text here.
1080
1081 \subfilesection{4. Contributions to training}
1082
1083 %% Enter section text here.
1084
1085 \end{document}
1086 %</researchcontributions>
1087 %<*research-creationsupportmaterial>
1088 \documentclass[insight_proposal]{subfiles}
1089 \begin{document}
1090 \subfiletitle{Research-creation Support Material}
1091
1092 %% Enter document text here.
1093
1094 \end{document}
1095 %</research-creationsupportmaterial>
1096 %<*researchteam>
1097 \documentclass[insight_proposal]{subfiles}
1098 \begin{document}
1099 \subfiletitle{Research Team, Student Training, Previous Output}
1100
1101 \subfilesection{Description of the research team}
1102
1103 %% Enter section text here.
1104
1105 \subfilesection{Description of previous and ongoing research results}
1106
1107 %% Enter section text here.
1108
1109 \subfilesection{Description of proposed student training strategies}
1110
1111 %% Enter section text here.
1112
1113 \end{document}
1114 %</researchteam>
1115 %<*summary>
1116 \documentclass[insight_proposal]{subfiles}
1117 \begin{document}
1118 \subfiletitle{Summary of Proposal}
1119
1120 %% Enter form text in the command argument below.
1121 \countchars{}
1122
1123 \end{document}
1124 %</summary>
1125 %<*insightproposalbib>
1126 @article{art1,
1127 author = {Ferenc Farkas and Lili Lakatos and Fruzsina Fekete},
1128 author+an = {1=student;3=student},
1129 title = {A new approach to underwater basket-weaving},
1130 journal = {Journal of Underwater Basket-weaving},
1131 pages = {107--113},
1132 year = 2024,
1133 }
1134
1135 @article{art2,
1136 author = {Lili Lakatos},
1137 title = {An old approach to underwater basket-weaving},
1138 journal = {Journal of Underwater Basket-weaving},
1139 pages = {21--35},
1140 year = 2021,
1141 keywords = {sshrc},
1142 }
1143 %</insightproposalbib>
1144 % \fi
1145 % \Finale