Skip to content

Commit

Permalink
fix validation issues
Browse files Browse the repository at this point in the history 
fix prompting display a different way since just removing term doesn't

term is not valid in a para context, only in a varlist, but looks like we don't even really want that.  simplify the tagging and update the indent while we're in there, particularly for the three variants of gqa and check.  this ensures the prompts line up right with their output, and there's a space after the prompt (as they're all in literallayouts) for better readability.  passes build checks.
  • Loading branch information
@brlcad
brlcad committed Aug 5, 2023
1 parent 38e43ad commit efa715b
Show file tree
Hide file tree
Showing 6 changed files with 684 additions and 556 deletions.
156 changes: 70 additions & 86 deletions doc/docbook/system/man1/gqa.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,7 @@
An example file might look like the following:
</para>

<literallayout class="normal">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../misc/GQA_SAMPLE_DENSITIES" parse="text"/>
</literallayout>
<literallayout class="normal"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../misc/GQA_SAMPLE_DENSITIES" parse="text"/></literallayout>


<para>
Expand All @@ -152,8 +150,7 @@
</para>

<para>
<prompt>mged&gt; </prompt><userinput>mater -d import
<replaceable>filename</replaceable></userinput>
<literallayout><prompt>mged&gt; </prompt><userinput>mater -d import <replaceable>filename</replaceable></userinput></literallayout>
</para>

<para>
Expand Down Expand Up @@ -682,8 +679,8 @@
<emphasis remap="I">wheel.r</emphasis> from the geometry
database <emphasis remap="I">model.g</emphasis> and reports the
weight and volume, and checks for overlaps.
<literallayout><userinput>gqa model.g
wheel.r</userinput></literallayout>

<literallayout><userinput>gqa model.g wheel.r</userinput></literallayout>
</para>

</example>
Expand All @@ -695,8 +692,8 @@
for overlaps and report exposed air. The grid starts at 1 cm and
is refined to 1 mm unless overlaps or exposed air are detected
before the grid is refined to 1 mm.
<literallayout><userinput>gqa -g 1cm-1mm -A oe model.g hull
turret suspension</userinput></literallayout>

<literallayout><userinput>gqa -g 1cm-1mm -A oe model.g hull turret suspension</userinput></literallayout>
</para>

</example>
Expand All @@ -707,88 +704,75 @@
The following computes volume and weight of hull, turret, and
suspension. Results are reported in cubic centimeters (cc) and
ounces (oz). The grid spacing starts at 5 in. and will not be
refined below 0.3 mm spacing. <literallayout><userinput>gqa
-g5in-0.3mm -Avw -u ft, cc, oz test.g hull turret
suspension</userinput></literallayout>
refined below 0.3 mm spacing.

<literallayout><userinput>gqa -g5in-0.3mm -Avw -u ft, cc, oz test.g hull turret suspension</userinput></literallayout>
</para>

</example>

<example><title>Different Analysis Types</title>

<para>For an example of each independent analysis type, consider
the following:</para>
<variablelist>
<varlistentry>
<term><prompt>%</prompt><userinput>gqa -u m, m^3, kg -Ao geometry.g overlaps</userinput></term>
<listitem>
<literallayout class="normal">
Units:
length: m volume: m^3 weight: kg
grid spacing 50mm 199 x 199 x 199
Summary:
list Overlaps:
/overlaps/overlap_obj.r /overlaps/closed_box.r count:32039 dist:8m @ (9050 1000 1000)
</literallayout>
</listitem>
</varlistentry>
<varlistentry>
<term><prompt>%</prompt><userinput>gqa -u m, m^3, kg -Ae geometry.g exposed_air.g</userinput></term>
<listitem>
<literallayout class="normal">
Units:
length: m volume: m^3 weight: kg
grid spacing 50mm 199 x 199 x 199
Summary:
list Exposed Air:
/exposed_air.g/exposed_air.r count:25921 dist:9m @ (10000 1000 1000)
</literallayout>
</listitem>
</varlistentry>
<varlistentry>
<term><prompt>%</prompt><userinput>gqa -u m, m^3, kg -Ag geometry.g gap.g</userinput></term>
<listitem>
<literallayout class="normal">
Units:
length: m volume: m^3 weight: kg
grid spacing 50mm 199 x 199 x 199
Summary:
list Gaps:
/gap.g/closed_box.r /gap.g/closed_box.r count:26082 dist:8m @ (9000 1000 1000)
/gap.g/adj_air2.r /gap.g/closed_box.r count:25921 dist:4m @ (1000 5000 1000)
</literallayout>
</listitem>
</varlistentry>
<varlistentry>
<term><prompt>%</prompt><userinput>gqa -u m, m^3, kg -Av geometry.g closed_box.r</userinput></term>
<listitem>
<literallayout class="normal">
Units:
length: m volume: m^3 weight: kg
setting volume tolerance to 1 m^3
grid spacing 50mm 199 x 199 x 199
grid spacing 25mm 399 x 399 x 399
grid spacing 12.5mm 799 x 799 x 799
Summary:
closed_box.r 484.195 m^3
Average total volume: 488.327 m^3
</literallayout>
</listitem>
</varlistentry>
<varlistentry>
<term><prompt>%</prompt><userinput>gqa -u m, m^3, kg -Aw geometry.g closed_box.r</userinput></term>
<listitem>
<literallayout class="normal">
Units:
length: m volume: m^3 weight: kg
setting weight tolerance to 768000 kg
grid spacing 50mm 199 x 199 x 199
Summary:
Weight:
closed_box.r 3.6375e+06 kg
Average total weight: 3.67541e+06 kg
</literallayout>
</listitem>
</varlistentry>
</variablelist>
the following:

<literallayout class="normal">
<prompt></prompt><userinput>gqa -u m, m^3, kg -Ao geometry.g overlaps</userinput>
Units:
length: m volume: m^3 weight: kg
grid spacing 50mm 199 x 199 x 199
Summary:
list Overlaps:
/overlaps/overlap_obj.r /overlaps/closed_box.r count:32039 dist:8m @ (9050 1000 1000)
</literallayout>

<literallayout class="normal">
<prompt></prompt><userinput>gqa -u m, m^3, kg -Ae geometry.g exposed_air.g</userinput>
Units:
length: m volume: m^3 weight: kg
grid spacing 50mm 199 x 199 x 199
Summary:
list Exposed Air:
/exposed_air.g/exposed_air.r count:25921 dist:9m @ (10000 1000 1000)
</literallayout>

<literallayout class="normal">
<prompt></prompt><userinput>gqa -u m, m^3, kg -Ag geometry.g gap.g</userinput>
Units:
length: m volume: m^3 weight: kg
grid spacing 50mm 199 x 199 x 199
Summary:
list Gaps:
/gap.g/closed_box.r /gap.g/closed_box.r count:26082 dist:8m @ (9000 1000 1000)
/gap.g/adj_air2.r /gap.g/closed_box.r count:25921 dist:4m @ (1000 5000 1000)
</literallayout>

<literallayout class="normal">
<prompt></prompt><userinput>gqa -u m, m^3, kg -Av geometry.g closed_box.r</userinput>
Units:
length: m volume: m^3 weight: kg
setting volume tolerance to 1 m^3
grid spacing 50mm 199 x 199 x 199
grid spacing 25mm 399 x 399 x 399
grid spacing 12.5mm 799 x 799 x 799
Summary:
closed_box.r 484.195 m^3
Average total volume: 488.327 m^3
</literallayout>

<literallayout class="normal">
<prompt></prompt><userinput>gqa -u m, m^3, kg -Aw geometry.g closed_box.r</userinput>
Units:
length: m volume: m^3 weight: kg
setting weight tolerance to 768000 kg
grid spacing 50mm 199 x 199 x 199
Summary:
Weight:
closed_box.r 3.6375e+06 kg
Average total weight: 3.67541e+06 kg
</literallayout>
</para>
</example>
</refsection>

<refsection xml:id="author">
Expand Down
37 changes: 18 additions & 19 deletions doc/docbook/system/mann/bb.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,59 +117,59 @@


<para>
<prompt>mged&gt; </prompt><userinput>bb havoc</userinput>
<literallayout class="normal">
<literallayout class="normal">
<prompt>mged&gt; </prompt><userinput>bb havoc</userinput>
Bounding Box Dimensions, Object(s) havoc:
X Length: 1988.4 cm
Y Length: 1683.6 cm
Z Length: 625.0 cm
Bounding Box Volume: 2092246392.4 cm^3
</literallayout>
</literallayout>
</para>

</example>
<example><title>Report only the min and max points of a bounding box</title>


<para>
<prompt>mged&gt; </prompt><userinput>bb -q -e havoc</userinput>
<literallayout class="normal">
<literallayout class="normal">
<prompt>mged&gt; </prompt><userinput>bb -q -e havoc</userinput>
min {-759.447479 -8437.866455 -890.000000} max {19124.621094 8397.693207 5360.000000}
</literallayout>
</literallayout>
</para>

</example>
<example><title>Bounding Box for multiple components</title>


<para>
<prompt>mged&gt; </prompt><userinput>bb havoc_front havoc_middle havoc_tail</userinput>
<literallayout class="normal">
<literallayout class="normal">
<prompt>mged&gt; </prompt><userinput>bb havoc_front havoc_middle havoc_tail</userinput>
Bounding Box Dimensions, Object(s) havoc_front, havoc_middle, havoc_tail:
X Length: 1775.9 cm
Y Length: 358.0 cm
Z Length: 536.0 cm
Bounding Box Volume: 340782488.9 cm^3
</literallayout>
</literallayout>
</para>

</example>
<example><title>Create Bounding Box ARB8 in database</title>

<example><title>Create ARB8 Bounding Box</title>

<para>
<prompt>mged&gt; </prompt><userinput>bb -c havoc_parts_bbox.s havoc_front havoc_middle havoc_tail</userinput>
<literallayout class="normal">
mged&gt; bb -c havoc_parts_bbox.s havoc_front havoc_middle havoc_tail
<literallayout class="normal">
<prompt>mged&gt; </prompt><userinput>bb -c havoc_parts_bbox.s havoc_front havoc_middle havoc_tail</userinput>
Bounding Box Dimensions, Object(s) havoc_front, havoc_middle, havoc_tail:
X Length: 1775.9 cm
Y Length: 358.0 cm
Z Length: 536.0 cm
Bounding Box Volume: 340782488.9 cm^3
</literallayout>
</para>


havoc havoc_tail havoc_middle havoc_parts_bbox.s havoc_front
mged&gt; l havoc_parts_bbox.s
<para>
<literallayout class="normal">
<prompt>mged&gt; </prompt><userinput>l havoc_parts_bbox.s</userinput>
havoc_parts_bbox.s: ARB8
1 (-75.9447, -158, -4.86374e-06)
2 (-75.9447, -158, 536)
Expand All @@ -179,8 +179,7 @@ havoc_parts_bbox.s: ARB8
6 (1700, -158, 536)
7 (1700, 200, 536)
8 (1700, 200, -4.86374e-06)

</literallayout>
</literallayout>
</para>

</example>
Expand Down
Loading

0 comments on commit efa715b

Please sign in to comment.