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
1267 @math{|} 31 int[@t{n-refs}] int16*[@t{n-refs}] Format
1270 Format @result{} 00 00 count(FormatString Style 58)
1271 FormatString @result{} count((count((i0 58)?) (58 @math{|} 31 string))?)
1274 bool[@t{bold}] bool[@t{italic}] bool[@t{underline}] bool[@t{show}]
1275 string[@t{fgcolor}] string[@t{bgcolor}]
1276 string[@t{typeface}] byte[@t{size}]
1279 int[@t{halign}] int[@t{valign}] double[@t{offset}]
1280 int16[@t{left-margin}] int16[@t{right-margin}]
1281 int16[@t{top-margin}] int16[@t{bottom-margin}]
1285 A ValueMod that begins with ``31 i0'' specifies a string to append to
1286 the main text of the Value, as a subscript. The subscript text is a
1287 brief indicator, e.g.@: @samp{a} or @samp{a,b}, with its meaning
1288 indicated by the table caption. In this usage, subscripts are similar
1289 to footnotes. One apparent difference is that a Value can only
1290 reference one footnote but a subscript can list more than one letter.
1292 A ValueMod that begins with 31 followed by a nonzero ``int'' specifies
1293 a footnote or footnotes that the Value references. Footnote markers
1294 are shown appended to the main text of the Value, as superscripts.
1296 The Format, if present, is a format string for substitutions using the
1297 syntax explained previously. It appears to be an English-language
1298 version of the localized format string in the Value in which the
1301 Style and Style2, if present, change the style for this individual
1302 Value. @code{bold}, @code{italic}, and @code{underline} control the
1303 particular style. @code{fgcolor} and @code{bgcolor} are strings, such
1304 as @code{#ffffff}. The @code{size} is a font size in units of 1/96
1307 @code{halign} is 0 for center, 2 for left, 4 for right, 6 for decimal,
1308 0xffffffad for mixed. For decimal alignment, @code{offset} is the
1309 decimal point's offset from the right side of the cell, in units of
1312 @code{valign} specifies vertical alignment: 0 for center, 1 for top, 3
1315 @code{left-margin}, @code{right-margin}, @code{top-margin}, and
1316 @code{bottom-margin} are in units of 1/72 inch.
1318 @node SPV Legacy Detail Member Binary Format
1319 @section Legacy Detail Member Binary Format
1321 Whereas the light binary format represents everything about a given
1322 pivot table, the legacy binary format conceptually consists of a
1323 number of named sources, each of which consists of a number of named
1324 variables, each of which is a 1-dimensional array of numbers or
1325 strings or a mix. Thus, the legacy binary member format is quite
1328 This section uses the same context-free grammar notation as in the
1329 previous section, with the following additions:
1333 In a version 0xaf legacy member, @var{x}; in other versions, nothing.
1334 (The legacy member header indicates the version; see below.)
1337 In a version 0xb0 legacy member, @var{x}; in other versions, nothing.
1340 A legacy detail member @file{.bin} has the following overall format:
1344 LegacyBinary @result{}
1345 00 byte[@t{version}] int16[@t{n-sources}] int[@t{member-size}]
1346 Metadata*[@t{n-sources}] Data*[@t{n-sources}]
1350 @code{version} is a version number that affects the interpretation of
1351 some of the other data in the member. Versions 0xaf and 0xb0 are
1352 known. We will refer to ``version 0xaf'' and ``version 0xb0'' members
1355 A legacy member consists of @code{n-sources} data sources, each of
1356 which has Metadata and Data.
1358 @code{member-size} is the size of the legacy binary member, in bytes.
1360 The following sections go into more detail.
1363 * SPV Legacy Member Metadata::
1364 * SPV Legacy Member Data::
1367 @node SPV Legacy Member Metadata
1368 @subsection Metadata
1373 int[@t{n-data}] int[@t{n-variables}] int[@t{offset}]
1374 vAF(byte*32[@t{source-name}])
1375 vB0(byte*64[@t{source-name}] int[@t{x}])
1379 A data source has @code{n-variables} variables, each with
1380 @code{n-data} data values.
1382 @code{source-name} is a 32- or 64-byte string padded on the right with
1383 zero bytes. The names that appear in the corpus are very generic:
1384 usually @code{tableData} for pivot table data or @code{source0} for
1387 A given Metadata's @code{offset} is the offset, in bytes, from the
1388 beginning of the member to the start of the corresponding Data. This
1389 allows programs to skip to the beginning of the data for a particular
1390 source; it is also important to determine whether a source includes
1391 any string data (@pxref{SPV Legacy Member Data}).
1393 The meaning of @code{x} in version 0xb0 is unknown.
1395 @node SPV Legacy Member Data
1400 Data @result{} NumericData*[@t{n-variables}] StringData?
1401 NumericData @result{} byte*288[@t{variable-name}] double*[@t{n-data}]
1405 Data follow the Metadata in the legacy binary format, with sources in
1406 the same order. Each NumericSeries begins with a @code{variable-name}
1407 that generally indicates its role in the pivot table, e.g.@: ``cell'',
1408 ``cellFormat'', ``dimension0categories'', ``dimension0group0'',
1409 followed by the numeric data, one double per datum. A double with the
1410 maximum negative double @code{-DBL_MAX} represents the system-missing
1415 StringData @result{} i1 string[@t{source-name}] Pairs Labels
1417 Pairs @result{} int[@t{n-string-vars}] PairSeries*[@t{n-string-vars}]
1418 PairVar @result{} string[@t{pair-var-name}] int[@t{n-pairs}] Pair*[@t{n-pairs}]
1419 Pair @result{} int[@t{i}] int[@t{j}]
1421 Labels @result{} int[@t{n-labels}] Label*[@t{n-labels}]
1422 Label @result{} int[@t{frequency}] int[@t{s}]
1426 A source may include a mix of numeric and string data values. When a
1427 source includes any string data, the data values that are strings are
1428 set to SYSMIS in the NumericData, and StringData follows the
1429 NumericData. A source that contains no string data omits the
1430 StringData. To reliably determine whether a source includes
1431 StringData, the reader should check whether the offset following the
1432 NumericData is the offset of the next source, as indicated by its
1433 Metadata (or the end of the member, in the case of the last source).
1435 StringData repeats the name of the source (from Metadata).
1437 The string data overlays the numeric data. @code{n-string-vars} is
1438 the number of variables in the source that include string data. More
1439 precisely, it is the 1-based index of the last variable in the source
1440 that includes any string data; thus, it would be 4 if there are 5
1441 variables and only the fourth one includes string data.
1443 Each PairVar consists a sequence of 0 or more Pair nonterminals, each
1444 of which maps from a 0-based index within variable @code{i} to a
1445 0-based label index @code{j}, e.g.@: pair @code{i} = 2, @code{j} = 3,
1446 means that the third data value (with value SYSMIS) is to be replaced
1447 by the string of the fourth Label.
1449 The labels themselves follow the pairs. The valuable part of each
1450 label is the string @code{s}. Each label also includes a
1451 @code{frequency} that reports the number of pairs that reference it
1452 (although this is not useful).
1454 @node SPV Legacy Detail Member XML Format
1455 @section Legacy Detail Member XML Format
1457 This format is still under investigation.
1459 The design of the detail XML format is not what one would end up with
1460 for describing pivot tables. This is because it is a special case
1461 of a much more general format (``visualization XML'' or ``VizML'')
1462 that can describe a wide range of visualizations. Most of this
1463 generality is overkill for tables, and so we end up with a funny
1464 subset of a general-purpose format.
1466 The important elements of the detail XML format are:
1470 Variables. Variables in detail XML roughly correspond to the
1471 dimensions in a light detail member. There is one variable for each
1472 dimension, plus one variable for each level of labeling along an axis.
1474 The bulk of variables are defined with @code{sourceVariable} elements.
1475 The data for these variables comes from the associated
1476 @code{tableData.bin} member. Some variables are defined, with
1477 @code{derivedVariable} elements, as a constant or in terms of a
1478 mapping function from a source variable.
1481 Assignment of variables to axes. A variable can appear as columns, or
1482 rows, or layers. The @code{faceting} element and its sub-elements
1483 describe this assignment.
1486 All elements have an optional @code{id} attribute. In practice many
1487 elements are assigned @code{id} attributes that are never referenced.
1490 * SPV Detail visualization Element::
1491 * SPV Detail userSource Element::
1492 * SPV Detail sourceVariable Element::
1493 * SPV Detail derivedVariable Element::
1494 * SPV Detail extension Element::
1495 * SPV Detail graph Element::
1496 * SPV Detail location Element::
1497 * SPV Detail coordinates Element::
1498 * SPV Detail faceting Element::
1499 * SPV Detail facetLayout Element::
1502 @node SPV Detail visualization Element
1503 @subsection The @code{visualization} Element
1506 Parent: Document root
1510 (sourceVariable @math{|} derivedVariable)@math{+}
1518 This element has the following attributes.
1520 @defvr {Required} creator
1521 The version of the software that created this SPV file, as a string of
1522 the form @code{xxyyzz}, which represents software version xx.yy.zz,
1523 e.g.@: @code{160001} is version 16.0.1. The corpus includes major
1524 versions 16 through 19.
1527 @defvr {Required} date
1528 The date on the which the file was created, as a string of the form
1532 @defvr {Required} lang
1533 The locale used for output, in Windows format, which is similar to the
1534 format used in Unix with the underscore replaced by a hyphen, e.g.@:
1535 @code{en-US}, @code{en-GB}, @code{el-GR}, @code{sr-Cryl-RS}.
1538 @defvr {Required} name
1539 The title of the pivot table, localized to the output language.
1542 @defvr {Required} style
1543 The @code{id} of a @code{style} element (@pxref{SPV Detail style
1544 element}). This is the base style for the entire pivot table. In
1545 every example in the corpus, the value is @code{visualizationStyle}
1546 and the corresponding @code{style} element has no attributes other
1550 @defvr {Required} type
1551 A floating-point number. The meaning is unknown.
1554 @defvr {Required} version
1555 The visualization schema version number. In the corpus, the value is
1556 one of 2.4, 2.5, 2.7, and 2.8.
1559 @node SPV Detail userSource Element
1560 @subsection The @code{userSource} Element
1562 Parent: @code{visualization} @*
1565 This element has the following attributes.
1567 @defvr {Optional} missing
1568 Always @code{listwise}.
1571 @node SPV Detail sourceVariable Element
1572 @subsection The @code{sourceVariable} Element
1574 Parent: @code{visualization} @*
1575 Contents: @code{extension}* (@code{format} @math{|} @code{stringFormat})?
1577 This element defines a variable whose values can be used elsewhere in
1578 the visualization. It ties this element's @code{id} to a variable
1579 from the @file{tableData.bin} member that corresponds to this
1582 This element has the following attributes.
1584 @defvr {Required} categorical
1585 Always set to @code{true}.
1588 @defvr {Required} source
1589 Always set to @code{tableData}, the @code{source-name} in the
1590 corresponding @file{tableData.bin} member (@pxref{SPV Legacy Member
1594 @defvr {Required} sourceName
1595 The name of a variable within the source, the @code{variable-name} in
1596 the corresponding @file{tableData.bin} member (@pxref{SPV Legacy
1600 @defvr {Optional} dependsOn
1601 The @code{variable-name} of a variable linked to this one, so that a
1602 viewer can work with them together. For a group variable, this is the
1603 name of the corresponding categorical variable.
1606 @defvr {Optional} label
1607 The variable label, if any
1610 @defvr {Optional} labelVariable
1611 The @code{variable-name} of a variable whose string values correspond
1612 one-to-one with the values of this variable and are suitable for use
1616 @node SPV Detail derivedVariable Element
1617 @subsection The @code{derivedVariable} Element
1619 Parent: @code{visualization} @*
1620 Contents: @code{extension}* (@code{format} @math{|} @code{stringFormat} @code{valueMapEntry}*)
1622 Like @code{sourceVariable}, this element defines a variable whose
1623 values can be used elsewhere in the visualization. Instead of being
1624 read from a data source, the variable's data are defined by a
1625 mathematical expression.
1627 This element has the following attributes.
1629 @defvr {Required} categorical
1630 Always set to @code{true}.
1633 @defvr {Required} value
1634 An expression that defines the variable's value. In theory this could
1635 be an arbitrary expression in terms of constants, functions, and other
1636 variables, e.g.@: @math{(@var{var1} + @var{var2}) / 2}. In practice,
1637 the corpus contains only the following forms of expressions:
1640 @item constant(@var{number})
1641 @itemx constant(@var{variable})
1642 A constant. The meaning when a variable is named is unknown.
1643 Sometimes the ``variable name'' has spaces in it.
1645 @item map(@var{variable})
1646 Transforms the values in the named @var{variable} using the
1647 @code{valueMapEntry}s contained within the element.
1651 @defvr {Optional} dependsOn
1652 The @code{variable-name} of a variable linked to this one, so that a
1653 viewer can work with them together. For a group variable, this is the
1654 name of the corresponding categorical variable.
1658 * SPV Detail valueMapEntry Element::
1661 @node SPV Detail valueMapEntry Element
1662 @subsubsection The @code{valueMapEntry} Element
1664 Parent: @code{derivedVariable} @*
1667 A @code{valueMapEntry} element defines a mapping from one or more
1668 values of a source expression to a target value. (In the corpus, the
1669 source expression is always just the name of a variable.) Each target
1670 value requires a separate @code{valueMapEntry}. If multiple source
1671 values map to the same target value, they can be combined or separate.
1673 @code{valueMapEntry} has the following attributes.
1675 @defvr {Required} from
1676 A source value, or multiple source values separated by semicolons,
1677 e.g.@: @code{0} or @code{13;14;15;16}.
1680 @defvr {Required} to
1684 @node SPV Detail extension Element
1685 @subsection The @code{extension} Element
1687 This is a general-purpose ``extension'' element. Readers that don't
1688 understand a given extension should be able to safely ignore it. The
1689 attributes on this element, and their meanings, vary based on the
1690 context. Each known usage is described separately below. The current
1691 extensions use attributes exclusively, without any nested elements.
1693 @subsubheading @code{visualization} Parent Element
1695 With @code{visualization} as its parent element, @code{extension} has
1696 the following attributes.
1698 @defvr {Optional} numRows
1699 An integer that presumably defines the number of rows in the displayed
1703 @defvr {Optional} showGridline
1704 Always set to @code{false} in the corpus.
1707 @defvr {Optional} minWidthSet
1708 @defvrx {Optional} maxWidthSet
1709 Always set to @code{true} in the corpus.
1712 @subsubheading @code{container} Parent Element
1714 With @code{container} as its parent element, @code{extension} has the
1715 following attributes.
1717 @defvr {Required} combinedFootnotes
1718 Always set to @code{true} in the corpus.
1721 @subsubheading @code{sourceVariable} and @code{derivedVariable} Parent Element
1723 With @code{sourceVariable} or @code{derivedVariable} as its parent
1724 element, @code{extension} has the following attributes. A given
1725 parent element often contains several @code{extension} elements that
1726 specify the meaning of the source data's variables or sources, e.g.@:
1729 <extension from="0" helpId="corrected_model"/>
1730 <extension from="3" helpId="error"/>
1731 <extension from="4" helpId="total_9"/>
1732 <extension from="5" helpId="corrected_total"/>
1735 @defvr {Required} from
1736 An integer or a name like ``dimension0''.
1739 @defvr {Required} helpId
1743 @node SPV Detail graph Element
1744 @subsection The @code{graph} Element
1746 Parent: @code{visualization} @*
1747 Contents: @code{location}@math{+} @code{coordinates} @code{faceting} @code{facetLayout} @code{interval}
1749 @code{graph} has the following attributes.
1751 @defvr {Required} cellStyle
1752 @defvrx {Required} style
1753 Each of these is the @code{id} of a @code{style} element (@pxref{SPV
1754 Detail style element}). The former is the default style for
1755 individual cells, the latter for the entire table.
1758 @node SPV Detail location Element
1759 @subsection The @code{location} Element
1761 Parent: @code{graph} @*
1764 Each instance of this element specifies where some part of the table
1765 frame is located. All the examples in the corpus have four instances
1766 of this element, one for each of the parts @code{height},
1767 @code{width}, @code{left}, and @code{top}. Some examples in the
1768 corpus add a fifth for part @code{bottom}, even though it is not clear
1769 how all of @code{top}, @code{bottom}, and @code{heigth} can be honored
1770 at the same time. In any case, @code{location} seems to have little
1771 importance in representing tables; a reader can safely ignore it.
1773 @defvr {Required} part
1774 One of @code{height}, @code{width}, @code{top}, @code{bottom}, or
1775 @code{left}. Presumably @code{right} is acceptable as well but the
1776 corpus contains no examples.
1779 @defvr {Required} method
1780 How the location is determined:
1784 Based on the natural size of the table. Observed only for
1785 parts @code{height} and @code{width}.
1788 Based on the location specified in @code{target}. Observed only for
1789 parts @code{top} and @code{bottom}.
1792 Using the value in @code{value}. Observed only for parts @code{top},
1793 @code{bottom}, and @code{left}.
1796 Same as the specified @code{target}. Observed only for part
1801 @defvr {Optional} min
1802 Minimum size. Only observed with value @code{100pt}. Only observed
1803 for part @code{width}.
1806 @defvr {Dependent} target
1807 Required when @code{method} is @code{attach} or @code{same}, not
1808 observed otherwise. This is the ID of an element to attach to.
1809 Observed with the ID of @code{title}, @code{footnote}, @code{graph},
1813 @defvr {Dependent} value
1814 Required when @code{method} is @code{fixed}, not observed otherwise.
1815 Observed values are @code{0%}, @code{0px}, @code{1px}, and @code{3px}
1816 on parts @code{top} and @code{left}, and @code{100%} on part
1820 @node SPV Detail coordinates Element
1821 @subsection The @code{coordinates} Element
1823 Parent: @code{graph} @*
1826 This element is always present and always empty, with no attributes
1829 @node SPV Detail faceting Element
1830 @subsection The @code{faceting} Element
1832 Parent: @code{graph} @*
1833 Contents: @code{cross} @code{layer}*
1835 The @code{faceting} element describes the row, column, and layer
1836 structure of the table. Its @code{cross} child determines the row and
1837 column structure, and each @code{layer} child (if any) represents a
1840 @code{faceting} has no attributes (other than @code{id}).
1842 @subsubheading The @code{cross} Element
1844 Parent: @code{faceting} @*
1845 Contents: @code{nest} @code{nest}
1847 The @code{cross} element describes the row and column structure of the
1848 table. It has exactly two @code{nest} children, the first of which
1849 describes the table's rows and the second the table's columns.
1851 @code{cross} has no attributes (other than @code{id}).
1853 @subsubheading The @code{nest} Element
1855 Parent: @code{cross} @*
1856 Contents: @code{variableReference}@math{+}
1858 A given @code{nest} usually consists of one or more dimensions, each
1859 of which is represented by @code{variableReference} child elements.
1860 Minimally, a dimension has two @code{variableReference} children, one
1861 for the categories, one for the data, e.g.:
1865 <variableReference ref="dimension0categories"/>
1866 <variableReference ref="dimension0"/>
1871 Groups of categories introduce additional variable references, e.g.@:
1875 <variableReference ref="dimension0categories"/>
1876 <variableReference ref="dimension0group0"/>
1877 <variableReference ref="dimension0"/>
1882 Grouping can be hierarchical, e.g.@:
1886 <variableReference ref="dimension0categories"/>
1887 <variableReference ref="dimension0group1"/>
1888 <variableReference ref="dimension0group0"/>
1889 <variableReference ref="dimension0"/>
1894 XXX what are group maps?
1897 <nest id="nest_1973">
1898 <variableReference ref="dimension1categories"/>
1899 <variableReference ref="dimension1group1map"/>
1900 <variableReference ref="dimension1group0map"/>
1901 <variableReference ref="dimension1"/>
1904 <variableReference ref="dimension0categories"/>
1905 <variableReference ref="dimension0group0map"/>
1906 <variableReference ref="dimension0"/>
1911 A @code{nest} can contain multiple dimensions:
1915 <variableReference ref="dimension1categories"/>
1916 <variableReference ref="dimension1group0"/>
1917 <variableReference ref="dimension1"/>
1918 <variableReference ref="dimension0categories"/>
1919 <variableReference ref="dimension0"/>
1923 One @code{nest} within a given @code{cross} may have no dimensions, in
1924 which case it still has one @code{variableReference} child, which
1925 references a @code{derivedVariable} whose @code{value} attribute is
1926 @code{constant(0)}. In the corpus, such a @code{derivedVariable} has
1927 @code{row} or @code{column}, respectively, as its @code{id}.
1929 @code{nest} has no attributes (other than @code{id}).
1931 @subsubheading The @code{variableReference} Element
1933 Parent: @code{nest} @*
1936 @code{variableReference} has one attribute.
1938 @defvr {Required} ref
1939 The @code{id} of a @code{sourceVariable} or @code{derivedVariable}
1943 @subsubheading The @code{layer} Element
1945 Parent: @code{faceting} @*
1948 Each layer is represented by a pair of @code{layer} elements. The
1949 first of this pair is for a category variable, the second for the data
1953 <layer value="0" variable="dimension0categories" visible="true"/>
1954 <layer value="dimension0" variable="dimension0" visible="false"/>
1958 @code{layer} has the following attributes.
1960 @defvr {Required} variable
1961 The @code{id} of a @code{sourceVariable} or @code{derivedVariable}
1965 @defvr {Required} value
1966 The value to select. For a category variable, this is always
1967 @code{0}; for a data variable, it is the same as the @code{variable}
1971 @defvr {Optional} visible
1972 Whether the layer is visible. Generally, category layers are visible
1973 and data layers are not, but sometimes this attribute is omitted.
1976 @defvr {Optional} method
1977 When present, this is always @code{nest}.
1980 @node SPV Detail facetLayout Element
1981 @subsection The @code{facetLayout} Element
1983 Parent: @code{graph} @*
1984 Contents: @code{tableLayout} @code{facetLevel}@math{+} @code{setCellProperties}*
1986 @subsubheading The @code{tableLayout} Element
1988 Parent: @code{facetLayout} @*
1991 @defvr {Required} verticalTitlesInCorner
1992 Always set to @code{true}.
1995 @defvr {Optional} style
1996 The @code{id} of a @code{style} element.
1999 @defvr {Optional} fitCells
2000 Always set to @code{ticks}.
2003 @subsubheading The @code{facetLevel} Element
2005 Parent: @code{facetLayout} @*
2006 Contents: @code{axis}
2008 Each @code{facetLevel} describes a @code{variableReference} or
2009 @code{layer}, and a table has one @code{facetLevel} element for
2010 each such element. For example, an SPV detail member that contains
2011 four @code{variableReference} elements and two @code{layer} elements
2012 will contain six @code{facetLevel} elements.
2014 In the corpus, @code{facetLevel} elements and the elements that they
2015 describe are always in the same order. The correspondence may also be
2016 observed in two other ways. First, one may use the @code{level}
2017 attribute, described below. Second, in the corpus, a
2018 @code{facetLevel} always has an @code{id} that is the same as the
2019 @code{id} of the element it describes with @code{_facetLevel}
2020 appended. One should not formally rely on this, of course, but it is
2021 usefully indicative.
2023 @defvr {Required} level
2024 A 1-based index into the @code{variableReference} and @code{layer}
2025 elements, e.g.@: a @code{facetLayout} with a @code{level} of 1
2026 describes the first @code{variableReference} in the SPV detail member,
2027 and in a member with four @code{variableReference} elements, a
2028 @code{facetLayout} with a @code{level} of 5 describes the first
2029 @code{layer} in the member.
2032 @defvr {Required} gap
2033 Always observed as @code{0pt}.
2036 @subsubheading The @code{axis} Element
2038 Parent: @code{facetLevel} @*
2039 Contents: @code{label}? @code{majorTicks}
2041 @defvr {Attribute} style
2042 The @code{id} of a @code{style} element.
2045 @subsubheading The @code{label} Element
2047 Parent: @code{axis} or @code{labelFrame} @*
2048 Contents: @code{text}@math{+} @math{|} @code{descriptionGroup}
2050 This element represents a label on some aspect of the table. For example,
2051 the table's title is a @code{label}.
2053 The contents of the label can be one or more @code{text} elements or a
2054 @code{descriptionGroup}.
2056 @defvr {Attribute} style
2057 @defvrx {Optional} textFrameStyle
2058 Each of these is the @code{id} of a @code{style} element.
2059 @code{style} is the style of the label text, @code{textFrameStyle} the
2060 style for the frame around the label.
2063 @defvr {Optional} purpose
2064 The kind of entity being labeled, one of @code{title},
2065 @code{subTitle}, @code{layer}, or @code{footnote}.
2068 @subsubheading The @code{descriptionGroup} Element
2070 Parent: @code{label} @*
2071 Contents: (@code{description} @math{|} @code{text})@math{+}
2073 A @code{descriptionGroup} concatenates one or more elements to form a
2074 label. Each element can be a @code{text} element, which contains
2075 literal text, or a @code{description} element that substitutes a value
2078 @defvr {Attribute} target
2079 The @code{id} of an element being described. In the corpus, this is
2080 always @code{faceting}.
2083 @defvr {Attribute} separator
2084 A string to separate the description of multiple groups, if the
2085 @code{target} has more than one. In the corpus, this is always a
2089 Typical contents for a @code{descriptionGroup} are a value by itself:
2091 <description name="value"/>
2093 @noindent or a variable and its value, separated by a colon:
2095 <description name="variable"/><text>:</text><description name="value"/>
2098 @subsubheading The @code{description} Element
2100 Parent: @code{descriptionGroup} @*
2103 A @code{description} is like a macro that expands to some property of
2104 the target of its parent @code{descriptionGroup}.
2106 @defvr {Attribute} name
2107 The name of the property. Only @code{variable} and @code{value}
2108 appear in the corpus.
2111 @subsubheading The @code{majorTicks} Element
2113 Parent: @code{axis} @*
2114 Contents: @code{gridline}?
2116 @defvr {Attribute} labelAngle
2117 @defvrx {Attribute} length
2118 Both always defined to @code{0}.
2121 @defvr {Attribute} style
2122 @defvrx {Attribute} tickFrameStyle
2123 Each of these is the @code{id} of a @code{style} element.
2124 @code{style} is the style of the tick labels, @code{tickFrameStyle}
2125 the style for the frames around the labels.
2128 @subsubheading The @code{gridline} Element
2130 Parent: @code{majorTicks} @*
2133 Represents ``gridlines,'' which for a table represents the lines
2134 between the rows or columns of a table (XXX?).
2136 @defvr {Attribute} style
2137 The style for the gridline.
2140 @defvr {Attribute} zOrder
2141 Observed as a number between 28 and 31. Does not seem to be
2145 @subsubheading The @code{setCellProperties} Element
2147 Parent: @code{facetLayout} @*
2148 Contents: @code{setMetaData} @code{setStyle}* @code{setFormat}@math{+} @code{union}?
2150 This element sets style properties of cells designated by the
2151 @code{target} attribute of its child elements, as further restricted
2152 by the optional @code{union} element if present. The @code{target}
2153 values often used, e.g.@: @code{graph} or @code{labeling}, actually
2154 affect every cell, so the @code{union} element is a useful
2157 @defvr {Optional} applyToConverse
2158 If present, always @code{true}. This appears to invert the meaning of
2159 the @code{target} of sub-elements: the selected cells are the ones
2160 @emph{not} designated by @code{target}. This is confusing, given the
2161 additional restrictions of @code{union}, but in the corpus
2162 @code{applyToConverse} is never present along with @code{union}.
2165 @subsubheading The @code{setMetaData} Element
2167 Parent: @code{setCellProperties} @*
2170 This element is not known to have any visible effect.
2172 @defvr {Required} target
2173 The @code{id} of an element whose metadata is to be set. In the
2174 corpus, this is always @code{graph}, the @code{id} used for the
2175 @code{graph} element.
2178 @defvr {Required} key
2179 @defvrx {Required} value
2180 A key-value pair to set for the target.
2182 In the corpus, @code{key} is @code{cellPropId} or, rarely,
2183 @code{diagProps}, and @code{value} is always the @code{id} of the
2184 parent @code{setCellProperties}.
2187 @subsubheading The @code{setStyle} Element
2189 Parent: @code{setCellProperties} @*
2192 This element associates a style with the target.
2194 @defvr {Required} target
2195 The @code{id} of an element whose style is to be set. In the corpus,
2196 this is always the @code{id} of an @code{interval}, @code{labeling},
2197 or, rarely, @code{graph} element.
2200 @defvr {Required} style
2201 The @code{id} of a @code{style} element that identifies the style to
2205 @subsubheading The @code{setFormat} Element
2208 Parent: @code{setCellProperties}
2211 @math{|} @code{numberFormat}
2212 @math{|} @code{stringFormat}@math{+}
2213 @math{|} @code{dateTimeFormat}
2216 This element sets the format of the target, ``format'' in this case
2217 meaning the SPSS print format for a variable.
2219 The details of this element vary depending on the schema version, as
2220 declared in the root @code{visualization} element's @code{version}
2221 attribute (@pxref{SPV Detail visualization Element}). In version 2.5
2222 and earlier, @code{setFormat} contains one of a number of child
2223 elements that correspond to the different varieties of print formats.
2224 In version 2.7 and later, @code{setFormat} instead always contains a
2225 @code{format} element.
2227 XXX reinvestigate the above claim about versions: it appears to be
2230 The @code{setFormat} element itself has the following attributes.
2232 @defvr {Required} target
2233 The @code{id} of an element whose style is to be set. In the corpus,
2234 this is always the @code{id} of an @code{majorTicks} or
2235 @code{labeling} element.
2238 @defvr {Optional} reset
2239 If this is @code{true}, this format overrides the target's previous
2240 format. If it is @code{false}, the adds to the previous format. In
2241 the corpus this is always @code{true}. The default behavior is
2246 * SPV Detail format Element::
2247 * SPV Detail numberFormat Element::
2248 * SPV Detail stringFormat Element::
2249 * SPV Detail dateTimeFormat Element::
2250 * SPV Detail affix Element::
2251 * SPV Detail relabel Element::
2252 * SPV Detail union Element::
2255 @node SPV Detail format Element
2256 @subsubsection The @code{format} Element
2258 Parent: @code{sourceVariable}, @code{derivedVariable}, @code{formatMapping}, @code{labeling}, @code{formatMapping}, @code{setFormat} @*
2259 Contents: (@code{affix}@math{+} @math{|} @code{relabel}@math{+})?
2261 This element appears only in schema version 2.7 (@pxref{SPV Detail
2262 visualization Element}).
2264 This element determines a format, equivalent to an SPSS print format.
2266 @subsubheading Attributes for All Formats
2268 These attributes apply to all kinds of formats. The most important of
2269 these attributes determines the high-level kind of formatting in use:
2271 @defvr {Optional} baseFormat
2272 Either @code{dateTime} or @code{elapsedTime}. When this attribute is
2273 omitted, this element is a numeric or string format.
2277 Whether, in the corpus, other attributes are always present (``yes''),
2278 never present (``no''), or sometimes present (``opt'') depends on
2281 @multitable {maximumFractionDigits} {@code{dateTime}} {@code{elapsedTime}} {number} {string}
2282 @headitem Attribute @tab @code{dateTime} @tab @code{elapsedTime} @tab number @tab string
2283 @item errorCharacter @tab yes @tab yes @tab yes @tab opt
2285 @item separatorChars @tab yes @tab no @tab no @tab no
2287 @item mdyOrder @tab yes @tab no @tab no @tab no
2289 @item showYear @tab yes @tab no @tab no @tab no
2290 @item yearAbbreviation @tab yes @tab no @tab no @tab no
2292 @item showMonth @tab yes @tab no @tab no @tab no
2293 @item monthFormat @tab yes @tab no @tab no @tab no
2295 @item showDay @tab yes @tab opt @tab no @tab no
2296 @item dayPadding @tab yes @tab opt @tab no @tab no
2297 @item dayOfMonthPadding @tab yes @tab no @tab no @tab no
2298 @item dayType @tab yes @tab no @tab no @tab no
2300 @item showHour @tab yes @tab opt @tab no @tab no
2301 @item hourFormat @tab yes @tab opt @tab no @tab no
2302 @item hourPadding @tab yes @tab yes @tab no @tab no
2304 @item showMinute @tab yes @tab yes @tab no @tab no
2305 @item minutePadding @tab yes @tab yes @tab no @tab no
2307 @item showSecond @tab yes @tab yes @tab no @tab no
2308 @item secondPadding @tab no @tab yes @tab no @tab no
2310 @item showMillis @tab no @tab yes @tab no @tab no
2312 @item minimumIntegerDigits @tab no @tab no @tab yes @tab no
2313 @item maximumFractionDigits @tab no @tab yes @tab yes @tab no
2314 @item minimumFractionDigits @tab no @tab yes @tab yes @tab no
2315 @item useGrouping @tab no @tab opt @tab yes @tab no
2316 @item scientific @tab no @tab no @tab yes @tab no
2317 @item small @tab no @tab no @tab opt @tab no
2318 @item suffix @tab no @tab no @tab opt @tab no
2320 @item tryStringsAsNumbers @tab no @tab no @tab no @tab yes
2324 @defvr {Attribute} errorCharacter
2325 A character that replaces the formatted value when it cannot otherwise
2326 be represented in the given format. Always @samp{*}.
2329 @subsubheading Date and Time Attributes
2331 These attributes are used with @code{dateTime} and @code{elapsedTime}
2334 @defvr {Attribute} separatorChars
2335 Exactly four characters. In order, these are used for: decimal point,
2336 grouping, date separator, time separator. Always @samp{.,-:}.
2339 @defvr {Attribute} mdyOrder
2340 Within a date, the order of the days, months, and years.
2341 @code{dayMonthYear} is the only observed value, but one would expect
2342 that @code{monthDayYear} and @code{yearMonthDay} to be reasonable as
2346 @defvr {Attribute} showYear
2347 @defvrx {Attribute} yearAbbreviation
2348 Whether to include the year and, if so, whether the year should be
2349 shown abbreviated, that is, with only 2 digits. Each is @code{true}
2350 or @code{false}; only values of @code{true} and @code{false},
2351 respectively, have been observed.
2354 @defvr {Attribute} showMonth
2355 @defvrx {Attribute} monthFormat
2356 Whether to include the month (@code{true} or @code{false}) and, if so,
2357 how to format it. @code{monthFormat} is one of the following:
2361 The full name of the month, e.g.@: in an English locale,
2365 The abbreviated name of the month, e.g.@: in an English locale,
2369 The number representing the month, e.g.@: 9 for September.
2372 A two-digit number representing the month, e.g.@: 09 for September.
2375 Only values of @code{true} and @code{short}, respectively, have been
2379 @defvr {Attribute} dayPadding
2380 @defvrx {Attribute} dayOfMonthPadding
2381 @defvrx {Attribute} hourPadding
2382 @defvrx {Attribute} minutePadding
2383 @defvrx {Attribute} secondPadding
2384 These attributes presumably control whether each field in the output
2385 is padded with spaces to its maximum width, but the details are not
2386 understood. The only observed value for any of these attributes is
2390 @defvr {Attribute} showDay
2391 @defvrx {Attribute} showHour
2392 @defvrx {Attribute} showMinute
2393 @defvrx {Attribute} showSecond
2394 @defvrx {Attribute} showMillis
2395 These attributes presumably control whether each field is displayed
2396 in the output, but the details are not understood. The only
2397 observed value for any of these attributes is @code{true}.
2400 @defvr {Attribute} dayType
2401 This attribute is always @code{month} in the corpus, specifying that
2402 the day of the month is to be displayed; a value of @code{year} is
2403 supposed to indicate that the day of the year, where 1 is January 1,
2404 is to be displayed instead.
2407 @defvr {Attribute} hourFormat
2408 @code{hourFormat}, if present, is one of:
2412 The time is displayed with an @code{am} or @code{pm} suffix, e.g.@:
2416 The time is displayed in a 24-hour format, e.g.@: @code{22:15}.
2418 This is the only value observed in the corpus.
2421 The time is displayed in a 12-hour format, without distinguishing
2422 morning or evening, e.g.@: @code{10;15}.
2425 @code{hourFormat} is sometimes present for @code{elapsedTime} formats,
2426 which is confusing since a time duration does not have a concept of AM
2427 or PM. This might indicate a bug in the code that generated the XML
2428 in the corpus, or it might indicate that @code{elapsedTime} is
2429 sometimes used to format a time of day.
2432 @subsubheading Numeric Attributes
2434 These attributes are used for formats when @code{baseFormat} is
2435 @code{number}. Attributes @code{maximumFractionDigits}, and
2436 @code{minimumFractionDigits}, and @code{useGrouping} are also used
2437 when @code{baseFormat} is @code{elapsedTime}.
2439 @defvr {Attribute} minimumIntegerDigits
2440 Minimum number of digits to display before the decimal point. Always
2441 observed as @code{0}.
2444 @defvr {Attribute} maximumFractionDigits
2445 @defvrx {Attribute} maximumFractionDigits
2446 Maximum or minimum, respectively, number of digits to display after
2447 the decimal point. The observed values of each attribute range from 0
2451 @defvr {Attribute} useGrouping
2452 Whether to use the grouping character to group digits in large
2453 numbers. It would make sense for the grouping character to come from
2454 the @code{separatorChars} attribute, but that attribute is only
2455 present when @code{baseFormat} is @code{dateTime} or
2456 @code{elapsedTime}, in the corpus at least. Perhaps that is because
2457 this attribute has only been observed as @code{false}.
2460 @defvr {Attribute} scientific
2461 This attribute controls when and whether the number is formatted in
2462 scientific notation. It takes the following values:
2466 Use scientific notation only when the number's magnitude is smaller
2467 than the value of the @code{small} attribute.
2470 Use scientific notation when the number will not otherwise fit in the
2474 Always use scientific notation. Not observed in the corpus.
2477 Never use scientific notation. A number that won't otherwise fit will
2478 be replaced by an error indication (see the @code{errorCharacter}
2479 attribute). Not observed in the corpus.
2483 @defvr {Optional} small
2484 Only present when the @code{scientific} attribute is
2485 @code{onlyForSmall}, this is a numeric magnitude below which the
2486 number will be formatted in scientific notation. The values @code{0}
2487 and @code{0.0001} have been observed. The value @code{0} seems like a
2488 pathological choice, since no real number has a magnitude less than 0;
2489 perhaps in practice such a choice is equivalent to setting
2490 @code{scientific} to @code{false}.
2493 @defvr {Optional} prefix
2494 @defvrx {Optional} suffix
2495 Specifies a prefix or a suffix to apply to the formatted number. Only
2496 @code{suffix} has been observed, with value @samp{%}.
2499 @subsubheading String Attributes
2501 These attributes are used for formats when @code{baseFormat} is
2504 @defvr {Attribute} tryStringsAsNumbers
2505 When this is @code{true}, it is supposed to indicate that string
2506 values should be parsed as numbers and then displayed according to
2507 numeric formatting rules. However, in the corpus it is always
2511 @node SPV Detail numberFormat Element
2512 @subsubsection The @code{numberFormat} Element
2514 Parent: @code{setFormat} @*
2515 Contents: @code{affix}@math{+}
2517 This element appears only in schema version 2.5 and earlier
2518 (@pxref{SPV Detail visualization Element}). Possibly this element
2519 could also contain @code{relabel} elements in a more diverse corpus.
2521 This element has the following attributes.
2523 @defvr {Attribute} maximumFractionDigits
2524 @defvrx {Attribute} minimumFractionDigits
2525 @defvrx {Attribute} minimumIntegerDigits
2526 @defvrx {Optional} scientific
2527 @defvrx {Optional} small
2528 @defvrx {Optional} suffix
2529 @defvrx {Optional} useGroupging
2530 The syntax and meaning of these attributes is the same as on the
2531 @code{format} element for a numeric format. @pxref{SPV Detail format
2535 @node SPV Detail stringFormat Element
2536 @subsubsection The @code{stringFormat} Element
2538 Parent: @code{setFormat} @*
2539 Contents: (@code{affix}@math{+} @math{|} @code{relabel}@math{+})?
2541 This element appears only in schema version 2.5 and earlier
2542 (@pxref{SPV Detail visualization Element}).
2544 This element has no attributes.
2546 @node SPV Detail dateTimeFormat Element
2547 @subsubsection The @code{dateTimeFormat} Element
2549 Parent: @code{setFormat} @*
2552 This element appears only in schema version 2.5 and earlier
2553 (@pxref{SPV Detail visualization Element}). Possibly this element
2554 could also contain @code{affix} and @code{relabel} elements in a more
2557 The following attribute is required.
2559 @defvr {Attribute} baseFormat
2560 Either @code{dateTime} or @code{time}.
2563 When @code{baseFormat} is @code{dateTime}, the following attributes
2566 @defvr {Attribute} dayOfMonthPadding
2567 @defvrx {Attribute} dayPadding
2568 @defvrx {Attribute} dayType
2569 @defvrx {Attribute} hourFormat
2570 @defvrx {Attribute} hourPadding
2571 @defvrx {Attribute} mdyOrder
2572 @defvrx {Attribute} minutePadding
2573 @defvrx {Attribute} monthFormat
2574 @defvrx {Attribute} separatorChars
2575 @defvrx {Attribute} showDay
2576 @defvrx {Attribute} showHour
2577 @defvrx {Attribute} showMinute
2578 @defvrx {Attribute} showMonth
2579 @defvrx {Attribute} showSecond
2580 @defvrx {Attribute} showYear
2581 @defvrx {Attribute} yearAbbreviation
2582 The syntax and meaning of these attributes is the same as on the
2583 @code{format} element when that element's @code{baseFormat} is
2584 @code{dateTime}. @pxref{SPV Detail format Element}.
2587 When @code{baseFormat} is @code{time}, the following attributes are
2590 @defvr {Attribute} hourFormat
2591 @defvrx {Attribute} hourPadding
2592 @defvrx {Attribute} minutePadding
2593 @defvrx {Attribute} monthFormat
2594 @defvrx {Attribute} separatorChars
2595 @defvrx {Attribute} showDay
2596 @defvrx {Attribute} showHour
2597 @defvrx {Attribute} showMinute
2598 @defvrx {Attribute} showMonth
2599 @defvrx {Attribute} showSecond
2600 @defvrx {Attribute} showYear
2601 @defvrx {Attribute} yearAbbreviation
2602 The syntax and meaning of these attributes is the same as on the
2603 @code{format} element when that element's @code{baseFormat} is
2604 @code{elapsedTime}. @pxref{SPV Detail format Element}.
2607 @node SPV Detail affix Element
2608 @subsubsection The @code{affix} Element
2610 Parent: @code{format} or @code{numberFormat} or @code{stringFormat} @*
2613 Possibly this element could have @code{dateTimeFormat} as a parent in
2614 a more diverse corpus.
2616 This defines a suffix (or, theoretically, a prefix) for a formatted
2617 value. It is used to insert a reference to a footnote. It has the
2618 following attributes:
2620 @defvr {Attribute} definesReference
2621 This specifies the footnote number as a natural number: 1 for the
2622 first footnote, 2 for the second, and so on.
2625 @defvr {Attribute} position
2626 Position for the footnote label. Always @code{superscript}.
2629 @defvr {Attribute} suffix
2630 Whether the affix is a suffix (@code{true}) or a prefix
2631 (@code{false}). Always @code{true}.
2634 @defvr {Attribute} value
2635 The text of the suffix or prefix. Typically a letter, e.g.@: @code{a}
2636 for footnote 1, @code{b} for footnote 2, @enddots{} The corpus
2637 contains other values: @code{*}, @code{**}, and a few that begin with
2638 at least one comma: @code{,b}, @code{,c}, @code{,,b}, and @code{,,c}.
2641 @node SPV Detail relabel Element
2642 @subsubsection The @code{relabel} Element
2644 Parent: @code{format} or @code{stringFormat} @*
2647 Possibly this element could have @code{numberFormat} or
2648 @code{dateTimeFormat} as a parent in a more diverse corpus.
2650 This specifies how to display a given value. It is used to implement
2651 value labels and to display the system-missing value in a
2652 human-readable way. It has the following attributes:
2654 @defvr {Attribute} from
2655 The value to map. In the corpus this is an integer or the
2656 system-missing value @code{-1.797693134862316E300}.
2659 @defvr {Attribute} to
2660 The string to display in place of the value of @code{from}. In the
2661 corpus this is a wide variety of value labels; the system-missing
2662 value is mapped to @samp{.}.
2665 @node SPV Detail union Element
2666 @subsubsection The @code{union} Element
2668 Parent: @code{setCellProperties} @*
2669 Contents: @code{intersect}@math{+}
2671 This element represents a set of cells, computed as the union of the
2672 sets represented by each of its children.
2674 @subsubheading The @code{intersect} Element
2676 Parent: @code{union} @*
2677 Contents: @code{where}@math{+} @math{|} @code{intersectWhere}?
2679 This element represents a set of cells, computed as the intersection
2680 of the sets represented by each of its children.
2682 Of the two possible children, in the corpus @code{where} is far more
2683 common, appearing thousands of times, whereas @code{intersectWhere}
2684 only appears 4 times.
2686 Most @code{intersect} elements have two or more children.
2688 @subsubheading The @code{where} Element
2690 Parent: @code{intersect} @*
2693 This element represents the set of cells in which the value of a
2694 specified variable falls within a specified set.
2696 @defvr {Attribute} variable
2697 The @code{id} of a variable, e.g.@: @code{dimension0categories} or
2698 @code{dimension0group0map}.
2701 @defvr {Attribute} include
2702 A value, or multiple values separated by semicolons,
2703 e.g.@: @code{0} or @code{13;14;15;16}.
2706 @subsubheading The @code{intersectWhere}
2708 Parent: @code{intersect} @*
2711 The meaning of this element is unknown.
2713 @defvr {Attribute} variable
2714 @defvrx {Attribute} variable2
2715 The meaning of these attributes is unknown. In the four examples in
2716 the corpus they always take the values @code{dimension2categories} and
2717 @code{dimension0categories}, respectively.