1 @node SPSS Viewer File Format
2 @chapter SPSS Viewer File Format
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 chapter documents the format, based on examination of a corpus of
7 about 500 files from a variety of sources. This description is
8 detailed enough to read SPV files, but probably not enough to write
11 SPSS 15 and earlier versions use a completely different output format
12 based on the Microsoft Compound Document Format. This format is not
15 An SPV file is a Zip archive that can be read with @command{zipinfo}
16 and @command{unzip} and similar programs. The final member in the Zip
17 archive is a file named @file{META-INF/MANIFEST.MF}. This structure
18 makes SPV files resemble Java ``JAR'' files (and ODF files), but
19 whereas a JAR manifest contains a sequence of colon-delimited
20 key/value pairs, an SPV manifest contains the string
21 @samp{allowPivoting=true}, without a new-line. (This string may be
22 the best way to identify an SPV file; it is invariant across the
25 The rest of the members in an SPV file's Zip archive fall into two
26 categories: @dfn{structure} and @dfn{detail} members. Structure
27 member names begin with @file{outputViewer@var{nnnnnnnnnn}}, where
28 each @var{n} is a decimal digit, and end with @file{.xml}, and often
29 include the string @file{_heading} in between. Each of these members
30 represents some kind of output item (a table, a heading, a block of
31 text, etc.) or a group of them. The member whose output goes at the
32 beginning of the document is numbered 0, the next member in the output
33 is numbered 1, and so on.
35 Structure members contain XML. This XML is sometimes self-contained,
36 but it often references detail members in the Zip archive, which are
40 @item @file{@var{prefix}_table.xml} and @file{@var{prefix}_tableData.bin}
41 @itemx @file{@var{prefix}_lightTableData.bin}
42 The structure of a table plus its data. Older SPV files pair a
43 @file{@var{prefix}_table.xml} file that describes the table's
44 structure with a binary @file{@var{prefix}_tableData.bin} file that
45 gives its data. Newer SPV files (the majority of those in the corpus)
46 instead include a single @file{@var{prefix}_lightTableData.bin} file
47 that incorporates both into a single binary format.
49 @item @file{@var{prefix}_warning.xml} and @file{@var{prefix}_warningData.bin}
50 @itemx @file{@var{prefix}_lightWarningData.bin}
51 Same format used for tables, with a different name.
53 @item @file{@var{prefix}_notes.xml} and @file{@var{prefix}_notesData.bin}
54 @itemx @file{@var{prefix}_lightNotesData.bin}
55 Same format used for tables, with a different name.
57 @item @file{@var{prefix}_chartData.bin} and @file{@var{prefix}_chart.xml}
58 The structure of a chart plus its data. Charts do not have a
61 @item @file{@var{prefix}_pmml.scf}
62 @itemx @file{@var{prefix}_stats.scf}
63 @item @file{@var{prefix}_model.xml}
64 Not yet investigated. The corpus contains few examples.
67 The @file{@var{prefix}} in the names of the detail members is
68 typically an 11-digit decimal number that increases for each item,
69 tending to skip values. Older SPV files use different naming
70 conventions. Structure member refer to detail members by name, and so
71 their exact names do not matter to readers as long as they are unique.
74 * SPV Structure Member Format::
75 * SPV Light Detail Member Format::
76 * SPV Legacy Detail Member Binary Format::
77 * SPV Legacy Detail Member XML Format::
80 @node SPV Structure Member Format
81 @section Structure Member Format
83 Structure members' XML files claim conformance with a collection of
84 XML Schemas. These schemas are distributed, under a nonfree license,
85 with SPSS binaries. Fortunately, the schemas are not necessary to
86 understand the structure members. To a degree, the schemas can even
87 be deceptive because they document elements and attributes that are
88 not in the corpus and do not document elements and attributes that are
91 Structure members use a different XML namespace for each schema, but
92 these namespaces are not entirely consistent. In some SPV files, for
93 example, the @code{viewer-tree} schema is associated with namespace
94 @indicateurl{http://xml.spss.com/spss/viewer-tree} and in others with
95 @indicateurl{http://xml.spss.com/spss/viewer/viewer-tree} (note the
96 additional @file{viewer/}). Under either name, the schema URIs are
97 not resolvable to obtain the schemas themselves.
99 One may ignore all of the above in interpreting a structure member.
100 The actual XML has a simple and straightforward form that does not
101 require a reader to take schemas or namespaces into account.
103 The elements found in structure members are documented below. For
104 each element, we note the possible parent elements and the element's
105 contents. The contents are specified as pseudo-regular expressions
106 with the following conventions:
119 Grouping multiple elements.
124 @item @var{a} @math{|} @var{b}
125 A choice between @var{a} and @var{b}.
128 Zero or more @var{x}.
132 For a diagram illustrating the hierarchy of elements within an SPV
133 structure member, please refer to a PDF version of the manual.
137 The following diagram shows the hierarchy of elements within an SPV
138 structure member. Edges point from parent to child elements.
139 Unlabeled edges indicate that the child appears exactly once; edges
140 labeled with *, zero or more times; edges labeled with ?, zero or one
142 @center @image{dev/spv-structure, 5in}
146 * SPV Structure heading Element::
147 * SPV Structure label Element::
148 * SPV Structure container Element::
149 * SPV Structure text Element (Inside @code{container})::
150 * SPV Structure html Element::
151 * SPV Structure table Element::
152 * SPV Structure tableStructure Element::
153 * SPV Structure dataPath Element::
154 * SPV Structure pageSetup Element::
155 * SPV Structure pageHeader and pageFooter Elements::
156 * SPV Structure pageParagraph Element::
157 * SPV Structure @code{text} Element (Inside @code{pageParagraph})::
160 @node SPV Structure heading Element
161 @subsection The @code{heading} Element
163 Parent: Document root or @code{heading} @*
164 Contents: @code{pageSetup}? @code{label} (@code{container} @math{|} @code{heading})*
166 The root of a structure member is a @code{heading}, which represents a
167 section of output beginning with a title (the @code{label}) and
168 ordinarily followed by content containers or further nested
169 (sub)-sections of output.
171 The document root heading, only, may also contain a @code{pageSetup}
174 The following attributes have been observed on both document root and
175 nested @code{heading} elements.
177 @defvr {Optional} creator-version
178 The version of the software that created this SPV file. A string of
179 the form @code{xxyyzzww} represents software version xx.yy.zz.ww,
180 e.g.@: @code{21000001} is version 21.0.0.1. Trailing pairs of zeros
181 are sometimes omitted, so that @code{21}, @code{210000}, and
182 @code{21000000} are all version 21.0.0.0 (and the corpus contains all
183 three of those forms).
187 The following attributes have been observed on document root
188 @code{heading} elements only:
190 @defvr {Optional} @code{creator}
191 The directory in the file system of the software that created this SPV
195 @defvr {Optional} @code{creation-date-time}
196 The date and time at which the SPV file was written, in a
197 locale-specific format, e.g.@: @code{Friday, May 16, 2014 6:47:37 PM
198 PDT} or @code{lunedì 17 marzo 2014 3.15.48 CET} or even @code{Friday,
199 December 5, 2014 5:00:19 o'clock PM EST}.
202 @defvr {Optional} @code{lockReader}
203 Whether a reader should be allowed to edit the output. The possible
204 values are @code{true} and @code{false}, but the corpus only contains
208 @defvr {Optional} @code{schemaLocation}
209 This is actually an XML Namespace attribute. A reader may ignore it.
213 The following attributes have been observed only on nested
214 @code{heading} elements:
216 @defvr {Required} @code{commandName}
217 The locale-invariant name of the command that produced the output,
218 e.g.@: @code{Frequencies}, @code{T-Test}, @code{Non Par Corr}.
221 @defvr {Optional} @code{visibility}
222 To what degree the output represented by the element is visible. The
223 only observed value is @code{collapsed}.
226 @defvr {Optional} @code{locale}
227 The locale used for output, in Windows format, which is similar to the
228 format used in Unix with the underscore replaced by a hyphen, e.g.@:
229 @code{en-US}, @code{en-GB}, @code{el-GR}, @code{sr-Cryl-RS}.
232 @defvr {Optional} @code{olang}
233 The output language, e.g.@: @code{en}, @code{it}, @code{es},
234 @code{de}, @code{pt-BR}.
237 @node SPV Structure label Element
238 @subsection The @code{label} Element
240 Parent: @code{heading} or @code{container} @*
243 Every @code{heading} and @code{container} holds a @code{label} as its
244 first child. The root @code{heading} in a structure member always
245 contains the string ``Output''. Otherwise, the text in @code{label}
246 describes what it labels, often by naming the statistical procedure
247 that was executed, e.g.@: ``Frequencies'' or ``T-Test''. Labels are
248 often very generic, especially within a @code{container}, e.g.@:
249 ``Title'' or ``Warnings'' or ``Notes''. Label text is localized
250 according to the output language, e.g.@: in Italian a frequency table
251 procedure is labeled ``Frequenze''.
253 The corpus contains one example of an empty label, one that contains
256 This element has no attributes.
258 @node SPV Structure container Element
259 @subsection The @code{container} Element
261 Parent: @code{heading} @*
262 Contents: @code{label} (@code{table} @math{|} @code{text})?
264 A @code{container} serves to label a @code{table} or a @code{text}
267 This element has the following attributes.
269 @defvr {Required} @code{visibility}
270 Either @code{visible} or @code{hidden}, this indicates whether the
271 container's content is displayed.
274 @defvr {Optional} @code{text-align}
275 Presumably indicates the alignment of text within the container. The
276 only observed value is @code{left}. Observed with nested @code{table}
277 and @code{text} elements.
280 @defvr {Optional} @code{width}
281 The width of the container in the form @code{@var{n}px}, e.g.@:
285 @node SPV Structure text Element (Inside @code{container})
286 @subsection The @code{text} Element (Inside @code{container})
288 Parent: @code{container} @*
289 Contents: @code{html}
291 This @code{text} element is nested inside a @code{container}. There
292 is a different @code{text} element that is nested inside a
293 @code{pageParagraph}.
295 This element has the following attributes.
297 @defvr {Required} @code{type}
298 One of @code{title}, @code{log}, or @code{text}.
301 @defvr {Optional} @code{commandName}
302 As on the @code{heading} element. For output not specific to a
303 command, this is simply @code{log}. The corpus contains one example
304 of where @code{commandName} is present but set to the empty string.
307 @defvr {Optional} @code{creator-version}
308 As on the @code{heading} element.
311 @node SPV Structure html Element
312 @subsection The @code{html} Element
314 Parent: @code{text} @*
317 The CDATA contains an HTML document. In some cases, the document
318 starts with @code{<html>} and ends with @code{</html}; in others the
319 @code{html} element is implied. Generally the HTML includes a
320 @code{head} element with a CSS stylesheet. The HTML body often begins
321 with @code{<BR>}. The actual content ranges from trivial to simple:
322 just discarding the CSS and tags yields readable results.
324 This element has the following attributes.
326 @defvr {Required} @code{lang}
327 This always contains @code{en} in the corpus.
330 @node SPV Structure table Element
331 @subsection The @code{table} Element
333 Parent: @code{container} @*
334 Contents: @code{tableStructure}
336 This element has the following attributes.
338 @defvr {Required} @code{commandName}
339 As on the @code{heading} element.
342 @defvr {Required} @code{type}
343 One of @code{table}, @code{note}, or @code{warning}.
346 @defvr {Required} @code{subType}
347 The locale-invariant name for the particular kind of output that this
348 table represents in the procedure. This can be the same as
349 @code{commandName} e.g.@: @code{Frequencies}, or different, e.g.@:
350 @code{Case Processing Summary}. Generic subtypes @code{Notes} and
351 @code{Warnings} are often used.
354 @defvr {Required} @code{tableId}
355 A number that uniquely identifies the table within the SPV file,
356 typically a large negative number such as @code{-4147135649387905023}.
359 @defvr {Optional} @code{creator-version}
360 As on the @code{heading} element. In the corpus, this is only present
361 for version 21 and up and always includes all 8 digits.
364 @node SPV Structure tableStructure Element
365 @subsection The @code{tableStructure} Element
367 Parent: @code{table} @*
368 Contents: @code{dataPath}
370 This element has no attributes.
372 @node SPV Structure dataPath Element
373 @subsection The @code{dataPath} Element
375 Parent: @code{tableStructure} @*
378 Contains the name of the Zip member that holds the table details,
379 e.g.@: @code{0000000001437_lightTableData.bin}.
381 This element has no attributes.
383 @node SPV Structure pageSetup Element
384 @subsection The @code{pageSetup} Element
386 Parent: @code{heading} @*
387 Contents: @code{pageHeader} @code{pageFooter}
389 This element has the following attributes.
391 @defvr {Required} @code{initial-page-number}
395 @defvr {Optional} @code{chart-size}
396 Always @code{as-is} or a localization (!) of it (e.g.@: @code{dimensione
397 attuale}, @code{Wie vorgegeben}).
400 @defvr {Optional} @code{margin-left}
401 @defvrx {Optional} @code{margin-right}
402 @defvrx {Optional} @code{margin-top}
403 @defvrx {Optional} @code{margin-bottom}
404 Margin sizes in the form @code{@var{size}in}, e.g.@: @code{0.25in}.
407 @defvr {Optional} @code{paper-height}
408 @defvrx {Optional} @code{paper-width}
409 Paper sizes in the form @code{@var{size}in}, e.g.@: @code{8.5in} by
410 @code{11in} for letter paper or @code{8.267in} by @code{11.692in} for
414 @defvr {Optional} @code{reference-orientation}
418 @defvr {Optional} @code{space-after}
422 @node SPV Structure pageHeader and pageFooter Elements
423 @subsection The @code{pageHeader} and @code{pageFooter} Elements
425 Parent: @code{pageSetup} @*
426 Contents: @code{pageParagraph}*
428 This element has no attributes.
430 @node SPV Structure pageParagraph Element
431 @subsection The @code{pageParagraph} Element
433 Parent: @code{pageHeader} or @code{pageFooter} @*
434 Contents: @code{text}
436 Text to go at the top or bottom of a page, respectively.
438 This element has no attributes.
440 @node SPV Structure @code{text} Element (Inside @code{pageParagraph})
441 @subsection The @code{text} Element (Inside @code{pageParagraph})
443 Parent: @code{pageParagraph}
446 This @code{text} element is nested inside a @code{pageParagraph}. There
447 is a different @code{text} element that is nested inside a
450 The element is either empty, or contains CDATA that holds almost-XHTML
451 text: in the corpus, either an @code{html} or @code{p} element. It is
452 @emph{almost}-XHTML because the @code{html} element designates the
454 @code{http://xml.spss.com/spss/viewer/viewer-tree} instead of an XHTML
455 namespace, and because the CDATA can contain substitution variables:
456 @code{&[Page]} for the page number and @code{&[PageTitle]} for the
459 Typical contents (indented for clarity):
462 <html xmlns="http://xml.spss.com/spss/viewer/viewer-tree">
465 <p style="text-align:right; margin-top: 0">Page &[Page]</p>
470 This element has the following attributes.
472 @defvr {Required} @code{type}
476 @node SPV Light Detail Member Format
477 @section Light Detail Member Format
479 This section describes the format of ``light'' detail @file{.bin}
480 members. These members have a binary format which we describe here in
481 terms of a context-free grammar using the following conventions:
484 @item NonTerminal @result{} @dots{}
485 Nonterminals have CamelCaps names, and @result{} indicates a
486 production. The right-hand side of a production is often broken
487 across multiple lines. Break points are chosen for aesthetics only
488 and have no semantic significance.
490 @item 00, 01, @dots{}, ff.
491 A bytes with a fixed value, written as a pair of hexadecimal digits.
493 @item i0, i1, @dots{}, i9, i10, i11, @dots{}
494 @itemx b0, b1, @dots{}, b9, b10, b11, @dots{}
495 A 32-bit integer in little-endian or big-endian byte order,
496 respectively, with a fixed value, written in decimal, prefixed by
503 A byte with value 0 or 1.
507 A 16-bit integer in little-endian or big-endian byte order,
512 A 32-bit integer in little-endian or big-endian byte order,
517 A 64-bit integer in little-endian or big-endian byte order,
521 A 64-bit IEEE floating-point number.
524 A 32-bit IEEE floating-point number.
528 A 32-bit integer, in little-endian or big-endian byte order,
529 respectively, followed by the specified number of bytes of character
530 data. (The encoding is indicated by the Formats nonterminal.)
533 @var{x} is optional, e.g.@: 00? is an optional zero byte.
535 @item @var{x}*@var{n}
536 @var{x} is repeated @var{n} times, e.g. byte*10 for ten arbitrary bytes.
538 @item @var{x}[@var{name}]
539 Gives @var{x} the specified @var{name}. Names are used in textual
540 explanations. They are also used, also bracketed, to indicate counts,
541 e.g.@: int[@t{n}] byte*[@t{n}] for a 32-bit integer followed by the
542 specified number of arbitrary bytes.
544 @item @var{a} @math{|} @var{b}
545 Either @var{a} or @var{b}.
548 Parentheses are used for grouping to make precedence clear, especially
549 in the presence of @math{|}, e.g.@: in 00 (01 @math{|} 02 @math{|} 03)
553 A 32-bit integer that indicates the number of bytes in @var{x},
554 followed by @var{x} itself.
557 In a version 1 @file{.bin} member, @var{x}; in version 3, nothing.
558 (The @file{.bin} header indicates the version.)
561 In a version 3 @file{.bin} member, @var{x}; in version 1, nothing.
564 Little-endian byte order is far more common in this format, but a few
565 pieces of the format use big-endian byte order.
567 A ``light'' detail member @file{.bin} consists of a number of sections
568 concatenated together, terminated by a byte 01:
572 LightMember @result{}
575 Fonts Borders PrintSettings TableSettings Formats
581 The following sections go into more detail.
584 * SPV Light Member Header::
585 * SPV Light Member Title::
586 * SPV Light Member Caption::
587 * SPV Light Member Footnotes::
588 * SPV Light Member Fonts::
589 * SPV Light Member Borders::
590 * SPV Light Member Print Settings::
591 * SPV Light Member Table Settings::
592 * SPV Light Member Formats::
593 * SPV Light Member Dimensions::
594 * SPV Light Member Categories::
595 * SPV Light Member Data::
596 * SPV Light Member Value::
597 * SPV Light Member ValueMod::
600 @node SPV Light Member Header
603 An SPV light member begins with a 39-byte header:
609 (i1 @math{|} i3)[@t{version}]
611 int[@t{min-column-width}] int[@t{max-column-width}]
612 int[@t{min-row-width}] int[@t{max-row-width}]
617 @code{version} is a version number that affects the interpretation of
618 some of the other data in the member. We will refer to ``version 1''
619 and ``version 3'' later on and use v1(@dots{}) and v3(@dots{}) for
620 version-specific formatting (as described previously).
622 @code{table-id} is a binary version of the @code{tableId} attribute in
623 the structure member that refers to the detail member. For example,
624 if @code{tableId} is @code{-4122591256483201023}, then @code{table-id}
625 would be 0xc6c99d183b300001.
627 @code{min-column-width} is the minimum width that a column will be
628 assigned automatically. @code{max-column-width} is the maximum width
629 that a column will be assigned to accommodate a long column label.
630 @code{min-row-width} and @code{max-row-width} are a similar range for
631 the width of row labels. All of these measurements are in 1/96 inch
634 The meaning of the other variable parts of the header is not known.
636 @node SPV Light Member Title
642 Value[@t{title1}] 01?
644 Value[@t{title2}] 01?
648 The Title, which follows the Header, specifies the pivot table's title
649 twice, as @code{title1} and @code{title2}. In the corpus, they are
652 Whereas the Value in @code{title1} and in @code{title2} are
653 appropriate for presentation, and localized to the user's language,
654 @code{c} is in English, sometimes less specific, and sometimes less
655 well formatted. For example, for a frequency table, @code{title1} and
656 @code{title2} name the variable and @code{c} is simply ``Frequencies''.
658 @node SPV Light Member Caption
663 Caption @result{} Caption1 Caption2
664 Caption1 @result{} 31 Value @math{|} 58
665 Caption2 @result{} 31 Value @math{|} 58
669 The Caption, if present, is shown below the table. Caption2 is
670 normally present. Caption1 is only rarely nonempty; it might reflect
671 user editing of the caption.
673 @node SPV Light Member Footnotes
674 @subsection Footnotes
678 Footnotes @result{} int[@t{n}] Footnote*[@t{n}]
679 Footnote @result{} Value[@t{text}] (58 @math{|} 31 Value[@t{marker}]) byte*4
683 Each footnote has @code{text} and an optional customer @code{marker}
686 @node SPV Light Member Fonts
691 Fonts @result{} 00 Font*8
694 string[@t{typeface}] float[@t{size}] int[@t{style}] bool[@t{underline}]
695 int[@t{halign}] int[@t{valign}]
696 string[@t{fgcolor}] string[@t{bgcolor}]
697 byte[@t{alternate}] string[@t{altfg}] string[@t{altbg}]
698 v3(int[@t{left-margin}] int[@t{right-margin}] int[@t{top-margin}] int[@t{bottom-margin}])
702 Each Font represents the font style for a different element, in the
703 following order: title, caption, footer, corner, column
704 labels, row labels, data, and layers.
706 @code{index} is the 1-based index of the Font, i.e. 1 for the first
707 Font, through 8 for the final Font.
709 @code{typeface} is the string name of the font. In the corpus, this
710 is @code{SansSerif} in over 99% of instances and @code{Times New
713 @code{size} is the size of the font, in points. The most common size
714 in the corpus is 12 points.
716 @code{style} is a bit mask. Bit 0 (with value 1) is set for bold, bit
717 1 (with value 2) is set for italic.
719 @code{underline} is 1 if the font is underlined, 0 otherwise.
721 @code{halign} specifies horizontal alignment: 0 for center, 2 for
722 left, 4 for right, 61453 for decimal, 64173 for mixed. Mixed
723 alignment varies according to type: string data is left-justified,
724 numbers and most other formats are right-justified.
726 @code{valign} specifies vertical alignment: 0 for center, 1 for top, 3
729 @code{fgcolor} and @code{bgcolor} are the foreground color and
730 background color, respectively. In the corpus, these are always
731 @code{#000000} and @code{#ffffff}, respectively.
733 @code{alternate} is 01 if rows should alternate colors, 00 if all rows
734 should be the same color. When @code{alternate} is 01, @code{altfg}
735 and @code{altbg} specify the colors for the alternate rows.
737 @code{left-margin}, @code{right-margin}, @code{top-margin}, and
738 @code{bottom-margin} are measured in multiples of 1/96 inch.
740 @node SPV Light Member Borders
747 be32[@t{n-borders}] Border*[@t{n-borders}]
748 bool[@t{show-grid-lines}]
752 be32[@t{border-type}]
753 be32[@t{stroke-type}]
758 The Borders reflect how borders between regions are drawn.
760 The fixed value of @code{endian} can be used to validate the
763 @code{show-grid-lines} is 1 to draw grid lines, otherwise 0.
765 Each Border describes one kind of border. @code{n-borders} seems to
766 always be 19. Each @code{border-type} appears once (although in an
767 unpredictable order) and correspond to the following borders:
773 Left, top, right, and bottom outer frame.
775 Left, top, right, and bottom inner frame.
777 Left and top of data area.
779 Horizontal and vertical dimension rows.
781 Horizontal and vertical dimension columns.
783 Horizontal and vertical category rows.
785 Horizontal and vertical category columns.
788 @code{stroke-type} describes how a border is drawn, as one of:
805 @code{color} is an RGB color. Bits 24--31 are alpha, bits 16--23 are
806 red, 8--15 are green, 0--7 are blue. An alpha of 255 indicates an
807 opaque color, therefore opaque black is 0xff000000.
809 @node SPV Light Member Print Settings
810 @subsection Print Settings
814 PrintSettings @result{}
817 bool[@t{paginate-layers}]
820 bool[@t{top-continuation}]
821 bool[@t{bottom-continuation}]
822 be32[@t{n-orphan-lines}]
823 bestring[@t{continuation-string}]
827 The PrintSettings reflect settings for printing. The fixed value of
828 @code{endian} can be used to validate the endianness.
830 @code{all-layers} is 1 to print all layers, 0 to print only the
833 @code{paginate-layers} is 1 to print each layer at the start of a new
834 page, 0 otherwise. (This setting is honored only @code{all-layers} is
835 1, since otherwise only one layer is printed.)
837 @code{fit-width} and @code{fit-length} control whether the table is
838 shrunk to fit within a page's width or length, respectively.
840 @code{n-orphan-lines} is the minimum number of rows or columns to put
841 in one part of a table that is broken across pages.
843 If @code{top-continuation} is 1, then @code{continuation-string} is
844 printed at the top of a page when a table is broken across pages for
845 printing; similarly for @code{bottom-continuation} and the bottom of a
846 page. Usually, @code{continuation-string} is empty.
848 @node SPV Light Member Table Settings
849 @subsection Table Settings
853 TableSettings @result{}
856 be32[@t{current-layer}]
858 bool[@t{show-row-labels-in-corner}]
859 bool[@t{show-alphabetic-markers}]
860 bool[@t{footnote-marker-position}]
863 be32[@t{n}] byte*[@t{n}]
865 bestring[@t{table-look}]
871 The TableSettings reflect display settings. The fixed value of
872 @code{endian} can be used to validate the endianness.
874 @code{current-layer} is the displayed layer.
876 If @code{omit-empty} is 1, empty rows or columns (ones with nothing in
877 any cell) are hidden; otherwise, they are shown.
879 If @code{show-row-labels-in-corner} is 1, then row labels are shown in
880 the upper left corner; otherwise, they are shown nested.
882 If @code{show-alphabetic-markers} is 1, markers are shown as letters
883 (e.g. @samp{a}, @samp{b}, @samp{c}, @dots{}); otherwise, they are
884 shown as numbers starting from 1.
886 When @code{footnote-marker-position} is 1, footnote markers are shown
887 as superscripts, otherwise as subscripts.
889 @code{notes} is a text string that contains user-specified notes. It
890 is displayed when the user hovers the cursor over the table, like
891 ``alt text'' on a webpage. It is not printed. It is usually empty.
893 @code{table-look} is the name of a SPSS ``TableLook'' table style,
894 such as ``Default'' or ``Academic''; it is often empty.
896 TableSettings ends with an arbitrary number of null bytes.
898 @node SPV Light Member Formats
904 int[@t{nwidths}] int*[@t{nwidths}]
906 int (00 @math{|} 01) 00 (00 @math{|} 01)
908 byte[@t{decimal}] byte[@t{grouping}]
911 v3(count(count(X5) count(X6)))
913 CustomCurrency @result{} int[@t{n-ccs}] string*[@t{n-ccs}]
915 X5 @result{} byte*33 int[@t{n}] int*[@t{n}]
917 01 00 (03 @math{|} 04) 00 00 00
918 string[@t{command}] string[@t{subcommand}]
919 string[@t{language}] string[@t{charset}] string[@t{locale}]
920 (00 @math{|} 01) 00 bool bool
922 byte[@t{decimal}] byte[@t{grouping}]
924 (string[@t{dataset}] string[@t{datafile}] i0 int[@t{date}] i0)?
926 byte[@t{missing}] bool (i2000000 i0)?
930 If @code{nwidths} is nonzero, then the accompanying integers are
931 column widths as manually adjusted by the user. (Row heights are
932 computed automatically based on the widths.)
934 @code{encoding} is a character encoding, usually a Windows code page
935 such as @code{en_US.windows-1252} or @code{it_IT.windows-1252}. The
936 rest of the character strings in the member use this encoding. The
937 encoding string is itself encoded in US-ASCII.
939 @code{epoch} is the year that starts the epoch. A 2-digit year is
940 interpreted as belonging to the 100 years beginning at the epoch. The
941 default epoch year is 69 years prior to the current year; thus, in
942 2017 this field by default contains 1948. In the corpus, @code{epoch}
943 ranges from 1943 to 1948, plus some contain -1.
945 @code{decimal} is the decimal point character. The observed values
946 are @samp{.} and @samp{,}.
948 @code{grouping} is the grouping character. Usually, it is @samp{,} if
949 @code{decimal} is @samp{.}, and vice versa. Other observed values are
950 @samp{'} (apostrophe), @samp{ } (space), and zero (presumably
951 indicating that digits should not be grouped).
953 @code{dataset} is the name of the dataset analyzed to produce the
954 output, e.g.@: @code{DataSet1}, and @code{datafile} the name of the
955 file it was read from, e.g.@: @file{C:\Users\foo\bar.sav}. The latter
956 is sometimes the empty string.
958 @code{date} is a date, as seconds since the epoch, i.e.@: since
959 January 1, 1970. Pivot tables within an SPV files often have dates a
960 few minutes apart, so this is probably a creation date for the tables
961 rather than for the file.
963 Sometimes @code{dataset}, @code{datafile}, and @code{date} are present
964 and other times they are absent. The reader can distinguish by
965 assuming that they are present and then checking whether the
966 presumptive @code{dataset} contains a null byte (a valid string never
969 @code{n-ccs} is observed as either 0 or 5. When it is 5, the
970 following strings are CCA through CCE format strings. @xref{Custom
971 Currency Formats,,, pspp, PSPP}. Most commonly these are all
972 @code{-,,,} but other strings occur.
974 @node SPV Light Member Dimensions
975 @subsection Dimensions
977 A pivot table presents multidimensional data. A Dimension identifies
978 the categories associated with each dimension.
982 Dimensions @result{} int[@t{n-dims}] Dimension*[@t{n-dims}]
983 Dimension @result{} Value[@t{name}] DimUnknown int[@t{n-categories}] Category*[@t{n-categories}]
986 (00 @math{|} 01 @math{|} 02)[@t{d2}]
987 (i0 @math{|} i2)[@t{d3}]
988 (00 @math{|} 01)[@t{d4}]
989 (00 @math{|} 01)[@t{d5}]
995 @code{name} is the name of the dimension, e.g. @code{Variables},
996 @code{Statistics}, or a variable name.
998 @code{d1} is usually 0 but many other values have been observed.
1000 @code{d3} is 2 over 99% of the time.
1002 @code{d5} is 0 over 99% of the time.
1004 @code{d6} is either -1 or the 0-based index of the dimension, e.g.@: 0
1005 for the first dimension, 1 for the second, and so on. The latter is
1006 the case 98% of the time in the corpus.
1008 @node SPV Light Member Categories
1009 @subsection Categories
1011 Categories are arranged in a tree. Only the leaf nodes in the tree
1012 are really categories; the others just serve as grouping constructs.
1016 Category @result{} Value[@t{name}] (Leaf @math{|} Group)
1017 Leaf @result{} 00 00 00 i2 int[@t{index}] i0
1019 (00 @math{|} 01)[@t{merge}] 00 01 (i0 @math{|} i2)[@t{data}]
1020 i-1 int[@t{n-subcategories}] Category*[@t{n-subcategories}]
1024 @code{name} is the name of the category (or group).
1026 A Leaf represents a leaf category. The Leaf's @code{index} is a
1027 nonnegative integer less than @code{n-categories} in the Dimension in
1028 which the Category is nested (directly or indirectly).
1030 A Group represents a Group of nested categories. Usually a Group
1031 contains at least one Category, so that @code{n-subcategories} is
1032 positive, but a few Groups with @code{n-subcategories} 0 has been
1035 If a Group's @code{merge} is 00, the most common value, then the group
1036 is really a distinct group that should be represented as such in the
1037 visual representation and user interface. If @code{merge} is 01, the
1038 categories in this group should be shown and treated as if they were
1039 direct children of the group's containing group (or if it has no
1040 parent group, then direct children of the dimension), and this group's
1041 name is irrelevant and should not be displayed. (Merged groups can be
1044 A Group's @code{data} appears to be i2 when all of the categories
1045 within a group are leaf categories that directly represent data values
1046 for a variable (e.g. in a frequency table or crosstabulation, a group
1047 of values in a variable being tabulated) and i0 otherwise.
1049 @node SPV Light Member Data
1052 The final part of an SPV light member contains the actual data.
1057 int[@t{layers}] int[@t{rows}] int[@t{columns}] int*[@t{n-dimensions}]
1058 int[@t{n-data}] Datum*[@t{n-data}]
1059 Datum @result{} int64[@t{index}] v3(00?) Value
1063 The values of @code{layers}, @code{rows}, and @code{columns} each
1064 specifies the number of dimensions displayed in layers, rows, and
1065 columns, respectively. Any of them may be zero. Their values sum to
1066 @code{n-dimensions} from Dimensions (@pxref{SPV Light Member
1069 The @code{n-dimensions} integers are a permutation of the 0-based
1070 dimension numbers. The first @code{layers} integers specify each of
1071 the dimensions represented by layers, the next @code{rows} integers
1072 specify the dimensions represented by rows, and the final
1073 @code{columns} integers specify the dimensions represented by columns.
1074 When there is more than one dimension of a given kind, the inner
1075 dimensions are given first.
1077 The format of a Datum varies slightly from version 1 to version 3: in
1078 version 1 it allows for an extra optional 00 byte.
1080 A Datum consists of an @code{index} and a Value. Suppose there are
1081 @math{d} dimensions and dimension @math{i}, @math{0 \le i < d}, has
1082 @math{n_i} categories. Consider the datum at coordinates @math{x_i},
1083 @math{0 \le i < d}, and note that @math{0 \le x_i < n_i}. Then the
1084 index is calculated by the following algorithm:
1088 for each @math{i} from 0 to @math{d - 1}:
1089 @i{index} = (@math{n_i \times} @i{index}) @math{+} @math{x_i}
1092 For example, suppose there are 3 dimensions with 3, 4, and 5
1093 categories, respectively. The datum at coordinates (1, 2, 3) has
1094 index @math{5 \times (4 \times (3 \times 0 + 1) + 2) + 3 = 33}.
1096 @node SPV Light Member Value
1099 Value is used throughout the SPV light member format. It boils down
1100 to a number or a string.
1104 Value @result{} 00? 00? 00? 00? RawValue
1106 01 ValueMod int[@t{format}] double[@t{x}]
1107 @math{|} 02 ValueMod int[@t{format}] double[@t{x}]
1108 string[@t{varname}] string[@t{vallab}] (01 @math{|} 02 @math{|} 03)
1109 @math{|} 03 string[@t{local}] ValueMod string[@t{id}] string[@t{c}] (00 @math{|} 01)[@t{type}]
1110 @math{|} 04 ValueMod int[@t{format}] string[@t{vallab}] string[@t{varname}]
1111 (01 @math{|} 02 @math{|} 03) string[@t{s}]
1112 @math{|} 05 ValueMod string[@t{varname}] string[@t{varlabel}] (01 @math{|} 02 @math{|} 03)
1113 @math{|} ValueMod string[@t{format}] int[@t{n-args}] Argument*[@t{n-args}]
1116 @math{|} int[@t{x}] i0 Value*[@t{x}@math{+}1] /* @t{x} @math{>} 0 */
1120 There are several possible encodings, which one can distinguish by the
1121 first nonzero byte in the encoding.
1125 The numeric value @code{x}, intended to be presented to the user
1126 formatted according to @code{format}, which is in the format described
1127 for system files. @xref{System File Output Formats}, for details.
1128 Most commonly, @code{format} has width 40 (the maximum).
1130 An @code{x} with the maximum negative double value @code{-DBL_MAX}
1131 represents the system-missing value SYSMIS. (HIGHEST and LOWEST have
1132 not been observed.) @xref{System File Format}, for more about these
1136 Similar to @code{01}, with the additional information that @code{x} is
1137 a value of variable @code{varname} and has value label @code{vallab}.
1138 Both @code{varname} and @code{vallab} can be the empty string, the
1139 latter very commonly.
1141 The meaning of the final byte is unknown. Possibly it is connected to
1142 whether the value or the label should be displayed.
1145 A text string, in two forms: @code{c} is in English, and sometimes
1146 abbreviated or obscure, and @code{local} is localized to the user's
1147 locale. In an English-language locale, the two strings are often the
1148 same, and in the cases where they differ, @code{local} is more
1149 appropriate for a user interface, e.g.@: @code{c} of ``Not a PxP table
1150 for MCN...'' versus @code{local} of ``Computed only for a PxP table,
1151 where P must be greater than 1.''
1153 @code{c} and @code{local} are always either both empty or both
1156 @code{id} is a brief identifying string whose form seems to resemble a
1157 programming language identifier, e.g.@: @code{cumulative_percent} or
1158 @code{factor_14}. It is not unique.
1160 @code{type} is 00 for text taken from user input, such as syntax
1161 fragment, expressions, file names, data set names, and 01 for fixed
1162 text strings such as names of procedures or statistics. In the former
1163 case, @code{id} is always the empty string; in the latter case,
1164 @code{id} is still sometimes empty.
1167 The string value @code{s}, intended to be presented to the user
1168 formatted according to @code{format}. The format for a string is not
1169 too interesting, and the corpus contains many clearly invalid formats
1170 like A16.39 or A255.127 or A134.1, so readers should probably ignore
1171 the format entirely.
1173 @code{s} is a value of variable @code{varname} and has value label
1174 @code{vallab}. @code{varname} is never empty but @code{vallab} is
1177 The meaning of the final byte is unknown.
1180 Variable @code{varname}, which is rarely observed as empty in the
1181 corpus, with variable label @code{varlabel}, which is often empty.
1183 The meaning of the final byte is unknown.
1186 (These bytes begin a ValueMod.) A format string, analogous to
1187 @code{printf}, followed by one or more Arguments, each of which has
1188 one or more values. The format string uses the following syntax:
1195 Each of these expands to the character following @samp{\\}, to escape
1196 characters that have special meaning in format strings. These are
1197 effective inside and outside the @code{[@dots{}]} syntax forms
1201 Expands to a new-line, inside or outside the @code{[@dots{}]} forms
1205 Expands to a formatted version of argument @var{i}, which must have
1206 only a single value. For example, @code{^1} expands to the first
1207 argument's @code{value}.
1209 @item [:@var{a}:]@var{i}
1210 Expands @var{a} for each of the values in @var{i}. @var{a}
1211 should contain one or more @code{^@var{j}} conversions, which are
1212 drawn from the values for argument @var{i} in order. Some examples
1217 All of the values for the first argument, concatenated.
1220 Expands to the values for the first argument, each followed by
1224 Expands to @code{@var{x} = @var{y}} where @var{x} is the second
1225 argument's first value and @var{y} is its second value. (This would
1226 be used only if the argument has two values. If there were more
1227 values, the second and third values would be directly concatenated,
1228 which would look funny.)
1231 @item [@var{a}:@var{b}:]@var{i}
1232 This extends the previous form so that the first values are expanded
1233 using @var{a} and later values are expanded using @var{b}. For an
1234 unknown reason, within @var{a} the @code{^@var{j}} conversions are
1235 instead written as @code{%@var{j}}. Some examples from the corpus:
1239 Expands to all of the values for the first argument, separated by
1242 @item [%1 = %2:, ^1 = ^2:]1
1243 Given appropriate values for the first argument, expands to @code{X =
1247 Given appropriate values, expands to @code{1, 2, 3}.
1251 The format string is localized to the user's locale.
1254 @node SPV Light Member ValueMod
1255 @subsection ValueMod
1257 A ValueMod can specify special modifications to a Value.
1262 31 i0 (i0 @math{|} i1 string[@t{subscript}])
1263 v1(00 (i1 @math{|} i2) 00 00 int 00 00)
1264 v3(count(FormatString Style ValueModUnknown))
1265 @math{|} 31 int[@t{n-refs}] int16*[@t{n-refs}] Format
1271 bool[@t{bold}] bool[@t{italic}] bool[@t{underline}] bool
1272 string[@t{fgcolor}] string[@t{bgcolor}]
1273 string[@t{typeface}] byte[@t{size}]
1275 Format @result{} 00 00 count(FormatString Style 58)
1277 FormatString @result{} count((i0 (58 @math{|} 31 string))?)
1279 ValueModUnknown @result{}
1281 @math{|} 31 int[@t{halign}] int[@t{valign}] double[@t{offset}]
1282 int16[@t{left-margin}] int16[@t{right-margin}]
1283 int16[@t{top-margin}] int16[@t{bottom-margin}]
1287 A ValueMod that begins with ``31 i0'' specifies a string to append to
1288 the main text of the Value, as a subscript. The subscript text is a
1289 brief indicator, e.g.@: @samp{a} or @samp{a,b}, with its meaning
1290 indicated by the table caption. In this usage, subscripts are similar
1291 to footnotes. One apparent difference is that a Value can only
1292 reference one footnote but a subscript can list more than one letter.
1294 A ValueMod that begins with 31 followed by a nonzero ``int'' specifies
1295 a footnote or footnotes that the Value references. Footnote markers
1296 are shown appended to the main text of the Value, as superscripts.
1298 The Format, if present, is a format string for substitutions using the
1299 syntax explained previously. It appears to be an English-language
1300 version of the localized format string in the Value in which the
1303 The Style, if present, changes the style for this individual Value.
1304 The @code{size} is a font size in units of 1/96 inch.
1306 @code{halign} is 0 for center, 2 for left, 4 for right, 6 for decimal,
1307 0xffffffad for mixed. For decimal alignment, @code{offset} is the
1308 decimal point's offset from the right side of the cell, in units of
1311 @code{valign} specifies vertical alignment: 0 for center, 1 for top, 3
1314 @code{left-margin}, @code{right-margin}, @code{top-margin}, and
1315 @code{bottom-margin} are in units of 1/72 inch.
1317 @node SPV Legacy Detail Member Binary Format
1318 @section Legacy Detail Member Binary Format
1320 Whereas the light binary format represents everything about a given
1321 pivot table, the legacy binary format conceptually consists of a
1322 number of named sources, each of which consists of a number of named
1323 variables, each of which is a 1-dimensional array of numbers or
1324 strings or a mix. Thus, the legacy binary member format is quite
1327 This section uses the same context-free grammar notation as in the
1328 previous section, with the following additions:
1332 In a version 0xaf legacy member, @var{x}; in other versions, nothing.
1333 (The legacy member header indicates the version; see below.)
1336 In a version 0xb0 legacy member, @var{x}; in other versions, nothing.
1339 A legacy detail member @file{.bin} has the following overall format:
1343 LegacyBinary @result{}
1344 00 byte[@t{version}] int16[@t{n-sources}] int[@t{member-size}]
1345 Metadata*[@t{n-sources}] Data*[@t{n-sources}]
1349 @code{version} is a version number that affects the interpretation of
1350 some of the other data in the member. Versions 0xaf and 0xb0 are
1351 known. We will refer to ``version 0xaf'' and ``version 0xb0'' members
1354 A legacy member consists of @code{n-sources} data sources, each of
1355 which has Metadata and Data.
1357 @code{member-size} is the size of the legacy binary member, in bytes.
1359 The following sections go into more detail.
1362 * SPV Legacy Member Metadata::
1363 * SPV Legacy Member Data::
1366 @node SPV Legacy Member Metadata
1367 @subsection Metadata
1372 int[@t{n-data}] int[@t{n-variables}] int[@t{offset}]
1373 vAF(byte*32[@t{source-name}])
1374 vB0(byte*64[@t{source-name}] int[@t{x}])
1378 A data source has @code{n-variables} variables, each with
1379 @code{n-data} data values.
1381 @code{source-name} is a 32- or 64-byte string padded on the right with
1382 zero bytes. The names that appear in the corpus are very generic:
1383 usually @code{tableData} for pivot table data or @code{source0} for
1386 A given Metadata's @code{offset} is the offset, in bytes, from the
1387 beginning of the member to the start of the corresponding Data. This
1388 allows programs to skip to the beginning of the data for a particular
1389 source; it is also important to determine whether a source includes
1390 any string data (@pxref{SPV Legacy Member Data}).
1392 The meaning of @code{x} in version 0xb0 is unknown.
1394 @node SPV Legacy Member Data
1399 Data @result{} NumericData*[@t{n-variables}] StringData?
1400 NumericData @result{} byte*288[@t{variable-name}] double*[@t{n-data}]
1404 Data follow the Metadata in the legacy binary format, with sources in
1405 the same order. Each NumericSeries begins with a @code{variable-name}
1406 that generally indicates its role in the pivot table, e.g.@: ``cell'',
1407 ``cellFormat'', ``dimension0categories'', ``dimension0group0'',
1408 followed by the numeric data, one double per datum. A double with the
1409 maximum negative double @code{-DBL_MAX} represents the system-missing
1414 StringData @result{} i1 string[@t{source-name}] Pairs Labels
1416 Pairs @result{} int[@t{n-string-vars}] PairSeries*[@t{n-string-vars}]
1417 PairVar @result{} string[@t{pair-var-name}] int[@t{n-pairs}] Pair*[@t{n-pairs}]
1418 Pair @result{} int[@t{i}] int[@t{j}]
1420 Labels @result{} int[@t{n-labels}] Label*[@t{n-labels}]
1421 Label @result{} int[@t{frequency}] int[@t{s}]
1425 A source may include a mix of numeric and string data values. When a
1426 source includes any string data, the data values that are strings are
1427 set to SYSMIS in the NumericData, and StringData follows the
1428 NumericData. A source that contains no string data omits the
1429 StringData. To reliably determine whether a source includes
1430 StringData, the reader should check whether the offset following the
1431 NumericData is the offset of the next source, as indicated by its
1432 Metadata (or the end of the member, in the case of the last source).
1434 StringData repeats the name of the source (from Metadata).
1436 The string data overlays the numeric data. @code{n-string-vars} is
1437 the number of variables in the source that include string data. More
1438 precisely, it is the 1-based index of the last variable in the source
1439 that includes any string data; thus, it would be 4 if there are 5
1440 variables and only the fourth one includes string data.
1442 Each PairVar consists a sequence of 0 or more Pair nonterminals, each
1443 of which maps from a 0-based index within variable @code{i} to a
1444 0-based label index @code{j}, e.g.@: pair @code{i} = 2, @code{j} = 3,
1445 means that the third data value (with value SYSMIS) is to be replaced
1446 by the string of the fourth Label.
1448 The labels themselves follow the pairs. The valuable part of each
1449 label is the string @code{s}. Each label also includes a
1450 @code{frequency} that reports the number of pairs that reference it
1451 (although this is not useful).
1453 @node SPV Legacy Detail Member XML Format
1454 @section Legacy Detail Member XML Format
1456 This format is still under investigation.
1458 The design of the detail XML format is not what one would end up with
1459 for describing pivot tables. This is because it is a special case
1460 of a much more general format (``visualization XML'' or ``VizML'')
1461 that can describe a wide range of visualizations. Most of this
1462 generality is overkill for tables, and so we end up with a funny
1463 subset of a general-purpose format.
1465 The important elements of the detail XML format are:
1469 Variables. Variables in detail XML roughly correspond to the
1470 dimensions in a light detail member. There is one variable for each
1471 dimension, plus one variable for each level of labeling along an axis.
1473 The bulk of variables are defined with @code{sourceVariable} elements.
1474 The data for these variables comes from the associated
1475 @code{tableData.bin} member. Some variables are defined, with
1476 @code{derivedVariable} elements, as a constant or in terms of a
1477 mapping function from a source variable.
1480 Assignment of variables to axes. A variable can appear as columns, or
1481 rows, or layers. The @code{faceting} element and its sub-elements
1482 describe this assignment.
1485 All elements have an optional @code{id} attribute. In practice many
1486 elements are assigned @code{id} attributes that are never referenced.
1489 * SPV Detail visualization Element::
1490 * SPV Detail userSource Element::
1491 * SPV Detail sourceVariable Element::
1492 * SPV Detail derivedVariable Element::
1493 * SPV Detail extension Element::
1494 * SPV Detail graph Element::
1495 * SPV Detail location Element::
1496 * SPV Detail coordinates Element::
1497 * SPV Detail faceting Element::
1498 * SPV Detail facetLayout Element::
1501 @node SPV Detail visualization Element
1502 @subsection The @code{visualization} Element
1505 Parent: Document root
1509 (sourceVariable @math{|} derivedVariable)@math{+}
1517 This element has the following attributes.
1519 @defvr {Required} creator
1520 The version of the software that created this SPV file, as a string of
1521 the form @code{xxyyzz}, which represents software version xx.yy.zz,
1522 e.g.@: @code{160001} is version 16.0.1. The corpus includes major
1523 versions 16 through 19.
1526 @defvr {Required} date
1527 The date on the which the file was created, as a string of the form
1531 @defvr {Required} lang
1532 The locale used for output, in Windows format, which is similar to the
1533 format used in Unix with the underscore replaced by a hyphen, e.g.@:
1534 @code{en-US}, @code{en-GB}, @code{el-GR}, @code{sr-Cryl-RS}.
1537 @defvr {Required} name
1538 The title of the pivot table, localized to the output language.
1541 @defvr {Required} style
1542 The @code{id} of a @code{style} element (@pxref{SPV Detail style
1543 element}). This is the base style for the entire pivot table. In
1544 every example in the corpus, the value is @code{visualizationStyle}
1545 and the corresponding @code{style} element has no attributes other
1549 @defvr {Required} type
1550 A floating-point number. The meaning is unknown.
1553 @defvr {Required} version
1554 The visualization schema version number. In the corpus, the value is
1555 one of 2.4, 2.5, 2.7, and 2.8.
1558 @node SPV Detail userSource Element
1559 @subsection The @code{userSource} Element
1561 Parent: @code{visualization} @*
1564 This element has the following attributes.
1566 @defvr {Optional} missing
1567 Always @code{listwise}.
1570 @node SPV Detail sourceVariable Element
1571 @subsection The @code{sourceVariable} Element
1573 Parent: @code{visualization} @*
1574 Contents: @code{extension}* (@code{format} @math{|} @code{stringFormat})?
1576 This element defines a variable whose values can be used elsewhere in
1577 the visualization. It ties this element's @code{id} to a variable
1578 from the @file{tableData.bin} member that corresponds to this
1581 This element has the following attributes.
1583 @defvr {Required} categorical
1584 Always set to @code{true}.
1587 @defvr {Required} source
1588 Always set to @code{tableData}, the @code{source-name} in the
1589 corresponding @file{tableData.bin} member (@pxref{SPV Legacy Member
1593 @defvr {Required} sourceName
1594 The name of a variable within the source, the @code{variable-name} in
1595 the corresponding @file{tableData.bin} member (@pxref{SPV Legacy
1599 @defvr {Optional} dependsOn
1600 The @code{variable-name} of a variable linked to this one, so that a
1601 viewer can work with them together. For a group variable, this is the
1602 name of the corresponding categorical variable.
1605 @defvr {Optional} label
1606 The variable label, if any
1609 @defvr {Optional} labelVariable
1610 The @code{variable-name} of a variable whose string values correspond
1611 one-to-one with the values of this variable and are suitable for use
1615 @node SPV Detail derivedVariable Element
1616 @subsection The @code{derivedVariable} Element
1618 Parent: @code{visualization} @*
1619 Contents: @code{extension}* (@code{format} @math{|} @code{stringFormat} @code{valueMapEntry}*)
1621 Like @code{sourceVariable}, this element defines a variable whose
1622 values can be used elsewhere in the visualization. Instead of being
1623 read from a data source, the variable's data are defined by a
1624 mathematical expression.
1626 This element has the following attributes.
1628 @defvr {Required} categorical
1629 Always set to @code{true}.
1632 @defvr {Required} value
1633 An expression that defines the variable's value. In theory this could
1634 be an arbitrary expression in terms of constants, functions, and other
1635 variables, e.g.@: @math{(@var{var1} + @var{var2}) / 2}. In practice,
1636 the corpus contains only the following forms of expressions:
1639 @item constant(@var{number})
1640 @itemx constant(@var{variable})
1641 A constant. The meaning when a variable is named is unknown.
1642 Sometimes the ``variable name'' has spaces in it.
1644 @item map(@var{variable})
1645 Transforms the values in the named @var{variable} using the
1646 @code{valueMapEntry}s contained within the element.
1650 @defvr {Optional} dependsOn
1651 The @code{variable-name} of a variable linked to this one, so that a
1652 viewer can work with them together. For a group variable, this is the
1653 name of the corresponding categorical variable.
1657 * SPV Detail valueMapEntry Element::
1660 @node SPV Detail valueMapEntry Element
1661 @subsubsection The @code{valueMapEntry} Element
1663 Parent: @code{derivedVariable} @*
1666 A @code{valueMapEntry} element defines a mapping from one or more
1667 values of a source expression to a target value. (In the corpus, the
1668 source expression is always just the name of a variable.) Each target
1669 value requires a separate @code{valueMapEntry}. If multiple source
1670 values map to the same target value, they can be combined or separate.
1672 @code{valueMapEntry} has the following attributes.
1674 @defvr {Required} from
1675 A source value, or multiple source values separated by semicolons,
1676 e.g.@: @code{0} or @code{13;14;15;16}.
1679 @defvr {Required} to
1683 @node SPV Detail extension Element
1684 @subsection The @code{extension} Element
1686 This is a general-purpose ``extension'' element. Readers that don't
1687 understand a given extension should be able to safely ignore it. The
1688 attributes on this element, and their meanings, vary based on the
1689 context. Each known usage is described separately below. The current
1690 extensions use attributes exclusively, without any nested elements.
1692 @subsubheading @code{visualization} Parent Element
1694 With @code{visualization} as its parent element, @code{extension} has
1695 the following attributes.
1697 @defvr {Optional} numRows
1698 An integer that presumably defines the number of rows in the displayed
1702 @defvr {Optional} showGridline
1703 Always set to @code{false} in the corpus.
1706 @defvr {Optional} minWidthSet
1707 @defvrx {Optional} maxWidthSet
1708 Always set to @code{true} in the corpus.
1711 @subsubheading @code{container} Parent Element
1713 With @code{container} as its parent element, @code{extension} has the
1714 following attributes.
1716 @defvr {Required} combinedFootnotes
1717 Always set to @code{true} in the corpus.
1720 @subsubheading @code{sourceVariable} and @code{derivedVariable} Parent Element
1722 With @code{sourceVariable} or @code{derivedVariable} as its parent
1723 element, @code{extension} has the following attributes. A given
1724 parent element often contains several @code{extension} elements that
1725 specify the meaning of the source data's variables or sources, e.g.@:
1728 <extension from="0" helpId="corrected_model"/>
1729 <extension from="3" helpId="error"/>
1730 <extension from="4" helpId="total_9"/>
1731 <extension from="5" helpId="corrected_total"/>
1734 @defvr {Required} from
1735 An integer or a name like ``dimension0''.
1738 @defvr {Required} helpId
1742 @node SPV Detail graph Element
1743 @subsection The @code{graph} Element
1745 Parent: @code{visualization} @*
1746 Contents: @code{location}@math{+} @code{coordinates} @code{faceting} @code{facetLayout} @code{interval}
1748 @code{graph} has the following attributes.
1750 @defvr {Required} cellStyle
1751 @defvrx {Required} style
1752 Each of these is the @code{id} of a @code{style} element (@pxref{SPV
1753 Detail style element}). The former is the default style for
1754 individual cells, the latter for the entire table.
1757 @node SPV Detail location Element
1758 @subsection The @code{location} Element
1760 Parent: @code{graph} @*
1763 Each instance of this element specifies where some part of the table
1764 frame is located. All the examples in the corpus have four instances
1765 of this element, one for each of the parts @code{height},
1766 @code{width}, @code{left}, and @code{top}. Some examples in the
1767 corpus add a fifth for part @code{bottom}, even though it is not clear
1768 how all of @code{top}, @code{bottom}, and @code{heigth} can be honored
1769 at the same time. In any case, @code{location} seems to have little
1770 importance in representing tables; a reader can safely ignore it.
1772 @defvr {Required} part
1773 One of @code{height}, @code{width}, @code{top}, @code{bottom}, or
1774 @code{left}. Presumably @code{right} is acceptable as well but the
1775 corpus contains no examples.
1778 @defvr {Required} method
1779 How the location is determined:
1783 Based on the natural size of the table. Observed only for
1784 parts @code{height} and @code{width}.
1787 Based on the location specified in @code{target}. Observed only for
1788 parts @code{top} and @code{bottom}.
1791 Using the value in @code{value}. Observed only for parts @code{top},
1792 @code{bottom}, and @code{left}.
1795 Same as the specified @code{target}. Observed only for part
1800 @defvr {Optional} min
1801 Minimum size. Only observed with value @code{100pt}. Only observed
1802 for part @code{width}.
1805 @defvr {Dependent} target
1806 Required when @code{method} is @code{attach} or @code{same}, not
1807 observed otherwise. This is the ID of an element to attach to.
1808 Observed with the ID of @code{title}, @code{footnote}, @code{graph},
1812 @defvr {Dependent} value
1813 Required when @code{method} is @code{fixed}, not observed otherwise.
1814 Observed values are @code{0%}, @code{0px}, @code{1px}, and @code{3px}
1815 on parts @code{top} and @code{left}, and @code{100%} on part
1819 @node SPV Detail coordinates Element
1820 @subsection The @code{coordinates} Element
1822 Parent: @code{graph} @*
1825 This element is always present and always empty, with no attributes
1828 @node SPV Detail faceting Element
1829 @subsection The @code{faceting} Element
1831 Parent: @code{graph} @*
1832 Contents: @code{cross} @code{layer}*
1834 The @code{faceting} element describes the row, column, and layer
1835 structure of the table. Its @code{cross} child determines the row and
1836 column structure, and each @code{layer} child (if any) represents a
1839 @code{faceting} has no attributes (other than @code{id}).
1841 @subsubheading The @code{cross} Element
1843 Parent: @code{faceting} @*
1844 Contents: @code{nest} @code{nest}
1846 The @code{cross} element describes the row and column structure of the
1847 table. It has exactly two @code{nest} children, the first of which
1848 describes the table's rows and the second the table's columns.
1850 @code{cross} has no attributes (other than @code{id}).
1852 @subsubheading The @code{nest} Element
1854 Parent: @code{cross} @*
1855 Contents: @code{variableReference}@math{+}
1857 A given @code{nest} usually consists of one or more dimensions, each
1858 of which is represented by @code{variableReference} child elements.
1859 Minimally, a dimension has two @code{variableReference} children, one
1860 for the categories, one for the data, e.g.:
1864 <variableReference ref="dimension0categories"/>
1865 <variableReference ref="dimension0"/>
1870 Groups of categories introduce additional variable references, e.g.@:
1874 <variableReference ref="dimension0categories"/>
1875 <variableReference ref="dimension0group0"/>
1876 <variableReference ref="dimension0"/>
1881 Grouping can be hierarchical, e.g.@:
1885 <variableReference ref="dimension0categories"/>
1886 <variableReference ref="dimension0group1"/>
1887 <variableReference ref="dimension0group0"/>
1888 <variableReference ref="dimension0"/>
1893 XXX what are group maps?
1896 <nest id="nest_1973">
1897 <variableReference ref="dimension1categories"/>
1898 <variableReference ref="dimension1group1map"/>
1899 <variableReference ref="dimension1group0map"/>
1900 <variableReference ref="dimension1"/>
1903 <variableReference ref="dimension0categories"/>
1904 <variableReference ref="dimension0group0map"/>
1905 <variableReference ref="dimension0"/>
1910 A @code{nest} can contain multiple dimensions:
1914 <variableReference ref="dimension1categories"/>
1915 <variableReference ref="dimension1group0"/>
1916 <variableReference ref="dimension1"/>
1917 <variableReference ref="dimension0categories"/>
1918 <variableReference ref="dimension0"/>
1922 One @code{nest} within a given @code{cross} may have no dimensions, in
1923 which case it still has one @code{variableReference} child, which
1924 references a @code{derivedVariable} whose @code{value} attribute is
1925 @code{constant(0)}. In the corpus, such a @code{derivedVariable} has
1926 @code{row} or @code{column}, respectively, as its @code{id}.
1928 @code{nest} has no attributes (other than @code{id}).
1930 @subsubheading The @code{variableReference} Element
1932 Parent: @code{nest} @*
1935 @code{variableReference} has one attribute.
1937 @defvr {Required} ref
1938 The @code{id} of a @code{sourceVariable} or @code{derivedVariable}
1942 @subsubheading The @code{layer} Element
1944 Parent: @code{faceting} @*
1947 Each layer is represented by a pair of @code{layer} elements. The
1948 first of this pair is for a category variable, the second for the data
1952 <layer value="0" variable="dimension0categories" visible="true"/>
1953 <layer value="dimension0" variable="dimension0" visible="false"/>
1957 @code{layer} has the following attributes.
1959 @defvr {Required} variable
1960 The @code{id} of a @code{sourceVariable} or @code{derivedVariable}
1964 @defvr {Required} value
1965 The value to select. For a category variable, this is always
1966 @code{0}; for a data variable, it is the same as the @code{variable}
1970 @defvr {Optional} visible
1971 Whether the layer is visible. Generally, category layers are visible
1972 and data layers are not, but sometimes this attribute is omitted.
1975 @defvr {Optional} method
1976 When present, this is always @code{nest}.
1979 @node SPV Detail facetLayout Element
1980 @subsection The @code{facetLayout} Element
1982 Parent: @code{graph} @*
1983 Contents: @code{tableLayout} @code{facetLevel}@math{+} @code{setCellProperties}*
1985 @subsubheading The @code{tableLayout} Element
1987 Parent: @code{facetLayout} @*
1990 @defvr {Required} verticalTitlesInCorner
1991 Always set to @code{true}.
1994 @defvr {Optional} style
1995 The @code{id} of a @code{style} element.
1998 @defvr {Optional} fitCells
1999 Always set to @code{ticks}.
2002 @subsubheading The @code{facetLevel} Element
2004 Parent: @code{facetLayout} @*
2005 Contents: @code{axis}
2007 Each @code{facetLevel} describes a @code{variableReference} or
2008 @code{layer}, and a table has one @code{facetLevel} element for
2009 each such element. For example, an SPV detail member that contains
2010 four @code{variableReference} elements and two @code{layer} elements
2011 will contain six @code{facetLevel} elements.
2013 In the corpus, @code{facetLevel} elements and the elements that they
2014 describe are always in the same order. The correspondence may also be
2015 observed in two other ways. First, one may use the @code{level}
2016 attribute, described below. Second, in the corpus, a
2017 @code{facetLevel} always has an @code{id} that is the same as the
2018 @code{id} of the element it describes with @code{_facetLevel}
2019 appended. One should not formally rely on this, of course, but it is
2020 usefully indicative.
2022 @defvr {Required} level
2023 A 1-based index into the @code{variableReference} and @code{layer}
2024 elements, e.g.@: a @code{facetLayout} with a @code{level} of 1
2025 describes the first @code{variableReference} in the SPV detail member,
2026 and in a member with four @code{variableReference} elements, a
2027 @code{facetLayout} with a @code{level} of 5 describes the first
2028 @code{layer} in the member.
2031 @defvr {Required} gap
2032 Always observed as @code{0pt}.
2035 @subsubheading The @code{axis} Element
2037 Parent: @code{facetLevel} @*
2038 Contents: @code{label}? @code{majorTicks}
2040 @defvr {Attribute} style
2041 The @code{id} of a @code{style} element.
2044 @subsubheading The @code{label} Element
2046 Parent: @code{axis} or @code{labelFrame} @*
2047 Contents: @code{text}@math{+} @math{|} @code{descriptionGroup}
2049 This element represents a label on some aspect of the table. For example,
2050 the table's title is a @code{label}.
2052 The contents of the label can be one or more @code{text} elements or a
2053 @code{descriptionGroup}.
2055 @defvr {Attribute} style
2056 @defvrx {Optional} textFrameStyle
2057 Each of these is the @code{id} of a @code{style} element.
2058 @code{style} is the style of the label text, @code{textFrameStyle} the
2059 style for the frame around the label.
2062 @defvr {Optional} purpose
2063 The kind of entity being labeled, one of @code{title},
2064 @code{subTitle}, @code{layer}, or @code{footnote}.
2067 @subsubheading The @code{descriptionGroup} Element
2069 Parent: @code{label} @*
2070 Contents: (@code{description} @math{|} @code{text})@math{+}
2072 A @code{descriptionGroup} concatenates one or more elements to form a
2073 label. Each element can be a @code{text} element, which contains
2074 literal text, or a @code{description} element that substitutes a value
2077 @defvr {Attribute} target
2078 The @code{id} of an element being described. In the corpus, this is
2079 always @code{faceting}.
2082 @defvr {Attribute} separator
2083 A string to separate the description of multiple groups, if the
2084 @code{target} has more than one. In the corpus, this is always a
2088 Typical contents for a @code{descriptionGroup} are a value by itself:
2090 <description name="value"/>
2092 @noindent or a variable and its value, separated by a colon:
2094 <description name="variable"/><text>:</text><description name="value"/>
2097 @subsubheading The @code{description} Element
2099 Parent: @code{descriptionGroup} @*
2102 A @code{description} is like a macro that expands to some property of
2103 the target of its parent @code{descriptionGroup}.
2105 @defvr {Attribute} name
2106 The name of the property. Only @code{variable} and @code{value}
2107 appear in the corpus.
2110 @subsubheading The @code{majorTicks} Element
2112 Parent: @code{axis} @*
2113 Contents: @code{gridline}?
2115 @defvr {Attribute} labelAngle
2116 @defvrx {Attribute} length
2117 Both always defined to @code{0}.
2120 @defvr {Attribute} style
2121 @defvrx {Attribute} tickFrameStyle
2122 Each of these is the @code{id} of a @code{style} element.
2123 @code{style} is the style of the tick labels, @code{tickFrameStyle}
2124 the style for the frames around the labels.
2127 @subsubheading The @code{gridline} Element
2129 Parent: @code{majorTicks} @*
2132 Represents ``gridlines,'' which for a table represents the lines
2133 between the rows or columns of a table (XXX?).
2135 @defvr {Attribute} style
2136 The style for the gridline.
2139 @defvr {Attribute} zOrder
2140 Observed as a number between 28 and 31. Does not seem to be
2144 @subsubheading The @code{setCellProperties} Element
2146 Parent: @code{facetLayout} @*
2147 Contents: @code{setMetaData} @code{setStyle}* @code{setFormat}@math{+} @code{union}?
2149 This element sets style properties of cells designated by the
2150 @code{target} attribute of its child elements, as further restricted
2151 by the optional @code{union} element if present. The @code{target}
2152 values often used, e.g.@: @code{graph} or @code{labeling}, actually
2153 affect every cell, so the @code{union} element is a useful
2156 @defvr {Optional} applyToConverse
2157 If present, always @code{true}. This appears to invert the meaning of
2158 the @code{target} of sub-elements: the selected cells are the ones
2159 @emph{not} designated by @code{target}. This is confusing, given the
2160 additional restrictions of @code{union}, but in the corpus
2161 @code{applyToConverse} is never present along with @code{union}.
2164 @subsubheading The @code{setMetaData} Element
2166 Parent: @code{setCellProperties} @*
2169 This element is not known to have any visible effect.
2171 @defvr {Required} target
2172 The @code{id} of an element whose metadata is to be set. In the
2173 corpus, this is always @code{graph}, the @code{id} used for the
2174 @code{graph} element.
2177 @defvr {Required} key
2178 @defvrx {Required} value
2179 A key-value pair to set for the target.
2181 In the corpus, @code{key} is @code{cellPropId} or, rarely,
2182 @code{diagProps}, and @code{value} is always the @code{id} of the
2183 parent @code{setCellProperties}.
2186 @subsubheading The @code{setStyle} Element
2188 Parent: @code{setCellProperties} @*
2191 This element associates a style with the target.
2193 @defvr {Required} target
2194 The @code{id} of an element whose style is to be set. In the corpus,
2195 this is always the @code{id} of an @code{interval}, @code{labeling},
2196 or, rarely, @code{graph} element.
2199 @defvr {Required} style
2200 The @code{id} of a @code{style} element that identifies the style to
2204 @subsubheading The @code{setFormat} Element
2207 Parent: @code{setCellProperties}
2210 @math{|} @code{numberFormat}
2211 @math{|} @code{stringFormat}@math{+}
2212 @math{|} @code{dateTimeFormat}
2215 This element sets the format of the target, ``format'' in this case
2216 meaning the SPSS print format for a variable.
2218 The details of this element vary depending on the schema version, as
2219 declared in the root @code{visualization} element's @code{version}
2220 attribute (@pxref{SPV Detail visualization Element}). In version 2.5
2221 and earlier, @code{setFormat} contains one of a number of child
2222 elements that correspond to the different varieties of print formats.
2223 In version 2.7 and later, @code{setFormat} instead always contains a
2224 @code{format} element.
2226 XXX reinvestigate the above claim about versions: it appears to be
2229 The @code{setFormat} element itself has the following attributes.
2231 @defvr {Required} target
2232 The @code{id} of an element whose style is to be set. In the corpus,
2233 this is always the @code{id} of an @code{majorTicks} or
2234 @code{labeling} element.
2237 @defvr {Optional} reset
2238 If this is @code{true}, this format overrides the target's previous
2239 format. If it is @code{false}, the adds to the previous format. In
2240 the corpus this is always @code{true}. The default behavior is
2245 * SPV Detail format Element::
2246 * SPV Detail numberFormat Element::
2247 * SPV Detail stringFormat Element::
2248 * SPV Detail dateTimeFormat Element::
2249 * SPV Detail affix Element::
2250 * SPV Detail relabel Element::
2251 * SPV Detail union Element::
2254 @node SPV Detail format Element
2255 @subsubsection The @code{format} Element
2257 Parent: @code{sourceVariable}, @code{derivedVariable}, @code{formatMapping}, @code{labeling}, @code{formatMapping}, @code{setFormat} @*
2258 Contents: (@code{affix}@math{+} @math{|} @code{relabel}@math{+})?
2260 This element appears only in schema version 2.7 (@pxref{SPV Detail
2261 visualization Element}).
2263 This element determines a format, equivalent to an SPSS print format.
2265 @subsubheading Attributes for All Formats
2267 These attributes apply to all kinds of formats. The most important of
2268 these attributes determines the high-level kind of formatting in use:
2270 @defvr {Optional} baseFormat
2271 Either @code{dateTime} or @code{elapsedTime}. When this attribute is
2272 omitted, this element is a numeric or string format.
2276 Whether, in the corpus, other attributes are always present (``yes''),
2277 never present (``no''), or sometimes present (``opt'') depends on
2280 @multitable {maximumFractionDigits} {@code{dateTime}} {@code{elapsedTime}} {number} {string}
2281 @headitem Attribute @tab @code{dateTime} @tab @code{elapsedTime} @tab number @tab string
2282 @item errorCharacter @tab yes @tab yes @tab yes @tab opt
2284 @item separatorChars @tab yes @tab no @tab no @tab no
2286 @item mdyOrder @tab yes @tab no @tab no @tab no
2288 @item showYear @tab yes @tab no @tab no @tab no
2289 @item yearAbbreviation @tab yes @tab no @tab no @tab no
2291 @item showMonth @tab yes @tab no @tab no @tab no
2292 @item monthFormat @tab yes @tab no @tab no @tab no
2294 @item showDay @tab yes @tab opt @tab no @tab no
2295 @item dayPadding @tab yes @tab opt @tab no @tab no
2296 @item dayOfMonthPadding @tab yes @tab no @tab no @tab no
2297 @item dayType @tab yes @tab no @tab no @tab no
2299 @item showHour @tab yes @tab opt @tab no @tab no
2300 @item hourFormat @tab yes @tab opt @tab no @tab no
2301 @item hourPadding @tab yes @tab yes @tab no @tab no
2303 @item showMinute @tab yes @tab yes @tab no @tab no
2304 @item minutePadding @tab yes @tab yes @tab no @tab no
2306 @item showSecond @tab yes @tab yes @tab no @tab no
2307 @item secondPadding @tab no @tab yes @tab no @tab no
2309 @item showMillis @tab no @tab yes @tab no @tab no
2311 @item minimumIntegerDigits @tab no @tab no @tab yes @tab no
2312 @item maximumFractionDigits @tab no @tab yes @tab yes @tab no
2313 @item minimumFractionDigits @tab no @tab yes @tab yes @tab no
2314 @item useGrouping @tab no @tab opt @tab yes @tab no
2315 @item scientific @tab no @tab no @tab yes @tab no
2316 @item small @tab no @tab no @tab opt @tab no
2317 @item suffix @tab no @tab no @tab opt @tab no
2319 @item tryStringsAsNumbers @tab no @tab no @tab no @tab yes
2323 @defvr {Attribute} errorCharacter
2324 A character that replaces the formatted value when it cannot otherwise
2325 be represented in the given format. Always @samp{*}.
2328 @subsubheading Date and Time Attributes
2330 These attributes are used with @code{dateTime} and @code{elapsedTime}
2333 @defvr {Attribute} separatorChars
2334 Exactly four characters. In order, these are used for: decimal point,
2335 grouping, date separator, time separator. Always @samp{.,-:}.
2338 @defvr {Attribute} mdyOrder
2339 Within a date, the order of the days, months, and years.
2340 @code{dayMonthYear} is the only observed value, but one would expect
2341 that @code{monthDayYear} and @code{yearMonthDay} to be reasonable as
2345 @defvr {Attribute} showYear
2346 @defvrx {Attribute} yearAbbreviation
2347 Whether to include the year and, if so, whether the year should be
2348 shown abbreviated, that is, with only 2 digits. Each is @code{true}
2349 or @code{false}; only values of @code{true} and @code{false},
2350 respectively, have been observed.
2353 @defvr {Attribute} showMonth
2354 @defvrx {Attribute} monthFormat
2355 Whether to include the month (@code{true} or @code{false}) and, if so,
2356 how to format it. @code{monthFormat} is one of the following:
2360 The full name of the month, e.g.@: in an English locale,
2364 The abbreviated name of the month, e.g.@: in an English locale,
2368 The number representing the month, e.g.@: 9 for September.
2371 A two-digit number representing the month, e.g.@: 09 for September.
2374 Only values of @code{true} and @code{short}, respectively, have been
2378 @defvr {Attribute} dayPadding
2379 @defvrx {Attribute} dayOfMonthPadding
2380 @defvrx {Attribute} hourPadding
2381 @defvrx {Attribute} minutePadding
2382 @defvrx {Attribute} secondPadding
2383 These attributes presumably control whether each field in the output
2384 is padded with spaces to its maximum width, but the details are not
2385 understood. The only observed value for any of these attributes is
2389 @defvr {Attribute} showDay
2390 @defvrx {Attribute} showHour
2391 @defvrx {Attribute} showMinute
2392 @defvrx {Attribute} showSecond
2393 @defvrx {Attribute} showMillis
2394 These attributes presumably control whether each field is displayed
2395 in the output, but the details are not understood. The only
2396 observed value for any of these attributes is @code{true}.
2399 @defvr {Attribute} dayType
2400 This attribute is always @code{month} in the corpus, specifying that
2401 the day of the month is to be displayed; a value of @code{year} is
2402 supposed to indicate that the day of the year, where 1 is January 1,
2403 is to be displayed instead.
2406 @defvr {Attribute} hourFormat
2407 @code{hourFormat}, if present, is one of:
2411 The time is displayed with an @code{am} or @code{pm} suffix, e.g.@:
2415 The time is displayed in a 24-hour format, e.g.@: @code{22:15}.
2417 This is the only value observed in the corpus.
2420 The time is displayed in a 12-hour format, without distinguishing
2421 morning or evening, e.g.@: @code{10;15}.
2424 @code{hourFormat} is sometimes present for @code{elapsedTime} formats,
2425 which is confusing since a time duration does not have a concept of AM
2426 or PM. This might indicate a bug in the code that generated the XML
2427 in the corpus, or it might indicate that @code{elapsedTime} is
2428 sometimes used to format a time of day.
2431 @subsubheading Numeric Attributes
2433 These attributes are used for formats when @code{baseFormat} is
2434 @code{number}. Attributes @code{maximumFractionDigits}, and
2435 @code{minimumFractionDigits}, and @code{useGrouping} are also used
2436 when @code{baseFormat} is @code{elapsedTime}.
2438 @defvr {Attribute} minimumIntegerDigits
2439 Minimum number of digits to display before the decimal point. Always
2440 observed as @code{0}.
2443 @defvr {Attribute} maximumFractionDigits
2444 @defvrx {Attribute} maximumFractionDigits
2445 Maximum or minimum, respectively, number of digits to display after
2446 the decimal point. The observed values of each attribute range from 0
2450 @defvr {Attribute} useGrouping
2451 Whether to use the grouping character to group digits in large
2452 numbers. It would make sense for the grouping character to come from
2453 the @code{separatorChars} attribute, but that attribute is only
2454 present when @code{baseFormat} is @code{dateTime} or
2455 @code{elapsedTime}, in the corpus at least. Perhaps that is because
2456 this attribute has only been observed as @code{false}.
2459 @defvr {Attribute} scientific
2460 This attribute controls when and whether the number is formatted in
2461 scientific notation. It takes the following values:
2465 Use scientific notation only when the number's magnitude is smaller
2466 than the value of the @code{small} attribute.
2469 Use scientific notation when the number will not otherwise fit in the
2473 Always use scientific notation. Not observed in the corpus.
2476 Never use scientific notation. A number that won't otherwise fit will
2477 be replaced by an error indication (see the @code{errorCharacter}
2478 attribute). Not observed in the corpus.
2482 @defvr {Optional} small
2483 Only present when the @code{scientific} attribute is
2484 @code{onlyForSmall}, this is a numeric magnitude below which the
2485 number will be formatted in scientific notation. The values @code{0}
2486 and @code{0.0001} have been observed. The value @code{0} seems like a
2487 pathological choice, since no real number has a magnitude less than 0;
2488 perhaps in practice such a choice is equivalent to setting
2489 @code{scientific} to @code{false}.
2492 @defvr {Optional} prefix
2493 @defvrx {Optional} suffix
2494 Specifies a prefix or a suffix to apply to the formatted number. Only
2495 @code{suffix} has been observed, with value @samp{%}.
2498 @subsubheading String Attributes
2500 These attributes are used for formats when @code{baseFormat} is
2503 @defvr {Attribute} tryStringsAsNumbers
2504 When this is @code{true}, it is supposed to indicate that string
2505 values should be parsed as numbers and then displayed according to
2506 numeric formatting rules. However, in the corpus it is always
2510 @node SPV Detail numberFormat Element
2511 @subsubsection The @code{numberFormat} Element
2513 Parent: @code{setFormat} @*
2514 Contents: @code{affix}@math{+}
2516 This element appears only in schema version 2.5 and earlier
2517 (@pxref{SPV Detail visualization Element}). Possibly this element
2518 could also contain @code{relabel} elements in a more diverse corpus.
2520 This element has the following attributes.
2522 @defvr {Attribute} maximumFractionDigits
2523 @defvrx {Attribute} minimumFractionDigits
2524 @defvrx {Attribute} minimumIntegerDigits
2525 @defvrx {Optional} scientific
2526 @defvrx {Optional} small
2527 @defvrx {Optional} suffix
2528 @defvrx {Optional} useGroupging
2529 The syntax and meaning of these attributes is the same as on the
2530 @code{format} element for a numeric format. @pxref{SPV Detail format
2534 @node SPV Detail stringFormat Element
2535 @subsubsection The @code{stringFormat} Element
2537 Parent: @code{setFormat} @*
2538 Contents: (@code{affix}@math{+} @math{|} @code{relabel}@math{+})?
2540 This element appears only in schema version 2.5 and earlier
2541 (@pxref{SPV Detail visualization Element}).
2543 This element has no attributes.
2545 @node SPV Detail dateTimeFormat Element
2546 @subsubsection The @code{dateTimeFormat} Element
2548 Parent: @code{setFormat} @*
2551 This element appears only in schema version 2.5 and earlier
2552 (@pxref{SPV Detail visualization Element}). Possibly this element
2553 could also contain @code{affix} and @code{relabel} elements in a more
2556 The following attribute is required.
2558 @defvr {Attribute} baseFormat
2559 Either @code{dateTime} or @code{time}.
2562 When @code{baseFormat} is @code{dateTime}, the following attributes
2565 @defvr {Attribute} dayOfMonthPadding
2566 @defvrx {Attribute} dayPadding
2567 @defvrx {Attribute} dayType
2568 @defvrx {Attribute} hourFormat
2569 @defvrx {Attribute} hourPadding
2570 @defvrx {Attribute} mdyOrder
2571 @defvrx {Attribute} minutePadding
2572 @defvrx {Attribute} monthFormat
2573 @defvrx {Attribute} separatorChars
2574 @defvrx {Attribute} showDay
2575 @defvrx {Attribute} showHour
2576 @defvrx {Attribute} showMinute
2577 @defvrx {Attribute} showMonth
2578 @defvrx {Attribute} showSecond
2579 @defvrx {Attribute} showYear
2580 @defvrx {Attribute} yearAbbreviation
2581 The syntax and meaning of these attributes is the same as on the
2582 @code{format} element when that element's @code{baseFormat} is
2583 @code{dateTime}. @pxref{SPV Detail format Element}.
2586 When @code{baseFormat} is @code{time}, the following attributes are
2589 @defvr {Attribute} hourFormat
2590 @defvrx {Attribute} hourPadding
2591 @defvrx {Attribute} minutePadding
2592 @defvrx {Attribute} monthFormat
2593 @defvrx {Attribute} separatorChars
2594 @defvrx {Attribute} showDay
2595 @defvrx {Attribute} showHour
2596 @defvrx {Attribute} showMinute
2597 @defvrx {Attribute} showMonth
2598 @defvrx {Attribute} showSecond
2599 @defvrx {Attribute} showYear
2600 @defvrx {Attribute} yearAbbreviation
2601 The syntax and meaning of these attributes is the same as on the
2602 @code{format} element when that element's @code{baseFormat} is
2603 @code{elapsedTime}. @pxref{SPV Detail format Element}.
2606 @node SPV Detail affix Element
2607 @subsubsection The @code{affix} Element
2609 Parent: @code{format} or @code{numberFormat} or @code{stringFormat} @*
2612 Possibly this element could have @code{dateTimeFormat} as a parent in
2613 a more diverse corpus.
2615 This defines a suffix (or, theoretically, a prefix) for a formatted
2616 value. It is used to insert a reference to a footnote. It has the
2617 following attributes:
2619 @defvr {Attribute} definesReference
2620 This specifies the footnote number as a natural number: 1 for the
2621 first footnote, 2 for the second, and so on.
2624 @defvr {Attribute} position
2625 Position for the footnote label. Always @code{superscript}.
2628 @defvr {Attribute} suffix
2629 Whether the affix is a suffix (@code{true}) or a prefix
2630 (@code{false}). Always @code{true}.
2633 @defvr {Attribute} value
2634 The text of the suffix or prefix. Typically a letter, e.g.@: @code{a}
2635 for footnote 1, @code{b} for footnote 2, @enddots{} The corpus
2636 contains other values: @code{*}, @code{**}, and a few that begin with
2637 at least one comma: @code{,b}, @code{,c}, @code{,,b}, and @code{,,c}.
2640 @node SPV Detail relabel Element
2641 @subsubsection The @code{relabel} Element
2643 Parent: @code{format} or @code{stringFormat} @*
2646 Possibly this element could have @code{numberFormat} or
2647 @code{dateTimeFormat} as a parent in a more diverse corpus.
2649 This specifies how to display a given value. It is used to implement
2650 value labels and to display the system-missing value in a
2651 human-readable way. It has the following attributes:
2653 @defvr {Attribute} from
2654 The value to map. In the corpus this is an integer or the
2655 system-missing value @code{-1.797693134862316E300}.
2658 @defvr {Attribute} to
2659 The string to display in place of the value of @code{from}. In the
2660 corpus this is a wide variety of value labels; the system-missing
2661 value is mapped to @samp{.}.
2664 @node SPV Detail union Element
2665 @subsubsection The @code{union} Element
2667 Parent: @code{setCellProperties} @*
2668 Contents: @code{intersect}@math{+}
2670 This element represents a set of cells, computed as the union of the
2671 sets represented by each of its children.
2673 @subsubheading The @code{intersect} Element
2675 Parent: @code{union} @*
2676 Contents: @code{where}@math{+} @math{|} @code{intersectWhere}?
2678 This element represents a set of cells, computed as the intersection
2679 of the sets represented by each of its children.
2681 Of the two possible children, in the corpus @code{where} is far more
2682 common, appearing thousands of times, whereas @code{intersectWhere}
2683 only appears 4 times.
2685 Most @code{intersect} elements have two or more children.
2687 @subsubheading The @code{where} Element
2689 Parent: @code{intersect} @*
2692 This element represents the set of cells in which the value of a
2693 specified variable falls within a specified set.
2695 @defvr {Attribute} variable
2696 The @code{id} of a variable, e.g.@: @code{dimension0categories} or
2697 @code{dimension0group0map}.
2700 @defvr {Attribute} include
2701 A value, or multiple values separated by semicolons,
2702 e.g.@: @code{0} or @code{13;14;15;16}.
2705 @subsubheading The @code{intersectWhere}
2707 Parent: @code{intersect} @*
2710 The meaning of this element is unknown.
2712 @defvr {Attribute} variable
2713 @defvrx {Attribute} variable2
2714 The meaning of these attributes is unknown. In the four examples in
2715 the corpus they always take the values @code{dimension2categories} and
2716 @code{dimension0categories}, respectively.