PPS-24-papyrus
API
Generated with
PPS-24-papyrus/papyrus/papyrus.DSL/DSL

DSL

papyrus.DSL.DSL
object DSL

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
DSL.type

Members list

Type members

Classlikes

object given_Conversion_String_ImageBuilder extends Conversion[String, ImageBuilder]

Convert String to ImageBuilder

Convert String to ImageBuilder

Attributes

Supertypes
class Conversion[String, ImageBuilder]
trait String => ImageBuilder
class Object
trait Matchable
class Any
Self type
object given_Conversion_String_ItemBuilder extends Conversion[String, ItemBuilder]

Convert String to ItemBuilder

Convert String to ItemBuilder

Attributes

Supertypes
class Conversion[String, ItemBuilder]
trait String => ItemBuilder
class Object
trait Matchable
class Any
Self type
object given_Conversion_String_TextBuilder extends Conversion[String, TextBuilder]

Convert String to TextBuilder

Convert String to TextBuilder

Attributes

Supertypes
class Conversion[String, TextBuilder]
trait String => TextBuilder
class Object
trait Matchable
class Any
Self type
object given_Conversion_String_TitleBuilder extends Conversion[String, TitleBuilder]

Convert String to TitleBuilder

Convert String to TitleBuilder

Attributes

Supertypes
class Conversion[String, TitleBuilder]
trait String => TitleBuilder
class Object
trait Matchable
class Any
Self type

Value members

Concrete methods

def alignTable[T](init: (TableBuilder[T]) ?=> Align)(using tb: TableBuilder[T]): Unit

Set table horizontal alignment ("left", "right", "center")

Set table horizontal alignment ("left", "right", "center")

Attributes

def author(init: MetadataBuilder ?=> String)(using mb: MetadataBuilder): MetadataBuilder

Set author

Set author

Attributes

def backgroundColor(init: MetadataBuilder ?=> ColorString)(using msb: MetadataBuilder): MetadataBuilder

Set background color

Set background color

Attributes

def backgroundColorTable[T](init: (TableBuilder[T]) ?=> ColorString)(using tb: TableBuilder[T]): Unit

Set table background color

Set table background color

Attributes

def bold(init: TextBuilder ?=> TextBuilder)(using ctx: PapyrusBuilder | ContentBuilder | SectionBuilder | SubSectionBuilder): Unit

Insert bold text

Insert bold text

Attributes

def caption[T](init: (TableBuilder[T]) ?=> String)(using tb: TableBuilder[T]): Unit

Set table caption

Set table caption

Attributes

def charset(init: MetadataBuilder ?=> Charset)(using mb: MetadataBuilder): MetadataBuilder

Set charset (e.g. "utf-8")

Set charset (e.g. "utf-8")

Attributes

def content(init: ContentBuilder ?=> Unit)(using pb: PapyrusBuilder): Unit

Define document content

Define document content

Attributes

def extension(init: MetadataBuilder ?=> Extension)(using mb: MetadataBuilder): MetadataBuilder

Set file extension (e.g. "pdf", "html")

Set file extension (e.g. "pdf", "html")

Attributes

def font(init: MetadataBuilder ?=> FontFamily)(using msb: MetadataBuilder): MetadataBuilder

Set font family

Set font family

Attributes

def fontSize(init: MetadataBuilder ?=> FontSize)(using msb: MetadataBuilder): MetadataBuilder

Set font size (pixels)

Set font size (pixels)

Attributes

def image(init: ImageBuilder ?=> ImageBuilder)(using ctx: PapyrusBuilder | ContentBuilder | SectionBuilder | SubSectionBuilder): Unit

Insert image with optional caption, alt, width

Insert image with optional caption, alt, width

Attributes

def italic(init: TextBuilder ?=> TextBuilder)(using ctx: PapyrusBuilder | ContentBuilder | SectionBuilder | SubSectionBuilder): Unit

Insert italic text

Insert italic text

Attributes

def item(init: ItemBuilder ?=> ItemBuilder)(using ctx: ListBuilder): Unit

Define a list item, valid only inside listing

Define a list item, valid only inside listing

Attributes

def language(init: MetadataBuilder ?=> Language)(using mb: MetadataBuilder): MetadataBuilder

Set document language (e.g. "en", "it")

Set document language (e.g. "en", "it")

Attributes

def lineHeight(init: MetadataBuilder ?=> LineHeight)(using msb: MetadataBuilder): MetadataBuilder

Set line height (e.g. 1.5)

Set line height (e.g. 1.5)

Attributes

def listType(init: ListBuilder ?=> ListType)(using ctx: ListBuilder): Unit

Set list type ("ul" or "ol")

Set list type ("ul" or "ol")

Attributes

def listing(init: ListBuilder ?=> Unit)(using ctx: PapyrusBuilder | ContentBuilder | SectionBuilder | SubSectionBuilder | ListBuilder): Unit

Define a list with optional nested lists and sorting

Define a list with optional nested lists and sorting

Attributes

def margin(init: MetadataBuilder ?=> Margin)(using msb: MetadataBuilder): MetadataBuilder

Set margin (pixels)

Set margin (pixels)

Attributes

def marginTable[T](init: (TableBuilder[T]) ?=> Margin)(using tb: TableBuilder[T]): Unit

Set table margin

Set table margin

Attributes

def metadata(init: MetadataBuilder ?=> Unit)(using pb: PapyrusBuilder): Unit

Define document metadata

Define document metadata

Attributes

def metadataTitle(init: MetadataBuilder ?=> String)(using mb: MetadataBuilder): MetadataBuilder

Set metadata title

Set metadata title

Attributes

def nameFile(init: MetadataBuilder ?=> String)(using mb: MetadataBuilder): MetadataBuilder

Set filename

Set filename

Attributes

def ordered(init: ListBuilder ?=> SortingList)(using ctx: ListBuilder): Unit

Set list sorting ("alphabetical", "length", "reverse", "levenshtein")

Set list sorting ("alphabetical", "length", "reverse", "levenshtein")

Attributes

def papyrus(init: PapyrusBuilder ?=> Unit): Unit

Entry point for building a Papyrus document

Entry point for building a Papyrus document

Attributes

def path(init: MetadataBuilder ?=> String)(using mb: MetadataBuilder): MetadataBuilder

Set saving path

Set saving path

Attributes

def provaFunc(): Unit
def reference(init: ListBuilder ?=> String)(using ctx: ListBuilder): Unit

Set reference string for Levenshtein sorting

Set reference string for Levenshtein sorting

Attributes

def renderTable[T](init: (TableBuilder[T]) ?=> T => String)(using tb: TableBuilder[T]): Unit

Set table cell rendering function

Set table cell rendering function

Attributes

def section(init: SectionBuilder ?=> Unit)(using ctx: PapyrusBuilder | ContentBuilder): Unit

Define a section, only valid inside Papyrus or Content

Define a section, only valid inside Papyrus or Content

Attributes

def styleSheet(init: MetadataBuilder ?=> StyleSheet)(using mb: MetadataBuilder): MetadataBuilder

Set CSS style sheet file

Set CSS style sheet file

Attributes

def subsection(init: SubSectionBuilder ?=> Unit)(using cb: SectionBuilder): Unit

Define a subsection, only valid inside Section

Define a subsection, only valid inside Section

Attributes

def table[T](init: (TableBuilder[T]) ?=> Unit)(using ctx: PapyrusBuilder | ContentBuilder | SectionBuilder | SubSectionBuilder): Unit

Define a table

Define a table

Attributes

def text(init: TextBuilder ?=> TextBuilder)(using ctx: PapyrusBuilder | ContentBuilder | SectionBuilder | SubSectionBuilder): Unit

Insert plain text

Insert plain text

Attributes

def textAlign(init: MetadataBuilder ?=> Alignment)(using msb: MetadataBuilder): MetadataBuilder

Set text alignment ("left", "right", "center", "justify")

Set text alignment ("left", "right", "center", "justify")

Attributes

def textAlignTable[T](init: (TableBuilder[T]) ?=> Alignment)(using tb: TableBuilder[T]): Unit

Set table text alignment

Set table text alignment

Attributes

def textColor(init: MetadataBuilder ?=> ColorString)(using msb: MetadataBuilder): MetadataBuilder

Set text color (e.g. "#000000")

Set text color (e.g. "#000000")

Attributes

def title(init: TitleBuilder ?=> TitleBuilder)(using ctx: PapyrusBuilder | ContentBuilder | SectionBuilder | SubSectionBuilder): Unit

Define a title with automatic numbering depending on context

Define a title with automatic numbering depending on context

Attributes

def underline(init: TextBuilder ?=> TextBuilder)(using ctx: PapyrusBuilder | ContentBuilder | SectionBuilder | SubSectionBuilder): Unit

Insert underlined text

Insert underlined text

Attributes

def widthTable[T](init: (TableBuilder[T]) ?=> Width)(using tb: TableBuilder[T]): Unit

Set table width (pixels)

Set table width (pixels)

Attributes

def withList[T](init: (TableBuilder[T]) ?=> List[RowBuilder[T]])(using tb: TableBuilder[T]): Unit

Add list of rows to a table

Add list of rows to a table

Attributes

Givens

Givens

given given_Conversion_List_RowBuilder[T]: given_Conversion_List_RowBuilder[T]

Convert List[T] to RowBuilder[T]

Convert List[T] to RowBuilder[T]

Attributes

given given_Conversion_String_ImageBuilder: given_Conversion_String_ImageBuilder

Convert String to ImageBuilder

Convert String to ImageBuilder

Attributes

given given_Conversion_String_ItemBuilder: given_Conversion_String_ItemBuilder

Convert String to ItemBuilder

Convert String to ItemBuilder

Attributes

given given_Conversion_String_TextBuilder: given_Conversion_String_TextBuilder

Convert String to TextBuilder

Convert String to TextBuilder

Attributes

given given_Conversion_String_TitleBuilder: given_Conversion_String_TitleBuilder

Convert String to TitleBuilder

Convert String to TitleBuilder

Attributes

Generated with