{"_id":"wopr","_rev":"13-51c83a72d492d02ed4798b06dfff8a02","name":"wopr","time":{"modified":"2022-06-29T03:09:26.145Z","created":"2013-11-24T02:30:03.996Z","0.0.0":"2013-11-24T02:30:07.102Z","0.0.1":"2015-07-17T17:21:59.816Z","0.0.2":"2015-07-18T15:12:35.675Z","0.0.3":"2015-07-22T21:29:41.735Z","0.0.4":"2016-04-01T17:40:29.860Z","0.0.5":"2016-04-01T17:48:35.059Z"},"maintainers":[{"name":"yaron","email":"yaronn01@gmail.com"}],"dist-tags":{"latest":"0.0.5"},"readme":"# WOPR\r\n\r\nWOPR is a simple markup language for creating [rich terminal reports](https://github.com/yaronn/blessed-contrib), presentations and infographics.\r\n\r\nPut [a report](https://raw.githubusercontent.com/yaronn/wopr/master/examples/sample.xml) on the web (e.g. gist) and view it via curl:\r\n\r\n`````bash\r\n$> curl -N tty.zone/\\[0-2\\]\\?auto\\&cols=$((COLUMNS))\r\n`````\r\n(If you experience firewall issues replace tty.zone with ec2-23-21-64-152.compute-1.amazonaws.com or use a [local viewer](https://github.com/yaronn/wopr#viewing-reports))\r\n\r\nCreated by Yaron Naveh ([@YaronNaveh](https://twitter.com/YaronNaveh))\r\n\r\n![](./examples/images/charts.png \"term\")\r\n![](./examples/images/map.png \"term\")\r\n\r\n##Writing your first terminal report##\r\n\r\nHere is a simple report with a bar chart:\r\n\r\n`````xml\r\n\r\n \r\n - \r\n \r\n
\r\n \r\n\r\n`````\r\n\r\nYou have 3 options to view this report:\r\n\r\n**Option 1: POST it to the wopr online viewer**\r\n\r\n`````bash\r\n$> curl --data '- \r\n \r\n
\r\n - \r\n \r\n
\r\n \r\n\r\n`````\r\n\r\nHere, the bar widget is in the first column and row (0-based indexing) and spans three columns and rows.\r\nThe box element is in the same page but in a different position.\r\n\r\n\r\n**Widgets**\r\n\r\nThe available widgets are the ones that exist in the [blessed](https://github.com/chjj/blessed) and [blessed-contrib](https://github.com/yaronn/blessed-contrib) projects.\r\nYou can infer the xml representation of a javascript widget using a simple convention. Assume that you would instantiate some blessed widget with this javascript:\r\n\r\n`````javascript\r\nblessed.widget({ string: \"5\"\r\n , int: 1\r\n , intArray: [1,2,3]\r\n , stringArray: [\"a\", \"b\", \"c\"]\r\n , multiArray: [ [1,2,3], [4,5,6] ]\r\n , complexArray: [ {a: 1, b: [1,2] }, {a: 3, b: [3,4]} ]\r\n , object: { innerProp: 1, multiArray: [ [1,2], [3,4] ] }\r\n})\r\n`````\r\n\r\nThen here is how you would represent it in xml:\r\n \r\n`````xml\r\n\r\n \r\n 1,2,3\r\n 4,5,6\r\n \r\n \r\n 1,2\r\n 3,4\r\n \r\n \r\n \r\n \r\n \r\n\r\n`````\r\n\r\nYou can also look at the [demo xml](https://raw.githubusercontent.com/yaronn/wopr/master/examples/sample.xml) to get more samples.\r\n\r\n![](./examples/images/map.png \"term\")\r\n\r\n##Viewing Reports##\r\n\r\n\r\nDepending on how you use a report, you have a few ways to view it. On Windows you will probably only be able to use the third option and need to [install the fonts](http://webservices20.blogspot.com/2015/04/running-terminal-dashboards-on-windows.html) for best view.\r\n\r\n**Option 1: POST it to the wopr online viewer**\r\n\r\n`````bash\r\n$> curl --data '