Jump to content

Kexi/Plugins/Reports/CLI Export

From KDE Community Wiki
Revision as of 11:07, 10 August 2015 by Jstaniek (talk | contribs) (Created page with "Design document. Details: *Started: ~~~~ *{{wish|????}} *Target: 2.9.7 *Status: UNASSIGNED Add command line (CLI) support for exporting Kexi Reports. General command line s...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Design document.

Details:

Add command line (CLI) support for exporting Kexi Reports.

General command line schema:

kexi --export report:NAME [--format=FORMAT] [--overwrite] [--open-after-export]

Where:

  • NAME - report name (not caption), required
  • FORMAT: One of PDF, ODT, ODS, HTML, OLDHTML. Case-insensitive.
    • The default format is PDF
    • ODT means OpenDocument Text (available is Kexi has support for handling this format installed)
    • ODS means OpenDocument Sheet (available is Kexi has support for handling this format installed)
    • HTML means HTML web page with use of CSS and DIV elements
    • OLDHTML means a traditional HTML web page with use of TABLE elements
  • --overwrite - if the destination file exists, overwrite it; off by default
  • --open-after-export - open associated file viewer after a successful export, e.g. for HTML web browser is used

[PDF|ODT|ODS|HTML|RAWHTML[PDF|ODT|ODS|HTML|RAWHTML** HTML means

Requirements

  • Do not require any interaction
  • Support sane defaults

TODOs

  • Nice to have: support export of multiple reports in one go by specifying: report:NAME1,NAME2,....