Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the scriba Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:58:32 2020 GMT+0.
• Introduction | What scriba is all about | |
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
A markup format similar to Scribe. See the documentation.
Copyright (c) 2015 Fernando Borretti
Licensed under the MIT License.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The scriba system |
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(:git "git@github.com:commondoc/scriba.git")
MIT
A markup format similar to Scribe.
# 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
scriba.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The scriba/src module |
scriba (system)
src/
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The scriba.asd file | ||
• The scriba/src/parser.lisp file | ||
• The scriba/src/plump.lisp file | ||
• The scriba/src/emitter.lisp file | ||
• The scriba/src/scriba.lisp file |
Next: The scriba/src/parser․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
scriba.asd
scriba (system)
Next: The scriba/src/plump․lisp file, Previous: The scriba․asd file, Up: Lisp files [Contents][Index]
src (module)
src/parser.lisp
parse-string (function)
not-doublequote (function)
Next: The scriba/src/emitter․lisp file, Previous: The scriba/src/parser․lisp file, Up: Lisp files [Contents][Index]
parser.lisp (file)
src (module)
src/plump.lisp
parse (function)
Next: The scriba/src/scriba․lisp file, Previous: The scriba/src/plump․lisp file, Up: Lisp files [Contents][Index]
plump.lisp (file)
src (module)
src/emitter.lisp
Previous: The scriba/src/emitter․lisp file, Up: Lisp files [Contents][Index]
emitter.lisp (file)
src (module)
src/scriba.lisp
scriba (class)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The scriba.parser package | ||
• The scriba.plump package | ||
• The scriba.emitter package | ||
• The scriba package |
Next: The scriba․plump package, Previous: Packages, Up: Packages [Contents][Index]
Parse Scriba text into S-expressions.
parser.lisp (file)
parse-string (function)
not-doublequote (function)
Next: The scriba․emitter package, Previous: The scriba․parser package, Up: Packages [Contents][Index]
Parse the Scriba AST into Plump nodes.
plump.lisp (file)
common-lisp
parse (function)
Next: The scriba package, Previous: The scriba․plump package, Up: Packages [Contents][Index]
Dump CommonDoc nodes to Scriba text.
emitter.lisp (file)
Previous: The scriba․emitter package, Up: Packages [Contents][Index]
The main CommonDoc interface.
scriba.lisp (file)
common-lisp
scriba (class)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported functions | ||
• Exported generic functions | ||
• Exported classes |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
emitter.lisp (file)
Parse a string of Scriba text into a Plump node.
plump.lisp (file)
Parse a string of Scriba text into an S-expression.
parser.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Emit a node.
emitter.lisp (file)
Emit a paragraph.
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
The VerTeX format.
scriba.lisp (file)
document-format (class)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal macros | ||
• Internal functions |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
plump.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Emit a block tag.
emitter.lisp (file)
Emit a whole tag.
emitter.lisp (file)
Emit tag attributes.
emitter.lisp (file)
Emit a tag body.
emitter.lisp (file)
Emit a tag name.
emitter.lisp (file)
Previous: Internal macros, Up: Internal definitions [Contents][Index]
Take an AST S-exp and turn it into a format plump-sexp likes.
plump.lisp (file)
Emit the children of a node.
emitter.lisp (file)
Emit a hash table.
emitter.lisp (file)
emitter.lisp (file)
parser.lisp (file)
scriba.lisp (file)
scriba.lisp (file)
Take pairs of @begin/@end blocks and turn the into single blocks.
plump.lisp (file)
emitter.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L M S |
---|
Jump to: | F L M S |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | A E F G M N P S T W |
---|
Jump to: | A E F G M N P S T W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
S |
---|
Index Entry | Section | ||
---|---|---|---|
| |||
* | |||
*strip* : | Internal special variables | ||
| |||
S | |||
Special Variable, *strip* : | Internal special variables | ||
|
Jump to: | *
S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C P S |
---|
Jump to: | C P S |
---|