The parenml Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The parenml Reference Manual

This is the parenml Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:23:40 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

ParenML

Build Status

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.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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

[![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
Source

parenml.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 parenml/src

Parent

parenml (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 parenml.asd

Location

parenml.asd

Systems

parenml (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 parenml/src/parser.lisp

Parent

src (module)

Location

src/parser.lisp

Packages

parenml.parser

Exported Definitions

parse-string (function)


Previous: , Up: Lisp files   [Contents][Index]

4.1.3 parenml/src/emitter.lisp

Dependency

parser.lisp (file)

Parent

src (module)

Location

src/emitter.lisp

Packages

parenml.emitter


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 parenml.parser

Parse ParenML input into an S-expression.

Source

parser.lisp (file)

Use List
Exported Definitions

parse-string (function)


Previous: , Up: Packages   [Contents][Index]

5.2 parenml.emitter

Create an S-expression from a CommonDoc document.

Source

emitter.lisp (file)

Use List

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: parse-string STRING

Parse a ParenML string into an S-expression.

Package

parenml.parser

Source

parser.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   P  
Index Entry  Section

F
File, Lisp, parenml.asd: The parenml<dot>asd file
File, Lisp, parenml/src/emitter.lisp: The parenml/src/emitter<dot>lisp file
File, Lisp, parenml/src/parser.lisp: The parenml/src/parser<dot>lisp file

L
Lisp File, parenml.asd: The parenml<dot>asd file
Lisp File, parenml/src/emitter.lisp: The parenml/src/emitter<dot>lisp file
Lisp File, parenml/src/parser.lisp: The parenml/src/parser<dot>lisp file

M
Module, parenml/src: The parenml/src module

P
parenml.asd: The parenml<dot>asd file
parenml/src: The parenml/src module
parenml/src/emitter.lisp: The parenml/src/emitter<dot>lisp file
parenml/src/parser.lisp: The parenml/src/parser<dot>lisp file

Jump to:   F   L   M   P  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   F   P  
Index Entry  Section

F
Function, parse-string: Exported functions

P
parse-string: Exported functions

Jump to:   F   P  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, parenml.emitter: The parenml<dot>emitter package
Package, parenml.parser: The parenml<dot>parser package
parenml: The parenml system
parenml.emitter: The parenml<dot>emitter package
parenml.parser: The parenml<dot>parser package

S
System, parenml: The parenml system

Jump to:   P   S