git @ Cat's Eye Technologies Lexeduct / gh-pages
Merge branch 'gh-pages' of https://github.com/catseye/Lexeduct into gh-pages Chris Pressey 6 years ago
2 changed file(s) with 4 addition(s) and 4 deletion(s). Raw diff Collapse all Expand all
1212 <section class="page-header">
1313 <h1 class="project-name">Lexeduct</h1>
1414 <h2 class="project-tagline">Experimental framework for text-processing pipelines in JS (node or browser)</h2>
15 <a href="in-browser/" class="btn">Try it Online!</a>
1615 <a href="https://github.com/catseye/Lexeduct" class="btn">View on GitHub</a>
1716 <a href="https://github.com/catseye/Lexeduct/zipball/master" class="btn">Download .zip</a>
1817 <a href="https://github.com/catseye/Lexeduct/tarball/master" class="btn">Download .tar.gz</a>
2120 <section class="main-content">
2221 <h1>
2322 <a id="lexeduct" class="anchor" href="#lexeduct" aria-hidden="true"><span class="octicon octicon-link"></span></a>Lexeduct</h1>
23
24 <p><strong>You can try Lexeduct live in your web browser here: <a href="http://catseye.github.io/Lexeduct/in-browser/">Lexeduct Online</a></strong></p>
2425
2526 <blockquote>
2627 <p>"this is not a wheel I've re-invented before"</p>
109110
110111 <p>The module may also export a couple of other things, like an English description
111112 of the transformer, and the possible configuration options. For a reasonably
112 simple example, see the source of the <code>upper</code> transformer, found
113 in <a href="src/transformers/upper.js">src/transformers/upper.js</a>.</p>
113 simple example, see the source of the <code>upper</code> transformer, in <a href="https://github.com/catseye/Lexeduct/blob/master/src/transformers/upper.js">upper.js</a>.</p>
114114
115115 <p>State deposited into the state object is shared by all transformers, so it's
116116 a good idea to choose a key that you think will probably be unique.</p>
0 {"name":"Lexeduct","tagline":"Experimental framework for text-processing pipelines in JS (node or browser)","body":"Lexeduct\r\n========\r\n\r\n> \"this is not a wheel I've re-invented before\"\r\n\r\n**Lexeduct** is an experimental framework for text-processing pipelines,\r\nwritten in Javascript, usable both on the console under [Node.js][], and\r\nin a web browser.\r\n\r\nIt is currently a work in progress. The framework and usage and everything\r\nis subject to change without notice. The version number is nominally 0.1-PRE;\r\nthere is not yet a released version.\r\n\r\nBeing a framework, Lexeduct inevitably handles some use cases well, and other\r\nuse cases poorly. See the \"Limitations\" section below for more details.\r\n\r\nThe name \"Lexeduct\" is in analogy with \"aqueduct\": conduits for words intead\r\nof water.\r\n\r\nBasic Usage\r\n-----------\r\n\r\nThe main tool is `lexeduct.js`. You can `cd` into the `src` directory and run\r\nit as `./lexeduct.js`, or you can put the `src` directory on your executable\r\nsearch path, for example like\r\n\r\n export PATH=$PATH:/path/to/lexeduct/src\r\n\r\nand run it as `lexeduct.js` from anywhere on your system. (YMMV on Windows.)\r\n\r\nThe basic usage is\r\n\r\n lexeduct.js {param=value|transformer-name}\r\n\r\nSo, for example,\r\n\r\n $ echo 'Hello!' | lexeduct.js upper\r\n HELLO\r\n\r\nParameters can be given with the syntax `name=value` before the name of the\r\ntransformer they are to be applied to:\r\n\r\n $ echo 'Hello' | lexeduct.js chars=e remove-chars\r\n Hllo\r\n\r\nYou can of course use shell pipelines to compose transformers:\r\n\r\n $ echo 'Hello!' | lexeduct.js upper | lexeduct.js chars=' ' insert-chars\r\n H E L L O !\r\n\r\n*Or* you can name multiple transformers on `lexeduct.js`'s command line to\r\ncompose them:\r\n\r\n $ echo 'Hello!' | lexeduct.js upper chars=' ' insert-chars\r\n H E L L O !\r\n\r\nMultiple transformers are applied left-to-right.\r\n\r\n $ echo 'Hello!' | lexeduct.js chars=a insert-chars upper\r\n HAEALALAOA!A\r\n\r\n $ echo 'Hello!' | lexeduct.js upper chars=a insert-chars\r\n HaEaLaLaOa!a\r\n\r\nTransformers\r\n------------\r\n\r\nThe idea is that this repository will eventually contain a giant catalogue\r\nof possible text transformers that can be composed. Or at least, more than\r\nare presently included.\r\n\r\nEach transformer is in a seperate Javascript file in the `src/transformers`\r\ndirectory which exports, node-style, a single function called `makeTransformer`\r\nwhich takes a configuration object and returns a transformer function. The\r\ntransformer function takes two arguments: the current string to process, and\r\n(optionally) an object which can be used to store ancillary state. Every\r\ntransformer function should return either a string, or null (not yet supported),\r\nor an array of strings (not yet supported.)\r\n\r\nThe module may also export a couple of other things, like an English description\r\nof the transformer, and the possible configuration options. For a reasonably\r\nsimple example, see the source of the `upper` transformer, found\r\nin [src/transformers/upper.js](src/transformers/upper.js).\r\n\r\nState deposited into the state object is shared by all transformers, so it's\r\na good idea to choose a key that you think will probably be unique.\r\n\r\nIn-Browser Version\r\n------------------\r\n\r\nRun `./make.sh` from this directory (or the commands it contains) to generate\r\na Javascript file which contains all the available transformers in a format\r\nsuitable for loading in an HTML document.\r\n\r\nThen open `demo/lexeduct.html` in your browser. It provides a UI for composing\r\nthese transformers and applying them to text provided in a textarea.\r\n\r\nAcknowledgements\r\n----------------\r\n\r\nLexeduct was partly inspired by, and is partly a product of parallel evolution\r\nresembling, [Michael Paulukonis][]'s [TextMunger][]. It is also indebted to\r\nvarious and sundry discussion with him, and others on the\r\n[GenerativeText Forum][], particularly [John Ohno][].\r\n\r\n[Node.js]: https://nodejs.org/\r\n[Michael Paulukonis]: https://github.com/MichaelPaulukonis/\r\n[TextMunger]: https://github.com/MichaelPaulukonis/text-munger\r\n[GenerativeText Forum]: https://groups.google.com/forum/#!forum/generativetext\r\n[John Ohno]: https://github.com/enkiv2/\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
0 {"name":"Lexeduct","tagline":"Experimental framework for text-processing pipelines in JS (node or browser)","body":"Lexeduct\r\n========\r\n\r\n**You can try Lexeduct live in your web browser here: [Lexeduct Online][]**\r\n\r\n> \"this is not a wheel I've re-invented before\"\r\n\r\n**Lexeduct** is an experimental framework for text-processing pipelines,\r\nwritten in Javascript, usable both on the console under [Node.js][], and\r\nin a web browser.\r\n\r\nIt is currently a work in progress. The framework and usage and everything\r\nis subject to change without notice. The version number is nominally 0.1-PRE;\r\nthere is not yet a released version.\r\n\r\nBeing a framework, Lexeduct inevitably handles some use cases well, and other\r\nuse cases poorly. See the \"Limitations\" section below for more details.\r\n\r\nThe name \"Lexeduct\" is in analogy with \"aqueduct\": conduits for words intead\r\nof water.\r\n\r\nBasic Usage\r\n-----------\r\n\r\nThe main tool is `lexeduct.js`. You can `cd` into the `src` directory and run\r\nit as `./lexeduct.js`, or you can put the `src` directory on your executable\r\nsearch path, for example like\r\n\r\n export PATH=$PATH:/path/to/lexeduct/src\r\n\r\nand run it as `lexeduct.js` from anywhere on your system. (YMMV on Windows.)\r\n\r\nThe basic usage is\r\n\r\n lexeduct.js {param=value|transformer-name}\r\n\r\nSo, for example,\r\n\r\n $ echo 'Hello!' | lexeduct.js upper\r\n HELLO\r\n\r\nParameters can be given with the syntax `name=value` before the name of the\r\ntransformer they are to be applied to:\r\n\r\n $ echo 'Hello' | lexeduct.js chars=e remove-chars\r\n Hllo\r\n\r\nYou can of course use shell pipelines to compose transformers:\r\n\r\n $ echo 'Hello!' | lexeduct.js upper | lexeduct.js chars=' ' insert-chars\r\n H E L L O !\r\n\r\n*Or* you can name multiple transformers on `lexeduct.js`'s command line to\r\ncompose them:\r\n\r\n $ echo 'Hello!' | lexeduct.js upper chars=' ' insert-chars\r\n H E L L O !\r\n\r\nMultiple transformers are applied left-to-right.\r\n\r\n $ echo 'Hello!' | lexeduct.js chars=a insert-chars upper\r\n HAEALALAOA!A\r\n\r\n $ echo 'Hello!' | lexeduct.js upper chars=a insert-chars\r\n HaEaLaLaOa!a\r\n\r\nTransformers\r\n------------\r\n\r\nThe idea is that this repository will eventually contain a giant catalogue\r\nof possible text transformers that can be composed. Or at least, more than\r\nare presently included.\r\n\r\nEach transformer is in a seperate Javascript file in the `src/transformers`\r\ndirectory which exports, node-style, a single function called `makeTransformer`\r\nwhich takes a configuration object and returns a transformer function. The\r\ntransformer function takes two arguments: the current string to process, and\r\n(optionally) an object which can be used to store ancillary state. Every\r\ntransformer function should return either a string, or null (not yet supported),\r\nor an array of strings (not yet supported.)\r\n\r\nThe module may also export a couple of other things, like an English description\r\nof the transformer, and the possible configuration options. For a reasonably\r\nsimple example, see the source of the `upper` transformer, in [upper.js][].\r\n\r\nState deposited into the state object is shared by all transformers, so it's\r\na good idea to choose a key that you think will probably be unique.\r\n\r\nIn-Browser Version\r\n------------------\r\n\r\nRun `./make.sh` from this directory (or the commands it contains) to generate\r\na Javascript file which contains all the available transformers in a format\r\nsuitable for loading in an HTML document.\r\n\r\nThen open `demo/lexeduct.html` in your browser. It provides a UI for composing\r\nthese transformers and applying them to text provided in a textarea.\r\n\r\nAcknowledgements\r\n----------------\r\n\r\nLexeduct was partly inspired by, and is partly a product of parallel evolution\r\nresembling, [Michael Paulukonis][]'s [TextMunger][]. It is also indebted to\r\nvarious and sundry discussion with him, and others on the\r\n[GenerativeText Forum][], particularly [John Ohno][].\r\n\r\n[Lexeduct Online]: http://catseye.github.io/Lexeduct/in-browser/\r\n[Node.js]: https://nodejs.org/\r\n[upper.js]: https://github.com/catseye/Lexeduct/blob/master/src/transformers/upper.js\r\n[Michael Paulukonis]: https://github.com/MichaelPaulukonis/\r\n[TextMunger]: https://github.com/MichaelPaulukonis/text-munger\r\n[GenerativeText Forum]: https://groups.google.com/forum/#!forum/generativetext\r\n[John Ohno]: https://github.com/enkiv2/\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}