File: README

package info (click to toggle)
checker-framework-java 3.2.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 22,840 kB
  • sloc: java: 145,910; xml: 839; sh: 518; makefile: 401; perl: 26
file content (23 lines) | stat: -rw-r--r-- 1,044 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
This directory contains the SVG files used for the diagrams in the Checker
Framework manual.  The HTML manual uses the SVGs directly.  The PDF manual
uses PDF conversions of each SVG.

To edit an existing image (.svg file), use one of these tools.
 * Inkscape
 * Visio
 * LibreOffice/OpenOffice.
 * https://www.draw.io (no tool installation required)
    * The .svg files it exports don't convert to pdf with correct formatting
      if they have multiline text
    * The figures might require fine tuning with Inkscape afterwards.

To create a new image:
Copy an existing SVG and make modifications to it, so that its boxes and
arrows have the same size and font as in other SVGs.

To include an image in your chapter, use one of these:
 \includeimage{formatter-hierarchy}{3.5cm}
 \includeimagenocentering{value-subtyping}{2.75cm}
Note the absence of the SVG extension. Note that the size parameter is the
*vertical* size for the PDF only, not the HTML.  To affect the size of an
image in HTML, please edit the image size in the SVG directly.