pintos-os.org Git - pspp/blob - spv-file-format.texi

   1 @node SPSS Viewer Format
   2 @section SPSS Viewer Format
   3
   4 SPSS Viewer or @file{.spv} files, here called SPV files, are written
   5 by SPSS 16 and later to represent the contents of its output editor.
   6 This section documents the format.  This description is detailed
   7 enough to read SPV files, but it is probably not sufficient to
   8 write them.
   9
  10 An an aside, SPSS 15 and earlier versions use a completely different
  11 output format based on the Microsoft Compound Document Format.  This
  12 format is not documented.
  13
  14 An SPV file is a Zip archive that can be read with @command{zipinfo}
  15 and @command{unzip} and similar programs.  The final member in the Zip
  16 archive is a file named @file{META-INF/MANIFEST.MF}.  This structure
  17 makes SPV files resemble Java ``JAR'' files, but whereas a JAR
  18 manifest contains a sequence of colon-delimited key/value pairs, an
  19 SPV manifest contains the string @samp{allowPivoting=true}, without a
  20 new-line.
  21
  22 The rest of the members in an SPV file's Zip archive fall into two
  23 categories: structure and details.  ``Structure'' member names begin
  24 with @file{outputViewer@var{nnnnnnnnnn}}, where each @var{n} is a
  25 decimal digit, and end with @file{.xml}, and often include the string
  26 @file{_heading} in between.  Each of these members represents some
  27 kind of output item (a table, a heading, a block of text, etc.) or a
  28 group of them.  The member whose output goes at the beginning of the
  29 document is numbered 0, the next member in the output is numbered 1,
  30 and so on.
  31
  32 Structure members contain XML.  This XML is sometimes self-contained,
  33 but it often references other members in the Zip archive named as
  34 follows:
  35
  36 @table @asis
  37 @item @file{@var{prefix}_table.xml} and @file{@var{prefix}_tableData.bin}
  38 @itemx @file{@var{prefix}_lightTableData.bin}
  39 The structure of a table plus its data.  Older SPV files pair a
  40 @file{@var{prefix}_table.xml} file that describes the table's
  41 structure with a binary @file{@var{prefix}_tableData.bin} file that
  42 gives its data.  Newer SPV files (the majority of those in the corpus)
  43 instead include a single @file{@var{prefix}_lightTableData.bin} file
  44 that incorporates both into a single binary format.
  45
  46 @item @file{@var{prefix}_warning.xml} and @file{@var{prefix}_warningData.bin}
  47 @itemx @file{@var{prefix}_lightWarningData.bin}
  48 Same format used for tables, with a different name.
  49
  50 @item @file{@var{prefix}_notes.xml} and @file{@var{prefix}_notesData.bin}
  51 @itemx @file{@var{prefix}_lightNotesData.bin}
  52 Same format used for tables, with a different name.
  53
  54 @item @file{@var{prefix}_chartData.bin} and @file{@var{prefix}_chart.xml}
  55 The structure of a chart plus its data.  Charts do not have a
  56 ``light'' format.
  57
  58 @item @var{prefix}_model.xml
  59 @itemx @var{prefix}_pmml.xml
  60 @itemx @var{prefix}_stats.xml
  61 Not yet investigated.  The corpus contains only one example of each.
  62 @end table
  63
  64 The @file{@var{prefix}} in the names of the detail members is
  65 typically an 11-digit decimal number that increases for each item,
  66 tending to skip values.  Older SPV files use different naming
  67 conventions.  Structure member refer to detail members by name, and so
  68 their exact names do not appear to matter as long as they are unique.
  69
  70 @node SPV Structure Member Format
  71 @subsection Structure Member Format
  72