The parenml Reference Manual

Table of Contents

The parenml Reference Manual

This is the parenml Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:22:20 2018 GMT+0.

1 Introduction

ParenML

An S-expression markup language.

Overview

Usage

Examples

(:section (Counting)
  (:deflist
    (:item (Sum Rule)
      (If two tasks can be performed in $m$ and $n$ ways, respectively, then
       there are $m + n$ ways of doing (:b either).))
    (:item (Product Rule)
      (If two sequential tasks can be performed in $m$ and $n$ ways,
       respectively, there are $m * n$ ways of performing the sequence.))))

License

Copyright (c) 2014 Fernando Borretti

Licensed under the MIT License.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 parenml

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/CommonDoc/parenml

License

MIT

Description

S-expression markup language.

Long Description

# ParenML

[](https://travis-ci.org/CommonDoc/parenml)

An S-expression markup language.

# Overview

# Usage

# Examples

“‘lisp
(:section (Counting)
(:deflist
(:item (Sum Rule)
(If two tasks can be performed in $m$ and $n$ ways, respectively, then
there are $m + n$ ways of doing (:b either).))
(:item (Product Rule)
(If two sequential tasks can be performed in $m$ and $n$ ways,
respectively, there are $m * n$ ways of performing the sequence.))))
“‘

# License

Copyright (c) 2014 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies

• plump
• common-doc-plump
• esrap

Source

parenml.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 parenml/src

Parent

parenml (system)

Location

src/

Components

• parser.lisp (file)
• emitter.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 parenml.asd

Location

parenml.asd

Systems

parenml (system)

4.1.2 parenml/src/parser.lisp

Parent

src (module)

Location

src/parser.lisp

Packages

parenml.parser

Exported Definitions

parse-string (function)

4.1.3 parenml/src/emitter.lisp

Dependency

parser.lisp (file)

Parent

src (module)

Location

src/emitter.lisp

Packages

parenml.emitter

5 Packages

Packages are listed by definition order.

5.1 parenml.parser

Parse ParenML input into an S-expression.

Source

parser.lisp (file)

Use List

• esrap
• common-lisp

Exported Definitions

parse-string (function)

5.2 parenml.emitter

Create an S-expression from a CommonDoc document.

Source

emitter.lisp (file)

Use List

• common-doc
• common-lisp

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Functions

Function: parse-string STRING

Parse a ParenML string into an S-expression.

Package

parenml.parser

Source

parser.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types