commit 0abe6e70f3587d465311907306cfc409441a31c4
parent c5b9f4841f6ba57d3a2b530570855246debe7087
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 24 Feb 2026 11:35:37 +0100
Correction to the star-phor-input manual page.
Transform the system's ASCII art into comments in the example files.
This way, the ASCII art is formatted as literal text, as expected, since
ASCII art must be verbatim. Adding these drawings as comments in the
example files also illustrates how comments can be used to help describe
the system, directly in the file sources.
Beyond formatting alone, this change corrects the generation of the
manual page: the scdoc format uses spaces and tabs at the beginning of
lines as part of its language. As a result, ASCII art caused errors due
to non-compliance with this grammar.
Finally, note the modification of ASCII arts to display backslash
characters. These are used by scdoc to escape another character. They
must therefore be escaped themselves in order to be displayed.
Diffstat:
1 file changed, 34 insertions(+), 34 deletions(-)
diff --git a/doc/star-phor-input.5.scd b/doc/star-phor-input.5.scd
@@ -219,24 +219,24 @@ mol/m^3, and whose absorption cross section is provided in the file
defined as a sensor, with a unit response function, enabling for instance to
compute the number of photons absorbed within the cube per second.
- +-------------------+
- /| /|
- / | source / |
- / | /|\ / |
- / | v v v / |
- / | / |
-+-------------------+ |
-| | | |
-| | | |
-| +-------------|-----+
-| / | /
-| / ^ ^ ^ | /
-| / \|/ | /
-| / source | /
-|/ |/
-+-------------------+
-
```
+# +-------------------+
+# /| /|
+# / | source / |
+# / | / | \\ / |
+# / | v v v / |
+# / | / |
+# +-------------------+ |
+# | | | |
+# | | | |
+# | +-------------|-----+
+# | / | /
+# | / ^ ^ ^ | /
+# | / \\ | / | /
+# | / source | /
+# |/ |/
+# +-------------------+
+
volume: "reaction volume"
geometry: FRONT cube_top.stl
geometry: FRONT cube_bottom.stl
@@ -265,24 +265,24 @@ with specular reflectivity of 0.9. Here, the volume of the cube is defined as a
sensor, with a unit response function, enabling for instance to compute the
number of photons absorbed within the cube per second.
- + +-------------------+
- /| /| /|
- / | / | / |
- / | / | / |
- / | / | / |
- / | / | / |
-+ | +-------------------+ |
-| LED | | | | |
-| | | | | |
-| + | +-------------|-----+
-| / | / | /
-| / | / | /
-| / | / | /
-| / | / | /
-|/ |/ |/
-+ +-------------------+
-
```
+# + +-------------------+
+# /| /| /|
+# / | / | / |
+# / | / | / |
+# / | / | / |
+# / | / | / |
+# + | +-------------------+ |
+# | LED | | | | |
+# | | | | | |
+# | + | +-------------|-----+
+# | / | / | /
+# | / | / | /
+# | / | / | /
+# | / | / | /
+# |/ |/ |/
+# + +-------------------+
+
volume: "reaction volume"
geometry: FRONT cube.stl
prop_rad: "chemical 1" SCATTERER
