The scriba Reference Manual

Table of Contents

The scriba Reference Manual

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

1 Introduction

Scriba

A markup format similar to Scribe. See the documentation.

Similar Projects

• Skribilo
• Scribble

License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.

2 Systems

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

2.1 scriba

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/CommonDoc/scriba

Source Control

(:git "git@github.com:commondoc/scriba.git")

Bug Tracker

https://github.com/CommonDoc/scriba/issues

License

MIT

Description

A markup format similar to Scribe.

Long Description

# Scriba

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

A markup format similar to
[Scribe](http://en.wikipedia.org/wiki/Scribe_%28markup_language%29). See the
[documentation][docs].

[docs]: http://commondoc.github.io/scriba/docs/overview.html

# Similar Projects

* [Skribilo](http://www.nongnu.org/skribilo/)
* [Scribble](http://quickdocs.org/scribble/)

# License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies

• common-doc-plump
• plump-sexp
• esrap

Source

scriba.asd (file)

Component

src (module)

3 Modules

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

3.1 scriba/src

Parent

scriba (system)

Location

src/

Components

• parser.lisp (file)
• plump.lisp (file)
• emitter.lisp (file)
• scriba.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 scriba.asd

Location

scriba.asd

Systems

scriba (system)

4.1.2 scriba/src/parser.lisp

Parent

src (module)

Location

src/parser.lisp

Packages

scriba.parser

Exported Definitions

parse-string (function)

Internal Definitions

not-doublequote (function)

4.1.3 scriba/src/plump.lisp

Dependency

parser.lisp (file)

Parent

src (module)

Location

src/plump.lisp

Packages

scriba.plump

Exported Definitions

parse (function)

Internal Definitions

• *strip* (special variable)
• ast-to-plump-sexp (function)
• transform-blocks (function)

4.1.4 scriba/src/emitter.lisp

Dependency

plump.lisp (file)

Parent

src (module)

Location

src/emitter.lisp

Packages

scriba.emitter

Exported Definitions

• emit (generic function)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit-to-string (function)

Internal Definitions

• emit-children (function)
• emit-hash-table (function)
• emit-list (function)
• trivial-tag (function)
• with-block-tag (macro)
• with-tag (macro)
• with-tag-attrs (macro)
• with-tag-body (macro)
• with-tag-name (macro)

4.1.5 scriba/src/scriba.lisp

Dependency

emitter.lisp (file)

Parent

src (module)

Location

src/scriba.lisp

Packages

scriba

Exported Definitions

scriba (class)

Internal Definitions

• plump-to-text (function)
• string-to-common-doc (function)

5 Packages

Packages are listed by definition order.

5.1 scriba.parser

Parse Scriba text into S-expressions.

Source

parser.lisp (file)

Use List

• esrap
• common-lisp

Exported Definitions

parse-string (function)

Internal Definitions

not-doublequote (function)

5.2 scriba.plump

Parse the Scriba AST into Plump nodes.

Source

plump.lisp (file)

Use List

common-lisp

Exported Definitions

parse (function)

Internal Definitions

• *strip* (special variable)
• ast-to-plump-sexp (function)
• transform-blocks (function)

5.3 scriba.emitter

Dump CommonDoc nodes to Scriba text.

Source

emitter.lisp (file)

Use List

• common-doc
• common-lisp

Exported Definitions

• emit (generic function)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit (method)
• emit-to-string (function)

Internal Definitions

• emit-children (function)
• emit-hash-table (function)
• emit-list (function)
• trivial-tag (function)
• with-block-tag (macro)
• with-tag (macro)
• with-tag-attrs (macro)
• with-tag-body (macro)
• with-tag-name (macro)

5.4 scriba

The main CommonDoc interface.

Source

scriba.lisp (file)

Use List

common-lisp

Exported Definitions

scriba (class)

Internal Definitions

• plump-to-text (function)
• string-to-common-doc (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: emit-to-string NODE-OR-DOC

Package

scriba.emitter

Source

emitter.lisp (file)

Function: parse STRING

Parse a string of Scriba text into a Plump node.

Package

scriba.plump

Source

plump.lisp (file)

Function: parse-string STRING

Parse a string of Scriba text into an S-expression.

Package

scriba.parser

Source

parser.lisp (file)

6.1.2 Generic functions

Generic Function: emit NODE STREAM

Emit a node.

Package

scriba.emitter

Source

emitter.lisp (file)

Methods

Method: emit (DOC document) STREAM

Method: emit (NODE section) STREAM

Method: emit (NODE cell) STREAM

Method: emit (NODE row) STREAM

Method: emit (NODE table) STREAM

Method: emit (NODE figure) STREAM

Method: emit (NODE image) STREAM

Method: emit (NODE definition-list) STREAM

Method: emit (NODE ordered-list) STREAM

Method: emit (NODE unordered-list) STREAM

Method: emit (NODE definition) STREAM

Method: emit (NODE list-item) STREAM

Method: emit (NODE web-link) STREAM

Method: emit (NODE document-link) STREAM

Method: emit (NODE block-quote) STREAM

Method: emit (NODE inline-quote) STREAM

Method: emit (NODE code-block) STREAM

Method: emit (NODE markup) STREAM

Method: emit (NODE paragraph) STREAM

Emit a paragraph.

Method: emit (NODE text-node) STREAM

Method: emit (NODE content-node) STREAM

6.1.3 Classes

Class: scriba ()

The VerTeX format.

Package

scriba

Source

scriba.lisp (file)

Direct superclasses

document-format (class)

Direct methods

• emit-document (method)
• emit-document (method)
• parse-document (method)
• parse-document (method)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *strip*

Package

scriba.plump

Source

plump.lisp (file)

6.2.2 Macros

Macro: with-block-tag (NODE STREAM &key NAME EXTRA-ATTRS) &body BODY

Emit a block tag.

Package

scriba.emitter

Source

emitter.lisp (file)

Macro: with-tag (NODE STREAM &key NAME EXTRA-ATTRS) &body BODY

Emit a whole tag.

Package

scriba.emitter

Source

emitter.lisp (file)

Macro: with-tag-attrs (ATTRS STREAM &key EXTRA) &body BODY

Emit tag attributes.

Package

scriba.emitter

Source

emitter.lisp (file)

Macro: with-tag-body (STREAM) &body BODY

Emit a tag body.

Package

scriba.emitter

Source

emitter.lisp (file)

Macro: with-tag-name (NAME STREAM) &body BODY

Emit a tag name.

Package

scriba.emitter

Source

emitter.lisp (file)

6.2.3 Functions

Function: ast-to-plump-sexp AST

Take an AST S-exp and turn it into a format plump-sexp likes.

Package

scriba.plump

Source

plump.lisp (file)

Function: emit-children NODE STREAM

Emit the children of a node.

Package

scriba.emitter

Source

emitter.lisp (file)

Function: emit-hash-table HASH-TABLE STREAM

Emit a hash table.

Package

scriba.emitter

Source

emitter.lisp (file)

Function: emit-list LIST STREAM

Package

scriba.emitter

Source

emitter.lisp (file)

Function: not-doublequote CHAR

Package

scriba.parser

Source

parser.lisp (file)

Function: plump-to-text PLUMP-NODE STREAM

Package

scriba

Source

scriba.lisp (file)

Function: string-to-common-doc STRING

Package

scriba

Source

scriba.lisp (file)

Function: transform-blocks AST

Take pairs of @begin/@end blocks and turn the into single blocks.

Package

scriba.plump

Source

plump.lisp (file)

Function: trivial-tag NODE STREAM

Package

scriba.emitter

Source

emitter.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types