From: Ben Pfaff <blp@cs.stanford.edu>
Date: Fri, 31 Jul 2015 07:18:27 +0000 (-0700)
Subject: spv-file-format: Add more about file names.
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;ds=sidebyside;h=472ff71692f69577a4c20f07776413b559d795d8;p=pspp

spv-file-format: Add more about file names.
---

diff --git a/spv-file-format.texi b/spv-file-format.texi
index 663097c4be..5eae54df73 100644
--- a/spv-file-format.texi
+++ b/spv-file-format.texi
@@ -1,5 +1,5 @@
-@section SPSS Viewer Format
 @node SPSS Viewer Format
+@section SPSS Viewer Format
 
 SPSS Viewer or @file{.spv} files, here called SPV files, are written
 by SPSS 16 and later to represent the contents of its output editor.
@@ -22,45 +22,51 @@ new-line.
 The rest of the members in an SPV file's Zip archive fall into two
 categories: structure and details.  ``Structure'' member names begin
 with @file{outputViewer@var{nnnnnnnnnn}}, where each @var{n} is a
-decimal digit, and end with @file{.xml}.  Each of these members
-represents some kind of output item (a table, a heading, a block of
-text, etc.) or a group of them.  The member whose output goes at the
-beginning of the document is numbered 0, the next member in the output
-is numbered 1, and so on.
+decimal digit, and end with @file{.xml}, and often include the string
+@file{_heading} in between.  Each of these members represents some
+kind of output item (a table, a heading, a block of text, etc.) or a
+group of them.  The member whose output goes at the beginning of the
+document is numbered 0, the next member in the output is numbered 1,
+and so on.
 
 Structure members contain XML.  This XML is sometimes self-contained,
 but it often references other members in the Zip archive named as
 follows:
 
 @table @asis
-@item @file{*_table.xml} and @file{*_tableData.bin}
-@itemx @file{*_lightTableData.bin}
+@item @file{@var{prefix}_table.xml} and @file{@var{prefix}_tableData.bin}
+@itemx @file{@var{prefix}_lightTableData.bin}
 The structure of a table plus its data.  Older SPV files pair a
-@file{*_table.xml} file that describes the table's structure with a
-binary @file{*_tableData.bin} file that gives its data.  Newer SPV
-files (the majority of those in the corpus) instead include a single
-@file{*_lightTableData.bin} file that incorporates both into a single
-binary format.
+@file{@var{prefix}_table.xml} file that describes the table's
+structure with a binary @file{@var{prefix}_tableData.bin} file that
+gives its data.  Newer SPV files (the majority of those in the corpus)
+instead include a single @file{@var{prefix}_lightTableData.bin} file
+that incorporates both into a single binary format.
 
-@item @file{*_warning.xml} and @file{*_warningData.bin}
-@itemx @file{*_lightWarningData.bin}
+@item @file{@var{prefix}_warning.xml} and @file{@var{prefix}_warningData.bin}
+@itemx @file{@var{prefix}_lightWarningData.bin}
 Same format used for tables, with a different name.
 
-@item @file{*_notes.xml} and @file{*_notesData.bin}
-@itemx @file{*_lightNotesData.bin}
+@item @file{@var{prefix}_notes.xml} and @file{@var{prefix}_notesData.bin}
+@itemx @file{@var{prefix}_lightNotesData.bin}
 Same format used for tables, with a different name.
 
-@item @file{*_chartData.bin} and @file{*_chart.xml}
+@item @file{@var{prefix}_chartData.bin} and @file{@var{prefix}_chart.xml}
 The structure of a chart plus its data.  Charts do not have a
 ``light'' format.
 
-@item *_model.xml
-@itemx *_pmml.xml
-@itemx *_stats.xml
+@item @var{prefix}_model.xml
+@itemx @var{prefix}_pmml.xml
+@itemx @var{prefix}_stats.xml
 Not yet investigated.  The corpus contains only one example of each.
 @end table
 
-The @file{*} in the names of these members is typically an 11-digit
-decimal number that increases for each item, tending to skip values.
-Older files use different naming convention, and the exact names do
-not appear to matter as long as they are unique.
+The @file{@var{prefix}} in the names of the detail members is
+typically an 11-digit decimal number that increases for each item,
+tending to skip values.  Older SPV files use different naming
+conventions.  Structure member refer to detail members by name, and so
+their exact names do not appear to matter as long as they are unique.
+
+@node SPV Structure Member Format
+@subsection Structure Member Format
+