Mike Gerwitz
54d2eff8b9
Add diagram generation with graphviz
...
* configure.ac (TWOPI, HAS_TWOPI): Add variables.
Check for towpi.
* doc/.gitignore (diagrams/*.svg): Add output file ignore.
* doc/Makefile.am: Add svg diagram building.
2017-06-08 14:38:32 -04:00
Mike Gerwitz
7c6b884895
doc/design.texi (Group Styles): Put table into float
2017-03-23 12:16:52 -04:00
Mike Gerwitz
bff17bdbb6
doc/liza.css: Change font
...
This imports from Google, which is a privacy risk. These should be
moved to be hosted locally; their download can be scripted.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
f89c311d1d
doc/liza.texi: Add predicate system documentation
2017-03-23 12:16:52 -04:00
Mike Gerwitz
5abfedeb54
doc/liza.css: Example block and float styling
2017-03-23 12:16:52 -04:00
Mike Gerwitz
b05d48a572
doc/macros.texi (@progxml): Add macro
2017-03-23 12:16:52 -04:00
Mike Gerwitz
8d09c2d8c3
doc/macros.texi: Fix PDF output issues with @maintenance
...
doc/macros.texi (@maintstart, @maintend): Add macros.
(@maintenance): Use them.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
2ed43ba986
doc/macros.texi (@xmlnode, @xmlattr): Add macros
2017-03-23 12:16:52 -04:00
Mike Gerwitz
637ae01e95
doc/macros.texi (@tip): Add macro
...
doc/liza.css: Add tip notice styling.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
3dfde49f76
doc/design.texi (Program UI): Add notices
...
(Client): Add reference to Program UI in notice.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
b7adc3b844
doc/macros.texi (@refactornotice): Add macro
2017-03-23 12:16:52 -04:00
Mike Gerwitz
2475cc37a6
doc/macros.texi (@srcrefraw): Add macro
...
I do not think Texinfo supports optional macro arguments.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
a7368d1b52
doc/design.texi (Program): Add matinenance and mv notices
2017-03-23 12:16:52 -04:00
Mike Gerwitz
f93539a827
doc/macros.texi (@mvnotice): Add macro
2017-03-23 12:16:52 -04:00
Mike Gerwitz
87fb6277f7
doc/design.texi (Client): Add maintenance concerns
2017-03-23 12:16:52 -04:00
Mike Gerwitz
041cde783a
doc/design.texi (Assertions): Add maintenance concerns
2017-03-23 12:16:52 -04:00
Mike Gerwitz
0e29ddd5eb
doc/design.texi (Design & Architecture): Convert note to notice
2017-03-23 12:16:52 -04:00
Mike Gerwitz
a700d275de
doc/design.texi (Managing Error State): Add section text
2017-03-23 12:16:52 -04:00
Mike Gerwitz
e477b15298
Add @srcref to manual
...
doc/macros.texi (@srcref): Add macro.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
b6c9045008
Add @exnotice to manual
...
liza.css: Style exnotice
macros.texi (@exnotice): Add macro.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
d7b1fd2f18
Better multi-line devnotice styling in manual
...
* liza.css: Better style multi-line notices with icon.
* macros.texi (@noticestart, @noticeend): Add. Use instead of @rawnotice.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
0400b5f84c
Properly build and format TeX document
...
This doesn't have formatting (yet?) for notices aside from the basic
italics.
* design.texi: Move @ref's to end of sentence rather than treating as
links on existing text. It otherwise formats undesirably in the PDF.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
4ddebbc035
Add SRCURI configuration for manual
...
* configure.ac (SET_SRCURI): Provide source root to manual.
(--with-srcuri): Add configure option.
* doc/config.texi.in (SET_SRCURI): Add configuration value.
* doc/liza.texi: Add warning if SET_SRCURI is unset when DEVNOTES is set.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
eaacb7c5e0
doc/Makefile.am (liza_TEXINFOS): Depend upon liza.css
...
To trigger a rebuild when modified.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
1b4ebc13e3
Add notices and DEVNOTES flag
...
* .gitignore (/config.*): Restrict to root.
* configure.ac (DEVNOTES): Add variable.
(--enable-devnotes): Add configuration flag.
* doc/Makefile.am (liza_TEXINFOS): config.texi dependency.
* doc/config.texi.in: Add configuration file.
* doc/liza.css: Styling for notices.
* doc/liza.texi: Include configuration. Add notice for DEVNOTES.
* doc/macros.texi: Add notice macros.
* doc/.gitignore (config.texi): Ignore generated file.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
00e2389a5f
macros.texi (helpwanted): Add macro
2017-03-23 12:16:52 -04:00
Mike Gerwitz
9403a1d29b
liza.texi: Set document character encoding to UTF-8
2017-03-23 12:16:52 -04:00
Mike Gerwitz
05e22b2309
Add manual HTML styling
...
This uses GNU Octave's CSS, which formats it like a printed manual
using a modern style. It's certainly an opinionated style, but at the
very least, the width is important.
* Makefile.am (MAKEINFOHTML): Include CSS reference.
* liza.css: Add stylesheet.
2017-03-23 12:16:52 -04:00
Mike Gerwitz
0c496299a0
design.texi: Add initial component descriptions
2017-03-23 12:16:52 -04:00
Mike Gerwitz
09c32e4792
doc/liza.texi: Include version.texi before reference of VERSION
2017-03-23 12:16:52 -04:00
d432985c67
Added placeholder files for Texinfo documentation
...
Texinfo is the documenation format of the GNU operating system and can
produce output in a variety of useful formats, including info, HTML, and
PDF.
The HTML output is of particular importance here, since Liza is a JavaScript
framework.
2014-01-16 23:35:45 -05:00
Mike Gerwitz
Mike Gerwitz