nsf-proposal.cls

\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{nsf-proposal}[2024/04/30 memoir class for NSF proposals]
\RequirePackage{xstring} % for \IfEqCase and \IfEq
\RequirePackage{iftex} % to detect TeX engine

\newcommand{\setvalue}[2]{
    \ifdefined #1
        \renewcommand{#1}{#2}
    \else
        \newcommand{#1}{#2}
    \fi
}
\setvalue{\nsfproposalfont}{cm}

\DeclareOption{arial}{
  % Arial can only work with LuaTeX or XeTeX
  \iftutex
    \setvalue{\nsfproposalfont}{arial}%
  \else
    \ClassError{nsf-proposal}{option arial requires LuaLaTeX or XeLaTeX}%
  \fi
}
\DeclareOption{courier-new}{
  % Courier New can only work with LuaTeX or XeTeX
  \iftutex
    \setvalue{\nsfproposalfont}{courier-new}%
  \else
    \ClassError{nsf-proposal}{option courier-new requires LuaLaTeX or XeLaTeX}%
  \fi
}
\DeclareOption{helvetica}{
  \setvalue{\nsfproposalfont}{helvetica}
}
\DeclareOption{palatino}{
  \setvalue{\nsfproposalfont}{palatino}
}
\DeclareOption{palatino-linotype}{
 % Palatino Linotype can only work with LuaTeX or XeTeX
 \iftutex
   \setvalue{\nsfproposalfont}{palatino-linotype}%
 \else
   \ClassError{nsf-proposal}{option palatino-linotype requires LuaLaTeX or XeLaTeX}%
 \fi
}
\DeclareOption{times-new-roman}{
  % Times New Roman can only work with LuaTeX or XeTeX
  \iftutex
    \setvalue{\nsfproposalfont}{times-new-roman}%
  \else
    \ClassError{nsf-proposal}{option times-new-roman requires LuaLaTeX or XeLaTeX}
  \fi
}

\newif\ifusetg
\usetgfalse % don't use TeX Gyre by default

\DeclareOption{tg}{%
  % Use TeX Gyre font variants
  \iftutex%
    \usetgtrue%
  \else%
    \ClassError{nsf-proposal}{option tg requires LuaLaTeX or XeLaTeX}%
  \fi%
}

\DeclareOption{9pt}{
  \ClassError{nsf-proposal}{base font too small (<10pt)}
}
\DeclareOption{10pt}{
  % if 10pt, can only be:
  % - Arial/Helvetica/Palatino,
  % - Palatino Linotype, or
  % - Courier New
  %
  % https://new.nsf.gov/policies/pappg/23-1/ch-2-proposal-preparation#2C2
  % https://new.nsf.gov/policies/pappg/23-1/ch-2-proposal-preparation#_ftn6
  % https://new.nsf.gov/policies/pappg/24-1/ch-2-proposal-preparation#ch2C2
  % https://new.nsf.gov/policies/pappg/24-1/ch-2-proposal-preparation#ftn7
  \IfEqCase{\nsfproposalfont}{%
    {arial}{}%
    {courier-new}{}%
    {helvetica}{}%
    {palatino}{}%
    {palatino-linotype}{}%
  }[\ClassError{nsf-proposal}{base font too small (10pt) for selected font \nsfproposalfont}]
}

\DeclareOption*{\PassOptionsToClass{\CurrentOption}{memoir}}
\ProcessOptions
\LoadClass[openany]{memoir}

% All the font setup we can't do while processing options
\IfEqCase{\nsfproposalfont}{%
  {arial}{%
    \ifusetg%
      \ClassWarning{nsf-proposal}{option tg has no effect with option arial}%
    \fi%
    \RequirePackage{fontspec}%
    \RequirePackage{unicode-math}
    \setmainfont{Arial}%
    \setsansfont{Arial}%
    \setmathfont{latinmodern-math.otf}%
    \setmathfont[range=up]{Arial}%
    \setmathfont[range=it]{Arial Italic}%
    \setmathfont[range=bfup]{Arial Bold}%
    \setmathfont[range=bfit]{Arial Bold Italic}%
  }%
  {cm}{%
    \ifusetg%
      \ClassWarning{nsf-proposal}{option tg has no effect with (possibly default) option cm}%
    \fi%
  }%
  {courier-new}{%
    \ifusetg%
      \RequirePackage{fontspec}%
      \setmainfont{texgyrecursor}[
        Extension      = .otf,
        UprightFont    = *-regular,
        ItalicFont     = *-italic,
        BoldFont       = *-bold,
        BoldItalicFont = *-bolditalic,
        Ligatures      = NoCommon,
      ]%
    \else%
      \RequirePackage{fontspec}%
      \RequirePackage{unicode-math}
      \setmainfont{Courier New}%
      \setsansfont{Courier New}%
      \setmathfont{latinmodern-math.otf}%
      \setmathfont[range=up]{Courier New}%
      \setmathfont[range=it]{Courier New Italic}%
      \setmathfont[range=bfup]{Courier New Bold}%
      \setmathfont[range=bfit]{Courier New Bold Italic}%
      \fi%
  }%
  {helvetica}{%
    \ifusetg%
      \RequirePackage{fontspec}%
      \setmainfont{texgyreheros}[
        Extension      = .otf,
        UprightFont    = *-regular,
        ItalicFont     = *-italic,
        BoldFont       = *-bold,
        BoldItalicFont = *-bolditalic,
      ]%
    \else%
      \iftutex%
        \RequirePackage{fontspec}%
        \setmainfont{Helvetica}% for lualatex and xelatex, at least on Mac
      \else%
        \RequirePackage[scaled]{helvet}%
        \RequirePackage{sansmath}%
        \renewcommand{\familydefault}{\sfdefault}% for pdflatex, ends up with Nimbus Sans L
      \fi%
    \fi%
  }%
  {palatino}{%
    \ifusetg%
      \RequirePackage{fontspec}%
      \setmainfont{texgyrepagella}[
        Extension      = .otf,
        UprightFont    = *-regular,
        ItalicFont     = *-italic,
        BoldFont       = *-bold,
        BoldItalicFont = *-bolditalic,
      ]%
    \else%
      \iftutex%
        \RequirePackage{fontspec}%
        \setmainfont{Palatino}%
      \else%
        \RequirePackage{mathpazo}%
      \fi%
    \fi%
  }%
  {palatino-linotype}{%
    \ifusetg%
      \ClassWarning{nsf-proposal}{option tg has no effect with option palatino-linotype}%
    \fi
    \RequirePackage{mathpazo}
    \RequirePackage{fontspec}
    \setmainfont{Palatino Linotype}%
  }%
  {times-new-roman}{%
    \ifusetg%
      \RequirePackage{fontspec}%
      \RequirePackage{unicode-math}
      \setmainfont{texgyretermes}[
        Extension      = .otf,
        UprightFont    = *-regular,
        ItalicFont     = *-italic,
        BoldFont       = *-bold,
        BoldItalicFont = *-bolditalic,
      ]%
      \setmathfont{latinmodern-math.otf}%
    \else%
      \RequirePackage{fontspec}%
      \RequirePackage{unicode-math}
      \setmainfont{Times New Roman}%
      \setmathfont{latinmodern-math.otf}%
      \setmathfont[range=up]{Times New Roman}%
      \setmathfont[range=it]{Times New Roman Italic}%
      \setmathfont[range=bfup]{Times New Roman Bold}%
      \setmathfont[range=bfit]{Times New Roman Italic}%
    \fi%
  }%
}

% Page setup
\setstocksize{11in}{8.5in}
\setlrmarginsandblock{1.0in}{1.0in}{*}
\setulmarginsandblock{1.0in}{1.05in}{*}
\raggedbottom

\checkandfixthelayout

% Clear out page headers/footers
\AtBeginDocument{%
  \aliaspagestyle{chapter}{empty}%
  \makeoddhead{headings}{}{}{}%
  \makeevenhead{headings}{}{}{}%
}

% NSF's PDF parsers are too picky about the definition of ``no more than 6
% lines per inch'', so we add a bit of spacing when we're right at that
% limit for 10pt documents.
\AtBeginDocument{%
  \makeatletter%
  \ifdimcomp{\dimexpr\f@size pt}{>}{10pt}{% do nothing if >10pt
    }{% set lengths if <=10pt
    \setlength{\baselineskip}{12.05pt}%
    \@ifpackageloaded{biblatex}{%
      % Not sure why biblatex doesn't want to inherit the default spacing
      \appto{\bibsetup}{\setSpacing{1.004}}%
     }{}%
  }%
  \makeatother%
}

% Document division formatting: headstyle settings apply to that level and
% below, unless overridden

\chapterstyle{article} % no page breaks between chapters

% Unnumbered chapters, larger bold font, centered, whitespace before/after
\renewcommand{\chaptitlefont}{\normalfont\large\bfseries\centering}
\setlength{\beforechapskip}{0.25\baselineskip}
\setlength{\afterchapskip}{0.25\baselineskip}
\renewcommand{\printchapternum}{}

% Lettered sections, normal size bold font, centered, whitespace before/after
\setbeforesecskip{-0.45\baselineskip}
\setaftersecskip{0.25\baselineskip}
\setsecheadstyle{\normalfont\bfseries\centering}
\renewcommand{\thesection}{\Alph{section}}
\setsecnumformat{\csname the#1\endcsname:\quad}

% Lettered/numbered subsections, normal size bold font, whitespace before/after
\setbeforesubsecskip{-0.25\baselineskip}
\setaftersubsecskip{0.25\baselineskip}
\setsubsecheadstyle{\normalfont\bfseries}

% Unnumbered subsubsections and paragraphs, some whitespace before, inline bold
% title, whitespace after
\setsecnumdepth{subsection}
\setbeforesubsubsecskip{0.25\baselineskip}
\setaftersubsubsecskip{-\baselineskip}
\setbeforeparaskip{0.25\baselineskip}
\setafterparaskip{-\baselineskip}

% Number figures and tables continuously, not by chapter
\counterwithout{table}{chapter}
\counterwithout{figure}{chapter}

% URLs and other hyperlinks
\RequirePackage[bookmarks=false,
  pdfpagelabels=false,
  hyperfootnotes=false,
  hyperindex=false,
  pageanchor=false]{hyperref}

% How to turn on/off certain types (e.g. citation, url, file) of hyperref
% links? https://tex.stackexchange.com/a/117676
\let\saved@hyper@linkurl\hyper@linkurl
%\let\saved@hyper@linkfile\hyper@linkfile
\let\saved@hyper@link@\hyper@link@
\AtBeginDocument{%
  % Since the whole document is affected, only the \begin part of
  % environment `NoHyper' is needed.
  \NoHyper
  \let\hyper@linkurl\saved@hyper@linkurl % needed by \url
  %\let\hyper@linkfile\saved@hyper@linkfile % needed by \href{<file>}
  \let\hyper@link@\saved@hyper@link@ % needed by \href{<url>}
}

\endinput