Skip to content

Commit 626e0ea

Browse files
sadmac7000sadmac7000
authored
celluloid:0.1.0 (typst#2427)
1 parent a82c93c commit 626e0ea

File tree

7 files changed

+612
-0
lines changed

7 files changed

+612
-0
lines changed

‎packages/preview/celluloid/0.1.0/LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎packages/preview/celluloid/0.1.0/README.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# celluloid
2+
3+
A template for writing screenplays.
4+
5+
This template targets the fickle "submission script" format for Hollywoood
6+
production companies.
7+
8+
For the uninitiated: the format for screenplays being submitted to studios has
9+
no official standard, but there's a defacto industry standard, and studios have
10+
a reputation for being *extremely* picky about it. Allegedly this is an excuse
11+
to throw out more submissions and cull the massive volume they receive each
12+
year, though that could be a myth.
13+
14+
In fact, there's a lot of unreliable chatter about this format. Since there's no
15+
single recognized body putting out a single authoritative spec for this stuff,
16+
there's often a lot of debate about what formatting quirks are acceptable. Are
17+
scene transitions still done? Do you need `CONT'D` or can you drop it? Are
18+
montages still done as numbered lists? Are the studios actually way more relaxed
19+
about this stuff than people think and we're all just freaked out over nothing?
20+
Who knows.
21+
22+
With that context in mind, this template is based most heavily on an
23+
[example script](https://www.oscars.org/sites/oscars/files/scriptsample.pdf)
24+
published by The Academy of Motion Picture Arts and Sciences.
25+
26+
This template hews pretty close to what's demonstrated in that example script.
27+
There are features seen in screenplays for doing more complicated things (those
28+
numbered-list montages mentioned before for example), but for now this template
29+
takes AMPAS's failure to include those things in the example script as a
30+
disrecommendation rather than an oversight.
31+
32+
## Usage
33+
34+
You can use this template in the Typst web app by clicking "Start from template"
35+
on the dashboard and searching for celluloid.
36+
37+
Alternatively, you can use the CLI to kick this project off using the command
38+
```
39+
typst init @preview/celluloid
40+
```
41+
42+
Typst will create a new directory with all the files needed to get you started.
43+
44+
### Fonts
45+
46+
Pretty much every source on screenplay formats agrees that the entire document
47+
should be written in some form of Courier. There are several Courier variants
48+
available, and there's some debate on the merits of each. There seems to be some
49+
agreement that Courier New is inferior among the variants and should be avoided.
50+
This is the only variant mentioned explicitly in the AMPAS sample and it's a
51+
negative mention.
52+
53+
With that in mind, this template will try to find and use one of the following,
54+
in order of preference:
55+
56+
- Courier Final Draft
57+
- Courier
58+
- Courier Prime
59+
- Courier New
60+
61+
You can also set your own font name, see [Configuration](#configuration).
62+
63+
To make one of these fonts available in the Typst web app, you can simply upload
64+
the font files into the root of the project by clicking the "Explore Files"
65+
icon, then the "Upload Files" icon in the revealed panel.
66+
67+
To make one of these fonts available for the CLI, simply install the font on
68+
your system with whatever mechanism your operating system provides.
69+
70+
Of the fonts mentioned, Courier Prime is [available for free](https://fonts.google.com/specimen/Courier+Prime)
71+
under the [OFL](https://openfontlicense.org/).
72+
73+
## Configuration
74+
75+
This template exports the `screenplay` function which takes a positional
76+
argument for the title of the screenplay, and a positional argument for the body
77+
of the screenplay. It also accepts the following named arguments:
78+
79+
- `font`: The name of a font to use, or a list of names in order of preference.
80+
This template is designed to work with variants of Courier, though it cannot
81+
enforce this restriction.
82+
- `author`: The author's full name, used in the byline.
83+
- `contact`: Contact information. This will appear on the title page. It is
84+
typical to include a name, address, possibly a phone number, and an email.
85+
86+
87+
The template will initialize your package with a sample call to the `screenplay`
88+
function in a show rule. If you, however, want to change an existing project to
89+
use this template, you can add a show rule like this at the top of your file:
90+
91+
```typ
92+
#import "@preview/celluloid:0.1.0": *
93+
#show : screenplay.with(
94+
[Lorem Ipsum],
95+
author: [John Doe],
96+
contact: [
97+
John Doe\
98+
123 Hickory Street\
99+
Chicago, IL 12345\
100+
john.doe\@example.com
101+
])
102+
103+
// Your content goes here. Use the various other functions to include dialogue
104+
// and scene headers.
105+
```
106+
107+
## Formatting functions
108+
109+
In addition to `screenplay`, the following functions are provided:
110+
111+
-`scene`: Header appearing before every scene.
112+
-`dialogue`: A block of dialogue from a single character.
113+
-`more-dialogue`: A continuation of a previous dialogue block after breaking to
114+
insert some description.
115+
-`parenthetical`: A parenthetical description inside a `dialogue` block.
116+
-`intro`: Used to indicate the first time a character's name is mentioned.
117+
*Must* be used before giving that character any `dialogue` blocks.
118+
-`title-over`: A section which contains text shown on screen during the film.
119+
-`transition`: A brief heading indicating how to transition to the next scene.
120+
-`action`: A compact scene heading used for action sequences.

0 commit comments

Comments
 (0)