The scriba Reference Manual

Table of Contents

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

The scriba Reference Manual

This is the scriba Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 15:42:27 2018 GMT+0.


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

1 Introduction

Scriba

Build Status

A markup format similar to Scribe. See the documentation.

Similar Projects

License

Copyright (c) 2015 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 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

[![Build Status](https://travis-ci.org/CommonDoc/scriba.svg?branch=master)](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
Source

scriba.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 scriba/src

Parent

scriba (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 scriba.asd

Location

scriba.asd

Systems

scriba (system)


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

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)


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

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

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

4.1.4 scriba/src/emitter.lisp

Dependency

plump.lisp (file)

Parent

src (module)

Location

src/emitter.lisp

Packages

scriba.emitter

Exported Definitions
Internal Definitions

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

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

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

5 Packages

Packages are listed by definition order.


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

5.1 scriba.parser

Parse Scriba text into S-expressions.

Source

parser.lisp (file)

Use List
Exported Definitions

parse-string (function)

Internal Definitions

not-doublequote (function)


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

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

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

5.3 scriba.emitter

Dump CommonDoc nodes to Scriba text.

Source

emitter.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5.4 scriba

The main CommonDoc interface.

Source

scriba.lisp (file)

Use List

common-lisp

Exported Definitions

scriba (class)

Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

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)


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

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

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

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)

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

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *strip*
Package

scriba.plump

Source

plump.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


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

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   S  
Index Entry  Section

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

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

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

S
scriba.asd: The scriba<dot>asd file
scriba/src: The scriba/src module
scriba/src/emitter.lisp: The scriba/src/emitter<dot>lisp file
scriba/src/parser.lisp: The scriba/src/parser<dot>lisp file
scriba/src/plump.lisp: The scriba/src/plump<dot>lisp file
scriba/src/scriba.lisp: The scriba/src/scriba<dot>lisp file

Jump to:   F   L   M   S  

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

A.2 Functions

Jump to:   A   E   F   G   M   N   P   S   T   W  
Index Entry  Section

A
ast-to-plump-sexp: Internal functions

E
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit: Exported generic functions
emit-children: Internal functions
emit-hash-table: Internal functions
emit-list: Internal functions
emit-to-string: Exported functions

F
Function, ast-to-plump-sexp: Internal functions
Function, emit-children: Internal functions
Function, emit-hash-table: Internal functions
Function, emit-list: Internal functions
Function, emit-to-string: Exported functions
Function, not-doublequote: Internal functions
Function, parse: Exported functions
Function, parse-string: Exported functions
Function, plump-to-text: Internal functions
Function, string-to-common-doc: Internal functions
Function, transform-blocks: Internal functions
Function, trivial-tag: Internal functions

G
Generic Function, emit: Exported generic functions

M
Macro, with-block-tag: Internal macros
Macro, with-tag: Internal macros
Macro, with-tag-attrs: Internal macros
Macro, with-tag-body: Internal macros
Macro, with-tag-name: Internal macros
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions
Method, emit: Exported generic functions

N
not-doublequote: Internal functions

P
parse: Exported functions
parse-string: Exported functions
plump-to-text: Internal functions

S
string-to-common-doc: Internal functions

T
transform-blocks: Internal functions
trivial-tag: Internal functions

W
with-block-tag: Internal macros
with-tag: Internal macros
with-tag-attrs: Internal macros
with-tag-body: Internal macros
with-tag-name: Internal macros

Jump to:   A   E   F   G   M   N   P   S   T   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*strip*: Internal special variables

S
Special Variable, *strip*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
Class, scriba: Exported classes

P
Package, scriba: The scriba package
Package, scriba.emitter: The scriba<dot>emitter package
Package, scriba.parser: The scriba<dot>parser package
Package, scriba.plump: The scriba<dot>plump package

S
scriba: The scriba system
scriba: The scriba package
scriba: Exported classes
scriba.emitter: The scriba<dot>emitter package
scriba.parser: The scriba<dot>parser package
scriba.plump: The scriba<dot>plump package
System, scriba: The scriba system

Jump to:   C   P   S