diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/screenplay/screenplay.dtx')
-rw-r--r-- | Master/texmf-dist/source/latex/screenplay/screenplay.dtx | 122 |
1 files changed, 68 insertions, 54 deletions
diff --git a/Master/texmf-dist/source/latex/screenplay/screenplay.dtx b/Master/texmf-dist/source/latex/screenplay/screenplay.dtx index a497fa1de4c..7f2e7bfe77a 100644 --- a/Master/texmf-dist/source/latex/screenplay/screenplay.dtx +++ b/Master/texmf-dist/source/latex/screenplay/screenplay.dtx @@ -34,7 +34,7 @@ %</dtx> %<driver>\ProvidesFile{screenplay.drv} % \fi -%\ProvidesFile{screenplay}[2006/09/27 v1.487 +%\ProvidesFile{screenplay}[2006/09/30 v1.496 % LaTeX2e Draft Screenplay document class % (C)2006 John Pate % released under the GNU General Public License] @@ -42,7 +42,10 @@ %<*driver> \documentclass{article} \usepackage{doc} -\usepackage[dvips,letterpaper]{geometry} +\usepackage[dvips,letterpaper,pdfauthor=John\ Pate, +pdftitle=A\ LaTeX2e\ class\ for\ Draft\ Screenplays, +pdfsubject=LaTeX2e\ class\ documentation\ and\ source\ (C)2006\ John\ Pate] +{hyperref} \RecordChanges \CodelineIndex \begin{document} @@ -53,13 +56,18 @@ % % \CheckSum{295} % \changes{1.0.0}{2006 Sep 23}{initial version of \texttt{.dtx}, class date -% \texttt{[2006/09/23]}} -% \changes{1.0.1}{2006 Sep 24}{minor code changes, revision to documentation} +% \texttt{[2006/09/23], v1.457}} +% \changes{1.0.1}{2006 Sep 24}{minor code changes, revision to documentation, +% v1.461} % \changes{1.0.2}{2006 Sep 26}{minor code changes, revision to documentation, -% added \texttt{test} file, % \texttt{example} file, to \texttt{.dtx}, -% amended \texttt{.ins}} +% added \texttt{test} file, \texttt{example} file, to \texttt{.dtx}, +% amended \texttt{.ins}, v1.465} % \changes{1.0.3}{2006 Sep 27}{minor code changes, revision to documentation, -% added change history} +% added change history, v1.487} +% \changes{1.0.4}{2006 Sep 28}{enabled hyperlinks in documentation, v1.491} +% \changes{1.0.5}{2006 Sep 29}{minor code changes, revision to documentation, +% v1.494} +% \changes{1.0.6}{2006 Sep 30}{fixed typos, v1.496} % % \MakeShortVerb{\|} % @@ -130,8 +138,9 @@ % \item\texttt{COPYING}---GNU General Public License % \end{itemize} % -% If not, get \texttt{screenplay.zip} via -% \texttt{http://dvc.org.uk/sacrific.txt/screenplay.zip} +% If not, get \texttt{screenplay.zip} via, \\ +% \href{http://dvc.org.uk/sacrific.txt/screenplay.zip}% +% {\texttt{http://dvc.org.uk/sacrific.txt/screenplay.zip}} % % You use the command, \\ % \texttt{> latex screenplay.ins} \\ @@ -149,14 +158,16 @@ % \texttt{test.pdf}. % % Make sure everything in the printing chain can deal properly -% with \emph{letter paper}. Print out your version of -% \texttt{test} and the provided \texttt{test.pdf} (on letter -% paper of course!) and compare them. The two printouts should -% be dimensionally identical. If you have an old, or broken, -% version of \texttt{dvips} you'll need to fix it before you -% proceed further. +% with 8.5ins by 11ins letter paper. Print out your +% version of \texttt{test} and the provided \texttt{test.pdf} +% (on letter paper of course!) and compare them. The two +% printouts should be dimensionally identical. The left margin +% should measure as \emph{exactly} 1.5ins. If not you have +% an old version of \texttt{dvips} and/or your printer driver +% is configured incorrectly and you'll need to fix things before +% you proceed further. % -% \section{Some example bits of markup} +% \section{Some example markup} % % Although \texttt{screenplay.cls} builds on the standard \TeX\ document % class \texttt{article}, it is not intended you pass it any options @@ -164,12 +175,12 @@ % The formatting required is minimalist. \texttt{screenplay.cls} will % issue an error message if you use any options. % -% |\documentclass{screenplay}[2006/09/27]| \\ +% |\documentclass{screenplay}[2006/09/30]| \\ % is your first command, you can give the optional date argument in % case of any earlier copies of \texttt{screenplay.cls} lying around. % I'll try not to break things retro-actively with later revisions % but this can't be guaranteed. Per this revision, anything marked -% with |[2006/09/23]| or later will produce the expected results. +% with \texttt{[2006/09/23]} or later will produce the expected results. % % Your second command is, of course\ldots\\ % |\begin{document}| @@ -228,10 +239,10 @@ % formatting. You may need to insert linebreaks manually even % where `|Overfull \hbox|' warnings are absent. You'll know % when it is necessary by spotting extra vertical whitespace in -% the document. |example.tex| demonstrates this, read through -% the raw |.tex| file and try modifying it as indicated. -% It's likely you will have to put a quite a few linebreaks -% manually into dialogue text due to the restricted margins. +% the document. \texttt{example.tex} demonstrates this, read through +% the raw \texttt{.tex} file and try modifying it as indicated. +% It's likely you will have to put quite a few linebreaks +% `by hand' into dialogue text due to the restricted margins. % % \textbf{Do not put in pagebreaks until you have really, really, % really finished editing.} @@ -252,21 +263,25 @@ % Yes, that's the English (or for that matter French and Canadian) % ``centre'' not ``center'' in a stunning break from tradition. % -% For further enlightenment, you should scrutinise the raw text of +% For further enlightenment, you should scrutinise the markup of % \texttt{example.tex} and peruse \textbf{The Coding} % section of this document. % % You can see a completed script marked-up % via \LaTeXe\ and formatted with \texttt{screenplay.cls} -% at \texttt{http://dvc.org.uk/sacrific.txt/}. +% at \href{http://dvc.org.uk/sacrific.txt/}% +% {\texttt{http://dvc.org.uk/sacrific.txt/}}. % There is also, at time of writing, a ``work-in-progress'' script % that has had manual linebreaks inserted but not manual pagebreaks. % % \section{Specs from the Academy} % -% Be sure to read and inwardly digest, -% \texttt{http://www.oscars.org/nicholl/format.html} -% and view, \texttt{http://www.oscars.org/nicholl/script.pdf}, +% Be sure to read, carefully, and inwardly digest, \\ +% \href{http://www.oscars.org/nicholl/format.html}% +% {\texttt{http://www.oscars.org/nicholl/format.html}} \\ +% and view, \\ +% \href{http://www.oscars.org/nicholl/script.pdf}% +% {\texttt{http://www.oscars.org/nicholl/script.pdf}}, \\ % the model document. % % \begin{itemize} @@ -300,7 +315,7 @@ % % \section{The Coding} % -% \texttt{screenplay.cls v1.487} was tested with\ldots +% \texttt{screenplay.cls v1.496} was tested with\ldots % \begin{itemize} % \item pdfe\TeX\ 3.141592-1.21a-2.2 (\Web2C\ 7.5.4) % \item \texttt{dvips(k)} 5.95a @@ -320,7 +335,7 @@ % \end{macrocode} % Say it like it is\ldots % \begin{macrocode} -\ProvidesClass{screenplay}[2006/09/27 v1.487 +\ProvidesClass{screenplay}[2006/09/30 v1.496 LaTeX2e Draft Screenplay document class (C)2006 John Pate released under the GNU General Public License] @@ -329,12 +344,12 @@ % \begin{macrocode} \DeclareOption*{% \PackageError{screenplay}{Unwanted option '\CurrentOption'}% - {There are no options available for class screenplay v1.487}} + {There are no options available for class screenplay v1.496}} \ProcessOptions\relax % \end{macrocode} % |ifthen| needed for testing for optional args\ldots % \begin{macrocode} -\RequirePackage{ifthen} +\RequirePackage{ifthen}[2001/05/26] % \end{macrocode} % Use \texttt{article} class for its base functionality, % \emph{must} be @@ -346,13 +361,14 @@ % \texttt{geometry} package makes dvips/pdf do the right thang % for letter paper\ldots % \begin{macrocode} -\RequirePackage[dvips,letterpaper]{geometry} +\RequirePackage[dvips,letterpaper]{geometry}[2002/07/08] % \end{macrocode} % \ldots and make sure your printer driver knows letter. % Yes, you \emph{must} use American 8.5"x11" letter % paper---stationers in the UK call it `quarto' paper, % see\ldots\\ -% \texttt{http://www.gwydir.demon.co.uk/jo/units/print.htm} +% \href{http://www.gwydir.demon.co.uk/jo/units/print.htm}% +% {\texttt{http://www.gwydir.demon.co.uk/jo/units/print.htm}} % \begin{macrocode} \setlength{\paperheight}{11in} \setlength{\paperwidth}{8.5in} @@ -361,7 +377,7 @@ % \emph{Must} have \texttt{Courier} as font (may cause warnings about % font stuff, ignore)\ldots % \begin{macrocode} -\RequirePackage{courier} +\RequirePackage{courier}[2004/09/15] \renewcommand*\familydefault{\ttdefault} % \end{macrocode} % Can load hyphenation ability for non-standard font\ldots @@ -487,7 +503,7 @@ % This must be the first command after |\begin{document}|. % % \begin{macro}{\nicholl} -% |\nicholl{title of your magnum opus}| +% |\nicholl{title of your magnum opus}| \\ % for Nicholl Competition---just the title, not bolded\ldots % \begin{macrocode} \newcommand{\nicholl}[1]{ @@ -514,8 +530,8 @@ % \end{macrocode} % % \begin{macro}{\titleauthor} -% |\titleauthor| |[year]| |{title}| |{author's name}| -% |{contact details\\email etc}| +% |\titleauthor| |[year]| |{title}| |{author's name}| \\ +% |{contact details\\email etc}| \\ % the copyright notice doesn't fit the spec so optional\dots if you % put it on the web though \copyright\ certainly won't hurt! % \begin{macrocode} @@ -565,8 +581,8 @@ % \end{macrocode} % \end{macro} % \begin{macro}{\tilteextra} -% |\titleextra{extra blurb}| |{title}| |{author's name}| -% |{contact details\\email etc}| +% |\titleextra{extra blurb}| |{title}| |{author's name}| \\ +% |{contact details\\email etc}| \\ % for title page---author details with extra blurb % not recommended by \texttt{script.pdf} but by popular request, % apparently some people like to put in copyright and @@ -598,11 +614,10 @@ % \end{macro} % \textbf{Dialogue blocks}\ldots % \begin{macro}{\paren} -% |\paren{hello world}| -% parenthetical within dialogue environment stage dirs\ldots -% only for \emph{very short} text (directions) within dialogue -% environment, the optional argument is for internal use -% \emph{only}\ldots +% |\paren{hello world}| \\ +% parenthetical within dialogue environment\ldots +% only for \emph{very short} text (directions) within dialogue, +% the optional argument is for internal use \emph{only}\ldots % \begin{macrocode} \newcommand{\paren}[2][\\]{% #1\parentab\parbox[t]{\parenwidth}{\raggedright(#2)\parenkludge}\\ @@ -739,8 +754,7 @@ % \textbf{Title Over} % % \begin{macro}{titleover env} -% Title Over\ldots\\ -% |\begin{titleover}| \ \ldots\ |\end{titleover}| +% |\begin{titleover}| \ \ldots\ |\end{titleover}| \\ % as pseudo dialogue environment (think ``Star Wars'') % the optional argument is for internal use \emph{only}\ldots % \begin{macrocode} @@ -775,9 +789,8 @@ TITLE OVER:\\ % \end{macrocode} % \end{macro} % \begin{macro}{\centretitle} -% titleover for short text -% |\centretitle| |{short text}| -% most often a date\ldots +% |\centretitle| |{short text}| \\ +% titleover for short text most often a date\ldots % \begin{macrocode} \newcommand{\centretitle}[1]{ @@ -794,7 +807,7 @@ TITLE OVER: % \textbf{Other spiffy macros} % % \begin{macro}{\fadein} -% |\fadein| +% |\fadein| \\ % always the \emph{first} thing in your script, for some reason\ldots % \begin{macrocode} \newcommand{\fadein}{ @@ -807,7 +820,7 @@ FADE IN: % \end{macrocode} % \end{macro} % \begin{macro}{\fadeout} -% |\fadeout| +% |\fadeout| \\ % always the last thing in your script, for some reason\ldots % % \begin{macrocode} @@ -866,7 +879,8 @@ FADE IN: % % The test file \texttt{test.tex} shows \texttt{screenplay} % markup applied to ``FOR A FEW DAYS MORE'' -% (\texttt{http://www.oscars.org/nicholl/script.pdf}) +% (\href{http://www.oscars.org/nicholl/script.pdf}% +% {\texttt{http://www.oscars.org/nicholl/script.pdf}}) % and the \texttt{test.pdf} file was generated from that. % % A printout of the first page \texttt{script.pdf} and @@ -901,7 +915,7 @@ FADE IN: %% see http://www.dvc.org.uk/sacrific.txt/ %% for more information on the document class. %% -\documentclass{screenplay}[2006/09/27] +\documentclass{screenplay}[2006/09/30] \begin{document} \titleauthor{For a Few Days More}{April Rider} {April Rider\\ @@ -959,7 +973,7 @@ comes. %\fi %\iffalse %<*example> -\documentclass{screenplay}[2006/09/27] +\documentclass{screenplay}[2006/09/30] \begin{document} %% cover page, this command has to go first ... %% choose one of \titleauthor, \titleextra, \nicholl ... |