The s-graphviz Reference Manual

This is the s-graphviz Reference Manual, version 2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:38:12 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 s-graphviz

An s-expression presentation of GraphViz DOT language

Author

Xu Jingtao <>

License

MIT

Version

2.0

Defsystem Dependency

literate-lisp (system).

Dependency

iterate (system)., at least version "1.5"

Source

s-graphviz.asd.

Child Component

demo (module).


3 Modules

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


3.1 s-graphviz/demo

Source

s-graphviz.asd.

Parent Component

s-graphviz (system).

Child Component

s-graphviz.org (file).


4 Files

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


4.1 Lisp


4.1.1 s-graphviz/s-graphviz.asd

Source

s-graphviz.asd.

Parent Component

s-graphviz (system).

ASDF Systems

s-graphviz.

Packages

s-graphviz.system.


4.1.2 s-graphviz/demo/s-graphviz.org

Source

s-graphviz.asd.

Parent Component

demo (module).

Packages

s-graphviz.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 s-graphviz

Source

s-graphviz.org.

Nickname

graphviz

Use List
  • common-lisp.
  • iterate.
Public Interface
Internals

5.2 s-graphviz.system

Source

s-graphviz.asd.

Use List
  • asdf/interface.
  • common-lisp.

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: format-graph (s-expression &key stream)
Package

s-graphviz.

Source

s-graphviz.org.

Function: render-graph (file-name s-expression &key format dot-exe dot-options dot-output-format-switch)
Package

s-graphviz.

Source

s-graphviz.org.


6.2 Internals


6.2.1 Special variables

Special Variable: *dot-stream*
Package

s-graphviz.

Source

s-graphviz.org.

Special Variable: *indent-spaces*
Package

s-graphviz.

Source

s-graphviz.org.

Special Variable: *indent-tab-size*
Package

s-graphviz.

Source

s-graphviz.org.

Special Variable: *valid-graph-predicates*
Package

s-graphviz.

Source

s-graphviz.org.


6.2.2 Ordinary functions

Function: format-attr-list (attr-list)
Package

s-graphviz.

Source

s-graphviz.org.

Function: format-attr-stmt (stmt)
Package

s-graphviz.

Source

s-graphviz.org.

Function: format-attribute (stmt)
Package

s-graphviz.

Source

s-graphviz.org.

Function: format-edge-stmt (stmt)
Package

s-graphviz.

Source

s-graphviz.org.

Function: format-id (id)
Package

s-graphviz.

Source

s-graphviz.org.

Function: format-node-id (id-port)
Package

s-graphviz.

Source

s-graphviz.org.

Function: format-node-stmt (stmt)
Package

s-graphviz.

Source

s-graphviz.org.

Function: format-port (port)
Package

s-graphviz.

Source

s-graphviz.org.

Function: format-stmt (stmt)
Package

s-graphviz.

Source

s-graphviz.org.

Function: format-stmt-list (stmt-list)
Package

s-graphviz.

Source

s-graphviz.org.

Function: format-subgraph-stmt (stmt)
Package

s-graphviz.

Source

s-graphviz.org.


Appendix A Indexes


A.1 Concepts