SceneDocument#
Import |
|
Defined in |
|
Install |
|
Since |
0.10 |
Stability |
Public: follows semantic versioning. Below 1.0, a minor release may change it, and the CHANGELOG says how. |
- class scenet.frontends.yaml_front.SceneDocument[source]#
Bases:
objectA scene, read: its panels, and the pages they are laid out on.
- panels#
Panel name to validated IR, in declaration order – which is reading order. A single-panel document has one, named
panel.
- layout#
The page format and the pages.
layout.pagesis empty for a document that lays nothing out, which is every document written before pages existed.- Type:
- notes#
What reading it noticed that is worth saying but is no fault, each naming its line. Only a comic script has any yet.
Example
>>> from scenet import SceneDocument, parse_scene_document >>> document = parse_scene_document("cast: {a: {reference: alice}}") >>> isinstance(document, SceneDocument), list(document.panels) (True, ['panel'])
See also
parse_scene_document, which returns one.- property direction: Direction#
Which way the document is read: the one direction every panel in it shares.
Every panel takes it from the document and none may write its own, so the first panel’s is everyone’s; a document with no panels reads the default way.
- __init__(panels, layout, notes=())#