The Mud Puddle

Name

sol : solida - Overview of the solida formatter.

Synopsis

solida filename

#! heading
#@ code
## numbered list
#* bulleted list
#- end formatting
#+ start formatting

Using the Formatter

To view solida formatting in a file, run the solida program in the bin subdirectory of the sol installation directory, passing as a parameter the name (and optionally the path) of a file. The formatter extracts formatting information from comments in the file; #+ is used to start formatting, so if this command is not present, none of the file will be output. #- and #+ pairs may be used within the file to toggle formatting, but a #- is not necessary before end-of-file.

Text Formatting

Normal text appears in normal comments and is output as it is written.

To produce a heading in the formatted output, the #! command is used. Any text following #! appears on its own line in all capital letters, e.g.:

#!this is a heading

produces:

THIS IS A HEADING

in the formatted output.

To produce an indented block of code in output, the #@ command is used:

#@here (is) {some code;}

gives:

    here (is) {some code;}

List Formatting

There are two types of lists recognised by the formatter: numbered lists and bulleted lists. Numbered lists begin with the ## command, and, starting at 1., create incrementally-numbered list items for as long as only ## and # are used. Bulleted lists have similar effects, but always produce a * before lines and do not break if non-list commands are present. E.g.:

#!this is a heading
##number one
##number two
# still number two
##number three
#*bullet
##number one again
#*bullet one
# still bullet one
#*bullet two
#!another heading
#*bullet three

outputs:

THIS IS A HEADING

1.  number one
2.  number two
    still number two
3.  number three
*   bullet
1.  number one again
*   bullet one
    still bullet one
*   bullet two

ANOTHER HEADING

*   bullet three

References and Miscellaneous

A number of reference and other commands will be added in the near future, using the reserved command symbols #$, #%, #^, #&, possibly #_ and #=, and less possibly #(, #), #[, #], #<, and #>.

Author

Jon "evincarofautumn" Purdy evincarofautumn@gmail.com

last updated 1 year ago #