Elements

Type Members

1. case class Classifier(content: Seq[Span], options: Options = NoOpt) extends Element with Span with SpanContainer[Classifier] with Product with Serializable

   

   A classifier for a term in a definition list.

2. case class Contents(title: String, depth: Int = Int.MaxValue, local: Boolean = false, options: Options = NoOpt) extends Element with Block with BlockResolver with Product with Serializable

   

   Generates a table of contents element inside a topic.

3. case class CustomizedTextRole(name: String, apply: (String) ⇒ Span, options: Options = NoOpt) extends Element with Definition with Product with Serializable

   

   Temporary element to represent a customized text role that can be applied to spans of interpreted text.

   Temporary element to represent a customized text role that can be applied to spans of interpreted text. The apply function can then be applied to spans of interpreted text referring to the name of this role and passing the text as the argument to the function.

4. case class DoctestBlock(content: String, options: Options = NoOpt) extends Element with Block with TextContainer with Product with Serializable

   

   Represents an interactive Python session.

   Represents an interactive Python session. Somewhat unlikely to be used in the context of this library, but included for the sake of completeness.

5. case class Field(name: Seq[Span], content: Seq[Block], options: Options = NoOpt) extends Element with ListItem with BlockContainer[Field] with Product with Serializable

   

   A single entry in a field list consisting of name and body.

6. case class FieldList(content: Seq[Field], options: Options = NoOpt) extends Element with Block with ListContainer[FieldList] with Product with Serializable

   

   A two-column table-like structure used for bibliographic fields or directive options.

7. case class Include(path: String, options: Options = NoOpt) extends Element with Block with BlockResolver with Product with Serializable

   

   Temporary element representing a file inclusion.

   Temporary element representing a file inclusion. The path is interpreted as relative to the path of the processed document if it is not an absolute path.

8. case class InterpretedText(role: String, content: String, source: String, options: Options = NoOpt) extends Element with Reference with TextContainer with Product with Serializable

   

   Temporary element to represent interpreted text with its associated role name.

   Temporary element to represent interpreted text with its associated role name. In a post-processing step this text will be replaced by the result of calling the corresponding role function.

9. case class OptionArgument(value: String, delimiter: String) extends Element with Product with Serializable

   

   A single option argument.

10. case class OptionList(content: Seq[OptionListItem], options: Options = NoOpt) extends Element with Block with ListContainer[OptionList] with Product with Serializable

    

    A list of command line options and descriptions.

11. case class OptionListItem(programOptions: Seq[ProgramOption], content: Seq[Block], options: Options = NoOpt) extends Element with ListItem with BlockContainer[OptionListItem] with Product with Serializable

    

    A single item in an option list.

    A single item in an option list. The content property serves as the description of the option.

12. case class OverlineAndUnderline(char: Char) extends HeaderDecoration with Product with Serializable

    

    Header decoration consisting of both an overline and an underline.

13. case class ProgramOption(name: String, argument: Option[OptionArgument]) extends Element with Product with Serializable

    

    A single option, including its name and all arguments, but not the description.

14. case class SubstitutionDefinition(name: String, content: Span, options: Options = NoOpt) extends Element with Definition with Product with Serializable

    

    A substitution definition with its span content that will be inserted wherever this substitution is referenced in flow content.

15. case class SubstitutionReference(name: String, options: Options = NoOpt) extends Element with Reference with Product with Serializable

    

    Refers to a substitution definition with the same name.

    Refers to a substitution definition with the same name. This type of element will only temporarily be part of the document tree and replaced by the content of the substitution definition in a rewrite step.

16. case class Underline(char: Char) extends HeaderDecoration with Product with Serializable

    

    Header decoration consisting of an underline only.