Reference

36 classes, interfaces, traits and enums, read from src/.

• Archive: A presentation, which is a ZIP archive that is read in memory.
• Cli: The command line: reads a presentation and writes its voice-overs.
• CliArguments: The arguments of the command line, read and checked.
• CliArgumentsReader: Reads the arguments of the command line and checks that they go together.
• CliInput: The words of the command line, sorted into the options that have a value, the flags and the files.
• Duplicates: What to do when a speaker uses the same reference twice.
• Emphasis: How the styles of the notes are written in a plain text, where there is no bold or italic.
• EmphasisWriter: Writes the text of a run with its styles, for a plain text: the spaces around the text stay outside the marks.
• ExtractionException: Thrown when a presentation can be read but its notes cannot be extracted.
• Extracts: Extracts the voice-over texts written in the notes of a presentation.
• Format: The content of a voice-over that is written in a result.
• HtmlRenderer: Writes paragraphs as HTML: the styles, the links, the line breaks and the lists.
• Inline: A run of text with its style, or a line break.
• Layout: Where the reference of a voice-over is written in a script.
• Links: Checks the URL of a link.
• ListItem: The place of a paragraph in a list.
• ListType: The type of a list item: a bullet or a number.
• Markers: The signs that delimit the voice-overs: the one that opens them, and the one that closes them.
• MissingDependencyException: A package that is optional is needed and is not installed.
• Notes: The notes of a slide: the page, and the external links that it refers to.
• NotesReader: Reads the notes of a presentation in the order of its slides, without extracting anything on the disk.
• OpenLists: The lists that are open while a list is written: it gives the tags to write for each new item.
• Options: The settings of an extraction. The object is immutable: use the named arguments to change a setting.
• PackagePath: The paths inside the archive of a presentation.
• Paragraph: A paragraph of a note: its runs of text, and its place in a list if it has one.
• ParagraphReader: Reads a paragraph of a note: the style of each run, the line breaks, the links and the list item.
• Relationships: The relationships of a file of the archive: the files and the links that it refers to.
• Script: The voice-overs of one speaker, written as a document that can be sent to a voice actor: as text, as HTML or as a PDF. The HTML and the PDF keep the formatting of the notes.
• ScriptFiles: Writes the script of each speaker in a file of a directory, named after the speaker.
• ScriptOptions: The settings of a script. The object is immutable: use the named arguments to change a setting.
• ScriptUse: Checks that the options of a script, --speaker, --split and the formats go together.
• TextRenderer: Writes paragraphs as plain text: one line per paragraph, "-" and "1." for the lists, and the URL of a link after its text.
• VoiceOver: A voice-over: who says it, its reference, the slide it comes from and its content.
• VoiceOverIndex: The voice-overs that were found, by speaker and by reference.
• VoiceOverReader: Reads the voice-overs of the paragraphs of one page of notes: a voice-over starts at a line that begins with the sign and has a speaker, and ends at the next line that begins with the sign.
• VoiceOvers: The voice-overs of a presentation, sorted by speaker, then in the order of the slides.