Briq
/
camelot-py
6
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update CLI doc

pull/2/head
Vinayak Mehta 2018-09-14 02:58:04 +05:30
parent 5daf24ecb0
commit 3d2c9b5435
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/user/advanced.rst
View File

@ -51,7 +51,7 @@ Let's generate a plot for each geometry using this `PDF <_static/pdf/foo.pdf>`__
text 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 <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 :alt: A plot of all text on a PDF page
:align: left :align: left
.. _geometry_table: This, as we shall later see, is very helpful with :ref:`Stream <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 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" "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>`_. There might be cases where you want to differentiate between the text and superscripts and subscripts, like this `PDF <_static/pdf/superscript.pdf>`_.

6
docs/user/cli.rst
View File

@ -3,6 +3,10 @@
Command-line interface 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 $ camelot --help
@ -41,7 +45,7 @@ Command-line interface
length of detected lines. length of detected lines.
-copy, --copy_text [h|v] (with --mesh) Specify direction in which -copy, --copy_text [h|v] (with --mesh) Specify direction in which
text will be copied over in a spanning cell. 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. text in a spanning cell should flow.
-l, --line_close_tol INTEGER (with --mesh) Tolerance parameter used to -l, --line_close_tol INTEGER (with --mesh) Tolerance parameter used to
merge close vertical lines and close merge close vertical lines and close