Filters/external-filters.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!--
   3
   4 This file allows you to use external programs to extract text from
   5 more structured file formats.  For example, you could use pdftotext to
   6 extract data from PDF files.  (Beagle includes a PDF filter, so this
   7 isn't necessary, but you get the idea.)
   8
   9 There are some limitations to this system: the external programs must
  10 take a filename on the command line and must output text to standard
  11 out.  You cannot extract any metadata using this system.  Using our
  12 PDF example, you could extract all of the text, but you couldn't
  13 extract the author of the document as a special field.  For that, you
  14 will have to write a more traditional filter.
  15
  16 Now, an example entry:
  17
  18 <filter>
  19   <mimetype>text/plain</mimetype>
  20   <extension>.txt</extension>
  21   <command>cat</command>
  22   <arguments>%s</arguments>
  23 </filter>
  24
  25 mimetype - The mime type handled by this filter.  You may have 0 or
  26 more of these for any filter.
  27
  28 extension - The file extension handled by this filter.  You may have 0
  29 or more of these for any filter.
  30
  31 command - The filename of the command to run.  Do not put any command
  32 line arguments in this.  This item is required.
  33
  34 arguments - Any arguments to pass into the given command.  The special
  35 token "%s" means the filename to be passed in.  This item is required.
  36 -->
  37
  38 <external-filters>
  39
  40 </external-filters>