The parenml Reference Manual

This is the parenml Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:28:04 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 parenml

S-expression markup language.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

Home Page

https://github.com/CommonDoc/parenml

License

MIT

Long Description

# ParenML

[![Build Status](https://travis-ci.org/CommonDoc/parenml.svg?branch=master)](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 (system).
  • common-doc-plump (system).
  • esrap (system).
Source

parenml.asd.

Child Component

src (module).


3 Modules

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


3.1 parenml/src

Source

parenml.asd.

Parent Component

parenml (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 parenml/parenml.asd

Source

parenml.asd.

Parent Component

parenml (system).

ASDF Systems

parenml.


4.1.2 parenml/src/parser.lisp

Source

parenml.asd.

Parent Component

src (module).

Packages

parenml.parser.

Public Interface

parse-string (function).


4.1.3 parenml/src/emitter.lisp

Dependency

parser.lisp (file).

Source

parenml.asd.

Parent Component

src (module).

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.

Use List
  • common-lisp.
  • esrap.
Public Interface

parse-string (function).


5.2 parenml.emitter

Create an S-expression from a CommonDoc document.

Source

emitter.lisp.

Use List
  • common-doc.
  • common-lisp.

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: parse-string (string)

Parse a ParenML string into an S-expression.

Package

parenml.parser.

Source

parser.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   F   P  
Index Entry  Section

F
Function, parse-string: Public ordinary functions

P
parse-string: Public ordinary functions


A.3 Variables