summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/sides/README
blob: 9b71525083f8a17c17126c731c8b861843fc232b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
  sides - Typesetting stageplays with LaTeX2e, Version 1, 5/9/2005
  Copyright (c) 2005 Wing L. Mui
  http://www.wingie.org
  

  WHAT IS SIDES?
  
    sides is a class package for typsetting stage plays in LaTeX2e.
    
    In theater-jargon, ``sides'' are the (imcomplete) copies of the script
    used for auditions and rehearsals.

    This class package was based on the package ``plari'' written by
    Antti-Juhani Kaijanaho in 1998.
    
    
  HOW TO USE SIDES

    Simply start your document off with \documentclass[12pt]{sides}.

    Within the sides class, all text are single spaced and paragraphs
    are not indented. The document is divided into acts and scenes. They each
    have their own counters. Starting a new act starts a new page as well.
    
    The commands are listed below and as comments in the class code.
    
    ``sides-sample.tex'', included with this package, shows example usage
    of every command in sides in a real playwriting context.

    \newact
      creates a new act with heading Act N, N is act number in Roman num
    \newactnamed{actname}
      creates a new act with heading actname, does not increment counter
      this is useful for interludes, prologues, etc.
    \newscene
      creates a new scene with heading Scene M, M is scene number
    \newscenenamed{scname}
      creates a new scene with heading scname, does not increment counter
    \repl{charname} diag
      outputs a line with text diag spoken by charname
    \stagedir{dir}
      outputs italized stage directions dir
    \chara{charname}
      outputs charname in smallcaps, as in repl
    \paren{remark}
      inserts an italized parenthetical remark into the text
    \pause
      an alias for \paren{Pause.}
    \castpage, \castpagelatin
      inserts a cast section, which in reality is just an unnumbered scene
      \castpagelatin outputs ``dramatis personae'' instead of boring English
    \cast{charname}{desc}
      outputs an entry with character charname and description desc
    \notes
      inserts a section for playwright's notes, does not start a new page

    \castpage and \notes are just shorthands, one can always just use
    \newscenenamed{title} to accomplish the same thing.
    
  
  LICENSE

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; see the file COPYING.  If not, write to
    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.