Rhombus Scribble

1	Getting Started
2	Overview
3	Core Scribble
4	Documentation Scribble
5	Styles and Style Properties
6	Scribble Libraries

On this page:

Rhombus Scribble

9.0.0.6

top contents ← prev up next →

Rhombus Scribble🔗ℹ

Rhombus Scribble is a language for writing prose documents, especially documentation for Rhombus libraries. The result of running a Rhombus Scribble program is a document, and a Rhombus Scribble program is meant to be run with raco scribble, which takes the document result and renders it to a format such as HTML or PDF.

1 Getting Started

1.1 A First Example

1.2 Multiple Sections

1.3 Splitting the Document Source

1.4 More Functions

1.4.1 Centering

1.4.2 Margin Notes

1.4.3 Itemizations

1.5 Text Mode vs. Rhombus Mode for Arguments

1.6 More @ Syntax

2.2 Document Structure

2.3 Decoding Parts, Flow Blocks, and Content

2.3.1 Part Decoding Mode

2.3.2 Flow Decoding Mode

2.3.3 Content Decoding Mode

2.4 Document Passes

2.4.1 Cross-Reference Tags

2.4.2 Part Context

3 Core Scribble

3.1 Title and Sections

3.2 Flow Blocks

3.8 Table of Contents

3.9 Main Datatypes

3.10 Additional Datatypes

4 Documentation Scribble

4.1 Typesetting Code

4.2 Documenting Bindings

4.3 Links and Literals

4.4 Evaluation and Examples

4.5 Code Binding-Space Adjusters

4.5.1 Spacers and Indirect Binding

4.6 Creating Documentation Forms

5 Styles and Style Properties

5.1 Element Styles

5.2 Part and Section Styles

5.3 Paragraph Styles

5.4 Table, Column, and Cell Styles

5.5 Itemization Styles

5.6 Nested Flow Styles

5.7 Compound Paragraph Styles

5.8 Style Property Datatypes

6 Scribble Libraries

6.1 Backus-Naur Form (BNF) Grammars

top contents ← prev up next →