Command and FISH Highlighting in the Program
In this documentation, commands and FISH functions presented as examples or as offset listings will match the default syntax highlighting of the program (assuming the default is in use — syntax highlighting may be customized by the user in the Options dialog).
When commands and FISH appear in reference sections, in body text (either in plain text or, as is most frequently the case, as a hyperlink), or elsewhere, the presentation is simplified somewhat. Command words and keywords are presented in black text; values supplied with keywords or arguments, regardless of type, are shown in blue text.
To illustrate, a reference in the body text such as this — zone face apply
— is a basic hyperlink to the reference information for the command. This is quite common. Similarly, inline illustration of a “filled out” command is common, and would look something like this: zone face apply stress-xy 110.23 system dip-direction 47.4.
However, if offset in the text, either as a simple “snippet”-style example (as here) or as a line in a full data file listing, it would appear like this:
zone face apply stress-xy 110.23 system dip-direction 47.4 ...
range position-x 22.7 1.19e-1
Type style/ character | Used for |
---|---|
command | first word in a command |
keyword | command keyword |
fishword | a FISH function name or statement |
fishvar | a FISH variable |
flt or int | a number of float or integer type |
str or bool | a string value or boolean value |
comment | a comment |
stop | stop, pause, return, quit (stop words) |
solve | solve, cycle (execute words) |
& or … | line continuation characters |
Was this helpful? ... | PFC 6.0 © 2019, Itasca | Updated: Nov 19, 2021 |