diff --git a/site/htdocs/doc/index.html b/site/htdocs/doc/index.html index 38d9178d1..f411bf7ea 100644 --- a/site/htdocs/doc/index.html +++ b/site/htdocs/doc/index.html @@ -352,33 +352,33 @@ v306 -> v305 [label = "B"]; v305 -> v302 [label = "A, B"]; } -

The Command Line Interface

usage: collatex []
-        ( |   [[] ...])
--a,--algorithm                     progressive alignment algorithm to
+

The Command Line Interface

usage: collatex [<options>]
+                (<json_input> | <witness_1> <witness_2> [[<witness_3>] ...])
+  -a,--algorithm <arg>                    progressive alignment algorithm to
                                           use 'dekker' (default), 'medite',
                                           'needleman-wunsch'
--cp,--context-path                 URL base/context path of the
+  -cp,--context-path <arg>                URL base/context path of the
                                           service, default: '/'
--dot,--dot-path                    path to Graphviz 'dot',
+  -dot,--dot-path <arg>                   path to Graphviz 'dot',
                                           auto-detected by default
--f,--format                        result/output format: 'json', 'csv',
+  -f,--format <arg>                       result/output format: 'json', 'csv',
                                           'dot', 'graphml', 'tei'
--h,--help                               print usage instructions
-  -ie,--input-encoding               charset to use for decoding non-XML
+  -h,--help                               print usage instructions
+  -ie,--input-encoding <arg>              charset to use for decoding non-XML
                                           witnesses; default: UTF-8
-  -mcs,--max-collation-size          maximum number of characters
+  -mcs,--max-collation-size <arg>         maximum number of characters
                                           (counted over all witnesses) to
                                           perform collations on, default:
                                           unlimited
-  -mpc,--max-parallel-collations     maximum number of collations to
+  -mpc,--max-parallel-collations <arg>    maximum number of collations to
                                           perform in parallel, default: 2
-  -o,--output                        output file; '-' for standard output
+  -o,--output <arg>                       output file; '-' for standard output
                                           (default)
-  -oe,--output-encoding              charset to use for encoding the
+  -oe,--output-encoding <arg>             charset to use for encoding the
                                           output; default: UTF-8
-  -p,--port                          HTTP port to bind server to,
+  -p,--port <arg>                         HTTP port to bind server to,
                                           default: 7369
-  -s,--script                        ECMA/JavaScript resource with
+  -s,--script <arg>                       ECMA/JavaScript resource with
                                           functions to be plugged into the
                                           alignment algorithm
   -S,--http                               start RESTful HTTP server
@@ -386,10 +386,9 @@
                                           *not* be joined to segments
   -xml,--xml-mode                         witnesses are treated as XML
                                           documents
-  -xp,--xpath                        XPath 1.0 expression evaluating to
+  -xp,--xpath <arg>                       XPath 1.0 expression evaluating to
                                           tokens of XML witnesses; default:
-                                          '//text()'
-                                          

ECMA/JavaScript Callbacks

The RESTful Web Service

java -jar collatex-tools-1.6.jar --http

The CollateX service is callable via + '//text()'

ECMA/JavaScript Callbacks

The RESTful Web Service

java -jar collatex-tools-1.6.jar --http

The CollateX service is callable via HTTP POST requests to /collate.

It expects input formatted in JavaScript Object Notation (JSON) as the request body; diff --git a/site/templates/doc/index.jade b/site/templates/doc/index.jade index 794ee96b8..13932960a 100644 --- a/site/templates/doc/index.jade +++ b/site/templates/doc/index.jade @@ -612,44 +612,8 @@ block content h2#cli The Command Line Interface - pre.prettyprint.lang-xml. - usage: collatex [] - ( | [[] ...]) - -a,--algorithm progressive alignment algorithm to - use 'dekker' (default), 'medite', - 'needleman-wunsch' - -cp,--context-path URL base/context path of the - service, default: '/' - -dot,--dot-path path to Graphviz 'dot', - auto-detected by default - -f,--format result/output format: 'json', 'csv', - 'dot', 'graphml', 'tei' - -h,--help print usage instructions - -ie,--input-encoding charset to use for decoding non-XML - witnesses; default: UTF-8 - -mcs,--max-collation-size maximum number of characters - (counted over all witnesses) to - perform collations on, default: - unlimited - -mpc,--max-parallel-collations maximum number of collations to - perform in parallel, default: 2 - -o,--output output file; '-' for standard output - (default) - -oe,--output-encoding charset to use for encoding the - output; default: UTF-8 - -p,--port HTTP port to bind server to, - default: 7369 - -s,--script ECMA/JavaScript resource with - functions to be plugged into the - alignment algorithm - -S,--http start RESTful HTTP server - -t,--tokenized consecutive matches of tokens will - *not* be joined to segments - -xml,--xml-mode witnesses are treated as XML - documents - -xp,--xpath XPath 1.0 expression evaluating to - tokens of XML witnesses; default: - '//text()' + pre.prettyprint.lang-xml + include ./usage-instructions.txt h3#cli-js-callbacks ECMA/JavaScript Callbacks diff --git a/site/templates/doc/usage-instructions.txt b/site/templates/doc/usage-instructions.txt new file mode 100644 index 000000000..12d4354f1 --- /dev/null +++ b/site/templates/doc/usage-instructions.txt @@ -0,0 +1,37 @@ +usage: collatex [<options>] + (<json_input> | <witness_1> <witness_2> [[<witness_3>] ...]) + -a,--algorithm <arg> progressive alignment algorithm to + use 'dekker' (default), 'medite', + 'needleman-wunsch' + -cp,--context-path <arg> URL base/context path of the + service, default: '/' + -dot,--dot-path <arg> path to Graphviz 'dot', + auto-detected by default + -f,--format <arg> result/output format: 'json', 'csv', + 'dot', 'graphml', 'tei' + -h,--help print usage instructions + -ie,--input-encoding <arg> charset to use for decoding non-XML + witnesses; default: UTF-8 + -mcs,--max-collation-size <arg> maximum number of characters + (counted over all witnesses) to + perform collations on, default: + unlimited + -mpc,--max-parallel-collations <arg> maximum number of collations to + perform in parallel, default: 2 + -o,--output <arg> output file; '-' for standard output + (default) + -oe,--output-encoding <arg> charset to use for encoding the + output; default: UTF-8 + -p,--port <arg> HTTP port to bind server to, + default: 7369 + -s,--script <arg> ECMA/JavaScript resource with + functions to be plugged into the + alignment algorithm + -S,--http start RESTful HTTP server + -t,--tokenized consecutive matches of tokens will + *not* be joined to segments + -xml,--xml-mode witnesses are treated as XML + documents + -xp,--xpath <arg> XPath 1.0 expression evaluating to + tokens of XML witnesses; default: + '//text()' \ No newline at end of file