benn/lumiera_
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

DOC: add source files to build the doc_map.svg drawing

Browse source
This commit is contained in:
benn 2023-09-12 12:00:31 +02:00 committed by Ichthyostega
parent 5d8c36720a
commit 13b168978f
4 changed files with 129 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
admin/build_svgs/DIR_INFO Normal file
View file

@ -0,0 +1,2 @@
Scripts to produce graphics
Currently only using LaTeX/TikZ to produce graphics

4
admin/build_svgs/TikZ/DIR_INFO Normal file
View file

@ -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

76
admin/build_svgs/TikZ/doc_map.tex Normal file
View file

@ -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}

47
admin/build_svgs/TikZ/makefile Normal file
View file

@ -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