From 6a976a40d77adaff911ef873cd24737430523e82 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Sun, 26 Sep 2010 01:07:43 +0200 Subject: Add the arch and flow diagrams to the manual --- doc/makefile | 8 +- doc/manual.xhtml | 6 +- doc/odb-arch.png | Bin 0 -> 16883 bytes doc/odb-arch.svg | 410 +++++++++++++++++++++++++++ doc/odb-flow.png | Bin 0 -> 41030 bytes doc/odb-flow.svg | 822 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 1241 insertions(+), 5 deletions(-) create mode 100644 doc/odb-arch.png create mode 100644 doc/odb-arch.svg create mode 100644 doc/odb-flow.png create mode 100644 doc/odb-flow.svg (limited to 'doc') diff --git a/doc/makefile b/doc/makefile index 1995e36..32ad89a 100644 --- a/doc/makefile +++ b/doc/makefile @@ -44,7 +44,9 @@ $(out_base)/odb.1: $(src_root)/odb/options.cli \ # Manual. # $(out_base)/odb-manual.ps: $(src_base)/manual.xhtml \ - $(src_base)/manual.html2ps | $(out_base)/. + $(src_base)/manual.html2ps \ + $(src_base)/odb-arch.png \ + $(src_base)/odb-flow.png | $(out_base)/. $(call message,html2ps $<,html2ps -f $(src_base)/manual.html2ps -o $@ $<) $(out_base)/odb-manual.pdf: $(out_base)/odb-manual.ps @@ -52,9 +54,9 @@ $(out_base)/odb-manual.pdf: $(out_base)/odb-manual.ps # Dist. # -$(dist): export docs := default.css odb.xhtml odb-manual.ps odb-manual.pdf +$(dist): data_dist := default.css odb-arch.png odb-flow.png +$(dist): export docs = $(data_dist) odb.xhtml odb-manual.ps odb-manual.pdf $(dist): export mans := odb.1 -$(dist): data_dist := default.css $(dist): \ $(out_base)/odb.1 \ $(out_base)/odb.xhtml \ diff --git a/doc/manual.xhtml b/doc/manual.xhtml index ff2255e..36dec66 100644 --- a/doc/manual.xhtml +++ b/doc/manual.xhtml @@ -406,7 +406,8 @@ the object persistence architecture of an application that uses MySQL as the underlying database system:

-

@@ arch diagram

+ +

The ODB system also defines two special-purpose languages: the ODB Pragma Language and ODB Query Language. The ODB Pragma @@ -428,7 +429,8 @@ following diagram shows the typical build workflow of an application that uses ODB:

-

@@ flow diagram

+ +

1.2 Benefits

diff --git a/doc/odb-arch.png b/doc/odb-arch.png new file mode 100644 index 0000000..511b198 Binary files /dev/null and b/doc/odb-arch.png differ diff --git a/doc/odb-arch.svg b/doc/odb-arch.svg new file mode 100644 index 0000000..368c223 --- /dev/null +++ b/doc/odb-arch.svg @@ -0,0 +1,410 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + Application Code + + Persistent Classes + + + + ODB + Application + ODB Common Runtime + Generated Code + + ODB MySQL Runtime + + MySQL Database + + diff --git a/doc/odb-flow.png b/doc/odb-flow.png new file mode 100644 index 0000000..0479d21 Binary files /dev/null and b/doc/odb-flow.png differ diff --git a/doc/odb-flow.svg b/doc/odb-flow.svg new file mode 100644 index 0000000..292a121 --- /dev/null +++ b/doc/odb-flow.svg @@ -0,0 +1,822 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + C++ Source + Application Code + + + + + C++ Header + + + + + + + + + + + + C++ Source + + + C++ Header + Generated Code + ODB Compiler + + + C++ Compiler + + ODB Runtime Libraries + + libodb + + libodb-mysql + + + Linker + + Application Executable + + + Database Schema + + + + + + + + + + + + + #include + #include + + -- cgit v1.1