lex

Documentation

Overview

The lex format is basically a parse tree for screenplays, which enables quick debugging.

Index

• func Write(s Document, out io.Writer)
• type Document
  • func Parse(file io.Reader) (out Document)
• type Line

Functions

func Write

func Write(s Document, out io.Writer)

Types

type Document

type Document []Line

func Parse

func Parse(file io.Reader) (out Document)

Parse walks through the lex file, which contains the element of a screenplay, optionally followed by a colon and space and the actual contents of that element. Special elements exist: newpage, titlepage and metasection. These elements trigger pdf creation instructions.

type Line

type Line struct {
	Type     string
	Contents string
}