odk/examples/python/DocumentHandling/README.md

   1 # Document Handling Examples
   2
   3 These examples are somehow similar to DocumentLoader in C++ and Java.
   4 To get started, first start LibreOffice listening on port 2083
   5
   6     $OFFICE_PROGRAM_PATH/soffice "--accept=socket,port=2083;urp;"
   7
   8 Each example script accepts `-h` to show the usage, e.g.
   9
  10     $OFFICE_PROGRAM_PATH/python DocumentLoader.py -h
  11
  12 You should use `setsdkenv_unix` for Unix/Linux and `setsdkenv_windows.bat` for
  13 Windows. In this way, the LibreOffice internal Python interpreter will be used.
  14
  15 ## Document Converter
  16
  17 ```bash
  18 $OFFICE_PROGRAM_PATH/python DocumentConverter.py ./tests/ "MS Word 97" doc /tmp/
  19 ```
  20
  21 This command searches LibreOffice documents recursively under directory
  22 `./tests` and convert every found document to format Microsoft Word 97. The
  23 converted document can be found under directory `/tmp`.
  24
  25 ## Document Loader
  26
  27 ```bash
  28 $OFFICE_PROGRAM_PATH/python DocumentLoader.py ./tests/hello.odt
  29 ```
  30
  31 This command opens document `./tests/hello.odt` in a separate window.
  32
  33 This script also accepts option to open an empty document. For example, to open
  34 an empty spreadsheet document:
  35
  36 ```bash
  37 $OFFICE_PROGRAM_PATH/python DocumentLoader.py --calc
  38 ```
  39
  40 ## Document Printer
  41
  42 ```bash
  43 $OFFICE_PROGRAM_PATH/python DocumentPrinter.py myprinter ./tests/hello.odt "1-3"
  44 ```
  45
  46 This command prints the first three pages of document `./tests/hello.odt` on
  47 printer `myprinter `. You can also specify the page range in various format,
  48 e.g. `1,3-5`.
  49
  50 ## Document Saver
  51
  52 ```bash
  53 $OFFICE_PROGRAM_PATH/python DocumentSaver.py path/to/hello.doc path/to/hello.odt
  54 ```
  55
  56 This command saves a Word document `hello.doc` as an OpenDocument file `hello.odt`.