Commit da464d81 authored by Alexandre Duret-Lutz's avatar Alexandre Duret-Lutz

org: document explicit vs. on-the-fly

* doc/org/tut50.org: New file.
* doc/org/tut.org: Add it.
* NEWS: Mention it.
* doc/Makefile.am: Add tut50.org, and download plantuml.jar when needed.
* doc/org/.dir-locals.el.in, doc/org/init.el.in: Activate plantum.
* HACKING: Mention the Java dependency.
parent d7d6b409
...@@ -37,6 +37,7 @@ since the generated files they produce are distributed.) ...@@ -37,6 +37,7 @@ since the generated files they produce are distributed.)
ImageMagick ImageMagick
Python >= 3.3, IPython >= 2.3 Python >= 3.3, IPython >= 2.3
GraphViz GraphViz
Java >= 1.7 (needed to run PlantUML while generating the doc)
The following additional tools are used if they are present, or The following additional tools are used if they are present, or
only for certain operations (like releases): only for certain operations (like releases):
......
...@@ -171,6 +171,8 @@ New in spot 2.0.3a (not yet released) ...@@ -171,6 +171,8 @@ New in spot 2.0.3a (not yet released)
* A new example page shows how to test the equivalence of * A new example page shows how to test the equivalence of
two LTL/PSL formulas. https://spot.lrde.epita.fr/tut04.html two LTL/PSL formulas. https://spot.lrde.epita.fr/tut04.html
* A new page discusses explicit vs. on-the-fly interfaces for
exploring automata in C++. https://spot.lrde.epita.fr/tut50.html
* The concepts.html page now lists all named properties * The concepts.html page now lists all named properties
used by automata. used by automata.
......
...@@ -58,9 +58,12 @@ dist_pkgdata_DATA = $(srcdir)/spot.tag ...@@ -58,9 +58,12 @@ dist_pkgdata_DATA = $(srcdir)/spot.tag
org: org:
cd $(top_builddir) && $(MAKE) doc/org/init.el cd $(top_builddir) && $(MAKE) doc/org/init.el
rm -rf $(srcdir)/userdoc rm -rf $(srcdir)/userdoc
$(MAKE) org-man $(MAKE) org-man org/plantuml.jar
$(EMACS) --batch -Q -l org/init.el $(EMACS) --batch -Q -l org/init.el
org/plantuml.jar:
wget http://downloads.sourceforge.net/project/plantuml/plantuml.jar -O org/plantuml.jar
org-man: org-man:
mkdir -p $(srcdir)/userdoc/man mkdir -p $(srcdir)/userdoc/man
$(top_srcdir)/tools/man2html.pl $(top_srcdir)/bin/man $(srcdir)/userdoc/man $(top_srcdir)/tools/man2html.pl $(top_srcdir)/bin/man $(srcdir)/userdoc/man
...@@ -103,6 +106,7 @@ ORG_FILES = \ ...@@ -103,6 +106,7 @@ ORG_FILES = \
org/tut21.org \ org/tut21.org \
org/tut22.org \ org/tut22.org \
org/tut30.org \ org/tut30.org \
org/tut50.org \
org/upgrade2.org \ org/upgrade2.org \
org/satmin.org \ org/satmin.org \
org/satmin.tex \ org/satmin.tex \
...@@ -137,3 +141,5 @@ dist-hook: optipng ...@@ -137,3 +141,5 @@ dist-hook: optipng
.PHONY: optipng .PHONY: optipng
optipng: optipng:
-(optipng -v >/dev/null) && optipng -o5 $(distdir)/userdoc/*.png -(optipng -v >/dev/null) && optipng -o5 $(distdir)/userdoc/*.png
DISTCLEANFILES = org/plantuml.jar
...@@ -26,8 +26,10 @@ ...@@ -26,8 +26,10 @@
(org-babel-do-load-languages 'org-babel-load-languages (org-babel-do-load-languages 'org-babel-load-languages
'((sh . t) '((sh . t)
(python . t) (python . t)
(plantuml . t)
(dot . t) (dot . t)
(C . t))))) (C . t)))))
(org-plantuml-jar-path . "./plantuml.jar")
(org-confirm-babel-evaluate . nil) (org-confirm-babel-evaluate . nil)
(org-babel-python-command . "@PYTHON@") (org-babel-python-command . "@PYTHON@")
(org-babel-C++-compiler . "./g++wrap") (org-babel-C++-compiler . "./g++wrap")
......
...@@ -23,9 +23,10 @@ ...@@ -23,9 +23,10 @@
'((sh . t) '((sh . t)
(dot . t) (dot . t)
(python . t) (python . t)
(plantuml . t)
(C . t))) (C . t)))
(setq org-confirm-babel-evaluate nil) (setq org-confirm-babel-evaluate nil)
(setq org-plantuml-jar-path "./plantuml.jar")
(setq org-babel-python-command "@PYTHON@") (setq org-babel-python-command "@PYTHON@")
(setq org-babel-C++-compiler "./g++wrap") (setq org-babel-C++-compiler "./g++wrap")
(setq shell-file-name "@SHELL@") (setq shell-file-name "@SHELL@")
......
...@@ -33,6 +33,10 @@ three interfaces supported by Spot: shell commands, Python, or C++. ...@@ -33,6 +33,10 @@ three interfaces supported by Spot: shell commands, Python, or C++.
- [[file:tut21.org][Custom print of an automaton]] - [[file:tut21.org][Custom print of an automaton]]
- [[file:tut22.org][Creating an automaton by adding states and transitions]] - [[file:tut22.org][Creating an automaton by adding states and transitions]]
* Examples in C++ only
- [[file:tut50.org][Explicit vs. on-the-fly: two interfaces for exploring automata]]
* Examples in Python only * Examples in Python only
In directory =python/tests=, the [[file:install.org][Spot tarball]] contains a small In directory =python/tests=, the [[file:install.org][Spot tarball]] contains a small
......
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment