diff options
Diffstat (limited to 'Master')
| -rw-r--r-- | Master/texmf-dist/doc/latex/stage/stage-documentation.pdf | bin | 100382 -> 149275 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/stage/stage-documentation.tex | 189 | ||||
| -rw-r--r-- | Master/texmf-dist/tex/latex/stage/stage.cls | 265 |
3 files changed, 238 insertions, 216 deletions
diff --git a/Master/texmf-dist/doc/latex/stage/stage-documentation.pdf b/Master/texmf-dist/doc/latex/stage/stage-documentation.pdf Binary files differindex 685526e5a10..c60d22d2b6c 100644 --- a/Master/texmf-dist/doc/latex/stage/stage-documentation.pdf +++ b/Master/texmf-dist/doc/latex/stage/stage-documentation.pdf diff --git a/Master/texmf-dist/doc/latex/stage/stage-documentation.tex b/Master/texmf-dist/doc/latex/stage/stage-documentation.tex new file mode 100644 index 00000000000..1be157b45f4 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stage/stage-documentation.tex @@ -0,0 +1,189 @@ +\documentclass{report} + +\usepackage[utf8x]{inputenx} +\usepackage{url} +\usepackage{cprotect} +\usepackage[Q=yes]{examplep} + +\begin{document} + +\title{Using \texttt{stage}} +\author{Robert Jahrling} +\maketitle + +\chapter{Introduction} + +Have you ever heard the adage about using the best tool for the job at hand? For writing a stage play, \LaTeX\ and \texttt{stage} are probably not the best tools. They are good tools, and \LaTeX\ itself is the best tool for a variety of jobs. Playwriting is not one of them. + +Why have \texttt{stage} then? \TeX\ produces very nice output, and while it would be arguably easier to write a play using a WYSIWYG word processor like OpenOffice.org Writer, there isn’t a program out there that would make your play look as good as \TeX\ does. There are many other reasons to use \TeX\ and \LaTeX, far too numerous to list here\,—\,I use it because it looks good. + +If you want to write screenplays, I suggest you look at Adrian McCarthy’s Script\TeX\footnote{http://www.aidtopia.com/software/scripttex/}. It’s a great screenplay tool, and Adrian, being much smarter than me, took care of a lot of hairy stuff that I barely understand. However, and I say this very respectfully, Script\TeX’s stage play mode is not correct\footnote{Script\TeX’s stage play mode produces scripts designed for reading, not production.}. + +\section{Changes in version 1.00} + +Since the previous release, which had no version number, dated 2003/05/15, the \verb|quotepage| environment has been removed, as well as the \verb|\copyrightnotice| and \verb|\draft| commands. These are either contrary to standard advice on scriptwriting (as acknowledged in their documentation) or can easily be implemented with standard \LaTeX\. The command \verb|\initsd| is no longer necessary (\verb|\charsd| may be used instead), but is still defined for backward compatibility. + +\section{Manuscript Format} + +\texttt{stage} is a \LaTeX2e\ class designed to produce correctly-formatted stage plays for production and for submission to literary agents and competitions. Recognize, however, that “correct” isn’t nearly as rigidly defined in the theater world as it is in Hollywood. For the stage, it is usually sufficient that your script look good\,—\,nobody will be holding a ruler to your manuscript. + +The formatting that I follow for stage is based on the formatting rules found at Virginia Commonwealth University’s website, The Playwriting Seminars, at \url{http://www.pubinfo.vcu.edu/artweb/playwriting/}. In brief: + +\begin{itemize} +\item Top and left margins are set at 1.5 inches. +\item Bottom and right margins are set at 1 inch. +\item Page numbers are set 1 inch from the top and right. +\item Character names are indented 4 inches, not centered. +\item Opening stage directions are indented 4 inches. +\item Other stage directions are indent 3.5 inches. +\item The text is set at 12\textbackslash 14. +\end{itemize} + +\section{\LaTeX\ information} + +This document isn’t intended to be an introduction to \LaTeX. For more information on using and installing \LaTeX, please visit the \LaTeX\ project website at \url{http://www.latex-project.org}. + +This is a standard \LaTeX2e\ class, and can be installed in the usual way. For more information on what exactly “the usual way” is, visit the CTAN archive at \url{http://www.ctan.org}. You can also review the documentation for your particular \TeX\ package. + +\section{Playwriting Information} + +There are a few resources that I would recommend to anyone who wants to write plays. + +\subsection{The Theater} + +The most important thing you can do, as a playwright, is to go see plays. Your local theater groups are putting on plays right now. It’s not terribly expensive, and it gives you an insight into what’s going on in theater, what works and what doesn’t, and what’s possible. I’m not going to get highbrow on you, either. If all you’ve got is a ”Grease” revival at the dinner theater on Route 10, go see it. + +If you live in a city, even a small one, I guarantee you there are groups out there putting on shows. If you have no money but lots of time, volunteer to be tech crew. You get to see the play over and over again, and a good idea of how theater works. + +\subsection{Reading Plays} +The second most important thing you can do as a playwright is to go to the library. Plays are found in the nonfiction section, in and around the low 800s in any Dewey Decimal-oriented library. It doesn’t even matter what you read, as long as you read it. If Shakespeare is your thing, read Shakespeare. If Wally Shawn is more to your taste, read Wally Shawn. Just read. Close your eyes and reach out and grab a play or five and read them, regardless of what they are. Some people will tell you to stick to acknowledged classics. Not me. Read everything. + +\subsection{Books on Playwriting} + +There are many, many good books on writing plays. I have a couple of recommendations, but these are by no means the only books you’ll want to look at. + +Spencer, Stuart. \emph{The Playwright’s Guidebook: An Insightful Primer on the Art of Dramatic Writing.} Faber \& Faber, 2002. Ayckbourn, Alan. \emph{The Crafty Art of Playmaking.} Palgrave Macmillan, 2003. + +\subsection{Playwriting Websites} +As with books, there are many websites on writing plays. I like the aforementioned Playwriting Seminars at \url{http://www.pubinfo.vcu.edu/artweb/playwriting/}. + +\section{Licensing} + +\texttt{stage} is distributed under the provisions of the \LaTeX\ Project Public License, a copy of which is available at \url{http://www.latex-project.org/lppl.txt}. + +\chapter{\texttt{stage} Functions} + +\texttt{stage} is based on the default \LaTeX\ book class, using the \texttt{12pt}, and \texttt{oneside} options. Other options can be supplied if desired to the \verb|\documentclass| command. + +Any documents made to use \texttt{stage} need to begin with a \verb|\documentclass{stage}| declaration. + +\section{Title Page} + +In addition to the standard \LaTeX\ title page information, \texttt{stage} provides some additional capabilities for play manuscripts. These commands all come after the document class declaration and before \maketitle. They are all optional. + +\cprotect\subsection{\verb|\address{<address>}|} +\verb|\address| blocks your address on the lower left of the title page. Separate multiple lines with \verb|\\|. It is appropriate to put any relevant contact information in this block, including phone numbers and email addresses. + +\section{Cast Page} + +To create a page for your cast of characters, use the \texttt{castpage} environment. To set up the environment, use \verb|\begin{castpage}|. When you are done adding characters, use \verb|\end{castpage}|. This page must come after the title page. + +\cprotect\subsection{\verb|\addcharacter{<name>}{<description>}|} +Use \verb|\addcharacter| to add characters to the cast page. + +\section{Page Matter} + +\cprotect\subsection{\verb|\act|} + +If you are numbering acts, use \verb|\act| before each act to place act headers. Acts are numbered with uppercase Roman numerals. This affects pagination: works with acts number the pages by act. + +\cprotect\subsection[\verb|\dialog{<character>}{<speech>}| \verb|\dialogue{<character>}{<speech>}|]{\verb|\dialog{<character>}{<speech>}|\\\verb|\dialogue{<character>}{<speech>}|} + +\verb|\dialog| sets off speeches with the appropriate formatting. Dialogue across page breaks will lead with the character’s name and “(Continued)”. Two spellings are provided for the sake of convenience, but they work identically. + +It may be convenient for you to define macros in your scripts to set up dialogue tags for each character to reduce typing. For example, if you use \verb|\def\Bob{\dialog{Bob}}|, you can set off Bob’s dialogue in your play by simply typing \verb|\Bob{<dialog>}|. + +\cprotect\subsection{\verb|\introduce{<character>}|} + +This command sets the character’s name in smallcaps when they are first introduced in stage directions. + +\cprotect\subsection{\verb|\pause|} + +Provided for convenience, this inserts a (Pause) stage direction for those of us who overuse them. + +\cprotect\subsection{\verb|\scene|} + +If you are numbering scenes, use \verb|\scene| before each scene to place scene headers. Scene headers use Arabic numbers. + +\cprotect\subsection[\verb|\charsd{<direction>}| \verb|\opensd{<direction>}| \verb|\open{<direction>}| \verb|\stage{<direction>}|]{\verb|\charsd{<direction>}|\\\verb|\opensd{<direction>}|\\\verb|\open{<direction>}|\\\verb|\stage{<direction>}|} + +There are several different commands for stage directions; which one you use depends on the circumstances. The stage directions that open your play, describe the stage and the setting, are indented slightly differently from other stage directions. For these, use \verb|\opensd| or its synonym, \verb|\open|. + +Use \verb|\stage| for inter-dialogue stage directions. + +Use \verb|\charsd| for intra-dialogue stage directions. + +\section{Translation and customization} + +If you want to use \texttt{stage} in another language, or want to customize any of the text it outputs automatically (for example, perhaps you want your script to finish “Finis” rather than “The End”), then you can redefine the corresponding command. For example: + +\begin{verbatim} +\renewcommand{\theendname}{Finis} +\end{verbatim} + +The commands correspond to the following messages: + +% Note: keep the following in sync with the code +\begin{description} + \item[\Q{\\actname}]The name of an act (“Act”). + \item[\Q{\\scenename}]The name of a scene (“Scene”). + \item[\Q{\\continuedname}]Used when dialog is continued over a page break (“Continued”). + \item[\Q{\\castname}]The title of the cast list (“Cast of Characters”). + \item[\Q{\\theendname}]The text written at the end of the script (“The End”). +\end{description} + +If you translate the set into another language, do send the translations to the maintainer, so that they can be included in a future release of \texttt{stage}. + + +\chapter{Putting It All Together} + +Here is a script template formatted with \LaTeX\ and \texttt{stage}. It should provide you with an idea of how to use \texttt{stage}. + +\begin{verbatim} +\documentclass{stage} + +\title{} +\author{} + +%%% The following items are optional. Uncomment to use. +% \address{} +% \copyrightnotice{} +% \draft{} + +\begin{document} + +\maketitle + +%%% Uncomment the following line to add a quote page. +% \quotepage{Quote}{Author} + +%%% Uncomment the next few lines to add a cast page. +% \begin{castpage} +% +\addcharacter{Name}{Description} +% +% \end{castpage} + +% The magic happens here... +% +% \act +% \scene +% \opensd{Opening stage directions.} +% \dialog{who}{what} + +\end{document} +\end{verbatim} + +If you have any questions on \texttt{stage}, please feel free to contact the maintainer at \url{rrt@sc3d.org}. + +\end{document} diff --git a/Master/texmf-dist/tex/latex/stage/stage.cls b/Master/texmf-dist/tex/latex/stage/stage.cls index 13b24567883..d369724ccb8 100644 --- a/Master/texmf-dist/tex/latex/stage/stage.cls +++ b/Master/texmf-dist/tex/latex/stage/stage.cls @@ -1,5 +1,9 @@ %% stage.cls %% Copyright 2005 Robert Jahrling +%% Copyright 2017 Reuben Thomas +% +% This is a LaTeX2e class called stage, providing a class +% for stage play Manuscript Format. % % This work may be distributed and/or modified under the % conditions of the LaTeX Project Public License, either version 1.3 @@ -11,128 +15,23 @@ % % This work has the LPPL maintenance status "maintained". % -% This Current Maintainer of this work is Robert Jahrling +% This Current Maintainer of this work is Reuben Thomas % % This work consists of the file stage.cls. % -% Contact me at jahrling@chorus.net -% -% I'd love to hear if or how people are using this! What do you -% think of the "warts-and-all" approach I took? I left in all the -% changes I made, and the stuff I didn't like (commented out). -% -% CHANGES NEEDED 5/16/2003: -% Fix Margins -% Fix Widows/Orphans -% -% Changes 5/17/2003: -% -% Added counters for acts. -% Added counters for scenes. -% Added comments and TODOs. -% -% Changes 5/18/2003: -% -% Correctly break pages for scenes. -% Changed \dialog to be the way I wanted. -% ...which entailed fixing up some spacing. -% ...which entailed removing more \doublespace commands. -% Added \paren as alias for \charsd for ScriptTeX compatibility. -% -% Changes 5/19/2003: -% -% Added \address command for \maketitle. -% Added \opensd command (and \open). -% Added \quotepage. -% -% Changes 5/20/2003: -% -% Added \castpage environment -% Added \addcharacter command -% Correct page numbering, <Act>-<page> -% Removed old (commented-out) \dialog command -% Deleted commented-out \doublespaces -% Added \dialogue as implementation of \dialog -% Added \AtEndDocument to print "The End" at the end of the document -% -% Changes 5/25/20003: -% -% Still monkeying with spacing -% Added \oneact command for one-act plays. -% -% Changes 6/5/2003: -% -% Got spacing looking pretty good. Still not entirely happy. -% -% Changes 6/10/2003: -% -% Reorganized \dialog command to remove the use of the -% changemargin environment. Requires adjustment to use of -% \dialog in scripts, but the tradeoff is worth it, -% because the tradeoff is... -% PROPER CONTINUED MARKS. Added use of fancyhdr to create -% a continued mark for interrupted dialog and a more mark -% for interrupted stage directions. -% -% Changes 6/11/2003: -% -% Changed \lhead to set the text at the top left corner of -% the picture box. As it stood, it was right-aligning, -% which threw alignment off. -% Break problem POSSIBLY solved. Must experiment. -% -% Changes 6/12/2003: -% -% Removed \extramarks from stage directions. Was having problem -% with pages having extra marks where none were needed, mostly -% when a stage direction was the last thing on the page and -% was complete. -% Added \copyrightnotice to separate copyright notice from the -% address block. Use is completely optional. stage will ignore -% its absence (unlike LaTeX and \author, for example). -% Added \draft to indicate draft number. Also completely optional; -% stage will ignore its absence. -% Changed \maketitle to reflect the aforementioned new additions. -% Added \pause. -% -% Changes 2/17/05: -% -% Added LPPL license notice. Per C.-E. Pfeiler's suggestion, -% I'll be uploading stage.cls to CTAN. -% -% NOTES: -% \castpage and \quotepage definitions must come after \maketitle -% in any documents created with this class. -% \act MUST appear or else page numbers get whacked. This should -% be considered a TODO bugfix. Can be fixed by using \oneact. -% As of 6/10, we're back to \dialog{speaker}{speech}. -% -% TODO: -% Time/setting page -% Character s.d. spacing is not the greatest. -% -% Required: -% -% This is a LaTeX2e class called stage, providing a class -% for stage play Manuscript Format. +% See https://github.com/rrthomas/stage or contact me at rrt@sc3d.org % + \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{stage}[2003/05/15 Manuscript Format for stage plays] -% The class is based on the default book class; since this -% is so far a personal project, I am defaulting to letter -% paper. -\LoadClass[12pt,oneside,letterpaper]{book} +\ProvidesClass{stage}[2017/04/25 v1.00 Manuscript Format for stage plays] +% The class is based on the default book class +\LoadClass[12pt,oneside]{book} +\PassOptionsToClass{\CurrentOption}{book} % We're going to use ifthen to do some conditional page breaking. \RequirePackage{ifthen} \RequirePackage{fancyhdr} \RequirePackage{extramarks} -% We provide a friendly warning when an option is specified; -% since stage provides no options, all options return an error. -\DeclareOption*{% - \ClassWarning{stage}{Unknown option `\CurrentOption'}% -} -% Required to process options. -\ProcessOptions\relax +\RequirePackage{needspace} % These three commands are required. % The default font size is 12/14. It looks better than 12 solid. % The textwidth and textheight represent one-inch margins all @@ -144,6 +43,14 @@ \raggedbottom + +%%% Customizable strings (Note: keep in sync with the docs) +\newcommand{\actname}{Act} +\newcommand{\scenename}{Scene} +\newcommand{\continuedname}{Continued} +\newcommand{\castname}{Cast of Characters} +\newcommand{\theendname}{The End} + %%% pagestyle commands % use fancy pagestyle \pagestyle{fancy} @@ -166,51 +73,28 @@ % No indentation. Double space between paragraphs. \parindent 0pt -% \parskip 1.6ex \parskip 0pt +\newlength{\doublespacelength} +\setlength{\doublespacelength}{1.6ex} % \doublespace leaves a line's worth of space between elements. -\newcommand{\doublespace}{\vspace{1.6ex}} +\newcommand{\doublespace}{\vspace{\doublespacelength}} % \introduce is used the first time we meet a character. \newcommand{\introduce}[1]{\textsc{#1}} -% \address is used for the writer's copyright notice and address +% \address is used for the writer's address \newcommand{\address}[1]{\gdef\@address{#1}} -% \draft is used if the writer wants to indicate draft number -\newcommand{\draft}[1]{\gdef\@draftno{#1}} -% \copyrightnotice is used if the writer wants to indicate copyright -\newcommand{\copyrightnotice}[1]{\gdef\@crightnotice{#1}} % Counts acts \newcounter{actcounter} % We need to initialize actcounter for page numbering. -\setcounter{actcounter}{1} -% pagestyle and headers -% 6/10/03 removed myheadings in favor of fancyhdr -% \pagestyle{myheadings} -% \thepage does page numbering. -% -% Yes, this is incredibly ugly. For some reason, acts were not being -% numbered from 1, so I needed to initialize actcounter to 1. -% This had a side effect of making the use of actcounter in the -% headers off by 1, so we need to subtract 1 from the counter, -% print the page number, and add the 1 back in. -\renewcommand{\thepage}{% - \addtocounter{actcounter}{-1}% - \Roman{actcounter}-\arabic{page}% - \addtocounter{actcounter}{1}% -} -% If we're writing a one-act play, we don't need the special page -% numbering scheme, so we tell stage that we're writing a one-act -% and it takes care of that. -\newcommand{\oneact}{% - \renewcommand{\thepage}{% - \arabic{page}% - }% -} +\setcounter{actcounter}{0} % Counts scenes per act \newcounter{scenecounter}[actcounter] % An environment for specifying margin changes \newenvironment{changemargin}[2]{% \begin{list}{}{% + % Without the following critical setting, we could use + % changepage’s adjustwidth environment + \setlength{\partopsep}{0pt}% \setlength{\topsep}{0pt}% \setlength{\leftmargin}{#1}% \setlength{\rightmargin}{#2}% @@ -219,25 +103,14 @@ \setlength{\parsep}{\parskip}% }% \item[]}{\end{list}} -% \dialog sets the character's name above his speech -% Still need to figure out how to keep name and speech together, -% i.e. not allow pagebreaks between name and speech. -% \newcommand{\dialog}[1]{% -% \doublespace -% % \parskip 1.6ex -% \begin{changemargin}{2.5in}{0in} -% \textsc{#1}% -% \end{changemargin} -% \vspace{-0.9ex} -% } +% \dialog sets the character's name above their speech \newcommand{\dialog}[2]{% - \doublespace% - \hskip 2.5in\textsc{#1}\par% - \nobreak - \extramarks{}{} - \nobreak - #2 - \extramarks{\textsc{#1}(Continued)}{} + \doublespace% + \needspace{2\baselineskip}% + \begin{changemargin}{2.5in}{0in}\textsc{#1}\end{changemargin}% + \extramarks{}{}% + #2% + \extramarks{\textsc{#1} (\continuedname)}{} } % \dialogue, for people who like that spelling better @@ -247,14 +120,14 @@ % % Start a new page for each Act except the first \newcommand{\act}{% + \renewcommand{\thepage}{\Roman{actcounter}-\arabic{page}}% \begin{changemargin}{2.5in}{0in} \ifthenelse{\value{actcounter} > 1}{\newpage}{} - \textsc{Act} \Roman{actcounter} \ifthenelse{\value{actcounter} = 1}{\doublespace}{} \stepcounter{actcounter} + \textsc{\actname} \Roman{actcounter} \end{changemargin} \setcounter{page}{1} -% \doublespace } % \scene creates a scene header, with arabic numerals % @@ -263,20 +136,15 @@ \begin{changemargin}{2.5in}{0in} \stepcounter{scenecounter} \ifthenelse{\value{scenecounter} > 1}{\newpage}{} - \textsc{Scene} \arabic{scenecounter} + \textsc{\scenename} \arabic{scenecounter} \ifthenelse{\value{scenecounter} = 1}{\doublespace}{} \end{changemargin} } -% \stage sets the stage directions a little farther in than the -% dialog box and parenthesizes them. -% -% I'm not happy with this; I'd rather not have to put braces -% around the stage directions, but it seems like there's no -% way around it. +% \stage sets the stage directions farther in than the box +% containing the dialog, and parenthesizes them. \newcommand{\stage}[1]{% \doublespace \begin{changemargin}{2in}{0in} - % \extramarks{}{(more)}% (#1)% \end{changemargin} } @@ -284,28 +152,15 @@ % stage directions. It's intended to set properly into a passage % of dialog. \newcommand{\charsd}[1]{% - % \parskip 0pt - \begin{changemargin}{2in}{0in} - % \vspace{0.8ex}% + \begin{changemargin}{2in}{0in}% (#1)% - \end{changemargin} - % \parskip 0pt -} + \end{changemargin}} +% Undocumented, for backwards compatibility +\newcommand{\initsd}[1]{\charsd{#1}} % \pause is just convenient. \newcommand{\pause}{\stage{Pause.}} -% \initsd is a quick hack to get around messed-up \charsd spacing -% when a \charsd comes before any dialog. -\newcommand{\initsd}[1]{% - \vspace{-0.6ex}% - \begin{changemargin}{2in}{0in} - (#1)% - \end{changemargin} - \parskip 0pt - \vspace{-0.6ex} -} - % Implemented \paren to ease transition from ScriptTeX \newcommand{\paren}[1]{\charsd{#1}} @@ -320,9 +175,6 @@ \newcommand{\open}[1]{\opensd{#1}} % "placeholder" redefinition of \maketitle. -% -% TODO: address and copyright -% 5/19/2003: done, but copyright just gets folded in to address. \renewcommand{\maketitle}{% \begin{titlepage} \center{\textsc{\@title}} @@ -330,33 +182,17 @@ \center{\@author} \vspace{5in} \begin{changemargin}{0in}{0in} - \ifthenelse{\not\isundefined{\@crightnotice}}{% - \copyright \@crightnotice}{} - \par \ifthenelse{\not\isundefined{\@address}}{\@address}{} - \par - \ifthenelse{\not\isundefined{\@draftno}}{DRAFT \@draftno}{} \end{changemargin} \end{titlepage} \setcounter{page}{1} } -\newcommand{\quotepage}[2]{% - \thispagestyle{empty} - \begin{quote} - \end{quote} - \begin{quote} - \vspace{1in} - ``#1''\par\emph{#2} - \end{quote} - \setcounter{page}{0} - \newpage -} % The castpage environment sets up the cast page \newenvironment{castpage}{% \thispagestyle{empty}% - \center{\textsc{Cast of Characters}}% - \doublespace% + \center{\textsc{\castname}}% + \vspace{3ex}% \begin{changemargin}{0in}{0.5in}% }{% \end{changemargin}% @@ -364,17 +200,14 @@ \newpage% } % \addcharacter adds characters to the cast page. -% NOTE: There must be a blank line between \addcharacter commands -% in the LaTeX source! \newcommand{\addcharacter}[2]{% \begin{tabular}[2]{p{2in} p{4in}} - \textsc{#1} & #2 + \textsc{#1} & #2\\[\doublespacelength] \end{tabular} - \doublespace } -% Print "The End" at the end of the document. +% Mark the end of the document. \AtEndDocument{% \doublespace % \hskip 2.5in % - \textsc{The End}% + \textsc{\theendname}% } |