https://github.com/docelic/tcs_chart
https://github.com/docelic/tcs_chart
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/docelic/tcs_chart
- Owner: docelic
- Created: 2018-09-01T09:10:21.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-05T17:20:25.000Z (almost 8 years ago)
- Last Synced: 2025-03-30T18:48:37.774Z (about 1 year ago)
- Language: HTML
- Size: 153 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tox Client Standard (TCS) - Compliance Data and Chart Generator
Tox TCS is located at: https://tox.gitbooks.io/tox-client-standard/content/index.html.
## Introduction
TCS points have been converted to parsable JSON format and stored in `tcs_points.json`.
Tox software's compliance sheets are found in `tox_software/*.json`.
When `generate.pl` is run with default options, it reads both and prints a complete compliance chart, in HTML format, to STDOUT.
Please run `./generate.pl -h` for all command line options and variations of this basic process.
Users will most likely want to configure options "output file" (`-o`), and possibly "point condition" (`-pc`) and "software condition" (`-sc`).
The first one configures the output file; the other two specify which subset of TCS points and/or software should be included in the report.
Using options `-pc` or `-sc` requires at least minimal familiarity with Perl. In both options, variable `$x` is a hash reference of the item being examined. Arbitrary Perl code can be run, and the item will be included in the output if the code block ends with a true value.
## Usage
```
# Basic usage, complete table is printed as HTML to STDOUT
./generate.pl # (or perl generate.pl)
# Dump complete table to file /tmp/chart.html
./generate.pl -o /tmp/chart.html
# Only include Tox software of type "client" into the chart:
./generate.pl -sc '$$x{type} eq "client"'
# Show only TCS points from section "2", and only software which
# is compliant with TCS point 1.0.1 or contains regular expression "ox"
# in its full name:
./generate.pl -pc '$$x{name} =~ /^2/' -sc '$$x{points}{"1.0.1"}{compliant} || $$x{name} =~ /ox/'
# Use option -pc or -sc to quickly dump the structure of element $x
./generate.pl -pc 'print Dumper $x; exit'
# or
./generate.pl -pc 'print $json->encode($x); exit'
```
## HTML Output
The chart-like HTML output has been optimized for easy examination.
All items in the header column and header row (TCS points and software names) contain a tooltip with more information as well as a link to the relevant web page.
All data cells contain tooltips which repeat in plain text the visual representation visible in the chart. They also contain an explanation why a certain TCS point is required, recommended, or not-applicable, and also they include any free-form comments or notes added by the submitter or reviewer of the particular cell's data.
Example of the output can be previewed at https://hcoop.net/~docelic/tcs_full.html