TODO.md

{ "title": "OSF, A Go package support Open Screenplay Format" }

Action Items

Bugs

Next

• Update code to Go 1.22
• Remove dependency on github.com/caltechlibrary/cli
• implement a txt2osf demonstration
• review Text element, make sure I am mapping embedded newlines and formatting correctly
• validate ToXML() after FromFountain() can be read by FadeIn

Someday, Maybe

• write and osf2html using scrippets approach
• add support for Ron Severdia's Open Screenplay Format 2.1 spec
  • rename divergent structs' xml defs with 20 and 21 suffix
  • make sure they are all 20/21 structs are treated as tag ",omitempty"
  • duplicate String methods as needed
  • Parse, ParseFile should work without sniffing using a single struct tree for 1.2, 2.0 or 2.1

Completed

• String (Fountain style plain text) needs to be formatted correctly...
• Write osf.go, osf_test.go based on Open Screenplay Format 2.0 and in the mode of fdx package
• Write osf2txt
• Write fadein2osf
• Write fadein2txt
• self closing tags should be self closing
• Support parsing .fadein files (i.e. unzip the Fade In file, then parse document.xml)
• Add ParseFile() to osf.go, if file extension is ".fadein" then it should handle the unzipping and and parsing of document.xml as OSF

Reference links

• Fountain
• Open Screenplay Format 2.0 (the one targeted by osf.go)
• Open Screenplay Format 2.1
• Fade In
• Open Screenplay Format by Kent Tessman
• screenplay-parser - a PHP repo with a really nice README.md discussing format and conversion issues and challenges