From 13b168978f75837da0180a04301cce7b68687dba Mon Sep 17 00:00:00 2001
From: benn <benny.lyons@gmx.net>
Date: Tue, 12 Sep 2023 12:00:31 +0200
Subject: [PATCH] DOC: add source files to build the doc_map.svg drawing

---
 admin/build_svgs/DIR_INFO         |  2 +
 admin/build_svgs/TikZ/DIR_INFO    |  4 ++
 admin/build_svgs/TikZ/doc_map.tex | 76 +++++++++++++++++++++++++++++++
 admin/build_svgs/TikZ/makefile    | 47 +++++++++++++++++++
 4 files changed, 129 insertions(+)
 create mode 100644 admin/build_svgs/DIR_INFO
 create mode 100644 admin/build_svgs/TikZ/DIR_INFO
 create mode 100644 admin/build_svgs/TikZ/doc_map.tex
 create mode 100644 admin/build_svgs/TikZ/makefile

diff --git a/admin/build_svgs/DIR_INFO b/admin/build_svgs/DIR_INFO
new file mode 100644
index 000000000..450db99db
--- /dev/null
+++ b/admin/build_svgs/DIR_INFO
@@ -0,0 +1,2 @@
+Scripts to produce graphics
+Currently only using LaTeX/TikZ to produce graphics
\ No newline at end of file
diff --git a/admin/build_svgs/TikZ/DIR_INFO b/admin/build_svgs/TikZ/DIR_INFO
new file mode 100644
index 000000000..e48810eef
--- /dev/null
+++ b/admin/build_svgs/TikZ/DIR_INFO
@@ -0,0 +1,4 @@
+LaTeX/TikZ source to build graphics in svg formnat
+To run these, you'll require LaTeX and TikZ
+LateX is available on Debian via the texlive package
+TikZ is available froom the texlive-pictures package
\ No newline at end of file
diff --git a/admin/build_svgs/TikZ/doc_map.tex b/admin/build_svgs/TikZ/doc_map.tex
new file mode 100644
index 000000000..7ce0d83be
--- /dev/null
+++ b/admin/build_svgs/TikZ/doc_map.tex
@@ -0,0 +1,76 @@
+% doc_map.tex: Generate map of how Lumiera developer documentation is organised
+%  glossary.sh - Lumiera RfC:
+%
+%  Copyright (C)         Lumiera.org
+%    2023,               Benny Lyons <benny.lyons@gmx.net>
+%
+%  This program is free software; you can redistribute it and/or
+%  modify it under the terms of the GNU General Public License as
+%  published by the Free Software Foundation; either version 2 of
+%  the License, or (at your option) any later version.
+%
+%  This program is distributed in the hope that it will be useful,
+%  but WITHOUT ANY WARRANTY; without even the implied warranty of
+%  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+%  GNU General Public License for more details.
+%
+%  You should have received a copy of the GNU General Public License
+%  along with this program; if not, write to the Free Software
+%  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+%
+% To compile the graphics, you will require TikZ.
+% On Debian, this is to be found in the texlive-pictures package.
+%
+\documentclass[dvisgvm]{article}
+\usepackage{tikz}
+
+
+\begin{document}
+
+\pagestyle{empty}
+
+\begin{tikzpicture}
+  [font=\footnotesize,
+    grow=right,
+    level 1/.style={sibling distance=8em},
+    level 2/.style={sibling distance=0.8em},level distance=3.5cm]
+
+  \node{\hbox{\vbox{
+                \hbox{Lumiera (as seen)}
+                \hbox{from Outer Space}
+              }
+        }
+  } % root
+  child {node {\hbox{\vbox{
+                       \hbox{Technical Docs}
+                       \hbox{The Inner Core}
+                     }
+               }
+    }
+    child {node {Developer Howtos} }
+    child {node {Infrastructure} }
+    child {node {Code Base} }
+    child {node {Support Lib} }
+    child {node {Vault} child { node {API doc}}}
+    child {node {Steam} child { node {API doc}}}
+    child {node {Stage} child { node {API doc}}}
+    child {node {Build System} }
+  }
+  child {node {Design Docs}
+    child {node {Governance} }
+    child {node {Workflow} }
+    child {node {Engine} }
+    child {node {Low-level Model} }
+    child {node {Application} }
+    child {node {Plugins} }
+    child {node {GUI} }
+    child {node {Model} }
+    child {node {Architecture} }
+  };
+
+\end{tikzpicture}
+
+
+
+\end{document}
diff --git a/admin/build_svgs/TikZ/makefile b/admin/build_svgs/TikZ/makefile
new file mode 100644
index 000000000..23fe0653b
--- /dev/null
+++ b/admin/build_svgs/TikZ/makefile
@@ -0,0 +1,47 @@
+#  makefile - build graphic map illustrating the organisation of the Lumiera developer doc 
+#
+#  Copyright (C)         Lumiera.org
+#    2023,               Benny Lyons <benny.lyons@gmx.net>
+#
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License as
+#  published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+#
+# Do compile the graphics, you will require TikZ.
+# On Debian, this is to be found in the texlive-pictures package.
+
+#
+# Requirements
+# tex, e.g., texlive
+#            TikZ (on Debian in the package tetxlive-pictures
+#            convert contained in Imagemagic
+#            It is possible the png file using other tools
+
+BUILDME=doc_map
+$(BUILDME): $(BUILDME).pdf $(BUILDME).svg $(BUILDME).png
+
+$(BUILDME).pdf: $(BUILDME).tex
+	pdflatex $< $@
+
+$(BUILDME).svg: $(BUILDME).dvi
+	dvisvgm $<
+$(BUILDME).dvi: $(BUILDME).tex
+	latex $<
+$(BUILDME).png: $(BUILDME).svg
+	convert -background none -size 1024x1024 $<  $@
+
+
+:PHONEY: clean
+clean:
+	@rm -f $(BUILDME).pdf $(BUILDME).svg $(BUILDME).dvi $(BUILDME).png