From 3d2c9b5435d420fe40fa32ba1b5aacf807a40e05 Mon Sep 17 00:00:00 2001 From: Vinayak Mehta Date: Fri, 14 Sep 2018 02:58:04 +0530 Subject: [PATCH] Update CLI doc --- docs/user/advanced.rst | 10 ++++++---- docs/user/cli.rst | 6 +++++- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst index 70ff878..9f3f127 100644 --- a/docs/user/advanced.rst +++ b/docs/user/advanced.rst @@ -51,7 +51,7 @@ Let's generate a plot for each geometry using this `PDF <_static/pdf/foo.pdf>`__ text ^^^^ -Passing ``geometry_type=text`` creates a plot for all the text present on a PDF page. This, as we shall later see, is very helpful with :ref:`Stream `, when you have to choose specific table areas to parse or have to specify your own column separators in case the Stream method cannot guess them correctly. +Passing ``geometry_type=text`` creates a plot for all the text present on a PDF page. :: @@ -64,9 +64,11 @@ Passing ``geometry_type=text`` creates a plot for all the text present on a PDF :alt: A plot of all text on a PDF page :align: left -.. _geometry_table: +This, as we shall later see, is very helpful with :ref:`Stream `, for noting table areas and column separators, in case Stream cannot guess them correctly. -.. note:: As you can see in the image above, the *x-y* coordinates change as you move your mouse cursor, which will help you note coordinates for table areas and column separators. +.. note:: As you can see in the image above, the *x-y* coordinates change as you move your mouse cursor, which can help you note coordinates. + +.. _geometry_table: table ^^^^^ @@ -199,7 +201,7 @@ To deal with cases like the output from the previous section, you can pass ``spl "NUMBER","TYPE","DBA NAME","LICENSEE NAME","ADDRESS","CITY","ST","ZIP","PHONE NUMBER","EXPIRES" "...","...","...","...","...","...","...","...","...","..." -Flag subscripts and superscripts +Flag superscripts and subscripts -------------------------------- There might be cases where you want to differentiate between the text and superscripts and subscripts, like this `PDF <_static/pdf/superscript.pdf>`_. diff --git a/docs/user/cli.rst b/docs/user/cli.rst index bfacca0..59c3190 100644 --- a/docs/user/cli.rst +++ b/docs/user/cli.rst @@ -3,6 +3,10 @@ Command-line interface ====================== +Camelot comes with a command-line interface. + +You can print the help for the interface, by typing ``camelot --help`` in your favorite terminal, as shown below. + :: $ camelot --help @@ -41,7 +45,7 @@ Command-line interface length of detected lines. -copy, --copy_text [h|v] (with --mesh) Specify direction in which text will be copied over in a spanning cell. - -shift, --shift_text [l|r|t|b] (with --mesh) Specify direction in which + -shift, --shift_text [|l|r|t|b] (with --mesh) Specify direction in which text in a spanning cell should flow. -l, --line_close_tol INTEGER (with --mesh) Tolerance parameter used to merge close vertical lines and close