Pikchr

Check-in [d9e1502ed7]
Login
Overview
Comment:Minor documentation tweaks.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: d9e1502ed74c6aabcb055cf7983c897a28cbe09cc4e16b6eebd36ee69aadb612
User & Date: drh 2021-07-22 00:03:21.716
Context
2021-11-04
18:36
Fix a compiler warning: decimal constant is unsigned only in ISO C90" (check-in: b79ce27929 user: drh tags: trunk)
2021-07-22
00:03
Minor documentation tweaks. (check-in: d9e1502ed7 user: drh tags: trunk)
2021-07-21
12:17
Improved explanation of color names in Pikchr. (check-in: c740e5d417 user: drh tags: trunk)
Changes
Unified Diff Ignore Whitespace Patch
Changes to doc/cylinderobj.md.
1
2
3
4
5
6
7
8
9
10
11
12
# Cylinder objects

A cylinder is a stylized projection of a cylinder into the 2-D space of
the diagram.  Cylinders are commonly used to represent bulk data storage in
architecture diagrams, as legacy disk packs were cylindrical in shape.

The shape of a cylinder is defined by the width, height, and radius.
The radius is the minor axis of the ellipse that forms the top of the
cylinder, and the semiellipse the forms the bottom.

~~~~ pikchr indent
A: cylinder thick rad 150%




|







1
2
3
4
5
6
7
8
9
10
11
12
# Cylinder objects

A cylinder is a stylized projection of a cylinder into the 2-D space of
the diagram.  Cylinders are commonly used to represent bulk data storage in
software architecture diagrams, as legacy disk packs were cylindrical in shape.

The shape of a cylinder is defined by the width, height, and radius.
The radius is the minor axis of the ellipse that forms the top of the
cylinder, and the semiellipse the forms the bottom.

~~~~ pikchr indent
A: cylinder thick rad 150%
Changes to doc/fit.md.
1
2
3
4
5
6
7
8
# The `fit` attribute

The "`fit`" attribute causes an object to automatically adjust its
"`width`", "`height`", and/or "`radius`" so that it will enclose its
text annotations with a reasonable margin.

~~~ pikchr toggle
box "with" "\"fit\"" fit
|







1
2
3
4
5
6
7
8
# The "fit" attribute

The "`fit`" attribute causes an object to automatically adjust its
"`width`", "`height`", and/or "`radius`" so that it will enclose its
text annotations with a reasonable margin.

~~~ pikchr toggle
box "with" "\"fit\"" fit
Changes to doc/pathattr.md.
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
is no previous object, "`from (0,0)`".   If no "to" forms are
provided then a single movement in the current layout direction
by either the "linewid" or "lineht" (depending on layout direction)
is used.

The "from" can occur
either before or after the various "to" subclauses.  That does not
matter.  But the order of the various "to" subclauses do matter, of course.

If there are two consecutive *direction* clauses (*direction* is
always one of "`up`", "`down`", "`left`", or "`right`") then
the two will be combined to specify a single line segment.
Hence, the following are equivalent:









|







23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
is no previous object, "`from (0,0)`".   If no "to" forms are
provided then a single movement in the current layout direction
by either the "linewid" or "lineht" (depending on layout direction)
is used.

The "from" can occur
either before or after the various "to" subclauses.  That does not
matter.  But the order is important for the various "to" subclauses.

If there are two consecutive *direction* clauses (*direction* is
always one of "`up`", "`down`", "`left`", or "`right`") then
the two will be combined to specify a single line segment.
Hence, the following are equivalent:


Changes to doc/thickthin.md.
1
2
3
4
5
6
7
8
# The `thick` and `thin` attributes

The "`thick`" and "`thin`" attributes increase or decrease the stroke-width
for the lines used to draw an object.  There can be multiple "`thick`" or
"`thin`" attributes - the effects are cumulative.

# The `solid` attribute

|







1
2
3
4
5
6
7
8
# The "thick" and "thin" attributes

The "`thick`" and "`thin`" attributes increase or decrease the stroke-width
for the lines used to draw an object.  There can be multiple "`thick`" or
"`thin`" attributes - the effects are cumulative.

# The `solid` attribute