Skip to content

Latest commit

 

History

History
53 lines (44 loc) · 1.68 KB

README.md

File metadata and controls

53 lines (44 loc) · 1.68 KB

gCS

Interpreter that reads source code and outputs geological columnar section as HTML file in the current directory.
GitHub: https://github.com/YujiSODE/gCS
Wiki: https://github.com/YujiSODE/gCS/wiki

Copyright (c) 2017 Yuji SODE <yuji.sode@gmail.com>
This software is released under the MIT License.
See LICENSE or http://opensource.org/licenses/mit-license.php


1. Synopsis

Tcl
::gCS::_Run filePath ?encoding?;
Shell
tclsh gCS.tcl filePath ?encoding?;

Parameters

  • $filePath: file path of a file to load
  • $encoding: encoding name

2. Script

It requires Tcl/Tk 8.6+.

  • gCS.tcl: Interpreter
  • source code of geological columnar section as a tcl file; formatted with following syntaxes

3. Syntax

Source code of geological columnar section consits of three blocks: @VAR, @FIG and @TXT.
All descriptions should be put between relating blocks. These blocks must be escaped with # as follows:

#@VAR
...
#@VAR
#@FIG
#...
#@FIG
#TXT
#...
#TXT

3-1. Block @VAR

Tcl variables in namespace ::gCS are declared in this block.
Title, size of figure, names of strata etc. are declared here.

3-2. Block @FIG

All descriptions in this block must be escaped with #.
A columnar section is described using declared names of strata between @VAR.

3-3. Block @TXT

All descriptions in this block must be escaped with #.
All descriptions in this block are regarded as additional information.

4. Library list