1
0
Fork 0
lvspec/lvspec.cls

764 lines
18 KiB
OpenEdge ABL
Raw Normal View History

% LoVullo Specification class
\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{lvspec}
2013-08-21 10:37:52 -04:00
\newif\iflvspec@draft
\newif\iflvspec@bw
2013-08-22 11:07:57 -04:00
\newif\iflvspec@term@dev \newif\iflvspec@term@ins
2013-08-21 10:37:52 -04:00
\DeclareOption{draft}{%
\global\lvspec@drafttrue
\PassOptionsToClass{\CurrentOption}{scrreprt}%
}
2013-08-21 10:37:52 -04:00
\DeclareOption{bw}{\global\lvspec@bwtrue}
2013-08-22 11:07:57 -04:00
\DeclareOption{devterms}{\global\lvspec@term@devtrue}
2013-08-21 13:45:41 -04:00
\DeclareOption{insuranceterms}{\global\lvspec@term@instrue}
\DeclareOption*{\PassOptionsToClass{\CurrentOption}{scrreprt}}
\ProcessOptions\relax
2013-08-21 10:37:52 -04:00
% base class, defaulting to 10pt
\LoadClass[10pt]{scrreprt}
\RequirePackage{xparse}
2014-05-15 12:42:42 -04:00
\RequirePackage{tenativeerr}
\RequirePackage[top=4.5cm,bottom=5cm,width=\textwidth]{geometry}
\RequirePackage{makeidx}
\RequirePackage{minitoc}
\RequirePackage{titlesec}
\RequirePackage{hyperref}
\RequirePackage[usenames,dvipsnames]{xcolor}
\RequirePackage{url}
\RequirePackage{varioref}
\RequirePackage{amsmath}
2013-08-21 12:23:24 -04:00
\RequirePackage{amssymb}
\RequirePackage{multirow}
2013-08-21 10:50:37 -04:00
\RequirePackage{task}
\RequirePackage{booktabs}
2013-09-12 12:15:05 -04:00
\RequirePackage{paralist}
2013-08-23 11:09:48 -04:00
% default hyperlink color
\definecolor{hyperlink}{HTML}{000040}
% unless black and white
\iflvspec@bw
\definecolor{hyperlink}{HTML}{000000}
\fi
\hypersetup{
% get rid of box in older versions of hyperref
colorlinks=true,
linkcolor=hyperlink,
citecolor=black,
filecolor=black,
urlcolor=blue,
final % enable links in draft mode
}
% reduce section spacing after sections and before subsections (carefully
% balanced with \parskip below)
\titlespacing{\section}{0em}{1em plus 1em minus 0.5em}{0em plus 0.5em}
\titlespacing{\subsection}{0em}{0em plus 0.5em}{0em}
\titlespacing{\subsubsection}{0em}{0em plus 0.5em}{0em}
% remove indentation and provide flexible paragraph spacing (this style of
% display is more appropriate for paragraph numbering)
\parindent0ex
\parskip1em plus 0.2em minus 0.5em
% show subsubsection numbers
\setcounter{tocdepth}{4}
\setcounter{minitocdepth}{4}
\setcounter{secnumdepth}{4}
% the version string is taken directly from a file written by the build process
\def\@verstr{{%
\footnotesize\tt
% if verstr.tex exists, then use that as the version string; otherwise, fall
% back to the current date
\IfFileExists{verstr.tex}%
{\input{verstr.tex}}%
{\number\year-\number\month-\number\day}%
}}
2013-08-21 10:48:16 -04:00
\let\@lvspec@premarktitle\relax
\def\@oddhead{\small\sc\rightmark\hfill\@lvspec@premarktitle\@title@short}
\let\@evenhead\@oddhead
\def\@oddfoot{\S\thefullsection\hfill\thepage\hfill\@verstr}
\let\@evenfoot\@oddfoot
% section numbers will appear in the margin and the chapter number will be
% slightly enlarged
\titleformat{\chapter}
{\huge\bfseries\sffamily}
{\llap{{\Huge\thechapter}\hskip1ex}}
{0em}
{\aftergroup\minitoc\aftergroup\minilot\aftergroup\minilof}
\titleformat{\section}
{\Large\bfseries\sffamily}
{\llap{\thesection\hskip1ex}}
{0em}
{}
\titleformat{\subsection}
{\large\bfseries\sffamily}
{\llap{\thesubsection\hskip1ex}}
{0em}
{}
\titleformat{\subsubsection}
{\normalsize\bfseries\sffamily}
{\llap{\thesubsubsection\hskip1ex}}
{0em}
{}
% lazy
\let\@minitoc@orig\minitoc
\def\minitocoff{\gdef\minitoc{}}
\def\minitocon{\global\let\minitoc\@minitoc@orig}
% enable index generation and minis
\makeindex
\dominitoc \dominilot \dominilof
2013-08-21 10:37:52 -04:00
\let\@title@orig\title
\renewcommand\title[2][]{{%
\def\@@short{#1}%
\@title@orig{#2}%
% use the full title if no short title is provided
\ifx\@@short\empty
\gdef\@title@short{#2}%
\else
\gdef\@title@short{#1}%
\fi
}}
% we'll output a bibliography if \cite is used
\newif\iflvspec@bib
\let\cite@orig\cite
\def\cite{%
\global\lvspec@bibtrue
% restore original command and re-invoke
\global\let\cite\cite@orig
\cite
}
%%
% Paragraph numbering and example environment
%
\newcount\pn \newcount\pnn
\pn0\relax \pnn1\relax
\newcount\pne
\pne1\relax
\def\pnum{{%
% never show paragraph numbers within an environment (LaTeX stores the name of
% the current environment in @currenvir)
2013-08-21 10:37:52 -04:00
\def\@@document{document}%
\def\@@premcalc{premcalc}%
2013-09-12 12:46:04 -04:00
\def\@@forms{forms}%
\def\@@protdev{protdev}%
2013-09-13 15:16:15 -04:00
\def\@@coglclass{c1glclass}%
2013-08-21 10:37:52 -04:00
% allow document by default
\let\@@cmp\@currenvir
2013-09-12 12:46:04 -04:00
% XXX: moveme
% allow premcalc env
\ifx\@currenvir\@@premcalc
\let\@@cmp\@@document
2013-09-12 12:46:04 -04:00
\else\ifx\@currenvir\@@forms
\let\@@cmp\@@document
2013-09-13 12:19:32 -04:00
\else\ifx\@currenvir\@@protdev
\let\@@cmp\@@document
\else\ifx\@currenvir\@@coglclass
\let\@@cmp\@@document
\fi\fi\fi\fi
% output if match
\ifx\@@cmp\@@document%
\ifx\haspnum1\relax
\@margin@sig%
\global\advance\pn1\relax%
\global\advance\pnn1\relax%
\global\pne0\relax%
\ifvmode\leavevmode\fi%
\llap{\the\pn. \,\,}%
\fi
\fi
}}
% margin area for paragraph signatures (initials)
\def\@margin@sig{%
% if in draft mode, add a spot next to the paragraph for initials
2013-08-21 10:37:52 -04:00
\iflvspec@draft%
\pnumoff%
\marginpar{%
\ifx\@@margin@sig@repl\empty%
% generate signature line slightly below the line itself
\underline{\hspace{3em}}%
\ifx\@@margin@sig@dept\relax
% one needs to be assigned
2013-08-21 10:37:52 -04:00
\PackageWarning{lvspec}{missing authorization party in%
\space\thechapter.\thesection}%
\else
\index{Needs Authorization@\textbf{Needs Authorization}!%
\@@margin@sig@dept
}%
\space{\scriptsize(\@@margin@sig@dept)}%
% clear the department, if necessary
\@margin@sig@cleardept
\fi
\else%
% use custom line and clear it
\@@margin@sig@repl%
\if@keepsigtext\else
\gdef\@@margin@sig@repl{}%
\fi
\fi%
}%
\pnumon%
\fi%
}
% for use externally
\let\signline\@margin@sig
\def\sigkeep{\global\@keepsigtexttrue}
\def\sigunkeep{
\global\@keepsigtextfalse
\gdef\@@margin@sig@repl{}%
}
% optional replacement text for next signature line
\let\@@margin@sig@repl\relax
% department that should do the signing
\let\@@margin@sig@dept\relax
\newif\if@@sectiondept
\let\@@groupdept\relax
\def\@margin@sig@cleardept{%
% do not clear if we're in a department group
\ifx\@@groupdept\relax
\global\let\@@margin@sig@dept\relax
\fi
}
% specifies the department(s) that are the intended audience (applies for a
% single signature line)
\def\dept#1{%
\def\@@margin@sig@dept{%
\hyperref[s:authorize]{\uppercase{#1}}%
}%
}
% indicates that an entire section applies to a given department (will be
% automatically cleared when a new section is encountered)
\def\sectiondept#1{%
\dept{#1}%
\@@sectiondepttrue
\def\@@groupdept{}%
}
% applies a department until the group is closed (may be nested); will clear
% section grouping
\def\begindeptgroup#1{%
\begingroup
\dept{#1}%
% using this def instead of an if boolean allows us to nest (will go out of
% scope when the group is ended)
\def\@@groupdept{}%
% disable section grouping (to prevent clearing the department when a new
% section is encountered)
\@@sectiondeptfalse
}
\def\enddeptgroup{%
\endgroup
}
% add paragraph numbering (we can't just set \everypar like we can in good 'ol
% TeX because LaTeX has its way with it)
\let\oldep\everypar
\let\haspnum0\relax
\let\hadpnum0\relax
\newtoks\everyparon
\newtoks\everyparoff
\def\pnumon{%
\oldep{\the\everyparon\pnum}%
\let\hadpnum\haspnum%
\let\haspnum1%
}
\def\pnumoff{%
\oldep{\the\everyparoff}%
\let\hadpnum\haspnum%
\let\haspnum0%
}
\def\pnumrest{%
\ifx\hadpnum1\relax
\pnumon%
\else%
\pnumoff%
\fi%
}
% outputs what will be the next page number
\def\sinit{%
\pn0\relax \pnn1\relax
% clear any department sections, if necessary
\if@@sectiondept
\@@sectiondeptfalse
\global\let\@@margin@sig@dept\relax
\fi
}
\let\@chapterorig\chapter
\let\@sectionorig\section
\let\@subsectionorig\subsection
\let\@subsubsectionorig\subsubsection
\let\@footnoteorig\footnote
\let\@footnotetextorig\footnotetext
% override chapter/section macros (it is important not to do this until we are
% sure that nothing with use \chapter, as that formally does not accept an
% argument...we treat it as though it does in order to make life easier)
\def\@hgcommon{%
\pnumrest
\phantomsection
\sinit
}
\def\@hgrab{
\gdef\chapter##1{\pnumoff\@chapterorig{##1}\@hgcommon}
\gdef\section##1{\pnumoff\@sectionorig{##1}\@hgcommon\smarkright{##1}}
\gdef\subsection##1{\pnumoff\@subsectionorig{##1}\@hgcommon\smarkright{##1}}
\gdef\subsubsection##1{\pnumoff\@subsubsectionorig{##1}\@hgcommon}
\gdef\footnote##1{\pnumoff\@footnoteorig{##1}\pnumrest}
\gdef\footnotetext##1{\pnumoff\@footnotetextorig{##1}\pnumrest}
}
% restore headings
\def\@hrestore{
\let\chapter\@chapterorig
\let\section\@sectionorig
\let\subsection\@subsectionorig
\let\subsubsection\@subsubsectionorig
\let\footnote\@footnoteorig
\let\footnotetext\@footnotetextorig
}
\def\smarkright#1{\markright{\S\thefullsection~#1}}
% these may be used for included files that aren't sure what level of section
% nesting they may be included at
\def\nextsection{%
\begingroup%
\ifnum\value{subsubsection}>0\relax%
\errmessage{Sorry; section nesting is too deep}%
\else\ifnum\value{subsection}>0\relax%
\aftergroup\subsubsection%
\else\ifnum\value{section}>0\relax%
\aftergroup\subsection%
\else%
\aftergroup\section%
\fi\fi\fi%
\endgroup%
}
% outputs the full section number, regardless of current depth
\def\thefullsection{%
\ifnum\value{subsubsection}>0\relax%
\thesubsubsection%
\else\ifnum\value{subsection}>0\relax%
\thesubsection%
\else\ifnum\value{section}>0\relax%
\thesection%
\else%
\thechapter%
\fi\fi\fi%
}
\def\thepne{\ifnum\the\pne>1\relax-\the\pne\fi}
\newenvironment{ex}%
{%
\goodbreak%
\global\advance\pne1\relax%
\list{}{%
\leftmargin4ex
\item\relax
\small%
}%
{\bf Example \thefullsection-\the\pn\thepne:\space}%
\ignorespaces
}%
{%
$\square$
\endlist
\par
\goodbreak
}
%%
% Common macros
%
\def\shall {Shall }
\let\Shall\shall
\def\shallnot {Shall Not }
\let\Shallnot\shallnot
\def\must {Must }
\def\mustnot {Must Not }
\def\may {May }
\let\May\may
\def\exempt {Exempt }
\def\unspecified{Unspecified}
\AtBeginDocument{%
% this guy causes problems with some macros that make the poor choice of using
% \undefined to represent a macro that is, well, not defined
\gdef\undefined{Undefined}
}
% formatting
\def\dt#1{%
\goodbreak%
\@dt@idx#1;||%
\item[#1]\hfill\\%
% display signature area in margin
\@margin@sig%
% get rid of mysterious magical hspace that appears from the marginpar
\hskip-1ex\relax%
}
\def\dfn#1{%
2013-09-12 13:06:48 -04:00
\begingroup
\ifx#1*
\aftergroup\dfn%
2013-09-12 13:06:48 -04:00
\else
\sl
\@idxhat@idx{#1}%
2013-09-12 13:06:48 -04:00
\fi
\endgroup
}
\def\rfc#1{{\tt RFC #1}}
\def\hex#1{{\tt 0x#1}}
\def\code#1{{\tt#1}}
2013-08-22 09:14:33 -04:00
\def\cmd{\path}
\def\func#1{{\tt #1()}}
\def\set#1{%
\ifmmode%
\left\{#1\right\}%
\else%
$\set{#1}$%
\fi%
}
2013-08-23 15:51:17 -04:00
% enough space for a number (all numbers are the same width, so this works well
% for quick-n-dirty alignment)
\newcommand\z{\phantom{0}}
% non-technical-reader-friendly if not in math mode
\def\true{\ifmmode\top\else Yes\fi}
\def\false{\ifmmode\bot\else No\fi}
\def\vecset#1{%
\ifmmode%
\left[\,#1\,\right]%
\else%
$\vecset{#1}$%
\fi%
}
\def\todo#1{{\sc Todo: \it#1\/}}
% trim a single space from the left, if present
\def\@triml#1{\ifx#1\ \else#1\fi}
% trim all spaces at the right, if present
\def\@trimr#1 |||{#1}
% properly adds semicolon-delimited terms to the index
\def\@dt@idx#1;#2||{%
\def\@second{#2}%
\index{\@triml#1}%
% recurse if we have more
\ifx\@second\empty\else%
% will already having a trailing semi-colon, so do not re-add
\@dt@idx#2||
\fi%
}
% refs
\def\fref#1{Figure~\vref{f:#1}}
\def\frefnopg#1{Figure~\ref{f:#1}}
2013-08-27 08:30:52 -04:00
\def\tref#1{Table~\vref{t:#1}}
\def\sref#1{\S\vref*{s:#1}}
\def\srefnopg#1{\S\ref{s:#1}}
\def\srefrange#1#2{\S\vrefrange{s:#1}{s:#2}}
\def\srefpagerange#1#2{\vpagerefrange*{s:#1}{s:#2}}
\let\Sref\sref
\def\p#1{%
% define pref and prefp macros that store, respectively, the section number
% and page number (for example, if #1=foo, then this will create pref@foo and
% prefp@foo); note that this is used before a paragraph begins, so we increase
% the paragraph number by one before storing it
\label{@pref:#1}
\expandafter\xdef\csname pref@#1\endcsname{\thefullsection-\the\pnn}
\expandafter\xdef\csname prefp@#1\endcsname{\thepage}
}
% TODO: forward references
\def\pref#1{%
\P\hyperref[@pref:#1]{\csname pref@#1\endcsname}%
% only output the page number if it is not the current page (we decrease the
% current page number by 1 to account for the fact that the page number may be
% off by one due to page box calculations; this consequently means that we may
% not display the page number on a following page, which should be fine)
\newcount\@@thepage \@@thepage\thepage \advance\@@thepage-1
\expandafter\let\expandafter\@pg\csname prefp@#1\endcsname
\ifx\@pg\relax\else
\ifnum\@@thepage>\@pg\relax%
\space on page~\pageref{@pref:#1}%
\fi
\fi
}
\newif\if@keepsigtext
\@keepsigtextfalse
% denotes incomplete sections/paragraphs
\def\@incomplete@default{{\small\bf Incomplete.}}
\def\incomplete{%
\gdef\@@margin@sig@repl{%
\index{Incomplete@\textbf{Incomplete}}%
\@incomplete@default
}%
}
\def\incompletei{%
\gdef\@@margin@sig@repl{%
\@incomplete@default\\%
\begingroup
\scriptsize
\space(Need more info%
\ifx\@@margin@sig@dept\relax\else
\space from\space\@@margin@sig@dept%
% clear the department, if necessary
\@margin@sig@cleardept
\fi
\index{Incomplete@\textbf{Incomplete}!\@@margin@sig@dept}%
.)%
\endgroup
}%
}%
2013-09-09 11:41:24 -04:00
% temporary until sPxTeX, after which it will be deprecated (but *never*
% removed, for bc)
\def\sigauth#1{%
\gdef\@@margin@sig@repl{%
\index{Approved@\textbf{Approved}}%
\raisebox{0ex}[2ex][1ex]{%
\shortstack{%
{\small\bf Approved.}%
\\%
{\scriptsize\sl by #1}%
}%
}%
}%
}
%%
% idxhat (index)
%
\def\@idxhat#1{%
\begingroup%
\ifmmode\@hat#1\else%
\ifx#1[%
\aftergroup\@idxhat@contained%
\else
\aftergroup\@idxhat@term%
\fi%
\aftergroup#1%
\fi%
\endgroup%
}
% term ends at the first space
\def\@idxhat@term#1 {\@idxhat@idx{#1} }
% grouped in [square brackets]
\def\@idxhat@contained[#1]{\@idxhat@idx{#1}}
\def\@idxhat@idx#1{\index{#1}\@idxhat@tail#1!||}
% strips all parents
\def\@idxhat@tail#1!#2||{%
% we're done once #2 is empty
\def\@chk{#2}%
\ifx\@chk\@empty%
#1%
\else%
% will already have a trailing '!'; don't add another
\@idxhat@tail#2||%
\fi%
}
% prepares for idxhat to be enabled, at some point
\let\@hat^
\begingroup
\catcode`\^=\active
\global\let^\@idxhat
\endgroup
% allow use of ^ (hat) as short-hand for adding entries to the index (inspired
% by Knuth's convention, mentioned in TeXbook)
\newcommand\idxhaton{%
% allow ^ to be used as a command
\global\catcode`\^=\active
}
\newcommand\idxhatoff{%
% restore to normal
\global\catcode`\^=7\relax
}
%%
% Hyphenation
%
\hyphenation{Concept-One}
2013-09-18 14:46:03 -04:00
\hyphenation{De-Rou-sseau}
2013-08-21 10:37:52 -04:00
%%
% Begin common content
%
2013-08-21 10:48:16 -04:00
\let\@lvspec@terminology\relax
2013-08-22 11:07:57 -04:00
\let\@lvspec@insterminology\relax
2013-08-21 10:48:16 -04:00
\let\@lvspec@abstract\relax
\let\@lvspec@pretitle\relax
\let\@lvspec@posttitle\relax
\let\@lvspec@titlecontent\relax
2013-08-21 10:37:52 -04:00
% allows us to use the abstract command whilst still using the environment
\let\@abstract\abstract
\let\end@abstract\endabstract
\newcommand\titlecontent[1]{%
\gdef\@lvspec@titlecontent{#1}%
}
2013-08-21 10:37:52 -04:00
\renewcommand\abstract[1]{%
\gdef\@lvspec@abstract{#1}%
}
\newcommand\terminology[1]{%
\gdef\@lvspec@terminology{#1}%
}
2013-08-22 11:07:57 -04:00
\iflvspec@term@ins
\newcommand\insuranceterminology[1]{%
\gdef\@lvspec@insterminology{#1}%
}
\fi
2013-08-21 10:37:52 -04:00
\renewcommand\maketitle{%
\begin{titlepage}
\begin{center}
% left and right borders
\llap{\rule{6pt}{\textheight}\hspace{4em}}
\marginpar{\hspace{4em}\rule{6pt}{\textheight}}
% content
\begingroup
\vspace{-\textheight}
\sc\Huge
\@lvspec@pretitle
\@title
\\
% indicate drafts
\iflvspec@draft
\vspace{2em}%
(Working Draft)\\
\fi
\endgroup
\vspace{5em}%
\begingroup
\Large
\@author\\LoVullo Associates\\
\vspace{2em}%
\vfill
\@lvspec@titlecontent
2013-08-21 10:37:52 -04:00
\today
\endgroup
\end{center}
\end{titlepage}
\begin{@abstract}
\@lvspec@abstract
\iflvspec@draft
\par
\emph{This specification is currently under development;} please direct
any questions to the appropriate party as shown in \sref{authorize}.
\fi
\vfill\raggedleft
\begingroup
\small
Copyright \copyright\ 2013 LoVullo Associates, Inc.\\
This document was generated on \today.\\
Version identifier: \@verstr
\endgroup
\end{@abstract}
\dominitoc \dominilot \dominilof
\tableofcontents \fakelistoftables \fakelistoffigures
2013-08-21 10:37:52 -04:00
\newpage
% enable paragraph numbering
\pnumon\@hgrab
\idxhaton
2013-08-21 10:37:52 -04:00
\section{Definitions}
\label{s:dfns}
\sectiondept{pm}
The definitions in this section \shall supersede any other uses of these terms,
regardless of their common use in the insurance industry or elsewhere.
2013-09-11 08:54:19 -04:00
\sigauth{NL}
2013-08-21 10:37:52 -04:00
Multiple terms that share the same definition will be delimited with semicolons.
\subsection{Specification Terminology}
\input{dfn/spec}
2013-08-22 11:07:57 -04:00
\iflvspec@term@dev
\subsection{Developer Terminology}
\input{dfn/dev}
\fi
2013-08-21 10:37:52 -04:00
2013-08-21 13:45:41 -04:00
\iflvspec@term@ins
\subsection{Insurance Terminology}
\input{dfn/ins}
2013-08-22 11:07:57 -04:00
% add any additional insurance terminology, if any
\@lvspec@insterminology
2013-08-21 13:45:41 -04:00
\fi
% include any custom terminology
\@lvspec@terminology
2013-08-21 10:37:52 -04:00
% signatures apply only to draft mode (we place this at the end of the other
% subsections so that the section numbering will not change between the two
% modes)
\iflvspec@draft
\phantomsection% correct hyperref issue
2013-08-21 10:37:52 -04:00
\subsection{Authorization Parties}
\input{dfn/authparty}
\fi
% post-title hooks for content to be rendered at beginning document
\@lvspec@posttitle
2013-08-21 10:37:52 -04:00
}
\AtEndDocument{%
\pnumoff\@hrestore
% only output bibliography if \cite was used
\iflvspec@bib
\bibliographystyle{plain}
\renewcommand{\bibname}{References}
2013-09-12 12:16:27 -04:00
\addcontentsline{toc}{chapter}{References}
\bibliography{common}
\fi
2013-08-21 10:37:52 -04:00
\begingroup
\markright{Index}
\small
\catcode`_=11\relax% due to allowing underscores as letters previously
\printindex
\endgroup
}