This is the scriba Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:39:40 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
scribaA markup format similar to Scribe.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(GIT git@github.com:CommonDoc/scriba.git)
MIT
# 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.
0.1
common-doc-plump (system).
plump-sexp (system).
esrap (system).
src (module).
Modules are listed depth-first from the system components tree.
scriba/srcscriba (system).
parser.lisp (file).
plump.lisp (file).
emitter.lisp (file).
scriba.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
scriba/scriba.asdscriba/src/parser.lispscriba/src/plump.lispscriba/src/emitter.lispscriba/src/scriba.lispscriba/src/parser.lispsrc (module).
parse-string (function).
scriba/src/plump.lispparser.lisp (file).
src (module).
parse (function).
*strip* (special variable).
ast-to-plump-sexp (function).
transform-blocks (function).
transform-multiple-blocks (function).
scriba/src/emitter.lispplump.lisp (file).
src (module).
emit (generic function).
emit-to-string (function).
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).
scriba/src/scriba.lispemitter.lisp (file).
src (module).
emit-document (method).
emit-document (method).
parse-document (method).
parse-document (method).
scriba (class).
plump-to-text (function).
string-to-common-doc (function).
Packages are listed by definition order.
scriba.plumpParse the Scriba AST into Plump nodes.
common-lisp.
parse (function).
*strip* (special variable).
ast-to-plump-sexp (function).
transform-blocks (function).
transform-multiple-blocks (function).
scribaThe main CommonDoc interface.
common-lisp.
scriba (class).
plump-to-text (function).
string-to-common-doc (function).
scriba.emitterDump CommonDoc nodes to Scriba text.
common-doc.
common-lisp.
emit (generic function).
emit-to-string (function).
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).
scriba.parserParse Scriba text into S-expressions.
common-lisp.
esrap.
parse-string (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Parse a string of Scriba text into a Plump node.
Parse a string of Scriba text into an S-expression.
Emit a node.
document) stream) ¶section) stream) ¶cell) stream) ¶row) stream) ¶table) stream) ¶figure) stream) ¶image) stream) ¶definition-list) stream) ¶ordered-list) stream) ¶unordered-list) stream) ¶definition) stream) ¶list-item) stream) ¶web-link) stream) ¶document-link) stream) ¶block-quote) stream) ¶inline-quote) stream) ¶code-block) stream) ¶markup) stream) ¶paragraph) stream) ¶Emit a paragraph.
text-node) stream) ¶content-node) stream) ¶scriba) (node document-node) stream) ¶common-doc.format.
scriba) (pathname pathname)) ¶Return a VerTeX document parsed from a file.
common-doc.format.
scriba) (string string)) ¶Return a VerTeX document parsed from a string.
common-doc.format.
The VerTeX format.
document-format.
Emit a block tag.
Emit a whole tag.
Emit tag attributes.
Emit a tag body.
Emit a tag name.
Take an AST S-exp and turn it into a format plump-sexp likes.
Emit the children of a node.
Emit a hash table.
Take pairs of @begin/@end blocks and turn the into single blocks.
| Jump to: | A E F G M P S T W |
|---|
| Jump to: | A E F G M P S T W |
|---|
| Jump to: | *
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| * | |||
*strip*: | Private special variables | ||
| | |||
| S | |||
Special Variable, *strip*: | Private special variables | ||
| | |||
| Jump to: | *
S |
|---|
| Jump to: | C E F M P S |
|---|
| Jump to: | C E F M P S |
|---|