diff --git a/docs/v1/Makefile b/docs/v1/Makefile index c2e4bbe5..8111e747 100644 --- a/docs/v1/Makefile +++ b/docs/v1/Makefile @@ -8,12 +8,7 @@ all: ${SPEC}.pdf ${SPEC}.html build: mkdir -p build -# Note: Brute-force image rendering; could use more precise file-by-file make rules -figs: build resources/figs/*.odg - soffice --convert-to svg --outdir resources/figs/ resources/figs/*.odg > /dev/null 2>&1 - soffice --convert-to png --outdir resources/figs/ resources/figs/*.odg > /dev/null 2>&1 - -${SPEC}.pdf: ${SPEC}.adoc figs +${SPEC}.pdf: ${SPEC}.adoc time asciidoctor-pdf -v \ -a pdf-fontsdir=resources/fonts \ -r asciidoctor-mathematical \ @@ -21,7 +16,7 @@ ${SPEC}.pdf: ${SPEC}.adoc figs -r asciidoctor-lists \ -a rouge-style=$(ROUGE_STYLE) $< -${SPEC}.html: ${SPEC}.adoc figs +${SPEC}.html: ${SPEC}.adoc time asciidoctor -v \ -r asciidoctor-mathematical \ -r asciidoctor-bibtex \ @@ -29,4 +24,4 @@ ${SPEC}.html: ${SPEC}.adoc figs -a rouge-css=$(ROUGE_CSS) $< clean: - /bin/rm -f ${SPEC}.pdf ${SPEC}.html resources/figs/stem-*.png \ No newline at end of file + /bin/rm -f ${SPEC}.pdf ${SPEC}.html \ No newline at end of file diff --git a/docs/v1/README.md b/docs/v1/README.md index 9be0b84b..bf2a069d 100644 --- a/docs/v1/README.md +++ b/docs/v1/README.md @@ -26,6 +26,23 @@ Files: - `*.bib` - Bibliography file that contains a list of bibliographical item, such as articles, books, and theses. - `Makefile` builds documentation in the build subdirectory +## Document Figures + +Each image in the specification has a corresponding `.odg` file under +`figures/`. These are LibreOffice drawing files. The files are rendered into +`.svg` and `.png` images (for HTML and PDF output, resepectively) at build time, +using the `soffice` command-line tool. The page size for each image should be +adjusted manually by the author ("artist") to just fit the image on the +apparrent "page," to minimize padding around the image in the rendered +document. Use the menu item `Format | Page/Size Properties.` See the example +screen shot below. (Do not check the "Fit object to paper format" box - it will +change the object's aspect ratio.) +![LibreOffice](libre-office.png) + +``` +soffice --convert-to svg --outdir resources/figs/ resources/figs/*.odg > /dev/null +soffice --convert-to png --outdir resources/figs/ resources/figs/*.odg > /dev/null +``` ## Building diff --git a/docs/v1/libre-office.png b/docs/v1/libre-office.png new file mode 100644 index 00000000..155c8f07 Binary files /dev/null and b/docs/v1/libre-office.png differ