rules

Documentation

Overview

The rules package of Lexington provides the tools around configuration of how a screenplay should look. The default should work but can be adjusted for a personal touch..

Index

• Variables
• func Dump(file string) error
• type Format
• type Set
  • func (s Set) Get(action string) (f Format)
• type TOMLConf
  • func DefaultConf() TOMLConf
  • func GetConf(file string) TOMLConf
  • func ReadFile(file string) (TOMLConf, error)

Variables

var Default = Set{
	"action": {
		Left:  1.5,
		Right: 1,
	},
	"speaker": {
		Left:  3.7,
		Right: 1.5,
	},
	"dialog": {
		Left:  2.5,
		Right: 1.5,
	},
	"scene": {
		Left:  1.5,
		Right: 1,
		Style: "b",
	},
	"paren": {
		Left:  3.1,
		Right: 1.5,
	},
	"trans": {
		Left:  1.5,
		Right: 1,
		Align: "R",
	},
	"note": {
		Left:  1.5,
		Right: 1,
	},
	"allcaps": {
		Left:  1.5,
		Right: 1,
	},
	"empty": {
		Left:  1.5,
		Right: 1,
	},
	"title": {
		Left:  1.5,
		Right: 1,
		Align: "C",
	},
	"meta": {
		Left:  1.5,
		Right: 1,
	},
	"center": {
		Left:  1.5,
		Right: 1,
		Align: "C",
	},
	"lyrics": {
		Left:  2,
		Right: 2,
		Style: "i",
		Font:  "Helvetica",
	},
}

Functions

func Dump

func Dump(file string) error

Types

type Format

type Format struct {
	Right   float64
	Left    float64
	Font    string
	Style   string
	Size    float64
	Hide    bool
	Align   string
	Prefix  string
	Postfix string
}

type Set

type Set map[string]Format

func (Set) Get

func (s Set) Get(action string) (f Format)

type TOMLConf

type TOMLConf struct {
	Elements map[string]Set
	Scenes   map[string][]string
	// contains filtered or unexported fields
}

func DefaultConf

func DefaultConf() TOMLConf

func GetConf

func GetConf(file string) TOMLConf

func ReadFile

func ReadFile(file string) (TOMLConf, error)