commit a11874485c0f409fa00b1db4d361729e675e852c
parent 32fab332c807c21a470b8b8fd7d980ad553662d0
Author: Eduardo Fontana Lazzari <edufonlaz@gmail.com>
Date: Sat, 4 Oct 2025 17:49:20 +0200
Add rule for the : (colon) character in the documentation
Colons are reserved characters used as separators in the input file.
Using them in other parts of the input file (such as structure names) may
lead to undefined behavior. This rule is now explicitly documented in the
man page for the input file.
Diffstat:
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/doc/star-phor-input.scd b/doc/star-phor-input.scd
@@ -48,9 +48,11 @@ properties.
Properties are specified either as a single-line entry or as a multi-line block,
where each line corresponds to a distinct property.
-Single line properties are declared using the "key: value" syntax. No additional
+Single-line properties are declared using the "key: value" syntax. No additional
content other than comments is allowed after the value. Both the key and the
-value must appear on the same line.
+value must appear on the same line. The colon (:) character is reserved as a
+separator in the input file and therefore cannot be used in the names of
+volumes, surfaces, or prop_rad elements.
The star-phor-input format does not enforce a specific order for property
declarations. However, when encountering a keyword that does not belong to the
@@ -67,7 +69,6 @@ tabs, spaces, or combinations of both are used, they will be ignored.
Please note that in the following lines, the percent symbol (%) is used to
introduce a comment in the file format description. It should not be taken into
-
account when writing these files, nor should anything that comes after it.
Text enclosed in single quotation marks (') must be included in the entry as is,
@@ -180,10 +181,10 @@ The file format describing a photoreactive system is as follows:
# EXAMPLES
-1. The example below describes a simple photoreactive system composed of a cube, in
-which absorption takes place. Tube walls have diffuse reflectivity. A LED panel
-emits light with a defined flux density, and a surface base reflects light with
-specular reflectivity.
+1. The example below describes a simple photoreactive system composed of a cube,
+in which absorption takes place. Tube walls have diffuse reflectivity. A LED
+panel emits light with a defined flux density, and a surface base reflects light
+with specular reflectivity.
```
# Keyword name
@@ -216,7 +217,8 @@ surface: "reflecting base"
brdf: SPECULAR 0.9
```
-2. The example below describes a volume and a source surface composed by several .stl files.
+2. The example below describes a volume and a source surface composed by several
+.stl files.
```
# Keyword name
