odf2xml.docbook 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. <?xml version="1.0"?>
  2. <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
  3. <refentry id="odf2xml">
  4. <refentryinfo>
  5. <productname>odfpy</productname>
  6. <author><firstname>Søren</firstname><surname>Roug</surname>
  7. <contrib>Original author</contrib>
  8. </author>
  9. </refentryinfo>
  10. <refmeta>
  11. <refentrytitle>odf2xml</refentrytitle>
  12. <manvolnum>1</manvolnum>
  13. <refmiscinfo class="manual">User commands</refmiscinfo>
  14. </refmeta>
  15. <refnamediv>
  16. <refname>odf2xml</refname>
  17. <refpurpose>Create OpenDocument XML file from OD? package</refpurpose>
  18. </refnamediv>
  19. <refsynopsisdiv>
  20. <cmdsynopsis>
  21. <command>odf2xml</command>
  22. <arg choice="opt">-e </arg>
  23. <arg choice="opt">-o <replaceable>outputfile</replaceable></arg>
  24. <arg choice="opt">
  25. <replaceable>inputfile</replaceable>
  26. </arg>
  27. </cmdsynopsis>
  28. </refsynopsisdiv>
  29. <refsect1>
  30. <title>Description</title>
  31. <para>
  32. OpenDocument can be a complete office document in a single
  33. XML file. The script will take an OpenDocument and create an XML file
  34. This is mainly useful XML processors such as XSL transformation.
  35. </para>
  36. <para>
  37. </para>
  38. <para>
  39. "Inputfile" is assumed to be an OpenDocument file.
  40. If there is no inputfile, the program will read from standard input.
  41. </para>
  42. </refsect1>
  43. <refsect1>
  44. <title>Options</title>
  45. <variablelist>
  46. <varlistentry>
  47. <term>-e</term>
  48. <listitem>
  49. <para>
  50. Normally, images that are stored in the archive in the Pictures folder are ignored.
  51. Using the -e flag will <emphasis>embed</emphasis> the images in the XML as base64.
  52. </para>
  53. </listitem>
  54. </varlistentry>
  55. <varlistentry>
  56. <term>-o <replaceable>outputfile</replaceable></term>
  57. <listitem>
  58. <para>
  59. If output file is not specified output will be to standard out.
  60. </para>
  61. </listitem>
  62. </varlistentry>
  63. </variablelist>
  64. </refsect1>
  65. <refsect1>
  66. <title>Example</title>
  67. <screen>
  68. odf2xml -o file.xml testdocument.odt
  69. </screen>
  70. </refsect1>
  71. <refsect1>
  72. <title>See Also</title>
  73. <para><command>xml2odf</command>(1)
  74. </para>
  75. </refsect1>
  76. <refsect1>
  77. <title>Bugs</title>
  78. <para>
  79. Doesn't handle external data -- images and such.
  80. </para>
  81. </refsect1>
  82. </refentry>