Disseminate

Document Processing

• Features: Basic
• Features: Advanced
• Quickstart

Installation

• MacOS (Homebrew)
• MacOS (Pip)
• Linux (Pip)

Markup Language

• Header
• Tags
  • Preamble
  • Headings
  • Text Formatting
  • References
  • Images
  • Equations
  • Code Fragments
  • Asymptote Diagrams
  • Figures
  • Captions
  • Table of Contents
  • Navigation
  • Feature Box
  • Tables
  • Data
• Macros

Projects

• Documents
• Templates

Interfaces

• Command-line

Development

• API Documentation
• Release Notes

• Index

Headings

Headings are used to group and demarcate parts of a document or project.

@part{...}

A part heading

aliases

@h1

attributes

id=x

The heading’s marker label

nolabel

If specified, a label is not created with this heading for TOC entries and links

short=x

The short title, which can be used in the TOC

fmt=x

The format for a tag’s label

examples

@chapter{Object Decorators}
@chapter[fmt="Chapter {label.tree_number}. '{label.short}'"]{Introduction}

@chapter{...}

A chapter heading

aliases

@h2

attributes

id=x

The heading’s marker label

nolabel

If specified, a label is not created with this heading for TOC entries and links

short=x

The short title, which can be used in the TOC

fmt=x

The format for a tag’s label

examples

@chapter{Object Decorators}
@chapter[fmt="Chapter {label.tree_number}. '{label.short}'"]{Introduction}

@section{...}

A section heading

aliases

@h3

attributes

id=x

The heading’s marker label

nolabel

If specified, a label is not created with this heading for TOC entries and links

short=x

The short title, which can be used in the TOC

fmt=x

The format for a tag’s label

examples

@section{Introduction}
@section[id="chapter1-introduction"]{Introduction}
@h2{Introduction}

@subsection{...}

A subsection heading

aliases

@h4

attributes

id=x

The heading’s marker label

nolabel

If specified, a label is not created with this heading for TOC entries and links

short=x

The short title, which can be used in the TOC

fmt=x

The format for a tag’s label

examples

@subsection{Methods}
@h3{Methods}

@subsubsection{...}

A subsubsection heading

aliases

@h5

attributes

id=x

The heading’s marker label

nolabel

If specified, a label is not created with this heading for TOC entries and links

short=x

The short title, which can be used in the TOC

fmt=x

The format for a tag’s label

examples

@subsubsection{Titration Procedure}
@h4{Titration Procedure}

@paragraph{...}

A paragraph heading

aliases

@h6

attributes

id=x

The paragraph’s marker label

html

In html, this tag will be rendered as a <span class="paragraph-heading"> instead of an <h5> element.

note

This tag is distinct from the @p, which is used to identify a paragraph element.

examples

@paragraph{Group A}. The first group ...
@h5{Group A}. The first group ...

Identifiers and Labels

By default, all headings have a unique identifier and label. Labels allow other portions of a project to reference the heading.

If a heading without a label is desired, the nolabel attribute can be used. Headings without a label cannot be linked and referenced in the project, and the heading will not be included in Tables of Content.

Otherwise, it is recommended to use an identifier. An identifier is specified with the id=x attribute, and it should be unique for the project. If an identifier is not specified, an identifier will be generated.

Empty Contents

If the contents are empty, the tag will search the header entries to see if an entry with the same name is present. For example, if the header has an entry chapter: My First Chapter, then inserting the @chapter tag in the body will use the ‘My First Chapter’ text as its contents.