... | ... | @@ -15,6 +15,70 @@ _Graßnick_ |
|
|
As `BraillePlot` is a [Java](https://www.oracle.com/java/) application, a Java Runtime Environment is required.
|
|
|
The minimum supported Java version is Java 11, so make sure, your JRE supports it.
|
|
|
|
|
|
## Command Line Interface
|
|
|
_Graßnick_
|
|
|
|
|
|
To run the `BraillePlot` application, run the following command:
|
|
|
|
|
|
``` bash
|
|
|
java -jar ${path_to_BraillePlot.jar}
|
|
|
```
|
|
|
|
|
|
|
|
|
This will show all supported parameters:
|
|
|
|
|
|
``` java
|
|
|
usage: BraillePlot [-b <arg>] -c <arg> -d <arg> [-f <arg>] [-h] [-i] [-l
|
|
|
<arg>] [-npw] -p <arg> [-s <arg>] -t <arg> [-v] [-x <arg>] [-y
|
|
|
<arg>]
|
|
|
Convert csv into braille
|
|
|
-b,--byte-dump <arg> Base file path for print data byte dump
|
|
|
file(s) (Omit '.bin' suffix)
|
|
|
-c,--csv-path <arg> Path to CSV
|
|
|
-d,--diagram-type <arg> Type of the diagram. Possible Values:
|
|
|
[ScatterPlot, LineChart, BarChart]
|
|
|
-f,--format <arg> Name of predefined format from
|
|
|
configuration (A4 portrait if not
|
|
|
specified)
|
|
|
-h,--help Print help and exit
|
|
|
-i,--inhibit-print Inhibit the printing process
|
|
|
-l,--log-level <arg> Logging output level. Possible Values:
|
|
|
[All, Trace, Debug, Info, Warn, Error,
|
|
|
Off] Defaults to 'Info'
|
|
|
-npw,--no-print-workaround Do not apply sleeptime workaround for
|
|
|
printer communication. Only has effect
|
|
|
on non-windows machines.
|
|
|
-p,--printer-config-path <arg> Path to printer configuration file
|
|
|
-s,--svg-export <arg> Base file path for export of svg file(s)
|
|
|
(Omit '.svg' suffix)
|
|
|
-t,--title <arg> Title of the diagram
|
|
|
-v,--vertical-csv Parse CSV in vertical instead of
|
|
|
horizontal orientation (Only applicable
|
|
|
for BarChart)
|
|
|
-x,--xLabel <arg> Label of X-axis including unit
|
|
|
-y,--yLabel <arg> Label of Y-axis including unit
|
|
|
```
|
|
|
|
|
|
In the following, there parameters will be described in detail.
|
|
|
`${arg}` evaluates to the parameter the user supplied.
|
|
|
|
|
|
|opt|long-opt|Has Argument|Required|Description|
|
|
|
|---|---|---|---|---|
|
|
|
|b|byte-dump|✔|✖|Write the final result (which can be send to the embosser) to a file. For each result page, a separate file with the name `${arg}_000.bin` to `${arg}_n.bin` will be created, where n is the number of result pages.|
|
|
|
|c|csv-path|✔|✔|The path to the CSV file, where the input data is stored (see [Input Data Files (CSV)](#input-data-files-(csv))).|
|
|
|
|d|diagram-type|✔|✔|The type of the diagram to generate. Possible values are `ScatterPlot`, `LineChart`, `BarChart`. Keep in mind that the CSV has to match the according specification as described in [Input Data Files (CSV)](#input-data-files-(csv)).|
|
|
|
|f|format|✔|✖|The name of the format to use. Must be defined in the format configuration (see [Configuration Files](#configuration-files)). Defaults to `A4`.|
|
|
|
|h|help|✖|✖|Print the included program usage information and terminate the program.|
|
|
|
|i|inhibit-print|✖|✖|Do not send any data to the embosser. Can be used for test runs when only creating previews via `--svg-export` or `--byte-dump`.|
|
|
|
|l|log-level|✔|✖|Set the logging level of the application. Possible values in increasing verbosity are: `Off`, `Error`, `Warn`, `Debug`, `Trace`, `All`. Defaults to `Info`.|
|
|
|
|npw|no-print-workaround|✖|✖|Do not use the implemented workaround on GNU/Linux and MacOS. As currently there are some internal problems when sending multiple large documents to the embosser, the workaround includes a forced waiting time of 100 seconds between sending each page to the embosser. Disable at own risk, documents may be malformatted.|
|
|
|
|p|printer-config-path|✔|✔|The path to the root configuration file (see [Configuration Files](#configuration-files)).|
|
|
|
|s|svg-export|✔|✖|Export a [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) based preview of the final embosser output. For each result page, a separate file with the name `${arg}_000.svg` to `${arg}_n.svg` will be created, where n is the number of result pages.|
|
|
|
|t|title|✔|✔|The title which will be embossed to each page that was created in this print job.|
|
|
|
|v|vertical-csv|✖|✖|Parse CSV in vertical instead of horizontal orientation (see [Input Data Files (CSV)](#input-data-files-(csv))).|
|
|
|
|x|x-Label|✔|✖|The description of the x-axis.|
|
|
|
|y|y-Label|✔|✖|The description of the y-axis.|
|
|
|
|
|
|
## Configuration Files
|
|
|
_Kupper_
|
|
|
|
... | ... | |