►Scribble Document Language
▼3 Core Scribble
On this page:
title
section
subsection
subsubsection
subsubsub_  section
include_  section
default_  document_  version
0.45+9.0.0.11
Rhombus
  top  contents    up   

3.1 Title and Sections🔗ℹ

function

fun title(

  ~tag: tag :: maybe(TagSuffix) = #false,

  ~tag_prefix: tag_prefix :: maybe(TagPrefix) = #false,

  ~style: part_style :: maybe(StyleLike) = #false,

  ~version: vers :: maybe(String) = default_document_version(),

  ~date: date :: maybe(String) = #false,

  ~category: category :: DocCategory = #'library,

  ~foreign_category: foreign_category :: DocCategory = category,

  ~index_extras: index_extras :: ExtrasMap = {},

  pre_content :: PreContent

) :: PartDecl

Declares a title for the document by producing a PartDecl that is recognized by the decoding process in part mode for a rhombus/scribble module body.

In the main module of a document, this title is the overall title of the document. In a section included via include_section, it is the name of the section.

See part_style for information about styles for parts. The vers and date argumentsa sre converted into style properties for the part.

The category, foreign_category, and index_extras arguments are merged into the tag_prefix argument. If tag_prefix is not a map that includes #'#{default-language-family} already, then that key is added with the value PairList["Rhombus"]. Similarly, category and foreign_category arguments are merged into index_extras if it does not already a have a #'#{doc-properties} key.

function

fun section(

  ~tag: tag :: maybe(TagSuffix) = #false,

  ~tag_prefix: tag_prefix :: maybe(TagPrefix) = #false,

  ~style: part_style :: maybe(StyleLike) = #false,

  ~index_extras: index_extras :: ExtrasMap = {},

  pre_content :: PreContent

) :: PartDecl

Declares a section at a level nested below title, recognized by the decoding process in part mode.

See part_style for information about styles for parts.

function

fun subsection(

  ~tag: tag :: maybe(TagSuffix) = #false,

  ~tag_prefix: tag_prefix :: maybe(TagPrefix) = #false,

  ~style: part_style :: maybe(StyleLike) = #false,

  ~index_extras: index_extras :: ExtrasMap = {},

  pre_content :: PreContent

) :: PartDecl

 

function

fun subsubsection(

  ~tag: tag :: maybe(TagSuffix) = #false,

  ~tag_prefix: tag_prefix :: maybe(TagPrefix) = #false,

  ~style: part_style :: maybe(StyleLike) = #false,

  ~index_extras: index_extras :: ExtrasMap = {},

  pre_content :: PreContent

) :: PartDecl

 

function

fun subsubsub_section(

  ~tag: tag :: maybe(TagSuffix) = #false,

  pre_content :: PreContent

) :: Paragraph

Like section, but declares sections as further nesting levels. At the subsubsub_section level, the result is simply a paragraph that renders as an unnumbered section header.

definition

include_section(module_path)

Makes the document at module_path a section of the enclosing document, where the module_path section hierarchy is effectively shifted to more nested my one layer. That is, title within module_path corresponds to a section written in the document where include_section is used, section corresponds to subsection, and so on.

function

fun default_document_version() :: String

Returns system.version() +& "+" +& system.racket_version().

  top  contents    up