All used (referenced) figures should be stored in figures/
.
All unused (unreferenced) figures should be stored in figures/unused
.
The naming convention for figures is <part><name>.<extension>
.
<part>
is the part of the standard owning the figure, e.g. sql_frm
.<name>
is the name of the figure using only underscores as separator and
preferrably only using lower case.<ext>
is the extension of the figure using only lower case.<part>
and that <part>
should not be a guide standard.
If the owning <part>
cannot be determined, use the standard itself, i.e.,
sql
or gql
instead.drawio is a freely available cross-platform gui application for the creation of diagrams in SVG.
It is possibly the only freely available such tool at the time of this writing.
drawio can be accessed in a number of ways:
There are some "gotchas" that one should be aware of when working with drawio. Consider following the following guidelines:
As a baseline font, use Times New Roman, 10pt for serif text. Use Helvetica for sans serif text.
Always store both the source file (.drawio
) and the result file (.svg
) in figures/
and make sure both files are tracked in git to support future editing of the figure.
drawio was originially intended for the production of SVGs embeddeed in a web page. Therefore it relies on certain features usually only available in web browsers for text rendering. Because of this, text in a SVG directly exported from drawio sometimes does not render correctly in our PDFs. There are two approaches available to handle this issue and create a SVG ready for use in our PDFs:
Use the desktop client but instead of exporting to SVG:
This approach is completely local and therefore preferred.
drawio provides no way to specify padding.
Use, e.g., padding-after='10pt'
(or padding-before='10pt'
) on figures to fix this.