| 1 |
% \iffalse meta-comment |
| 2 |
% |
| 3 |
% Copyright 2002-2003 M. C. DeMarco |
| 4 |
% Also copyright any individual authors listed in this file. |
| 5 |
% |
| 6 |
% This file provides the latex class sffms.cls and supporting files. |
| 7 |
% ------------------------------------------------------------------ |
| 8 |
% |
| 9 |
% It may be distributed and/or modified under the conditions of the |
| 10 |
% LaTeX Project Public License, either version 1.2 of this license or |
| 11 |
% (at your option) any later version. |
| 12 |
% The latest version of this license is in |
| 13 |
% http://www.latex-project.org/lppl.txt |
| 14 |
% and version 1.2 or later is part of all distributions of LaTeX |
| 15 |
% version 1999/12/01 or later. |
| 16 |
% |
| 17 |
% ** To produce the package documentation, run latex on this file. ** |
| 18 |
% |
| 19 |
% \fi |
| 20 |
% |
| 21 |
% \iffalse |
| 22 |
%<*driver> |
| 23 |
\documentclass{ltxdoc} |
| 24 |
\OnlyDescription % Comment out to print the code as well |
| 25 |
\begin{document} |
| 26 |
\title{The \textsf{sffms} package} |
| 27 |
\author{M. C. DeMarco\\ |
| 28 |
\texttt{[email protected]}} |
| 29 |
\date{2003/03/13} |
| 30 |
\maketitle |
| 31 |
\DocInput{sffms.dtx} |
| 32 |
\end{document} |
| 33 |
%</driver> |
| 34 |
% \section{Identification} |
| 35 |
% \begin{macrocode} |
| 36 |
%<sffms>\NeedsTeXFormat{LaTeX2e} |
| 37 |
%<sffms>\ProvidesClass{sffms}[2003/03/13 v2.0 |
| 38 |
%<smart>\ProvidesPackage{sffsmart}[2001/09/10 v1.0 |
| 39 |
%<dumb>\ProvidesPackage{sffdumb}[2001/09/23 v1.1 |
| 40 |
%<sffms> The SF/F manuscript class] |
| 41 |
%<smart|dumb> Quotation mark utility for sffms.cls] |
| 42 |
% \end{macrocode} |
| 43 |
% \fi |
| 44 |
% |
| 45 |
% \changes{v0.1}{2001/08/29}{Created sffms.cls from sfms.cls by Kevin |
| 46 |
% Russell} |
| 47 |
% \changes{v0.1}{2001/08/29}{Passed all options to report.cls, making |
| 48 |
% the non-submission format mostly transparent. The only additions |
| 49 |
% were real typeset scene breaks (a blank line) and real book |
| 50 |
% headers (author and title on facing pages) for the twoside option.} |
| 51 |
% \changes{v0.1}{2001/08/29}{Changed the commands slightly, gave most |
| 52 |
% of them default values, and added commands for user configuration |
| 53 |
% of the scene separator and ``The End''.} |
| 54 |
% \changes{v0.1}{2001/08/29}{Reredefined chapter so that chapter* |
| 55 |
% works in submissions, changed fancyheader calls to non-deprecated |
| 56 |
% versions.} |
| 57 |
% \changes{v0.1}{2001/08/29}{Added rudimentary documentation to the |
| 58 |
% class file.} |
| 59 |
% \changes{v0.2}{2001/09/02}{Added the magic command from ulem.sty to |
| 60 |
% change boldface (\bf) to squiggly lines in submission format} |
| 61 |
% \changes{v0.2}{2001/09/02}{Added quote smartening option (using |
| 62 |
% quote.sty), novel option and notitle option} |
| 63 |
% \changes{v0.2}{2001/09/02}{Fixed the a4paper option, I hope} |
| 64 |
% \changes{v0.2}{2001/09/02}{Added the ifsubmission command to mask |
| 65 |
% fancy markup (and text)} |
| 66 |
% \changes{v0.2}{2001/09/02}{Added the synopsis environment for book |
| 67 |
% synopses} |
| 68 |
% \changes{v0.2}{2001/09/02}{Changed spacing to 1.83 and neatened the |
| 69 |
% code} |
| 70 |
% \changes{v0.3}{2001/09/04}{Added quote dumbing option} |
| 71 |
% \changes{v0.3}{2001/09/04}{Ported sffms.cls and support files to |
| 72 |
% dtx file, added more documentation} |
| 73 |
% \changes{v0.3}{2001/09/04}{Switched from doublespace package to |
| 74 |
% setspace} |
| 75 |
% \changes{v1.0}{2001/09/10}{Improved documentation} |
| 76 |
% \changes{v1.0}{2001/09/10}{Reworked submission title page spacing and |
| 77 |
% added the disposable command} |
| 78 |
% \changes{v1.1}{2001/09/23}{Cut back on non-submission formatting} |
| 79 |
% \changes{v1.1}{2001/09/23}{Fixed spacing for ``The End''} |
| 80 |
% \changes{v1.1}{2001/09/23}{Quote spacing fixed and code for sffdumb |
| 81 |
% improved, thanks to Donald Arsenault and Martin Vaeth} |
| 82 |
% \changes{v1.2}{2002/03/17}{Added documentation} |
| 83 |
% \changes{v1.2}{2002/03/17}{Code cleanup, thanks to Daniel Richard G.} |
| 84 |
% \changes{v1.2}{2002/03/17}{Added submit, nosubmit and msheading |
| 85 |
% commands} |
| 86 |
% \changes{v1.3}{2002/03/17}{Double underline for textsc} |
| 87 |
% \changes{v1.3}{2002/03/18}{Added undocumented command pageofpages} |
| 88 |
% \changes{v1.3}{2002/03/18}{Made a rough automatic word count} |
| 89 |
% \changes{v1.3}{2002/03/23}{Fixed automatic word count} |
| 90 |
% \changes{v1.3}{2002/03/23}{Hid some internal defs and cleaned up code} |
| 91 |
% \changes{v1.3}{2002/03/23}{Documented LaTeX spacing commands} |
| 92 |
% \changes{v2.0}{2003/03/13}{Removed dependencies on ifthen and geometry |
| 93 |
% packages, made geometry an option} |
| 94 |
% \changes{v2.0}{2003/03/13}{Added baen, daw and wotf options} |
| 95 |
% \changes{v2.0}{2003/03/13}{Added troubleshooting section, a table of |
| 96 |
% contents, and various other improvements to the documentation} |
| 97 |
% |
| 98 |
% |
| 99 |
% \newcommand{\DescribeOption}[1]{\DescribeEnv{[#1]}} |
| 100 |
% |
| 101 |
% \begin{abstract}\noindent |
| 102 |
% Documentation for |sffms|, a \LaTeX\ class for typesetting fiction |
| 103 |
% manuscripts in the standard formats used in science-fiction/fantasy |
| 104 |
% publishing. |
| 105 |
% \end{abstract} |
| 106 |
% |
| 107 |
% \noindent |
| 108 |
% This \LaTeX\ class was modified from |sfms.cls|, copyright Kevin Russell |
| 109 |
% 2000, under the terms of the \LaTeX\ Project Public License. |
| 110 |
% The file |sffms.dtx| may be redistributed and/or modified under the |
| 111 |
% terms of the \LaTeX\ Project Public License, distributed from CTAN |
| 112 |
% archives in the directory macros/latex/base/lppl.txt---either |
| 113 |
% version 1.2 of the License, or any later version. |
| 114 |
% |
| 115 |
% |
| 116 |
% \newif\ifmulticols |
| 117 |
% \IfFileExists{multicol.sty}{\multicolstrue}{} |
| 118 |
% \ifmulticols |
| 119 |
% \addtocontents{toc}{% |
| 120 |
% \protect\setlength{\columnsep}{3pc}% |
| 121 |
% \protect\begin{multicols}{2}} |
| 122 |
% \fi |
| 123 |
% {\parskip 0pt |
| 124 |
% \tableofcontents |
| 125 |
% } |
| 126 |
% |
| 127 |
% \section{About {\tt sffms}} |
| 128 |
% |
| 129 |
% The |sffms| package produces a double-spaced manuscript in a 12-point |
| 130 |
% monospaced font with one-inch margins and running headers of the form |
| 131 |
% |Author/TITLE/n|, where |n| is the current page number. |
| 132 |
% On the title page, the author's name and address appear in the upper |
| 133 |
% left corner, the word count and an optional note that the manuscript |
| 134 |
% is disposable in the upper right, and the title and author in the |
| 135 |
% center of the page. For a short story, the text begins four lines |
| 136 |
% below, and for a novel, on the next page. Some publisher-specific |
| 137 |
% variants of the format are also supported. |
| 138 |
% |
| 139 |
% Other features of |sffms| include an optional single-spaced synopsis, |
| 140 |
% automatic conversion of italics, boldface, and small caps to |
| 141 |
% appropriately underlined text, and a rough automatic word count. |
| 142 |
% Simply by including the |nonsubmission| option, |
| 143 |
% the same document may be typeset in \LaTeX's usual professional |
| 144 |
% way. The non-submission format can be customized without |
| 145 |
% affecting the appearance of the version for submission, allowing |
| 146 |
% the user to print both camera-ready copies and submission |
| 147 |
% manuscripts from a single story file. |
| 148 |
% |
| 149 |
% The \LaTeX\ document preparation system is free and available for |
| 150 |
% all operating systems. This package and all supporting packages |
| 151 |
% are available from \textsc{ctan}. To obtain any recent version of |
| 152 |
% |sffms|, copies of the supporting packages, sample input and output |
| 153 |
% files, a list of known issues, and more information about manuscript |
| 154 |
% format, see |http://mcd.freeshell.org/|. If you still have questions |
| 155 |
% or suggestions after reading through this documentation, feel free to |
| 156 |
% email the author at |[email protected]|. |
| 157 |
% |
| 158 |
% \section{Getting Started} |
| 159 |
% |
| 160 |
% If you are already familiar with \LaTeX, you may wish to skip |
| 161 |
% this section. |
| 162 |
% |
| 163 |
% \subsection{Installing \LaTeX} |
| 164 |
% |
| 165 |
% \LaTeX\ is available for all operating systems, in a bewildering |
| 166 |
% variety of implementations. For the beginner, I recommend the |
| 167 |
% following popular combinations of an underlying \TeX\ engine and |
| 168 |
% a nice front-end and/or text editor: |
| 169 |
% |
| 170 |
% For Windows, MiKTeX (|www.miktex.org|) and WinEdt (|www.winedt.com|). |
| 171 |
% |
| 172 |
% For MacOS X, TeXLive-teTeX and TeXShop (both available at \\ |
| 173 |
% |www.uoregon.edu/~koch/texshop/texshop.html|). |
| 174 |
% |
| 175 |
% For MacOS 9 and below, OzTeX and Alpha. (See |
| 176 |
% |www.esm.psu.edu/mac-tex/| for links.) |
| 177 |
% |
| 178 |
% For Unix systems, emacs and \TeX\ should come pre-installed, but |
| 179 |
% you might want to look into teTeX (|www.tug.org/tetex|). |
| 180 |
% |
| 181 |
% Some of these packages use A4 as their default paper size. See the |
| 182 |
% Troubleshooting section for more details. |
| 183 |
% |
| 184 |
% \subsection{Installing {\tt sffms}} |
| 185 |
% |
| 186 |
% If you use a \TeX\ package management system to install |sffms|, you |
| 187 |
% need not follow the rest of the steps in this section, but you will |
| 188 |
% probably need to install the supporting packages listed below. |
| 189 |
% Be sure that you get the most recent version of |sffms|. The |
| 190 |
% version can be identified either by the date or the version |
| 191 |
% number. |
| 192 |
% |
| 193 |
% The |sffms| class is distributed as two files, |sffms.dtx| and |
| 194 |
% |sffms.ins|. |
| 195 |
% To install the class manually, run \LaTeX\ on |sffms.ins|. |
| 196 |
% You can do this either by opening |sffms.ins| in your front-end |
| 197 |
% (WinEdt or TeXShop) and hitting the \LaTeX\ button, |
| 198 |
% or by typing the following at the command line: |
| 199 |
%\begin{verbatim} |
| 200 |
%latex sffms.ins |
| 201 |
%\end{verbatim} |
| 202 |
% \LaTeX\ will automatically create the style files |
| 203 |
% |sffms.cls|, |sffsmart.sty| and |sffdumb.sty|. At this point, |
| 204 |
% you may either move the new files into the appropriate directory |
| 205 |
% of your \LaTeX\ distribution, or leave them in the directory |
| 206 |
% where your source files (stories) will be. |
| 207 |
% |
| 208 |
% The |sffms| class requires several supplemental style files which |
| 209 |
% may or may not be included in your \LaTeX\ or |sffms| distribution. |
| 210 |
% Try running a sample story file through \LaTeX\ (see below). |
| 211 |
% If \LaTeX\ asks for any of the following files, you will need |
| 212 |
% to download them and place them in the directory where you put |
| 213 |
% |sffms.cls|. The files are: |
| 214 |
%\begin{verbatim} |
| 215 |
%fancyhdr.sty |
| 216 |
%setspace.sty |
| 217 |
%ulem.sty |
| 218 |
%\end{verbatim} |
| 219 |
% As of version 2.0 of |sffms|, the |geometry| package is no longer |
| 220 |
% required. If you decide to use it, obtain |geometry.dtx| and |
| 221 |
% |geometry.ins| and latex the latter, as you did with |sffms.ins|. |
| 222 |
% |
| 223 |
% All of the files mentioned above |
| 224 |
% are available through {\sc ctan} (|www.ctan.org|). |
| 225 |
% |
| 226 |
% |
| 227 |
% \subsection{Using {\tt sffms}} |
| 228 |
% |
| 229 |
% All you need to use |sffms| is a plain text file with the following |
| 230 |
% contents: |
| 231 |
%\begin{verbatim} |
| 232 |
%\documentclass{sffms} |
| 233 |
%\author{Lois McMaster Bujold} |
| 234 |
%\title{Komarr} |
| 235 |
%\begin{document} |
| 236 |
%Your story goes here. |
| 237 |
%\end{document} |
| 238 |
%\end{verbatim} |
| 239 |
% |
| 240 |
% Call this source file |filename.tex| and latex it by typing |
| 241 |
%\begin{verbatim} |
| 242 |
%latex filename.tex |
| 243 |
%latex filename.tex |
| 244 |
%\end{verbatim} |
| 245 |
% \LaTeX\ should be run twice in order to get the correct word count. |
| 246 |
% |
| 247 |
% Depending on your \LaTeX\ installation, this command may produce |
| 248 |
% an output file in |dvi|, |ps|, or |pdf| format. If you prefer |pdf| |
| 249 |
% output, you may find it more convenient to use the |pdflatex| command. |
| 250 |
% |
| 251 |
% |
| 252 |
% \subsection{\LaTeX\ Basics} |
| 253 |
% |
| 254 |
% A \LaTeX\ file is essentially a text file. If you take a plain |
| 255 |
% text version of your story and insert the lines mentioned in the |
| 256 |
% previous section (|\documentclass|, {\em etc.}), it will be almost |
| 257 |
% ready for \LaTeX. Just keep the following requirements in mind: |
| 258 |
% |
| 259 |
% Paragraphs should be separated by a blank line. |
| 260 |
% |
| 261 |
% Use |-| for a hyphen, |--| for an en-dash (for ranges, like |
| 262 |
% 18--65), and |---| for an em-dash---the one used as punctuation. |
| 263 |
% |
| 264 |
% Normal \LaTeX\ ``smart |
| 265 |
% quotes'' are produced using a pair of accents (usually found |
| 266 |
% under the $\sim$ key) and a pair of |
| 267 |
% apostrophes, like so: |``smart quotes''|. A good \LaTeX\ editor |
| 268 |
% ({\it e.g.}, emacs) will insert smart quotes automatically when |
| 269 |
% you strike the dumb quote (|"|) key. You may also use dumb |
| 270 |
% quotes with |sffms|---see the section on handling quotation |
| 271 |
% marks, below. Note that |```| becomes ``\thinspace`. To produce |
| 272 |
% `\thinspace{``} instead, use braces, like so: |`{``}|. Likewise, |
| 273 |
% use |'{''}| if |'''| fails to do the job. |
| 274 |
% |
| 275 |
% Certain characters are reserved by \LaTeX\ for special purposes: |
| 276 |
%\begin{verbatim} |
| 277 |
%# $ % & ~ _ ^ \ { } |
| 278 |
%\end{verbatim} |
| 279 |
% To use a reserved character in a story, you must put a backslash |
| 280 |
% in front of it (|\$|, |\%|, {\em etc.}), except for |\\|, |\~|, |
| 281 |
% and |\^|, which have their own special meanings. |
| 282 |
% (The first is used to force a line break and the latter two |
| 283 |
% create accent marks over the following character.) |
| 284 |
% The command |$\backslash$| produces the backslash itself and |
| 285 |
% |$\sim$| the tilde alone. |
| 286 |
% |
| 287 |
% The percent-sign is particularly dangerous because it's the |
| 288 |
% comment character in \LaTeX. Anything between an unescaped |%| |
| 289 |
% and the end of the line will be silently ignored by \LaTeX\ |
| 290 |
% when it processes your file. |
| 291 |
% |
| 292 |
%\subsection{\LaTeX\ Tricks} |
| 293 |
% |
| 294 |
% Depending on your \LaTeX\ installation, you may be able to produce some |
| 295 |
% common accent marks thus: |
| 296 |
%\begin{center} |
| 297 |
% \'{a}~~|\'{a}| \hfill \`{e}~~|\`{e}| \hfill \"{\i}~~|\"{\i}| \hfill |
| 298 |
% \~{o}~~|\~{o}| \hfill \^{u}~~|\^{u}| \hfill \c{c}~~|\c{c}| |
| 299 |
%\end{center} |
| 300 |
%If you want something a little more alien, try some of the following: |
| 301 |
%\begin{verbatim} |
| 302 |
%\.{h} \^{m} \u{n} \v{q} \H{r} \d{v} \b{x} |
| 303 |
%\i \j \ae \OE \l \o \ss \S ?` !` \pounds |
| 304 |
%\end{verbatim} |
| 305 |
% Many more symbols are available in \LaTeX's math mode, but keep in |
| 306 |
% mind that such gimmicks are likely to annoy your editor. |
| 307 |
% |
| 308 |
% If you need finer control of your text layout, you can use the |
| 309 |
% |\noindent| command before a paragraph to keep it from |
| 310 |
% being indented. You can use the |\\| symbol to force a line |
| 311 |
% break without starting a new paragraph. (These two methods will have |
| 312 |
% the same effect for submissions, but not in |nonsubmission| mode.) |
| 313 |
% |
| 314 |
% \LaTeX\ ignores all extra spaces between words and sentences, then |
| 315 |
% inserts (approximately) two spaces between sentences. If you |
| 316 |
% prefer one space after all punctuation, include the command |
| 317 |
%\begin{verbatim} |
| 318 |
%\frenchspacing |
| 319 |
%\end{verbatim} |
| 320 |
% at the beginning of your document. To force a single space in |
| 321 |
% those rare cases where \LaTeX\ chooses the wrong spacing, use |
| 322 |
% |\ | (a backslash followed by a space) or |~|. |
| 323 |
%\begin{verbatim} |
| 324 |
%``Put only one space after a quote!''\ she demanded. |
| 325 |
% |
| 326 |
%``Of course, Dr.~Jones!'' |
| 327 |
%\end{verbatim} |
| 328 |
% The |~| also prevents a linebreak from occurring between the two |
| 329 |
% words. Use it with caution. |
| 330 |
% |
| 331 |
% All \LaTeX\ commands begin with a backslash, as in |
| 332 |
% |\documentclass{sffms}| or |\frenchspacing|. \LaTeX\ environments |
| 333 |
% begin with a |\begin| command and end with an |\end| command. |
| 334 |
% Two \LaTeX\ environments that may be of use are |
| 335 |
% |verse| and |quotation|: |
| 336 |
%\begin{verbatim} |
| 337 |
%\begin{verse} |
| 338 |
%First line of your verse,\\ |
| 339 |
%Second line\\ |
| 340 |
%Third line |
| 341 |
% |
| 342 |
%Beginning of a new stanza\\ |
| 343 |
%Etc. |
| 344 |
%\end{verse} |
| 345 |
%\end{verbatim} |
| 346 |
% |
| 347 |
%\begin{verbatim} |
| 348 |
%\begin{quotation} |
| 349 |
%Put normal paragraphs of text here, separated by blank lines as usual. |
| 350 |
%They will be indented from the margins, and each paragraph will |
| 351 |
%be indented. |
| 352 |
%\end{quotation} |
| 353 |
%\end{verbatim} |
| 354 |
% Long quotes or verse can be single-spaced, but by default they are |
| 355 |
% not. See the section |
| 356 |
% on environments for details. Underlining and boldface are also |
| 357 |
% discussed in a later section. |
| 358 |
% |
| 359 |
% |
| 360 |
% \section{Declaration of Options} |
| 361 |
% |
| 362 |
% The |sffms| class has several {\em options} which change the |
| 363 |
% appearance of the output. To use an option, enclose it in |
| 364 |
% brackets in the |documentclass| declaration in the first line |
| 365 |
% of your story file. Separate multiple options with commas. |
| 366 |
% For example, to use the |novel| and |baen| options, the first line |
| 367 |
% of the file should read: |
| 368 |
%\begin{verbatim} |
| 369 |
%\documentclass[novel,baen]{sffms} |
| 370 |
%\end{verbatim} |
| 371 |
% |
| 372 |
% \subsection{The Submission Options} |
| 373 |
% |
| 374 |
%\DescribeOption{submission} |
| 375 |
% The |submission| option is now the default and need not be |
| 376 |
% declared. This option causes the document to be typeset in |
| 377 |
% manuscript format, with double spacing, one-inch margins, |
| 378 |
% and a fixed-width font. All |sffms| |
| 379 |
% options except |nonsubmission| may be used with the submission |
| 380 |
% option, though |submission| plus |notitle| will make the output |
| 381 |
% format nonstandard. (Editors want titles.) |
| 382 |
% |
| 383 |
%\DescribeOption{novel} |
| 384 |
% There isn't much difference between a novel and a short story in |
| 385 |
% sf/f manuscripts. The short story begins on the title page, |
| 386 |
% while the novel begins on a fresh page. A novel may also have a |
| 387 |
% synopsis. |
| 388 |
% Use the |novel| option for a novel. If the |novel| option is |
| 389 |
% {\em not\/} used, the text will be typeset as a short story. |
| 390 |
% |
| 391 |
% The |sffms| class now includes publisher-specific options for |
| 392 |
% certain publishers whose |
| 393 |
% requirements differ slightly from the default |submission| style. |
| 394 |
% In all other respects, the story is treated as a normal submission. |
| 395 |
% Publishers' guidelines may change, so check that these options do |
| 396 |
% what you need them to do before using them. |
| 397 |
% |
| 398 |
%\DescribeOption{baen} |
| 399 |
% The |baen| option uses $1\,\frac{1}{2}$|"| margins rather than 1|"|. |
| 400 |
% Baen Books' requirements are available on-line (|www.baen.com/FAQS.htm|). |
| 401 |
%\begin{verbatim} |
| 402 |
%\documentclass[baen]{sffms} |
| 403 |
%\end{verbatim} |
| 404 |
% |
| 405 |
%\DescribeOption{daw} |
| 406 |
% The |daw| option typesets the address and wordcount on the |
| 407 |
% right-hand side of the first page rather than splitting it across |
| 408 |
% the page. The DAW Books manuscript requirements are available |
| 409 |
% on-line\\ |
| 410 |
% (|www.penguinputnam.com/static/packages/us/about/dawsub.htm|). |
| 411 |
%\begin{verbatim} |
| 412 |
%\documentclass[daw]{sffms} |
| 413 |
%\end{verbatim} |
| 414 |
% |
| 415 |
%\DescribeOption{wotf} |
| 416 |
% The |wotf| option uses a full cover page (like that of the novel |
| 417 |
% option) and alters the running header to omit the author's surname, |
| 418 |
% as required by the rules of the Writers of the Future contest |
| 419 |
% (|www.writersofthefuture.com|). |
| 420 |
% Also, the full title is used in the running header, and page |
| 421 |
% numbering begins with the first story page, rather than |
| 422 |
% counting the title page. |
| 423 |
%\begin{verbatim} |
| 424 |
%\documentclass[wotf]{sffms} |
| 425 |
%\end{verbatim} |
| 426 |
% |
| 427 |
% To my knowledge, the default submission format does not violate |
| 428 |
% the guidelines of Tor Books (|www.tor.com/torfaq.html|),\\ |
| 429 |
% Analog (|www.analogsf.com/information/submissions.shtml|),\\ |
| 430 |
% Asimov's (|www.asimovs.com/info/guidelines.shtml|),\\ |
| 431 |
% Fantasy \& Science Fiction (|www.sfsite.com/fsf/glines.htm|), |
| 432 |
% or the Star Trek Strange New Worlds contest. |
| 433 |
% |
| 434 |
% Please be sure to include all required contact information within |
| 435 |
% the |address| command, described below. |
| 436 |
% |
| 437 |
% |
| 438 |
% \subsection{Options for Quotation Marks} |
| 439 |
% |
| 440 |
% The |sffms| class provides two options for handling ``legacy'' |
| 441 |
% quotes, be they dumb quotes in a plain text file you want |
| 442 |
% smartened up for a good copy of your latest novel, or \LaTeX\ |
| 443 |
% quotes you want to dumb down to give your manuscript that |
| 444 |
% genuine Courier 12-point typewriter feel. |
| 445 |
% |
| 446 |
% Please note that neither of these options will handle |
| 447 |
% non-{\sc ascii} ``smart'' quotation marks in your source file. |
| 448 |
% All non-{\sc ascii} characters must be eliminated by saving |
| 449 |
% the file as plain text. Note that the changes explained below |
| 450 |
% appear in the output only---the source file is never |
| 451 |
% altered. |
| 452 |
% |
| 453 |
%\DescribeOption{smart} |
| 454 |
% The |smart| option turns pairs of normal {\sc ascii} |
| 455 |
% quotation marks (|"|dumb quotes|"|) into \LaTeX\ quotation |
| 456 |
% marks (|``|smart quotes|''|), so that the output file |
| 457 |
% will show true ``smart quotes.'' This option also correctly handles |
| 458 |
% quotations continued between paragraphs. |
| 459 |
% |
| 460 |
%\DescribeOption{dumb} |
| 461 |
% The |dumb| option suppresses \LaTeX\ |``|smart quotes,|''| |
| 462 |
% producing dumb, typewriter-style quotes in the output file |
| 463 |
% rather than the slanted ones that are the default in |
| 464 |
% submission mode. |
| 465 |
% The |dumb| option is not useful with the |nonsubmission| |
| 466 |
% option because only monospaced fonts like Courier include |
| 467 |
% a true dumb quotation mark (|"|) at all. |
| 468 |
% Other fonts may substitute a curly close-quote ('') instead, |
| 469 |
% which looks ''dumber than dumb.'' |
| 470 |
% |
| 471 |
% These options are not particularly robust, so they may cause more |
| 472 |
% problems than they solve. {\em Caveat emptor}. |
| 473 |
% They can handle mixed quotation mark styles (\LaTeX\ smart with |
| 474 |
% {\sc ascii} dumb) if the two sorts of marks are balanced---for |
| 475 |
% example, if some chapters use {\sc ascii} quotes and others |
| 476 |
% \LaTeX\ ones, or even if some sentences are smart and others |
| 477 |
% dumb. |
| 478 |
% |
| 479 |
% If these options do not work for you, you can always |
| 480 |
% change the quotation marks in your source file with a good text |
| 481 |
% editor like emacs. |
| 482 |
% |
| 483 |
% |
| 484 |
% \subsection{Non-submission Options} |
| 485 |
% |
| 486 |
%\DescribeOption{nonsubmission} |
| 487 |
% To force a document to be typeset as a normal book or article |
| 488 |
% (that is, without double-spacing or the fixed-width font), use the |
| 489 |
% |nonsubmission| option in your |documentclass| declaration: |
| 490 |
%\begin{verbatim} |
| 491 |
%\documentclass[nonsubmission]{sffms} |
| 492 |
%\end{verbatim} |
| 493 |
% |
| 494 |
%\DescribeOption{notitle} |
| 495 |
% When the |nonsubmission| option is chosen, the |sffms| |
| 496 |
% class creates a default title page. The |notitle| option will |
| 497 |
% remove it, allowing the user to specify his own \LaTeX\ layout; |
| 498 |
% |notitle| is also useful for saving paper. |
| 499 |
% |
| 500 |
% Because |sffms| is based on the standard \LaTeX\ report class, any |
| 501 |
% other \LaTeX\ report class options may be used for non-submissions, |
| 502 |
% including font size |
| 503 |
% options (|10pt|, |12pt|, {\em etc.}), paper size and other useful |
| 504 |
% typesetting options (|twoside|, |twocolumn|, {\em etc.}). Using |
| 505 |
% report-class options together with a |submission| option may |
| 506 |
% generate unexpected results. |
| 507 |
% |
| 508 |
% \subsection{Other Options} |
| 509 |
% |
| 510 |
%\DescribeOption{courier} |
| 511 |
% The |courier| option switches to a 12-point, 10-pitch Courier font |
| 512 |
% that may look better than \LaTeX's default monospaced font, |
| 513 |
% depending on your local \LaTeX\ setup. Try this option if you want |
| 514 |
% a fatter font than the default or if your |pdf| files are looking |
| 515 |
% grainy. |
| 516 |
% |
| 517 |
%\DescribeOption{geometry} |
| 518 |
% The |geometry| option forces |sffms| to use the |geometry| package |
| 519 |
% for page layout. This option is useful for getting around |
| 520 |
% page size problems. See the Troubleshooting section for |
| 521 |
% details. |
| 522 |
% |
| 523 |
%\DescribeOption{a4paper} |
| 524 |
%\DescribeOption{letterpaper} |
| 525 |
% If you use geometry with the intent of fixing your papersize, |
| 526 |
% you should declare the desired paper size explicitly. |
| 527 |
% A4 and letter are the most common choices, but other |
| 528 |
% paper sizes may also be used. See the documentation of |
| 529 |
% the geometry package for the full list. |
| 530 |
% |
| 531 |
% |
| 532 |
% \section{Commands} |
| 533 |
% |
| 534 |
% \subsection{Title} |
| 535 |
% |
| 536 |
% |
| 537 |
%\DescribeMacro\title |
| 538 |
% Every story should have a title. You must specify the title |
| 539 |
% using the \LaTeX\ |title| command thus: |
| 540 |
%\begin{verbatim} |
| 541 |
%\title{The Hobbit: or There and Back Again} |
| 542 |
%\end{verbatim} |
| 543 |
% |
| 544 |
%\DescribeMacro\runningtitle |
| 545 |
% In |submission| format, a short form of |
| 546 |
% the title is placed in the page header at the top right of |
| 547 |
% each page. |
| 548 |
% If your title is long, specify the desired short form thus: |
| 549 |
%\begin{verbatim} |
| 550 |
%\runningtitle{The Hobbit} |
| 551 |
%\end{verbatim} |
| 552 |
% If you fail to provide a |runningtitle|, your |title| will be |
| 553 |
% used instead, no matter how long it is. |
| 554 |
% |
| 555 |
% \subsection{Author} |
| 556 |
% |
| 557 |
%\DescribeMacro\author |
| 558 |
% Every story must also have an author. The name included in the |
| 559 |
% \LaTeX\ |author| command is used in the bylines on the title |
| 560 |
% page and synopsis page. |
| 561 |
% If you use a pseudonym, you may wish to put it here. |
| 562 |
%\begin{verbatim} |
| 563 |
%\author{Lois McMaster Bujold} |
| 564 |
%\end{verbatim} |
| 565 |
% |
| 566 |
%\DescribeMacro\authorname |
| 567 |
% A separate command, |authorname|, is provided for use with |
| 568 |
% your mailing address. It might be wise to put your real name |
| 569 |
% here. If you omit the |authorname| command, the value of |
| 570 |
% |author| will be used with your mailing address. |
| 571 |
%\begin{verbatim} |
| 572 |
%\authorname{Lois Bujold} |
| 573 |
%\end{verbatim} |
| 574 |
% |
| 575 |
%\DescribeMacro\surname |
| 576 |
% Like |runningtitle|, |surname| is used in page headers. Whose |
| 577 |
% surname goes in |surname| is up to you. |
| 578 |
%\begin{verbatim} |
| 579 |
%\surname{Bujold} |
| 580 |
%\end{verbatim} |
| 581 |
% If you omit |surname|, the full value of |author| will be used. |
| 582 |
% |
| 583 |
% \subsection{Other Information} |
| 584 |
% |
| 585 |
%\DescribeMacro\address |
| 586 |
% Your mailing address for the title page is specified with |
| 587 |
% the |address| command. Separate lines with the \LaTeX\ |
| 588 |
% linebreak symbol |\\| thus: |
| 589 |
%\begin{verbatim} |
| 590 |
%\address{One Vor Way\\ |
| 591 |
% Vor. Surleau\\ |
| 592 |
% VKD 28945} |
| 593 |
%\end{verbatim} |
| 594 |
% Other requested contact information (such as a phone number |
| 595 |
% or email address) should be included here. |
| 596 |
% |
| 597 |
%\DescribeMacro\wordcount |
| 598 |
% Your word count should also be included on the title page. |
| 599 |
% An approximate word count based on the number of pages will |
| 600 |
% appear automatically. However, the automatic word count is |
| 601 |
% not rounded off (much) and ought to be replaced by your own |
| 602 |
% rounded-up opinion of the word count. The |\wordcount| command |
| 603 |
% is used to set the value manually thus: |
| 604 |
%\begin{verbatim} |
| 605 |
%\wordcount{85,000} |
| 606 |
%\end{verbatim} |
| 607 |
% The automatic word count is generated by multiplying the page |
| 608 |
% count (not including a novel synopsis) by either 250 or 295, |
| 609 |
% depending on the font pitch and margin size. The latter |
| 610 |
% figure was obtained by taking a typical page of one of the |
| 611 |
% author's stories, finding the average number of characters |
| 612 |
% per line (71), dividing by six (a ``word''), multiplying by |
| 613 |
% the number of lines on a full page (25), and rounding off. |
| 614 |
% You may wish to repeat this process or a similar one for your |
| 615 |
% own stories, since a4 paper and partial pages (among other |
| 616 |
% things) were not taken into account. |
| 617 |
% |
| 618 |
%\DescribeMacro\disposable |
| 619 |
% The |disposable| command causes the words ``Disposable Copy'' |
| 620 |
% to be printed under the word count on the title page of |
| 621 |
% submissions. |
| 622 |
% |
| 623 |
% \subsection{Sectioning Commands} |
| 624 |
% |
| 625 |
%\DescribeMacro\newscene |
| 626 |
% For short stories, the only breaks should be scene breaks. |
| 627 |
% Place the |newscene| command wherever you want a scene break. |
| 628 |
%\begin{verbatim} |
| 629 |
%...the last few words of the previous scene. |
| 630 |
% |
| 631 |
%\newscene |
| 632 |
% |
| 633 |
%Time to start a new scene... |
| 634 |
%\end{verbatim} |
| 635 |
% This command inserts the proper scene break character, a |
| 636 |
% centered hash mark (|#|), in |
| 637 |
% submissions, and a blank line in non-submissions. |
| 638 |
% |
| 639 |
%\DescribeMacro\sceneseparator |
| 640 |
% If you would prefer to use a different scene separator, such |
| 641 |
% as |*****|, the |sceneseparator| command will change it. |
| 642 |
%\begin{verbatim} |
| 643 |
%\sceneseparator{$\star\star\star\star\star$} |
| 644 |
%\end{verbatim} |
| 645 |
% Beware of \LaTeX\ special characters when using this command. |
| 646 |
% |
| 647 |
%\DescribeMacro\chapter |
| 648 |
% For a novel, you can use both chapters and scenebreaks. The |
| 649 |
% \LaTeX\ chapter commands have been redefined in |sffms| to |
| 650 |
% fit the |submission| format. Begin a new chapter thus: |
| 651 |
%\begin{verbatim} |
| 652 |
%\chapter{Miles High} |
| 653 |
%\end{verbatim} |
| 654 |
%\DescribeMacro{\chapter*} |
| 655 |
% The \LaTeX\ |\chapter*| command also works in submissions. |
| 656 |
% It creates an unnumbered chapter, such as a preface or |
| 657 |
% appendix. |
| 658 |
%\begin{verbatim} |
| 659 |
%\chapter*{Preface} |
| 660 |
%\end{verbatim} |
| 661 |
% |
| 662 |
%\DescribeMacro\thirty |
| 663 |
% Last, but not least, comes the end. The default |
| 664 |
% end-of-story symbol, five hash marks (|# # # # #|), is inserted |
| 665 |
% automatically at the end of your story. To change it, use the |
| 666 |
% |thirty| command. |
| 667 |
%\begin{verbatim} |
| 668 |
%\thirty{The End} |
| 669 |
%\end{verbatim} |
| 670 |
% |
| 671 |
% \subsection{Italics, Boldface and Small Caps} |
| 672 |
% |
| 673 |
% In submission mode, italicized text is automatically converted |
| 674 |
% to underlined text. Boldface is replaced |
| 675 |
% by wavy underlining and small caps by double underlining. |
| 676 |
% |
| 677 |
%\DescribeMacro\em |
| 678 |
% The |\em| command may be used for single italicized words; it |
| 679 |
% goes inside the braces with the word, thus: |
| 680 |
%\begin{verbatim} |
| 681 |
%I can't believe that {\em you}, of all people... |
| 682 |
%\end{verbatim} |
| 683 |
% This produces underlining by default and italics in |
| 684 |
% non-submissions. |
| 685 |
%\DescribeMacro\emph |
| 686 |
% To underline (italicize) anything from a word to a paragraph, |
| 687 |
% use the |\emph| command. With |\emph|, the curly braces come |
| 688 |
% after the command. |
| 689 |
%\begin{verbatim} |
| 690 |
%\emph{I can't believe that they, of all people...} |
| 691 |
%\end{verbatim} |
| 692 |
%\DescribeMacro\thought |
| 693 |
% The |\thought| command works exactly like |\emph|, but may |
| 694 |
% be useful to the author for distinguishing between normal |
| 695 |
% italics and italicized thoughts within the source file. |
| 696 |
% To italicize more than one paragraph, use one |\emph| |
| 697 |
% or |\thought| per paragraph. |
| 698 |
% |
| 699 |
%\DescribeMacro\bfseries |
| 700 |
%\DescribeMacro\textbf |
| 701 |
% The |\bfseries| font declaration and the |\textbf| font command |
| 702 |
% will produce boldface in |
| 703 |
% non-submissions and wavy underlines in |submission| mode. The |
| 704 |
% font declaration goes inside the curly braces and the font |
| 705 |
% command outside, thus: |
| 706 |
%\begin{verbatim} |
| 707 |
%I can't believe that {\bfseries you}, of \textbf{all people}... |
| 708 |
%\end{verbatim} |
| 709 |
% |
| 710 |
%\DescribeMacro\scshape |
| 711 |
%\DescribeMacro\textsc |
| 712 |
% The |\scshape| font declaration and the |\textsc| font command |
| 713 |
% will produce small caps in |
| 714 |
% |nonsubmission| mode and double-underlined text in submissions. |
| 715 |
% They work exactly like the corresponding boldface commands: |
| 716 |
%\begin{verbatim} |
| 717 |
%I can't believe that {\scshape you}, of \textsc{all people}... |
| 718 |
%\end{verbatim} |
| 719 |
% |
| 720 |
% Since they can be used for individual words as well as phrases |
| 721 |
% and paragraphs, you may wish to use |\emph{}|, |\textbf{}|, |
| 722 |
% and |\textsc{}| in all cases to avoid confusion. |
| 723 |
% |
| 724 |
% \subsection{Other Commands} |
| 725 |
% |
| 726 |
%\DescribeMacro\ifsubmission |
| 727 |
% The |ifsubmission| command is used to hide latex code or text. |
| 728 |
% The first argument is evaluated for submissions, and ignored |
| 729 |
% otherwise, and vice versa for the second. It can be used in |
| 730 |
% various ways. |
| 731 |
%\begin{verbatim} |
| 732 |
%\ifsubmission{}{Some comments to myself...} |
| 733 |
%\end{verbatim} |
| 734 |
%\begin{verbatim} |
| 735 |
%\ifsubmission{\thirty{-30-}}{ |
| 736 |
% \setlength{\textheight}{8.5in} |
| 737 |
% \setlength{\topmargin}{0in} |
| 738 |
%} |
| 739 |
%\end{verbatim} |
| 740 |
% |
| 741 |
%\DescribeMacro\submit |
| 742 |
% Two commands are provided as a convenient shorthand for the |
| 743 |
% |\ifsubmission| command. They take one argument each. |
| 744 |
% Text or commands inside a |\submit| command will be used |
| 745 |
% only for submissions, |
| 746 |
%\DescribeMacro\nosubmit |
| 747 |
% and that in a |\nosubmit| will be used only for |
| 748 |
% non-submissions. For example, the following command is |
| 749 |
% equivalent to the first |\ifsubmission| command above. |
| 750 |
%\begin{verbatim} |
| 751 |
%\nosubmit{Some comments to myself...} |
| 752 |
%\end{verbatim} |
| 753 |
% |
| 754 |
%\DescribeMacro\msheading |
| 755 |
% If for some reason you wish to deviate from the standard running |
| 756 |
% page headings, you can use the |\msheading| command to change |
| 757 |
% them. To remove headings entirely, use the command: |
| 758 |
%\begin{verbatim} |
| 759 |
%\msheading{} |
| 760 |
%\end{verbatim} |
| 761 |
% To keep just the page number, use: |
| 762 |
%\begin{verbatim} |
| 763 |
%\msheading{\thepage} |
| 764 |
%\end{verbatim} |
| 765 |
% To add more space between the default heading parts, use: |
| 766 |
%\begin{verbatim} |
| 767 |
%\msheading{\getsurname\ /\ \getrunningtitle\ /\ \thepage} |
| 768 |
%\end{verbatim} |
| 769 |
% For page numbers of the form ``Page 3 of 135,'' use: |
| 770 |
%\begin{verbatim} |
| 771 |
%\msheading{\pageofpages} |
| 772 |
%\end{verbatim} |
| 773 |
% (Check the code for |\pageofpages| to see how it was done.) |
| 774 |
% Reckless use of the |\msheading| command may cause \LaTeX\ |
| 775 |
% errors. |
| 776 |
% |
| 777 |
% Any other \LaTeX\ commands may be used for non-submissions. |
| 778 |
% Using them for submissions may generate unexpected results. |
| 779 |
% |
| 780 |
% |
| 781 |
% \section{Environments} |
| 782 |
% |
| 783 |
%\DescribeEnv{synopsis} |
| 784 |
% The only new \LaTeX\ environment in |sffms| is |synopsis|, |
| 785 |
% intended for use with novels. |
| 786 |
% In |submission| mode, the synopsis is typeset |
| 787 |
% single-spaced with roman numerals for page numbers to distinguish |
| 788 |
% it from the rest of the novel. |
| 789 |
%\begin{verbatim} |
| 790 |
%\begin{synopsis} |
| 791 |
%Summarize your novel here. |
| 792 |
%\end{synopsis} |
| 793 |
%\end{verbatim} |
| 794 |
% The synopsis can be placed anywhere after the |\begin{document}| |
| 795 |
% command. The synopsis environment can |
| 796 |
% also be used without the |novel| option. |
| 797 |
% |
| 798 |
%\DescribeEnv{singlespace} |
| 799 |
% The |singlespace| and |doublespace| environments are inherited |
| 800 |
% from the |setspace| package which is provides the doublespacing |
| 801 |
% for |sffms|. The following will single-space a poem, for example: |
| 802 |
%\begin{verbatim} |
| 803 |
%\begin{singlespace} |
| 804 |
%\begin{verse} |
| 805 |
%Oh, what a bore,\\ |
| 806 |
%To be a Vor. |
| 807 |
%\end{verse} |
| 808 |
%\end{singlespace} |
| 809 |
%\end{verbatim} |
| 810 |
% (See the \LaTeX\ Tricks section for an explanation of the |verse| |
| 811 |
% and |quotation| environments.) |
| 812 |
% You should not need the |doublespace| environment, but it works the |
| 813 |
% same way. |
| 814 |
% |
| 815 |
% |
| 816 |
% \section{Troubleshooting} |
| 817 |
% |
| 818 |
% Problems with |sffms| are usually caused by typos in the source |
| 819 |
% file or by a local \LaTeX\ misconfiguration. This section |
| 820 |
% covers the most common issues. |
| 821 |
% |
| 822 |
% \subsection{Processing Errors} |
| 823 |
% |
| 824 |
% If \LaTeX\ complains that it cannot find one or more of |sffms|, |
| 825 |
% |fancyhdr|, |setspace|, |ulem|, or |geometry|, they may not |
| 826 |
% have been installed in the correct directory. If you cannot find |
| 827 |
% the correct spot, or if you are working on a public server |
| 828 |
% where you do not have permission to install new \LaTeX\ packages, |
| 829 |
% you can always put all required files in the folder where the |
| 830 |
% the story file itself is located. \LaTeX\ will find them |
| 831 |
% automatically. |
| 832 |
% |
| 833 |
% If, in particular, \LaTeX\ cannot find |sffms.cls|, |
| 834 |
% |sffdumb.sty|, |sffsmart.sty|, or |
| 835 |
% |geometry.sty|, these files may not have been extracted from |
| 836 |
% |sffms.dtx| or |geometry.dtx|. To create the appropriate files, |
| 837 |
% run latex on |sffms.ins| or |geometry.ins|, respectively, |
| 838 |
% as described in the section on installing |sffms|. |
| 839 |
% |
| 840 |
% The first time you run latex on a new story, you may see a |
| 841 |
% warning that `sffmswc' is undefined and a message telling you |
| 842 |
% to latex the file a second time. This is normal latex behavior. |
| 843 |
% You should latex the file a second time. |
| 844 |
% |
| 845 |
% If \LaTeX\ gives you underfull errors, you can ignore them. |
| 846 |
% If you get overfull errors, you can ignore the small ones |
| 847 |
% (under 5 or 10 points), but for large ones, you should locate |
| 848 |
% the problem line in the source file (by line number) or in the |
| 849 |
% output (by looking for lines that poke out into the margin or |
| 850 |
% end suddenly in with black box). If the overflow is large |
| 851 |
% you may want to split the problematic line or a word manually |
| 852 |
% using |\\|. |
| 853 |
% Normally, \LaTeX\ hyphenates words on its own, but hyphenation |
| 854 |
% is suppressed in submission mode. You should wait until your |
| 855 |
% story is in a final form before twiddling with overfull errors. |
| 856 |
% |
| 857 |
% Font errors can generally be ignored. If you do not like the |
| 858 |
% appearance of the default font, see the section below on appearance |
| 859 |
% issues. |
| 860 |
% |
| 861 |
% In cases where \LaTeX\ halts with an error, read the error |
| 862 |
% message carefully and then type |x| at the question-mark prompt |
| 863 |
% to exit. |
| 864 |
% Return to your story file and locate the section that caused |
| 865 |
% the problem, using either the wording or the line number |
| 866 |
% shown in the error message to help you track it down. |
| 867 |
% Check that you have closed all curly braces and have not |
| 868 |
% accidentally used a special character like |$| or |&|, or |
| 869 |
% misspelled a command. See the \LaTeX\ Basics section for |
| 870 |
% a full list of reserved characters. |
| 871 |
% |
| 872 |
% If you get a cryptic error like ``There's no line here to end'' |
| 873 |
% while using the |daw| option, |
| 874 |
% be sure you've included at least a |title|, |author|, and |
| 875 |
% |address|. |
| 876 |
% |
| 877 |
% \subsection{Margin Problems} |
| 878 |
% |
| 879 |
% Margin problems are almost always caused by an incorrect default |
| 880 |
% paper size setting within your \LaTeX\ installation. Several |
| 881 |
% popular \LaTeX\ installations come with |a4| set as the default |
| 882 |
% paper size. Before you blame \LaTeX, however, be sure you |
| 883 |
% understand what |sffms| is supposed to do. |
| 884 |
% |
| 885 |
% For a submission, the bottom margin should be about the same |
| 886 |
% as the side margins---one inch. The running page header with |
| 887 |
% your name, title and the page number pokes up into the top |
| 888 |
% margin, making it appear to be less than an inch on the right |
| 889 |
% side. Everywhere else, however, it should be an inch, or an |
| 890 |
% inch and a half if you are using the |baen| option. |
| 891 |
% |
| 892 |
% If you still think your top margin is too small and the bottom |
| 893 |
% too big, the problem is almost certainly due to your default |
| 894 |
% paper size setting. You can use the |geometry| option to |
| 895 |
% attempt to force the correct paper size, thus: |
| 896 |
%\begin{verbatim} |
| 897 |
%\documentclass[geometry,letterpaper]{sffms} |
| 898 |
%\end{verbatim} |
| 899 |
% |
| 900 |
% You can add papersize flags to certain commands, such as |dvips|, |
| 901 |
% to work around these problems, but the best approach |
| 902 |
% is to fix your default paper size once and for all, especially if |
| 903 |
% you intend to use the |nonsubmission| option |
| 904 |
% or if the geometry option fails. |
| 905 |
% |
| 906 |
% If you are using MiKTeX or a version of teTeX besides the one |
| 907 |
% installed with TeXShop, you may need to change your |
| 908 |
% default paper size to letter paper. |
| 909 |
% For teTeX, you should be able to adjust this setting |
| 910 |
% either during the installation process or afterwards |
| 911 |
% with the |texconfig| command: |
| 912 |
%\begin{verbatim} |
| 913 |
%texconfig dvips paper letter |
| 914 |
%texconfig xdvi us |
| 915 |
%\end{verbatim} |
| 916 |
% You may also need to edit the \\ |
| 917 |
% |/usr/local/teTeX/share/texmf/pdftex/config/pdftex.cfg| |
| 918 |
% file as described below for MiKTeX. The changes are the same. |
| 919 |
% |
| 920 |
% You can fix pdf output in MiKTeX by editing the file \\ |
| 921 |
% |\texmf\pdftex\config\pdftex.cfg| in your |
| 922 |
% text editor, replacing the lines |
| 923 |
%\begin{verbatim} |
| 924 |
%page_width 210 true mm |
| 925 |
%page_height 297 true mm |
| 926 |
%\end{verbatim} |
| 927 |
% with the following: |
| 928 |
%\begin{verbatim} |
| 929 |
%page_width 8.5 true in |
| 930 |
%page_height 11 true in |
| 931 |
%\end{verbatim} |
| 932 |
% You can fix postscript output by editing the file \\ |
| 933 |
% |\texmf\dvips\config\config.ps|, changing |
| 934 |
%\begin{verbatim} |
| 935 |
%@ A4size 210mm 297mm |
| 936 |
%@+ %%PaperSize: A4 |
| 937 |
% |
| 938 |
%@ letterSize 8.5in 11in |
| 939 |
%\end{verbatim} |
| 940 |
%to read only: |
| 941 |
%\begin{verbatim} |
| 942 |
%@ letterSize 8.5in 11in |
| 943 |
%@+ %%PaperSize: Letter |
| 944 |
%\end{verbatim} |
| 945 |
% You may still see a problem if you view dvi files in Yap. |
| 946 |
% In that case, open View $\vert$ Options... $\vert$ Display in the |
| 947 |
% Yap menu and change the paper size setting to letter paper. |
| 948 |
% Another possible, but unlikely, culprit is |
| 949 |
% |\texmf\dvipdfm\config\config|, in which you may wish to change |
| 950 |
% |p a4| to |p letter|. |
| 951 |
% |
| 952 |
% |
| 953 |
% |
| 954 |
% \subsection{Other Appearance Issues} |
| 955 |
% |
| 956 |
% If your PDF output looks grainy, try using the |courier| option. |
| 957 |
% |
| 958 |
% If you get a wordcount of |??|, you probably forgot to latex |
| 959 |
% your file twice. Latex the file a second time. |
| 960 |
% |
| 961 |
% Problems with underlining for italics and boldface have a |
| 962 |
% couple of likely causes. |
| 963 |
% The (required) |ulem.sty| package does not officially |
| 964 |
% support underlining across paragraph breaks, so for |
| 965 |
% long stretches of underlined text, you should use a separate |
| 966 |
% font command for each paragraph. You should use the |\emph| |
| 967 |
% |\textbf| or |\textsc| font commands for multiple words, rather |
| 968 |
% than the |\em|, |\bfseries| or |\scshape| font declarations. |
| 969 |
% Also, other \LaTeX\ font commands which produce boldface, |
| 970 |
% italics or slanted text, such as |\bf|, |\it|, or |\slshape|, |
| 971 |
% are not supported by |sffms| and will not be converted |
| 972 |
% properly to underlined text. |
| 973 |
% |
| 974 |
% |
| 975 |
% \section{Credits} |
| 976 |
% |
| 977 |
% Many thanks to Kevin Russell for writing |sfms.cls|, which |
| 978 |
% was itself inspired by code posted by Michael Grant |
| 979 |
% to {\tt rec.arts.sf.composition} in July 2000. |
| 980 |
% |
| 981 |
% The code for |sffsmart.sty| was adapted from |quote.sty| by |
| 982 |
% Hunter Goatley, available from {\sc ctan}. |
| 983 |
% |
| 984 |
% The code for |sffdumb.sty| was adapted from code posted to |
| 985 |
% |comp.text.tex| by Donald Arseneau and improved by advice from |
| 986 |
% the same source. |
| 987 |
% |
| 988 |
% Manuscript-style underlining is provided by |ulem.sty| by |
| 989 |
% Donald Arseneau. Double-spacing is provided by |setspace.sty| |
| 990 |
% by (at least) Geoffrey Tobin and Erica Harris. Running |
| 991 |
% headers are provided by |fancyhdr.sty| by Piet van Oostrum. |
| 992 |
% The geometry option loads |geometry.sty| by Hideo Umeki. |
| 993 |
% |
| 994 |
% Posts to |comp.text.tex| and |rec.arts.sf.composition|, |
| 995 |
% and email from users, notably Daniel Richard G., aided the |
| 996 |
% development of |sffms|. Any remaining errors are my own. |
| 997 |
% |
| 998 |
% \StopEventually{% |
| 999 |
% \ifmulticols |
| 1000 |
% \addtocontents{toc}{\protect\end{multicols}} |
| 1001 |
% \fi |
| 1002 |
% } |
| 1003 |
% |
| 1004 |
% \begin{macrocode} |
| 1005 |
%<*sffms> |
| 1006 |
|
| 1007 |
\newcounter{wordcounter} |
| 1008 |
\newcount\wordc |
| 1009 |
\newif\ifsffms@submit |
| 1010 |
\newif\ifsffms@novel |
| 1011 |
\newif\ifsffms@smart |
| 1012 |
\newif\ifsffms@dumb |
| 1013 |
\newif\ifsffms@notitle |
| 1014 |
\newif\ifsffms@courier |
| 1015 |
\newif\ifsffms@baen |
| 1016 |
\newif\ifsffms@daw |
| 1017 |
\newif\ifsffms@wotf |
| 1018 |
\newif\ifsffms@runningtitle |
| 1019 |
\newif\ifsffms@surname |
| 1020 |
\newif\ifsffms@afour |
| 1021 |
\newif\ifsffms@geometry |
| 1022 |
\sffms@submittrue |
| 1023 |
|
| 1024 |
\sfcode`\" = 0 |
| 1025 |
|
| 1026 |
\def\word@count{\ref{sffmswc}} |
| 1027 |
\def\author@name{\@author} |
| 1028 |
\def\author@address{} |
| 1029 |
\def\sur@name{} |
| 1030 |
\def\running@title{} |
| 1031 |
\def\scenesepstring{\#} |
| 1032 |
\def\thirtystring{\# \# \# \# \#} |
| 1033 |
\def\disposablestring{} |
| 1034 |
\def\pageofpages{Page {\thepage} of \pageref{sffmswc}} |
| 1035 |
\def\msheadstring{\getsurname\hspace{.5ex}/\hspace{.5ex}\getrunningtitle\hspace{.5ex}/\hspace{.5ex}\thepage} |
| 1036 |
|
| 1037 |
\DeclareOption{courier}{% |
| 1038 |
\sffms@couriertrue% |
| 1039 |
\AtBeginDocument{ |
| 1040 |
\fontfamily{pcr}\selectfont |
| 1041 |
\renewcommand{\ttdefault}{pcr} |
| 1042 |
\renewcommand{\bfdefault}{pcr} |
| 1043 |
\renewcommand{\itdefault}{pcr} |
| 1044 |
\renewcommand{\sldefault}{pcr} |
| 1045 |
\renewcommand{\scdefault}{pcr} |
| 1046 |
\renewcommand{\updefault}{pcr} |
| 1047 |
} |
| 1048 |
} |
| 1049 |
|
| 1050 |
\DeclareOption{nonsubmission}{\sffms@submitfalse} |
| 1051 |
\DeclareOption{submission}{\sffms@submittrue}%obsolete |
| 1052 |
\DeclareOption{novel}{\sffms@noveltrue} |
| 1053 |
|
| 1054 |
\DeclareOption{smart}{% |
| 1055 |
\sffms@smarttrue% |
| 1056 |
\AtBeginDocument{\begindoublequotes} |
| 1057 |
\AtEndDocument{\enddoublequotes} |
| 1058 |
} |
| 1059 |
|
| 1060 |
\DeclareOption{dumb}{\sffms@dumbtrue} |
| 1061 |
\DeclareOption{notitle}{\sffms@notitletrue} |
| 1062 |
|
| 1063 |
\DeclareOption{baen}{\sffms@baentrue} |
| 1064 |
\DeclareOption{daw}{\sffms@dawtrue} |
| 1065 |
\DeclareOption{wotf}{\sffms@wotftrue} |
| 1066 |
|
| 1067 |
\DeclareOption{geometry}{\sffms@geometrytrue} |
| 1068 |
|
| 1069 |
\DeclareOption{a4paper}{ |
| 1070 |
\sffms@afourtrue% |
| 1071 |
\PassOptionsToClass{\CurrentOption}{geometry} |
| 1072 |
\PassOptionsToClass{\CurrentOption}{report}} |
| 1073 |
|
| 1074 |
\DeclareOption{letterpaper}{ |
| 1075 |
\sffms@afourfalse% |
| 1076 |
\PassOptionsToClass{\CurrentOption}{geometry} |
| 1077 |
\PassOptionsToClass{\CurrentOption}{report}} |
| 1078 |
|
| 1079 |
|
| 1080 |
\DeclareOption*{\PassOptionsToClass{\CurrentOption}{report}} |
| 1081 |
\ProcessOptions |
| 1082 |
|
| 1083 |
|
| 1084 |
|
| 1085 |
\ifsffms@submit% |
| 1086 |
\LoadClass[12pt]{report} |
| 1087 |
\RequirePackage[T1]{fontenc} |
| 1088 |
\RequirePackage{fancyhdr} |
| 1089 |
\RequirePackage{ulem} |
| 1090 |
\RequirePackage{setspace}\setstretch{1.83} |
| 1091 |
\ifsffms@geometry |
| 1092 |
\ifsffms@baen \RequirePackage[hmargin=1.5in,bmargin=1.5in,tmargin=1.5in,headheight=.38in,headsep=.12in,nofoot]{geometry}% |
| 1093 |
\else \RequirePackage[hmargin=1in,bmargin=1in,tmargin=1in,headheight=.88in,headsep=.12in,nofoot]{geometry}% |
| 1094 |
\fi%endbaenif |
| 1095 |
\fi%endgeometryif |
| 1096 |
\else\LoadClass{report}% |
| 1097 |
\RequirePackage{setspace} \fi |
| 1098 |
|
| 1099 |
\ifsffms@smart \RequirePackage{sffsmart} \fi |
| 1100 |
\ifsffms@dumb \RequirePackage{sffdumb} \fi |
| 1101 |
|
| 1102 |
\ifsffms@submit% |
| 1103 |
\ifsffms@geometry% then margins are all set so do nothing |
| 1104 |
\sffms@geometrytrue |
| 1105 |
\else% have to set margins manually from paperdim |
| 1106 |
\setlength\headheight{.38in} |
| 1107 |
\setlength\headsep{.12in} |
| 1108 |
\setlength\textwidth{\paperwidth} |
| 1109 |
\newlength{\sffms@margin} |
| 1110 |
\setlength{\sffms@margin}{0in} |
| 1111 |
\ifsffms@baen \addtolength{\sffms@margin}{.5in} \fi |
| 1112 |
\setlength\textwidth{\paperwidth} |
| 1113 |
\addtolength\textwidth{-2in} |
| 1114 |
\addtolength\textwidth{-2\sffms@margin} |
| 1115 |
\setlength\oddsidemargin{\sffms@margin} |
| 1116 |
\setlength\textheight{\paperheight} |
| 1117 |
\addtolength\textheight{-2in} |
| 1118 |
\addtolength\textheight{-2\sffms@margin} |
| 1119 |
\setlength\topmargin{\sffms@margin} |
| 1120 |
\addtolength\topmargin{-.5in} |
| 1121 |
\fi% |
| 1122 |
\fi% |
| 1123 |
|
| 1124 |
|
| 1125 |
\newcommand{\authorname}[1]{\def\author@name{#1}} |
| 1126 |
\newcommand{\address}[1]{\def\author@address{#1}} |
| 1127 |
\newcommand{\wordcount}[1]{\def\word@count{#1}} |
| 1128 |
\newcommand{\surname}[1]{\def\sur@name{#1} \sffms@surnametrue} |
| 1129 |
\newcommand{\runningtitle}[1]{\def\running@title{#1} \sffms@runningtitletrue} |
| 1130 |
\newcommand{\sceneseparator}[1]{\def\scenesepstring{#1}} |
| 1131 |
\newcommand{\thirty}[1]{\def\thirtystring{#1}} |
| 1132 |
\newcommand{\disposable}{\def\disposablestring{Disposable~Copy}} |
| 1133 |
\ifsffms@wotf% |
| 1134 |
\def\msheadstring{\MakeUppercase{\@title}\hspace{.5ex}/\hspace{.5ex}\thepage} \fi% |
| 1135 |
\newcommand{\msheading}[1]{\def\msheadstring{#1}} |
| 1136 |
|
| 1137 |
\newcommand{\penname}[1]{} % obsolete |
| 1138 |
\newcommand{\getpenname}{\@author} % obsolete |
| 1139 |
|
| 1140 |
\newcommand{\getrunningtitle}{\ifsffms@runningtitle% |
| 1141 |
\MakeUppercase{\running@title}% |
| 1142 |
\else \MakeUppercase{\@title}% |
| 1143 |
\fi} |
| 1144 |
|
| 1145 |
\newcommand{\getsurname}{\ifsffms@surname% |
| 1146 |
\sur@name \else \@author \fi} |
| 1147 |
|
| 1148 |
\ifsffms@submit% |
| 1149 |
\newcommand{\newscene}{\centerline {\scenesepstring}} |
| 1150 |
\newcommand{\ifsubmission}[2]{#1}% |
| 1151 |
\else \newcommand{\newscene}{\vspace{1\baselineskip}} |
| 1152 |
\newcommand{\ifsubmission}[2]{#2} \fi |
| 1153 |
|
| 1154 |
\newcommand{\submit}[1]{\ifsubmission{#1}{}} |
| 1155 |
\newcommand{\nosubmit}[1]{\ifsubmission{}{#1}} |
| 1156 |
|
| 1157 |
\newcommand{\scenebreak}{\newscene} |
| 1158 |
|
| 1159 |
\newcommand{\thought}[1]{\emph{#1}} |
| 1160 |
|
| 1161 |
|
| 1162 |
\ifsffms@submit |
| 1163 |
\AtBeginDocument{ |
| 1164 |
\ttfamily |
| 1165 |
\useunder{\uwave}{\bfseries}{\textbf}%ulem command for boldface |
| 1166 |
\useunder{\uuline}{\scshape}{\textsc}%ulem command for smallcaps |
| 1167 |
\renewcommand\chapter{\if@openright\clearpage\else\cleardoublepage\fi |
| 1168 |
\secdef\@chapter\@schapter} |
| 1169 |
\def\@makechapterhead#1{\vspace*{4\baselineskip} |
| 1170 |
\begin{center}\@chapapp\space\thechapter\\ #1 \end{center} |
| 1171 |
\vspace*{1\baselineskip}} |
| 1172 |
\def\@schapter#1{% |
| 1173 |
\if@twocolumn\@topnewpage[\@makeschapterhead{#1}]% |
| 1174 |
\else\@makeschapterhead{#1}\@afterheading\fi} |
| 1175 |
\def\@makeschapterhead#1{\vspace*{4\baselineskip} |
| 1176 |
\begin{center} #1 \end{center} \vspace*{1\baselineskip}} |
| 1177 |
}% |
| 1178 |
\fi |
| 1179 |
|
| 1180 |
\ifsffms@novel% |
| 1181 |
\newcounter{tempcounter} |
| 1182 |
\newenvironment{synopsis} |
| 1183 |
{\setcounter{tempcounter}{\value{page}} |
| 1184 |
\pagenumbering{roman} |
| 1185 |
\singlespace |
| 1186 |
\chapter*{Synopsis of \MakeUppercase{\@title}}} |
| 1187 |
{\clearpage \setcounter{page}{\value{tempcounter}} |
| 1188 |
\pagenumbering{arabic} \pagestyle{fancy}}% |
| 1189 |
\else \newenvironment{synopsis}{SYNOPSIS: }{\scenebreak} \fi |
| 1190 |
|
| 1191 |
\newcommand{\sffms@commonsubsetup}% |
| 1192 |
{\pagestyle{fancy} |
| 1193 |
\fancyhead[r]{{\ttfamily \msheadstring}} |
| 1194 |
\fancyfoot{} |
| 1195 |
\renewcommand{\headrulewidth}{0pt} |
| 1196 |
\renewcommand{\footrulewidth}{0pt} |
| 1197 |
\raggedright |
| 1198 |
\settowidth{\parindent}{\texttt{~~~~~}} |
| 1199 |
} |
| 1200 |
|
| 1201 |
|
| 1202 |
\AtBeginDocument{ |
| 1203 |
\ifsffms@notitle% |
| 1204 |
\ifsffms@submit \sffms@commonsubsetup \fi% |
| 1205 |
\else% |
| 1206 |
\ifsffms@submit%beginning of + 2nd submit if |
| 1207 |
\sffms@commonsubsetup |
| 1208 |
\thispagestyle{empty} |
| 1209 |
\newsavebox{\sffms@fronttopsavebox} |
| 1210 |
\begin{lrbox}{\sffms@fronttopsavebox} |
| 1211 |
\begin{minipage}[t]{\textwidth} |
| 1212 |
\begin{singlespace}% |
| 1213 |
\ifsffms@daw \hfill\parbox[t]{.40\textwidth}{\raggedright\author@name\\% |
| 1214 |
\author@address\\[\baselineskip]% |
| 1215 |
\word@count\ words\\ \disposablestring}% |
| 1216 |
\else% |
| 1217 |
\parbox[t]{.65\textwidth}{\author@name\\\author@address}\hfill |
| 1218 |
\parbox[t]{.30\textwidth}{\raggedleft\word@count\ words\\[\baselineskip]% |
| 1219 |
\disposablestring}% |
| 1220 |
\fi% |
| 1221 |
\end{singlespace} |
| 1222 |
\end{minipage} |
| 1223 |
\end{lrbox} |
| 1224 |
\noindent\raisebox{0pt}[0pt][0pt]{\usebox{\sffms@fronttopsavebox}} |
| 1225 |
\vspace{0.39\textheight} |
| 1226 |
\begin{center}\MakeUppercase{\@title}\\by \@author\end{center} |
| 1227 |
\vspace{1\baselineskip}% |
| 1228 |
\else \maketitle \setcounter{page}{2} \fi% |
| 1229 |
\ifsffms@wotf \setcounter{page}{0} \clearpage% |
| 1230 |
\else \ifsffms@novel\clearpage\fi% |
| 1231 |
\fi% |
| 1232 |
\fi% |
| 1233 |
} |
| 1234 |
|
| 1235 |
\AtEndDocument{\vspace{12pt}\centerline{\thirtystring}% |
| 1236 |
\ifsffms@submit% |
| 1237 |
\wordc=\thepage% |
| 1238 |
\ifsffms@courier \multiply\wordc by 250% |
| 1239 |
\else \ifsffms@baen \multiply\wordc by 250% |
| 1240 |
\else \multiply\wordc by 295 \fi \fi% |
| 1241 |
\setcounter{wordcounter}{\the\wordc}% |
| 1242 |
\addtocounter{wordcounter}{-1}% |
| 1243 |
\refstepcounter{wordcounter}% |
| 1244 |
\fi% |
| 1245 |
\label{sffmswc}% |
| 1246 |
} |
| 1247 |
%</sffms> |
| 1248 |
% \end{macrocode} |
| 1249 |
% \begin{macrocode} |
| 1250 |
%<*smart> |
| 1251 |
{% |
| 1252 |
\catcode`\"=\active |
| 1253 |
\catcode`\@=11 |
| 1254 |
\gdef\begindoublequotes{% |
| 1255 |
\global\catcode`\"=\active |
| 1256 |
\global\chardef\dq=`\" |
| 1257 |
\global\let\dblqu@te=L |
| 1258 |
} |
| 1259 |
\gdef"{\ifinner\else\ifvmode\let\dblqu@te=L\fi\fi |
| 1260 |
\if L\dblqu@te``\global\let\dblqu@te=R% |
| 1261 |
\else |
| 1262 |
\let\xxx=\spacefactor |
| 1263 |
''\global\let\dblqu@te=L% |
| 1264 |
\spacefactor\xxx |
| 1265 |
\fi |
| 1266 |
} |
| 1267 |
} |
| 1268 |
|
| 1269 |
\gdef\enddoublequotes{\catcode`\"=12} |
| 1270 |
%</smart> |
| 1271 |
%<*dumb> |
| 1272 |
\def\dumbquote{\afterassignment"\let\next= } |
| 1273 |
\sfcode`\" = 0 |
| 1274 |
\def\rquote{'} |
| 1275 |
\def\lquote{`} |
| 1276 |
\catcode`'=\active \def'{\actrq} |
| 1277 |
\catcode``=\active \def`{\actlq} |
| 1278 |
\def\rqtest{\ifx\next'\let\next=\dumbquote\else\let\next=\rquote\fi\next} |
| 1279 |
\def\lqtest{\ifx\next`\let\next=\dumbquote\else\let\next=\lquote\fi\next} |
| 1280 |
\def\actrq{\futurelet\next\rqtest} |
| 1281 |
\def\actlq{\futurelet\next\lqtest} |
| 1282 |
%</dumb> |
| 1283 |
% \end{macrocode} |
| 1284 |
% |
| 1285 |
% \Finale |
| 1286 |
\endinput |
| 1287 |
|