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 Formats Borders PrintSettings TableSettings
581 The following sections go into more detail.
584 * SPV Light Member Header::
585 * SPV Light Member Title::
586 * PSV 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-height}] int[@t{max-row-height}]
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 The meaning of the other variable parts of the header is not known.
629 @node SPV Light Member Title
635 Value[@t{title1}] 01?
637 Value[@t{title2}] 01?
641 The Title, which follows the Header, specifies the pivot table's title
642 twice, as @code{title1} and @code{title2}. In the corpus, they are
645 Whereas the Value in @code{title1} and in @code{title2} are
646 appropriate for presentation, and localized to the user's language,
647 @code{c} is in English, sometimes less specific, and sometimes less
648 well formatted. For example, for a frequency table, @code{title1} and
649 @code{title2} name the variable and @code{c} is simply ``Frequencies''.
651 @node PSV Light Member Caption
656 Caption @result{} Caption1 Caption2
657 Caption1 @result{} 31 Value @math{|} 58
658 Caption2 @result{} 31 Value @math{|} 58
662 The Caption, if present, is shown below the table. Caption2 is
663 normally present. Caption1 is only rarely nonempty; it might reflect
664 user editing of the caption.
666 @node SPV Light Member Footnotes
667 @subsection Footnotes
671 Footnotes @result{} int[@t{n}] Footnote*[@t{n}]
672 Footnote @result{} Value[@t{text}] (58 @math{|} 31 Value[@t{marker}]) byte*4
676 Each footnote has @code{text} and an optional customer @code{marker}
679 @node SPV Light Member Fonts
684 Fonts @result{} 00 Font*8
687 string[@t{typeface}] float[@t{size}] int[@t{style}] bool[@t{underline}]
688 int[@t{halign}] int[@t{valign}]
689 string[@t{fgcolor}] string[@t{bgcolor}]
690 byte[@t{alternate}] string[@t{altfg}] string[@t{altbg}]
691 v3(int[@t{left-margin}] int[@t{right-margin}] int[@t{top-margin}] int[@t{bottom-margin}])
695 Each Font represents the font style for a different element, in the
696 following order: title, caption, footer, corner, column
697 labels, row labels, data, and layers.
699 @code{index} is the 1-based index of the Font, i.e. 1 for the first
700 Font, through 8 for the final Font.
702 @code{typeface} is the string name of the font. In the corpus, this
703 is @code{SansSerif} in over 99% of instances and @code{Times New
706 @code{size} is the size of the font, in points. The most common size
707 in the corpus is 12 points.
709 @code{style} is a bit mask. Bit 0 (with value 1) is set for bold, bit
710 1 (with value 2) is set for italic.
712 @code{underline} is 1 if the font is underlined, 0 otherwise.
714 @code{halign} specifies horizontal alignment: 0 for center, 2 for
715 left, 4 for right, 61453 for decimal, 64173 for mixed. Mixed
716 alignment varies according to type: string data is left-justified,
717 numbers and most other formats are right-justified.
719 @code{valign} specifies vertical alignment: 0 for center, 1 for top, 3
722 @code{fgcolor} and @code{bgcolor} are the foreground color and
723 background color, respectively. In the corpus, these are always
724 @code{#000000} and @code{#ffffff}, respectively.
726 @code{alternate} is 01 if rows should alternate colors, 00 if all rows
727 should be the same color. When @code{alternate} is 01, @code{altfg}
728 and @code{altbg} specify the colors for the alternate rows.
730 @node SPV Light Member Borders
737 be32[@t{n-borders}] Border*[@t{n-borders}]
738 bool[@t{show-grid-lines}]
742 be32[@t{border-type}]
743 be32[@t{stroke-type}]
748 The Borders reflect how borders between regions are drawn.
750 The fixed value of @code{endian} can be used to validate the
753 @code{show-grid-lines} is 1 to draw grid lines, otherwise 0.
755 Each Border describes one kind of border. @code{n-borders} seems to
756 always be 19. Each @code{border-type} appears once in order, and they
757 correspond to the following borders:
763 Left, top, right, and bottom outer frame.
765 Left, top, right, and bottom inner frame.
767 Left and top of data area.
769 Horizontal and vertical dimension rows.
771 Horizontal and vertical dimension columns.
773 Horizontal and vertical category rows.
775 Horizontal and vertical category columns.
778 @code{stroke-type} describes how a border is drawn, as one of:
795 @code{color} is an RGB color. Bits 24--31 are alpha, bits 16--23 are
796 red, 8--15 are green, 0--7 are blue. An alpha of 255 indicates an
797 opaque color, therefore opaque black is 0xff000000.
799 @node SPV Light Member Print Settings
800 @subsection Print Settings
804 PrintSettings @result{}
807 bool[@t{paginate-layers}]
810 bool[@t{top-continuation}]
811 bool[@t{bottom-continuation}]
812 be32[@t{n-orphan-lines}]
813 bestring[@t{continuation-string}]
817 The PrintSettings reflect settings for printing. The fixed value of
818 @code{endian} can be used to validate the endianness.
820 @code{layers} is 1 to print all layers, 0 to print only the visible
823 @code{paginate-layers} is 1 to print each layer at the start of a new
826 @code{fit-width} and @code{fit-length} control whether the table is
827 shrunk to fit within a page's width or length, respectively.
829 @code{n-orphan-lines} is the minimum number of rows or columns to put
830 in one part of a table that is broken across pages.
832 If @code{top-continuation} is 1, then @code{continuation-string} is
833 printed at the top of a page when a table is broken across pages for
834 printing; similarly for @code{bottom-continuation} and the bottom of a
835 page. Usually, @code{continuation-string} is empty.
837 @node SPV Light Member Table Settings
838 @subsection Table Settings
842 TableSettings @result{}
845 be32[@t{current-layer}]
847 bool[@t{show-row-labels-in-corner}]
848 bool[@t{show-alphabetic-markers}]
849 bool[@t{footnote-marker-position}]
852 be32[@t{n}] byte*[@t{n}]
854 bestring[@t{table-look}]
860 The TableSettings reflect display settings. The fixed value of
861 @code{endian} can be used to validate the endianness.
863 @code{current-layer} is the displayed layer.
865 If @code{omit-empty} is 1, empty rows or columns (ones with nothing in
866 any cell) are hidden; otherwise, they are shown.
868 If @code{show-row-labels-in-corner} is 1, then row labels are shown in
869 the upper left corner; otherwise, they are shown nested.
871 If @code{show-alphabetic-markers} is 1, markers are shown as letters
872 (e.g. @samp{a}, @samp{b}, @samp{c}, @dots{}); otherwise, they are
873 shown as numbers starting from 1.
875 When @code{footnote-marker-position} is 1, footnote markers are shown
876 as superscripts, otherwise as subscripts.
878 @code{table-look} is the name of a SPSS ``TableLook'' table style,
879 such as ``Default'' or ``Academic''; it is often empty.
881 TableSettings ends with an arbitrary number of null bytes.
883 @node SPV Light Member Formats
889 int[@t{n4}] int*[@t{n4}]
891 (i0 @math{|} i-1) (00 @math{|} 01) 00 (00 @math{|} 01)
893 byte[@t{decimal}] byte[@t{grouping}]
894 int[@t{n-ccs}] string*[@t{n-ccs}]
896 v3(count(count(X5) count(X6)))
898 X5 @result{} byte*33 int[@t{n}] int*[@t{n}]
900 01 00 (03 @math{|} 04) 00 00 00
901 string[@t{command}] string[@t{subcommand}]
902 string[@t{language}] string[@t{charset}] string[@t{locale}]
903 (00 @math{|} 01) 00 (00 @math{|} 01) (00 @math{|} 01)
905 byte[@t{decimal}] byte[@t{grouping}]
907 (string[@t{dataset}] string[@t{data file}] i0 int i0)?
908 int[@t{n-ccs}] string*[@t{n-ccs}]
909 2e (00 @math{|} 01) (i2000000 i0)?
913 Observed values of @code{n4} vary from 0 to 17. Out of 7,060 examples
914 in the corpus, it is nonzero only 36 times.
916 @code{encoding} is a character encoding, usually a Windows code page
917 such as @code{en_US.windows-1252} or @code{it_IT.windows-1252}. The
918 rest of the character strings in the member use this encoding. The
919 encoding string is itself encoded in US-ASCII.
921 @code{epoch} is the year that starts the epoch. A 2-digit year is
922 interpreted as belonging to the 100 years beginning at the epoch. The
923 default epoch year is 69 years prior to the current year; thus, in
924 2017 this field by default contains 1948. In the corpus, @t{epoch}
925 ranges from 1943 to 1948, plus some contain -1.
927 @code{decimal} is the decimal point character. The observed values
928 are @samp{.} and @samp{,}.
930 @code{grouping} is the grouping character. Usually, it is @samp{,} if
931 @code{decimal} is @samp{.}, and vice versa. Other observed values are
932 @samp{'} (apostrophe), @samp{ } (space), and zero (presumably
933 indicating that digits should not be grouped).
935 @code{n-ccs} is observed as either 0 or 5. When it is 5, the
936 following strings are CCA through CCE format strings. @xref{Custom
937 Currency Formats,,, pspp, PSPP}. Most commonly these are all
938 @code{-,,,} but other strings occur.
940 @node SPV Light Member Dimensions
941 @subsection Dimensions
943 A pivot table presents multidimensional data. A Dimension identifies
944 the categories associated with each dimension.
948 Dimensions @result{} int[@t{n-dims}] Dimension*[@t{n-dims}]
949 Dimension @result{} Value[@t{name}] DimUnknown int[@t{n-categories}] Category*[@t{n-categories}]
952 (00 @math{|} 01 @math{|} 02)[@t{d2}]
953 (i0 @math{|} i2)[@t{d3}]
954 (00 @math{|} 01)[@t{d4}]
955 (00 @math{|} 01)[@t{d5}]
961 @code{name} is the name of the dimension, e.g. @code{Variables},
962 @code{Statistics}, or a variable name.
964 @code{d1} is usually 0 but many other values have been observed.
966 @code{d3} is 2 over 99% of the time.
968 @code{d5} is 0 over 99% of the time.
970 @code{d6} is either -1 or the 0-based index of the dimension, e.g.@: 0
971 for the first dimension, 1 for the second, and so on. The latter is
972 the case 98% of the time in the corpus.
974 @node SPV Light Member Categories
975 @subsection Categories
977 Categories are arranged in a tree. Only the leaf nodes in the tree
978 are really categories; the others just serve as grouping constructs.
982 Category @result{} Value[@t{name}] (Leaf @math{|} Group)
983 Leaf @result{} 00 00 00 i2 int[@t{index}] i0
985 (00 @math{|} 01)[@t{merge}] 00 01 (i0 @math{|} i2)[@t{data}]
986 i-1 int[@t{n-subcategories}] Category*[@t{n-subcategories}]
990 @code{name} is the name of the category (or group).
992 A Leaf represents a leaf category. The Leaf's @code{index} is a
993 nonnegative integer less than @code{n-categories} in the Dimension in
994 which the Category is nested (directly or indirectly).
996 A Group represents a Group of nested categories. Usually a Group
997 contains at least one Category, so that @code{n-subcategories} is
998 positive, but a few Groups with @code{n-subcategories} 0 has been
1001 If a Group's @code{merge} is 00, the most common value, then the group
1002 is really a distinct group that should be represented as such in the
1003 visual representation and user interface. If @code{merge} is 01, the
1004 categories in this group should be shown and treated as if they were
1005 direct children of the group's containing group (or if it has no
1006 parent group, then direct children of the dimension), and this group's
1007 name is irrelevant and should not be displayed. (Merged groups can be
1010 A Group's @code{data} appears to be i2 when all of the categories
1011 within a group are leaf categories that directly represent data values
1012 for a variable (e.g. in a frequency table or crosstabulation, a group
1013 of values in a variable being tabulated) and i0 otherwise.
1015 @node SPV Light Member Data
1018 The final part of an SPV light member contains the actual data.
1023 int[@t{layers}] int[@t{rows}] int[@t{columns}] int*[@t{n-dimensions}]
1024 int[@t{n-data}] Datum*[@t{n-data}]
1025 Datum @result{} int64[@t{index}] v3(00?) Value
1029 The values of @code{layers}, @code{rows}, and @code{columns} each
1030 specifies the number of dimensions displayed in layers, rows, and
1031 columns, respectively. Any of them may be zero. Their values sum to
1032 @code{n-dimensions} from Dimensions (@pxref{SPV Light Member
1035 The @code{n-dimensions} integers are a permutation of the 0-based
1036 dimension numbers. The first @code{layers} integers specify each of
1037 the dimensions represented by layers, the next @code{rows} integers
1038 specify the dimensions represented by rows, and the final
1039 @code{columns} integers specify the dimensions represented by columns.
1040 When there is more than one dimension of a given kind, the inner
1041 dimensions are given first.
1043 The format of a Datum varies slightly from version 1 to version 3: in
1044 version 1 it allows for an extra optional 00 byte.
1046 A Datum consists of an @code{index} and a Value. Suppose there are
1047 @math{d} dimensions and dimension @math{i}, @math{0 \le i < d}, has
1048 @math{n_i} categories. Consider the datum at coordinates @math{x_i},
1049 @math{0 \le i < d}, and note that @math{0 \le x_i < n_i}. Then the
1050 index is calculated by the following algorithm:
1054 for each @math{i} from 0 to @math{d - 1}:
1055 @i{index} = (@math{n_i \times} @i{index}) @math{+} @math{x_i}
1058 For example, suppose there are 3 dimensions with 3, 4, and 5
1059 categories, respectively. The datum at coordinates (1, 2, 3) has
1060 index @math{5 \times (4 \times (3 \times 0 + 1) + 2) + 3 = 33}.
1062 @node SPV Light Member Value
1065 Value is used throughout the SPV light member format. It boils down
1066 to a number or a string.
1070 Value @result{} 00? 00? 00? 00? RawValue
1072 01 ValueMod int[@t{format}] double[@t{x}]
1073 @math{|} 02 ValueMod int[@t{format}] double[@t{x}]
1074 string[@t{varname}] string[@t{vallab}] (01 @math{|} 02 @math{|} 03)
1075 @math{|} 03 string[@t{local}] ValueMod string[@t{id}] string[@t{c}] (00 @math{|} 01)[@t{type}]
1076 @math{|} 04 ValueMod int[@t{format}] string[@t{vallab}] string[@t{varname}]
1077 (01 @math{|} 02 @math{|} 03) string[@t{s}]
1078 @math{|} 05 ValueMod string[@t{varname}] string[@t{varlabel}] (01 @math{|} 02 @math{|} 03)
1079 @math{|} ValueMod string[@t{format}] int[@t{n-args}] Argument*[@t{n-args}]
1082 @math{|} int[@t{x}] i0 Value*[@t{x}@math{+}1] /* @t{x} @math{>} 0 */
1086 There are several possible encodings, which one can distinguish by the
1087 first nonzero byte in the encoding.
1091 The numeric value @code{x}, intended to be presented to the user
1092 formatted according to @code{format}, which is in the format described
1093 for system files. @xref{System File Output Formats}, for details.
1094 Most commonly, @code{format} has width 40 (the maximum).
1096 An @code{x} with the maximum negative double value @code{-DBL_MAX}
1097 represents the system-missing value SYSMIS. (HIGHEST and LOWEST have
1098 not been observed.) @xref{System File Format}, for more about these
1102 Similar to @code{01}, with the additional information that @code{x} is
1103 a value of variable @code{varname} and has value label @code{vallab}.
1104 Both @code{varname} and @code{vallab} can be the empty string, the
1105 latter very commonly.
1107 The meaning of the final byte is unknown. Possibly it is connected to
1108 whether the value or the label should be displayed.
1111 A text string, in two forms: @code{c} is in English, and sometimes
1112 abbreviated or obscure, and @code{local} is localized to the user's
1113 locale. In an English-language locale, the two strings are often the
1114 same, and in the cases where they differ, @code{local} is more
1115 appropriate for a user interface, e.g.@: @code{c} of ``Not a PxP table
1116 for MCN...'' versus @code{local} of ``Computed only for a PxP table,
1117 where P must be greater than 1.''
1119 @code{c} and @code{local} are always either both empty or both
1122 @code{id} is a brief identifying string whose form seems to resemble a
1123 programming language identifier, e.g.@: @code{cumulative_percent} or
1124 @code{factor_14}. It is not unique.
1126 @code{type} is 00 for text taken from user input, such as syntax
1127 fragment, expressions, file names, data set names, and 01 for fixed
1128 text strings such as names of procedures or statistics. In the former
1129 case, @code{id} is always the empty string; in the latter case,
1130 @code{id} is still sometimes empty.
1133 The string value @code{s}, intended to be presented to the user
1134 formatted according to @code{format}. The format for a string is not
1135 too interesting, and the corpus contains many clearly invalid formats
1136 like A16.39 or A255.127 or A134.1, so readers should probably ignore
1137 the format entirely.
1139 @code{s} is a value of variable @code{varname} and has value label
1140 @code{vallab}. @code{varname} is never empty but @code{vallab} is
1143 The meaning of the final byte is unknown.
1146 Variable @code{varname}, which is rarely observed as empty in the
1147 corpus, with variable label @code{varlabel}, which is often empty.
1149 The meaning of the final byte is unknown.
1152 (These bytes begin a ValueMod.) A format string, analogous to
1153 @code{printf}, followed by one or more Arguments, each of which has
1154 one or more values. The format string uses the following syntax:
1161 Each of these expands to the character following @samp{\\}, to escape
1162 characters that have special meaning in format strings. These are
1163 effective inside and outside the @code{[@dots{}]} syntax forms
1167 Expands to a new-line, inside or outside the @code{[@dots{}]} forms
1171 Expands to a formatted version of argument @var{i}, which must have
1172 only a single value. For example, @code{^1} expands to the first
1173 argument's @code{value}.
1175 @item [:@var{a}:]@var{i}
1176 Expands @var{a} for each of the values in @var{i}. @var{a}
1177 should contain one or more @code{^@var{j}} conversions, which are
1178 drawn from the values for argument @var{i} in order. Some examples
1183 All of the values for the first argument, concatenated.
1186 Expands to the values for the first argument, each followed by
1190 Expands to @code{@var{x} = @var{y}} where @var{x} is the second
1191 argument's first value and @var{y} is its second value. (This would
1192 be used only if the argument has two values. If there were more
1193 values, the second and third values would be directly concatenated,
1194 which would look funny.)
1197 @item [@var{a}:@var{b}:]@var{i}
1198 This extends the previous form so that the first values are expanded
1199 using @var{a} and later values are expanded using @var{b}. For an
1200 unknown reason, within @var{a} the @code{^@var{j}} conversions are
1201 instead written as @code{%@var{j}}. Some examples from the corpus:
1205 Expands to all of the values for the first argument, separated by
1208 @item [%1 = %2:, ^1 = ^2:]1
1209 Given appropriate values for the first argument, expands to @code{X =
1213 Given appropriate values, expands to @code{1, 2, 3}.
1217 The format string is localized to the user's locale.
1220 @node SPV Light Member ValueMod
1221 @subsection ValueMod
1223 A ValueMod can specify special modifications to a Value.
1228 31 i0 (i0 @math{|} i1 string[@t{subscript}])
1229 v1(00 (i1 @math{|} i2) 00 00 int 00 00)
1230 v3(count(FormatString Style ValueModUnknown))
1231 @math{|} 31 int[@t{n-refs}] int16*[@t{n-refs}] Format
1233 Style @result{} 58 @math{|} 31 01? 00? 00? 00? 01 string[@t{fgcolor}] string[@t{bgcolor}] string[@t{typeface}] byte
1234 Format @result{} 00 00 count(FormatString Style 58)
1235 FormatString @result{} count((i0 (58 @math{|} 31 string))?)
1236 ValueModUnknown @result{} 58 @math{|} 31 i0 i0 i0 i0 01 00 (01 @math{|} 02 @math{|} 08) 00 08 00 0a 00)
1240 A ValueMod that begins with ``31 i0'' specifies a string to append to
1241 the main text of the Value, as a subscript. The subscript text is a
1242 brief indicator, e.g.@: @samp{a} or @samp{a,b}, with its meaning
1243 indicated by the table caption. In this usage, subscripts are similar
1244 to footnotes. One apparent difference is that a Value can only
1245 reference one footnote but a subscript can list more than one letter.
1247 A ValueMod that begins with 31 followed by a nonzero ``int'' specifies
1248 a footnote or footnotes that the Value references. Footnote markers
1249 are shown appended to the main text of the Value, as superscripts.
1251 The Format, if present, is a format string for substitutions using the
1252 syntax explained previously. It appears to be an English-language
1253 version of the localized format string in the Value in which the
1256 The Style, if present, changes the style for this individual Value.
1258 @node SPV Legacy Detail Member Binary Format
1259 @section Legacy Detail Member Binary Format
1261 Whereas the light binary format represents everything about a given
1262 pivot table, the legacy binary format conceptually consists of a
1263 number of named sources, each of which consists of a number of named
1264 variables, each of which is a 1-dimensional array of numbers or
1265 strings or a mix. Thus, the legacy binary member format is quite
1268 This section uses the same context-free grammar notation as in the
1269 previous section, with the following additions:
1273 In a version 0xaf legacy member, @var{x}; in other versions, nothing.
1274 (The legacy member header indicates the version; see below.)
1277 In a version 0xb0 legacy member, @var{x}; in other versions, nothing.
1280 A legacy detail member @file{.bin} has the following overall format:
1284 LegacyBinary @result{}
1285 00 byte[@t{version}] int16[@t{n-sources}] int[@t{member-size}]
1286 Metadata*[@t{n-sources}] Data*[@t{n-sources}]
1290 @code{version} is a version number that affects the interpretation of
1291 some of the other data in the member. Versions 0xaf and 0xb0 are
1292 known. We will refer to ``version 0xaf'' and ``version 0xb0'' members
1295 A legacy member consists of @code{n-sources} data sources, each of
1296 which has Metadata and Data.
1298 @code{member-size} is the size of the legacy binary member, in bytes.
1300 The following sections go into more detail.
1303 * SPV Legacy Member Metadata::
1304 * SPV Legacy Member Data::
1307 @node SPV Legacy Member Metadata
1308 @subsection Metadata
1313 int[@t{n-data}] int[@t{n-variables}] int[@t{offset}]
1314 vAF(byte*32[@t{source-name}])
1315 vB0(byte*64[@t{source-name}] int[@t{x}])
1319 A data source has @code{n-variables} variables, each with
1320 @code{n-data} data values.
1322 @code{source-name} is a 32- or 64-byte string padded on the right with
1323 zero bytes. The names that appear in the corpus are very generic:
1324 usually @code{tableData} for pivot table data or @code{source0} for
1327 A given Metadata's @code{offset} is the offset, in bytes, from the
1328 beginning of the member to the start of the corresponding Data. This
1329 allows programs to skip to the beginning of the data for a particular
1330 source; it is also important to determine whether a source includes
1331 any string data (@pxref{SPV Legacy Member Data}).
1333 The meaning of @code{x} in version 0xb0 is unknown.
1335 @node SPV Legacy Member Data
1340 Data @result{} NumericData*[@t{n-variables}] StringData?
1341 NumericData @result{} byte*288[@t{variable-name}] double*[@t{n-data}]
1345 Data follow the Metadata in the legacy binary format, with sources in
1346 the same order. Each NumericSeries begins with a @code{variable-name}
1347 that generally indicates its role in the pivot table, e.g.@: ``cell'',
1348 ``cellFormat'', ``dimension0categories'', ``dimension0group0'',
1349 followed by the numeric data, one double per datum. A double with the
1350 maximum negative double @code{-DBL_MAX} represents the system-missing
1355 StringData @result{} i1 string[@t{source-name}] Pairs Labels
1357 Pairs @result{} int[@t{n-string-vars}] PairSeries*[@t{n-string-vars}]
1358 PairVar @result{} string[@t{pair-var-name}] int[@t{n-pairs}] Pair*[@t{n-pairs}]
1359 Pair @result{} int[@t{i}] int[@t{j}]
1361 Labels @result{} int[@t{n-labels}] Label*[@t{n-labels}]
1362 Label @result{} int[@t{frequency}] int[@t{s}]
1366 A source may include a mix of numeric and string data values. When a
1367 source includes any string data, the data values that are strings are
1368 set to SYSMIS in the NumericData, and StringData follows the
1369 NumericData. A source that contains no string data omits the
1370 StringData. To reliably determine whether a source includes
1371 StringData, the reader should check whether the offset following the
1372 NumericData is the offset of the next source, as indicated by its
1373 Metadata (or the end of the member, in the case of the last source).
1375 StringData repeats the name of the source (from Metadata).
1377 The string data overlays the numeric data. @code{n-string-vars} is
1378 the number of variables in the source that include string data. More
1379 precisely, it is the 1-based index of the last variable in the source
1380 that includes any string data; thus, it would be 4 if there are 5
1381 variables and only the fourth one includes string data.
1383 Each PairVar consists a sequence of 0 or more Pair nonterminals, each
1384 of which maps from a 0-based index within variable @code{i} to a
1385 0-based label index @code{j}, e.g.@: pair @code{i} = 2, @code{j} = 3,
1386 means that the third data value (with value SYSMIS) is to be replaced
1387 by the string of the fourth Label.
1389 The labels themselves follow the pairs. The valuable part of each
1390 label is the string @code{s}. Each label also includes a
1391 @code{frequency} that reports the number of pairs that reference it
1392 (although this is not useful).
1394 @node SPV Legacy Detail Member XML Format
1395 @section Legacy Detail Member XML Format
1397 This format is still under investigation.
1399 The design of the detail XML format is not what one would end up with
1400 for describing pivot tables. This is because it is a special case
1401 of a much more general format (``visualization XML'' or ``VizML'')
1402 that can describe a wide range of visualizations. Most of this
1403 generality is overkill for tables, and so we end up with a funny
1404 subset of a general-purpose format.
1406 The important elements of the detail XML format are:
1410 Variables. Variables in detail XML roughly correspond to the
1411 dimensions in a light detail member. There is one variable for each
1412 dimension, plus one variable for each level of labeling along an axis.
1414 The bulk of variables are defined with @code{sourceVariable} elements.
1415 The data for these variables comes from the associated
1416 @code{tableData.bin} member. Some variables are defined, with
1417 @code{derivedVariable} elements, as a constant or in terms of a
1418 mapping function from a source variable.
1421 Assignment of variables to axes. A variable can appear as columns, or
1422 rows, or layers. The @code{faceting} element and its sub-elements
1423 describe this assignment.
1426 All elements have an optional @code{id} attribute. In practice many
1427 elements are assigned @code{id} attributes that are never referenced.
1430 * SPV Detail visualization Element::
1431 * SPV Detail userSource Element::
1432 * SPV Detail sourceVariable Element::
1433 * SPV Detail derivedVariable Element::
1434 * SPV Detail extension Element::
1435 * SPV Detail graph Element::
1436 * SPV Detail location Element::
1437 * SPV Detail coordinates Element::
1438 * SPV Detail faceting Element::
1439 * SPV Detail facetLayout Element::
1442 @node SPV Detail visualization Element
1443 @subsection The @code{visualization} Element
1446 Parent: Document root
1450 (sourceVariable @math{|} derivedVariable)@math{+}
1458 This element has the following attributes.
1460 @defvr {Required} creator
1461 The version of the software that created this SPV file, as a string of
1462 the form @code{xxyyzz}, which represents software version xx.yy.zz,
1463 e.g.@: @code{160001} is version 16.0.1. The corpus includes major
1464 versions 16 through 19.
1467 @defvr {Required} date
1468 The date on the which the file was created, as a string of the form
1472 @defvr {Required} lang
1473 The locale used for output, in Windows format, which is similar to the
1474 format used in Unix with the underscore replaced by a hyphen, e.g.@:
1475 @code{en-US}, @code{en-GB}, @code{el-GR}, @code{sr-Cryl-RS}.
1478 @defvr {Required} name
1479 The title of the pivot table, localized to the output language.
1482 @defvr {Required} style
1483 The @code{id} of a @code{style} element (@pxref{SPV Detail style
1484 element}). This is the base style for the entire pivot table. In
1485 every example in the corpus, the value is @code{visualizationStyle}
1486 and the corresponding @code{style} element has no attributes other
1490 @defvr {Required} type
1491 A floating-point number. The meaning is unknown.
1494 @defvr {Required} version
1495 The visualization schema version number. In the corpus, the value is
1496 one of 2.4, 2.5, 2.7, and 2.8.
1499 @node SPV Detail userSource Element
1500 @subsection The @code{userSource} Element
1502 Parent: @code{visualization} @*
1505 This element has the following attributes.
1507 @defvr {Optional} missing
1508 Always @code{listwise}.
1511 @node SPV Detail sourceVariable Element
1512 @subsection The @code{sourceVariable} Element
1514 Parent: @code{visualization} @*
1515 Contents: @code{extension}* (@code{format} @math{|} @code{stringFormat})?
1517 This element defines a variable whose values can be used elsewhere in
1518 the visualization. It ties this element's @code{id} to a variable
1519 from the @file{tableData.bin} member that corresponds to this
1522 This element has the following attributes.
1524 @defvr {Required} categorical
1525 Always set to @code{true}.
1528 @defvr {Required} source
1529 Always set to @code{tableData}, the @code{source-name} in the
1530 corresponding @file{tableData.bin} member (@pxref{SPV Legacy Member
1534 @defvr {Required} sourceName
1535 The name of a variable within the source, the @code{variable-name} in
1536 the corresponding @file{tableData.bin} member (@pxref{SPV Legacy
1540 @defvr {Optional} dependsOn
1541 The @code{variable-name} of a variable linked to this one, so that a
1542 viewer can work with them together. For a group variable, this is the
1543 name of the corresponding categorical variable.
1546 @defvr {Optional} label
1547 The variable label, if any
1550 @defvr {Optional} labelVariable
1551 The @code{variable-name} of a variable whose string values correspond
1552 one-to-one with the values of this variable and are suitable for use
1556 @node SPV Detail derivedVariable Element
1557 @subsection The @code{derivedVariable} Element
1559 Parent: @code{visualization} @*
1560 Contents: @code{extension}* (@code{format} @math{|} @code{stringFormat} @code{valueMapEntry}*)
1562 Like @code{sourceVariable}, this element defines a variable whose
1563 values can be used elsewhere in the visualization. Instead of being
1564 read from a data source, the variable's data are defined by a
1565 mathematical expression.
1567 This element has the following attributes.
1569 @defvr {Required} categorical
1570 Always set to @code{true}.
1573 @defvr {Required} value
1574 An expression that defines the variable's value. In theory this could
1575 be an arbitrary expression in terms of constants, functions, and other
1576 variables, e.g.@: @math{(@var{var1} + @var{var2}) / 2}. In practice,
1577 the corpus contains only the following forms of expressions:
1580 @item constant(@var{number})
1581 @itemx constant(@var{variable})
1582 A constant. The meaning when a variable is named is unknown.
1583 Sometimes the ``variable name'' has spaces in it.
1585 @item map(@var{variable})
1586 Transforms the values in the named @var{variable} using the
1587 @code{valueMapEntry}s contained within the element.
1591 @defvr {Optional} dependsOn
1592 The @code{variable-name} of a variable linked to this one, so that a
1593 viewer can work with them together. For a group variable, this is the
1594 name of the corresponding categorical variable.
1598 * SPV Detail valueMapEntry Element::
1601 @node SPV Detail valueMapEntry Element
1602 @subsubsection The @code{valueMapEntry} Element
1604 Parent: @code{derivedVariable} @*
1607 A @code{valueMapEntry} element defines a mapping from one or more
1608 values of a source expression to a target value. (In the corpus, the
1609 source expression is always just the name of a variable.) Each target
1610 value requires a separate @code{valueMapEntry}. If multiple source
1611 values map to the same target value, they can be combined or separate.
1613 @code{valueMapEntry} has the following attributes.
1615 @defvr {Required} from
1616 A source value, or multiple source values separated by semicolons,
1617 e.g.@: @code{0} or @code{13;14;15;16}.
1620 @defvr {Required} to
1624 @node SPV Detail extension Element
1625 @subsection The @code{extension} Element
1627 This is a general-purpose ``extension'' element. Readers that don't
1628 understand a given extension should be able to safely ignore it. The
1629 attributes on this element, and their meanings, vary based on the
1630 context. Each known usage is described separately below. The current
1631 extensions use attributes exclusively, without any nested elements.
1633 @subsubheading @code{visualization} Parent Element
1635 With @code{visualization} as its parent element, @code{extension} has
1636 the following attributes.
1638 @defvr {Optional} numRows
1639 An integer that presumably defines the number of rows in the displayed
1643 @defvr {Optional} showGridline
1644 Always set to @code{false} in the corpus.
1647 @defvr {Optional} minWidthSet
1648 @defvrx {Optional} maxWidthSet
1649 Always set to @code{true} in the corpus.
1652 @subsubheading @code{container} Parent Element
1654 With @code{container} as its parent element, @code{extension} has the
1655 following attributes.
1657 @defvr {Required} combinedFootnotes
1658 Always set to @code{true} in the corpus.
1661 @subsubheading @code{sourceVariable} and @code{derivedVariable} Parent Element
1663 With @code{sourceVariable} or @code{derivedVariable} as its parent
1664 element, @code{extension} has the following attributes. A given
1665 parent element often contains several @code{extension} elements that
1666 specify the meaning of the source data's variables or sources, e.g.@:
1669 <extension from="0" helpId="corrected_model"/>
1670 <extension from="3" helpId="error"/>
1671 <extension from="4" helpId="total_9"/>
1672 <extension from="5" helpId="corrected_total"/>
1675 @defvr {Required} from
1676 An integer or a name like ``dimension0''.
1679 @defvr {Required} helpId
1683 @node SPV Detail graph Element
1684 @subsection The @code{graph} Element
1686 Parent: @code{visualization} @*
1687 Contents: @code{location}@math{+} @code{coordinates} @code{faceting} @code{facetLayout} @code{interval}
1689 @code{graph} has the following attributes.
1691 @defvr {Required} cellStyle
1692 @defvrx {Required} style
1693 Each of these is the @code{id} of a @code{style} element (@pxref{SPV
1694 Detail style element}). The former is the default style for
1695 individual cells, the latter for the entire table.
1698 @node SPV Detail location Element
1699 @subsection The @code{location} Element
1701 Parent: @code{graph} @*
1704 Each instance of this element specifies where some part of the table
1705 frame is located. All the examples in the corpus have four instances
1706 of this element, one for each of the parts @code{height},
1707 @code{width}, @code{left}, and @code{top}. Some examples in the
1708 corpus add a fifth for part @code{bottom}, even though it is not clear
1709 how all of @code{top}, @code{bottom}, and @code{heigth} can be honored
1710 at the same time. In any case, @code{location} seems to have little
1711 importance in representing tables; a reader can safely ignore it.
1713 @defvr {Required} part
1714 One of @code{height}, @code{width}, @code{top}, @code{bottom}, or
1715 @code{left}. Presumably @code{right} is acceptable as well but the
1716 corpus contains no examples.
1719 @defvr {Required} method
1720 How the location is determined:
1724 Based on the natural size of the table. Observed only for
1725 parts @code{height} and @code{width}.
1728 Based on the location specified in @code{target}. Observed only for
1729 parts @code{top} and @code{bottom}.
1732 Using the value in @code{value}. Observed only for parts @code{top},
1733 @code{bottom}, and @code{left}.
1736 Same as the specified @code{target}. Observed only for part
1741 @defvr {Optional} min
1742 Minimum size. Only observed with value @code{100pt}. Only observed
1743 for part @code{width}.
1746 @defvr {Dependent} target
1747 Required when @code{method} is @code{attach} or @code{same}, not
1748 observed otherwise. This is the ID of an element to attach to.
1749 Observed with the ID of @code{title}, @code{footnote}, @code{graph},
1753 @defvr {Dependent} value
1754 Required when @code{method} is @code{fixed}, not observed otherwise.
1755 Observed values are @code{0%}, @code{0px}, @code{1px}, and @code{3px}
1756 on parts @code{top} and @code{left}, and @code{100%} on part
1760 @node SPV Detail coordinates Element
1761 @subsection The @code{coordinates} Element
1763 Parent: @code{graph} @*
1766 This element is always present and always empty, with no attributes
1769 @node SPV Detail faceting Element
1770 @subsection The @code{faceting} Element
1772 Parent: @code{graph} @*
1773 Contents: @code{cross} @code{layer}*
1775 The @code{faceting} element describes the row, column, and layer
1776 structure of the table. Its @code{cross} child determines the row and
1777 column structure, and each @code{layer} child (if any) represents a
1780 @code{faceting} has no attributes (other than @code{id}).
1782 @subsubheading The @code{cross} Element
1784 Parent: @code{faceting} @*
1785 Contents: @code{nest} @code{nest}
1787 The @code{cross} element describes the row and column structure of the
1788 table. It has exactly two @code{nest} children, the first of which
1789 describes the table's rows and the second the table's columns.
1791 @code{cross} has no attributes (other than @code{id}).
1793 @subsubheading The @code{nest} Element
1795 Parent: @code{cross} @*
1796 Contents: @code{variableReference}@math{+}
1798 A given @code{nest} usually consists of one or more dimensions, each
1799 of which is represented by @code{variableReference} child elements.
1800 Minimally, a dimension has two @code{variableReference} children, one
1801 for the categories, one for the data, e.g.:
1805 <variableReference ref="dimension0categories"/>
1806 <variableReference ref="dimension0"/>
1811 Groups of categories introduce additional variable references, e.g.@:
1815 <variableReference ref="dimension0categories"/>
1816 <variableReference ref="dimension0group0"/>
1817 <variableReference ref="dimension0"/>
1822 Grouping can be hierarchical, e.g.@:
1826 <variableReference ref="dimension0categories"/>
1827 <variableReference ref="dimension0group1"/>
1828 <variableReference ref="dimension0group0"/>
1829 <variableReference ref="dimension0"/>
1834 XXX what are group maps?
1837 <nest id="nest_1973">
1838 <variableReference ref="dimension1categories"/>
1839 <variableReference ref="dimension1group1map"/>
1840 <variableReference ref="dimension1group0map"/>
1841 <variableReference ref="dimension1"/>
1844 <variableReference ref="dimension0categories"/>
1845 <variableReference ref="dimension0group0map"/>
1846 <variableReference ref="dimension0"/>
1851 A @code{nest} can contain multiple dimensions:
1855 <variableReference ref="dimension1categories"/>
1856 <variableReference ref="dimension1group0"/>
1857 <variableReference ref="dimension1"/>
1858 <variableReference ref="dimension0categories"/>
1859 <variableReference ref="dimension0"/>
1863 One @code{nest} within a given @code{cross} may have no dimensions, in
1864 which case it still has one @code{variableReference} child, which
1865 references a @code{derivedVariable} whose @code{value} attribute is
1866 @code{constant(0)}. In the corpus, such a @code{derivedVariable} has
1867 @code{row} or @code{column}, respectively, as its @code{id}.
1869 @code{nest} has no attributes (other than @code{id}).
1871 @subsubheading The @code{variableReference} Element
1873 Parent: @code{nest} @*
1876 @code{variableReference} has one attribute.
1878 @defvr {Required} ref
1879 The @code{id} of a @code{sourceVariable} or @code{derivedVariable}
1883 @subsubheading The @code{layer} Element
1885 Parent: @code{faceting} @*
1888 Each layer is represented by a pair of @code{layer} elements. The
1889 first of this pair is for a category variable, the second for the data
1893 <layer value="0" variable="dimension0categories" visible="true"/>
1894 <layer value="dimension0" variable="dimension0" visible="false"/>
1898 @code{layer} has the following attributes.
1900 @defvr {Required} variable
1901 The @code{id} of a @code{sourceVariable} or @code{derivedVariable}
1905 @defvr {Required} value
1906 The value to select. For a category variable, this is always
1907 @code{0}; for a data variable, it is the same as the @code{variable}
1911 @defvr {Optional} visible
1912 Whether the layer is visible. Generally, category layers are visible
1913 and data layers are not, but sometimes this attribute is omitted.
1916 @defvr {Optional} method
1917 When present, this is always @code{nest}.
1920 @node SPV Detail facetLayout Element
1921 @subsection The @code{facetLayout} Element
1923 Parent: @code{graph} @*
1924 Contents: @code{tableLayout} @code{facetLevel}@math{+} @code{setCellProperties}*
1926 @subsubheading The @code{tableLayout} Element
1928 Parent: @code{facetLayout} @*
1931 @defvr {Required} verticalTitlesInCorner
1932 Always set to @code{true}.
1935 @defvr {Optional} style
1936 The @code{id} of a @code{style} element.
1939 @defvr {Optional} fitCells
1940 Always set to @code{ticks}.
1943 @subsubheading The @code{facetLevel} Element
1945 Parent: @code{facetLayout} @*
1946 Contents: @code{axis}
1948 Each @code{facetLevel} describes a @code{variableReference} or
1949 @code{layer}, and a table has one @code{facetLevel} element for
1950 each such element. For example, an SPV detail member that contains
1951 four @code{variableReference} elements and two @code{layer} elements
1952 will contain six @code{facetLevel} elements.
1954 In the corpus, @code{facetLevel} elements and the elements that they
1955 describe are always in the same order. The correspondence may also be
1956 observed in two other ways. First, one may use the @code{level}
1957 attribute, described below. Second, in the corpus, a
1958 @code{facetLevel} always has an @code{id} that is the same as the
1959 @code{id} of the element it describes with @code{_facetLevel}
1960 appended. One should not formally rely on this, of course, but it is
1961 usefully indicative.
1963 @defvr {Required} level
1964 A 1-based index into the @code{variableReference} and @code{layer}
1965 elements, e.g.@: a @code{facetLayout} with a @code{level} of 1
1966 describes the first @code{variableReference} in the SPV detail member,
1967 and in a member with four @code{variableReference} elements, a
1968 @code{facetLayout} with a @code{level} of 5 describes the first
1969 @code{layer} in the member.
1972 @defvr {Required} gap
1973 Always observed as @code{0pt}.
1976 @subsubheading The @code{axis} Element
1978 Parent: @code{facetLevel} @*
1979 Contents: @code{label}? @code{majorTicks}
1981 @defvr {Attribute} style
1982 The @code{id} of a @code{style} element.
1985 @subsubheading The @code{label} Element
1987 Parent: @code{axis} or @code{labelFrame} @*
1988 Contents: @code{text}@math{+} @math{|} @code{descriptionGroup}
1990 This element represents a label on some aspect of the table. For example,
1991 the table's title is a @code{label}.
1993 The contents of the label can be one or more @code{text} elements or a
1994 @code{descriptionGroup}.
1996 @defvr {Attribute} style
1997 @defvrx {Optional} textFrameStyle
1998 Each of these is the @code{id} of a @code{style} element.
1999 @code{style} is the style of the label text, @code{textFrameStyle} the
2000 style for the frame around the label.
2003 @defvr {Optional} purpose
2004 The kind of entity being labeled, one of @code{title},
2005 @code{subTitle}, @code{layer}, or @code{footnote}.
2008 @subsubheading The @code{descriptionGroup} Element
2010 Parent: @code{label} @*
2011 Contents: (@code{description} @math{|} @code{text})@math{+}
2013 A @code{descriptionGroup} concatenates one or more elements to form a
2014 label. Each element can be a @code{text} element, which contains
2015 literal text, or a @code{description} element that substitutes a value
2018 @defvr {Attribute} target
2019 The @code{id} of an element being described. In the corpus, this is
2020 always @code{faceting}.
2023 @defvr {Attribute} separator
2024 A string to separate the description of multiple groups, if the
2025 @code{target} has more than one. In the corpus, this is always a
2029 Typical contents for a @code{descriptionGroup} are a value by itself:
2031 <description name="value"/>
2033 @noindent or a variable and its value, separated by a colon:
2035 <description name="variable"/><text>:</text><description name="value"/>
2038 @subsubheading The @code{description} Element
2040 Parent: @code{descriptionGroup} @*
2043 A @code{description} is like a macro that expands to some property of
2044 the target of its parent @code{descriptionGroup}.
2046 @defvr {Attribute} name
2047 The name of the property. Only @code{variable} and @code{value}
2048 appear in the corpus.
2051 @subsubheading The @code{majorTicks} Element
2053 Parent: @code{axis} @*
2054 Contents: @code{gridline}?
2056 @defvr {Attribute} labelAngle
2057 @defvrx {Attribute} length
2058 Both always defined to @code{0}.
2061 @defvr {Attribute} style
2062 @defvrx {Attribute} tickFrameStyle
2063 Each of these is the @code{id} of a @code{style} element.
2064 @code{style} is the style of the tick labels, @code{tickFrameStyle}
2065 the style for the frames around the labels.
2068 @subsubheading The @code{gridline} Element
2070 Parent: @code{majorTicks} @*
2073 Represents ``gridlines,'' which for a table represents the lines
2074 between the rows or columns of a table (XXX?).
2076 @defvr {Attribute} style
2077 The style for the gridline.
2080 @defvr {Attribute} zOrder
2081 Observed as a number between 28 and 31. Does not seem to be
2085 @subsubheading The @code{setCellProperties} Element
2087 Parent: @code{facetLayout} @*
2088 Contents: @code{setMetaData} @code{setStyle}* @code{setFormat}@math{+} @code{union}?
2090 This element sets style properties of cells designated by the
2091 @code{target} attribute of its child elements, as further restricted
2092 by the optional @code{union} element if present. The @code{target}
2093 values often used, e.g.@: @code{graph} or @code{labeling}, actually
2094 affect every cell, so the @code{union} element is a useful
2097 @defvr {Optional} applyToConverse
2098 If present, always @code{true}. This appears to invert the meaning of
2099 the @code{target} of sub-elements: the selected cells are the ones
2100 @emph{not} designated by @code{target}. This is confusing, given the
2101 additional restrictions of @code{union}, but in the corpus
2102 @code{applyToConverse} is never present along with @code{union}.
2105 @subsubheading The @code{setMetaData} Element
2107 Parent: @code{setCellProperties} @*
2110 This element is not known to have any visible effect.
2112 @defvr {Required} target
2113 The @code{id} of an element whose metadata is to be set. In the
2114 corpus, this is always @code{graph}, the @code{id} used for the
2115 @code{graph} element.
2118 @defvr {Required} key
2119 @defvrx {Required} value
2120 A key-value pair to set for the target.
2122 In the corpus, @code{key} is @code{cellPropId} or, rarely,
2123 @code{diagProps}, and @code{value} is always the @code{id} of the
2124 parent @code{setCellProperties}.
2127 @subsubheading The @code{setStyle} Element
2129 Parent: @code{setCellProperties} @*
2132 This element associates a style with the target.
2134 @defvr {Required} target
2135 The @code{id} of an element whose style is to be set. In the corpus,
2136 this is always the @code{id} of an @code{interval}, @code{labeling},
2137 or, rarely, @code{graph} element.
2140 @defvr {Required} style
2141 The @code{id} of a @code{style} element that identifies the style to
2145 @subsubheading The @code{setFormat} Element
2148 Parent: @code{setCellProperties}
2151 @math{|} @code{numberFormat}
2152 @math{|} @code{stringFormat}@math{+}
2153 @math{|} @code{dateTimeFormat}
2156 This element sets the format of the target, ``format'' in this case
2157 meaning the SPSS print format for a variable.
2159 The details of this element vary depending on the schema version, as
2160 declared in the root @code{visualization} element's @code{version}
2161 attribute (@pxref{SPV Detail visualization Element}). In version 2.5
2162 and earlier, @code{setFormat} contains one of a number of child
2163 elements that correspond to the different varieties of print formats.
2164 In version 2.7 and later, @code{setFormat} instead always contains a
2165 @code{format} element.
2167 XXX reinvestigate the above claim about versions: it appears to be
2170 The @code{setFormat} element itself has the following attributes.
2172 @defvr {Required} target
2173 The @code{id} of an element whose style is to be set. In the corpus,
2174 this is always the @code{id} of an @code{majorTicks} or
2175 @code{labeling} element.
2178 @defvr {Optional} reset
2179 If this is @code{true}, this format overrides the target's previous
2180 format. If it is @code{false}, the adds to the previous format. In
2181 the corpus this is always @code{true}. The default behavior is
2186 * SPV Detail format Element::
2187 * SPV Detail numberFormat Element::
2188 * SPV Detail stringFormat Element::
2189 * SPV Detail dateTimeFormat Element::
2190 * SPV Detail affix Element::
2191 * SPV Detail relabel Element::
2192 * SPV Detail union Element::
2195 @node SPV Detail format Element
2196 @subsubsection The @code{format} Element
2198 Parent: @code{sourceVariable}, @code{derivedVariable}, @code{formatMapping}, @code{labeling}, @code{formatMapping}, @code{setFormat} @*
2199 Contents: (@code{affix}@math{+} @math{|} @code{relabel}@math{+})?
2201 This element appears only in schema version 2.7 (@pxref{SPV Detail
2202 visualization Element}).
2204 This element determines a format, equivalent to an SPSS print format.
2206 @subsubheading Attributes for All Formats
2208 These attributes apply to all kinds of formats. The most important of
2209 these attributes determines the high-level kind of formatting in use:
2211 @defvr {Optional} baseFormat
2212 Either @code{dateTime} or @code{elapsedTime}. When this attribute is
2213 omitted, this element is a numeric or string format.
2217 Whether, in the corpus, other attributes are always present (``yes''),
2218 never present (``no''), or sometimes present (``opt'') depends on
2221 @multitable {maximumFractionDigits} {@code{dateTime}} {@code{elapsedTime}} {number} {string}
2222 @headitem Attribute @tab @code{dateTime} @tab @code{elapsedTime} @tab number @tab string
2223 @item errorCharacter @tab yes @tab yes @tab yes @tab opt
2225 @item separatorChars @tab yes @tab no @tab no @tab no
2227 @item mdyOrder @tab yes @tab no @tab no @tab no
2229 @item showYear @tab yes @tab no @tab no @tab no
2230 @item yearAbbreviation @tab yes @tab no @tab no @tab no
2232 @item showMonth @tab yes @tab no @tab no @tab no
2233 @item monthFormat @tab yes @tab no @tab no @tab no
2235 @item showDay @tab yes @tab opt @tab no @tab no
2236 @item dayPadding @tab yes @tab opt @tab no @tab no
2237 @item dayOfMonthPadding @tab yes @tab no @tab no @tab no
2238 @item dayType @tab yes @tab no @tab no @tab no
2240 @item showHour @tab yes @tab opt @tab no @tab no
2241 @item hourFormat @tab yes @tab opt @tab no @tab no
2242 @item hourPadding @tab yes @tab yes @tab no @tab no
2244 @item showMinute @tab yes @tab yes @tab no @tab no
2245 @item minutePadding @tab yes @tab yes @tab no @tab no
2247 @item showSecond @tab yes @tab yes @tab no @tab no
2248 @item secondPadding @tab no @tab yes @tab no @tab no
2250 @item showMillis @tab no @tab yes @tab no @tab no
2252 @item minimumIntegerDigits @tab no @tab no @tab yes @tab no
2253 @item maximumFractionDigits @tab no @tab yes @tab yes @tab no
2254 @item minimumFractionDigits @tab no @tab yes @tab yes @tab no
2255 @item useGrouping @tab no @tab opt @tab yes @tab no
2256 @item scientific @tab no @tab no @tab yes @tab no
2257 @item small @tab no @tab no @tab opt @tab no
2258 @item suffix @tab no @tab no @tab opt @tab no
2260 @item tryStringsAsNumbers @tab no @tab no @tab no @tab yes
2264 @defvr {Attribute} errorCharacter
2265 A character that replaces the formatted value when it cannot otherwise
2266 be represented in the given format. Always @samp{*}.
2269 @subsubheading Date and Time Attributes
2271 These attributes are used with @code{dateTime} and @code{elapsedTime}
2274 @defvr {Attribute} separatorChars
2275 Exactly four characters. In order, these are used for: decimal point,
2276 grouping, date separator, time separator. Always @samp{.,-:}.
2279 @defvr {Attribute} mdyOrder
2280 Within a date, the order of the days, months, and years.
2281 @code{dayMonthYear} is the only observed value, but one would expect
2282 that @code{monthDayYear} and @code{yearMonthDay} to be reasonable as
2286 @defvr {Attribute} showYear
2287 @defvrx {Attribute} yearAbbreviation
2288 Whether to include the year and, if so, whether the year should be
2289 shown abbreviated, that is, with only 2 digits. Each is @code{true}
2290 or @code{false}; only values of @code{true} and @code{false},
2291 respectively, have been observed.
2294 @defvr {Attribute} showMonth
2295 @defvrx {Attribute} monthFormat
2296 Whether to include the month (@code{true} or @code{false}) and, if so,
2297 how to format it. @code{monthFormat} is one of the following:
2301 The full name of the month, e.g.@: in an English locale,
2305 The abbreviated name of the month, e.g.@: in an English locale,
2309 The number representing the month, e.g.@: 9 for September.
2312 A two-digit number representing the month, e.g.@: 09 for September.
2315 Only values of @code{true} and @code{short}, respectively, have been
2319 @defvr {Attribute} dayPadding
2320 @defvrx {Attribute} dayOfMonthPadding
2321 @defvrx {Attribute} hourPadding
2322 @defvrx {Attribute} minutePadding
2323 @defvrx {Attribute} secondPadding
2324 These attributes presumably control whether each field in the output
2325 is padded with spaces to its maximum width, but the details are not
2326 understood. The only observed value for any of these attributes is
2330 @defvr {Attribute} showDay
2331 @defvrx {Attribute} showHour
2332 @defvrx {Attribute} showMinute
2333 @defvrx {Attribute} showSecond
2334 @defvrx {Attribute} showMillis
2335 These attributes presumably control whether each field is displayed
2336 in the output, but the details are not understood. The only
2337 observed value for any of these attributes is @code{true}.
2340 @defvr {Attribute} dayType
2341 This attribute is always @code{month} in the corpus, specifying that
2342 the day of the month is to be displayed; a value of @code{year} is
2343 supposed to indicate that the day of the year, where 1 is January 1,
2344 is to be displayed instead.
2347 @defvr {Attribute} hourFormat
2348 @code{hourFormat}, if present, is one of:
2352 The time is displayed with an @code{am} or @code{pm} suffix, e.g.@:
2356 The time is displayed in a 24-hour format, e.g.@: @code{22:15}.
2358 This is the only value observed in the corpus.
2361 The time is displayed in a 12-hour format, without distinguishing
2362 morning or evening, e.g.@: @code{10;15}.
2365 @code{hourFormat} is sometimes present for @code{elapsedTime} formats,
2366 which is confusing since a time duration does not have a concept of AM
2367 or PM. This might indicate a bug in the code that generated the XML
2368 in the corpus, or it might indicate that @code{elapsedTime} is
2369 sometimes used to format a time of day.
2372 @subsubheading Numeric Attributes
2374 These attributes are used for formats when @code{baseFormat} is
2375 @code{number}. Attributes @code{maximumFractionDigits}, and
2376 @code{minimumFractionDigits}, and @code{useGrouping} are also used
2377 when @code{baseFormat} is @code{elapsedTime}.
2379 @defvr {Attribute} minimumIntegerDigits
2380 Minimum number of digits to display before the decimal point. Always
2381 observed as @code{0}.
2384 @defvr {Attribute} maximumFractionDigits
2385 @defvrx {Attribute} maximumFractionDigits
2386 Maximum or minimum, respectively, number of digits to display after
2387 the decimal point. The observed values of each attribute range from 0
2391 @defvr {Attribute} useGrouping
2392 Whether to use the grouping character to group digits in large
2393 numbers. It would make sense for the grouping character to come from
2394 the @code{separatorChars} attribute, but that attribute is only
2395 present when @code{baseFormat} is @code{dateTime} or
2396 @code{elapsedTime}, in the corpus at least. Perhaps that is because
2397 this attribute has only been observed as @code{false}.
2400 @defvr {Attribute} scientific
2401 This attribute controls when and whether the number is formatted in
2402 scientific notation. It takes the following values:
2406 Use scientific notation only when the number's magnitude is smaller
2407 than the value of the @code{small} attribute.
2410 Use scientific notation when the number will not otherwise fit in the
2414 Always use scientific notation. Not observed in the corpus.
2417 Never use scientific notation. A number that won't otherwise fit will
2418 be replaced by an error indication (see the @code{errorCharacter}
2419 attribute). Not observed in the corpus.
2423 @defvr {Optional} small
2424 Only present when the @code{scientific} attribute is
2425 @code{onlyForSmall}, this is a numeric magnitude below which the
2426 number will be formatted in scientific notation. The values @code{0}
2427 and @code{0.0001} have been observed. The value @code{0} seems like a
2428 pathological choice, since no real number has a magnitude less than 0;
2429 perhaps in practice such a choice is equivalent to setting
2430 @code{scientific} to @code{false}.
2433 @defvr {Optional} prefix
2434 @defvrx {Optional} suffix
2435 Specifies a prefix or a suffix to apply to the formatted number. Only
2436 @code{suffix} has been observed, with value @samp{%}.
2439 @subsubheading String Attributes
2441 These attributes are used for formats when @code{baseFormat} is
2444 @defvr {Attribute} tryStringsAsNumbers
2445 When this is @code{true}, it is supposed to indicate that string
2446 values should be parsed as numbers and then displayed according to
2447 numeric formatting rules. However, in the corpus it is always
2451 @node SPV Detail numberFormat Element
2452 @subsubsection The @code{numberFormat} Element
2454 Parent: @code{setFormat} @*
2455 Contents: @code{affix}@math{+}
2457 This element appears only in schema version 2.5 and earlier
2458 (@pxref{SPV Detail visualization Element}). Possibly this element
2459 could also contain @code{relabel} elements in a more diverse corpus.
2461 This element has the following attributes.
2463 @defvr {Attribute} maximumFractionDigits
2464 @defvrx {Attribute} minimumFractionDigits
2465 @defvrx {Attribute} minimumIntegerDigits
2466 @defvrx {Optional} scientific
2467 @defvrx {Optional} small
2468 @defvrx {Optional} suffix
2469 @defvrx {Optional} useGroupging
2470 The syntax and meaning of these attributes is the same as on the
2471 @code{format} element for a numeric format. @pxref{SPV Detail format
2475 @node SPV Detail stringFormat Element
2476 @subsubsection The @code{stringFormat} Element
2478 Parent: @code{setFormat} @*
2479 Contents: (@code{affix}@math{+} @math{|} @code{relabel}@math{+})?
2481 This element appears only in schema version 2.5 and earlier
2482 (@pxref{SPV Detail visualization Element}).
2484 This element has no attributes.
2486 @node SPV Detail dateTimeFormat Element
2487 @subsubsection The @code{dateTimeFormat} Element
2489 Parent: @code{setFormat} @*
2492 This element appears only in schema version 2.5 and earlier
2493 (@pxref{SPV Detail visualization Element}). Possibly this element
2494 could also contain @code{affix} and @code{relabel} elements in a more
2497 The following attribute is required.
2499 @defvr {Attribute} baseFormat
2500 Either @code{dateTime} or @code{time}.
2503 When @code{baseFormat} is @code{dateTime}, the following attributes
2506 @defvr {Attribute} dayOfMonthPadding
2507 @defvrx {Attribute} dayPadding
2508 @defvrx {Attribute} dayType
2509 @defvrx {Attribute} hourFormat
2510 @defvrx {Attribute} hourPadding
2511 @defvrx {Attribute} mdyOrder
2512 @defvrx {Attribute} minutePadding
2513 @defvrx {Attribute} monthFormat
2514 @defvrx {Attribute} separatorChars
2515 @defvrx {Attribute} showDay
2516 @defvrx {Attribute} showHour
2517 @defvrx {Attribute} showMinute
2518 @defvrx {Attribute} showMonth
2519 @defvrx {Attribute} showSecond
2520 @defvrx {Attribute} showYear
2521 @defvrx {Attribute} yearAbbreviation
2522 The syntax and meaning of these attributes is the same as on the
2523 @code{format} element when that element's @code{baseFormat} is
2524 @code{dateTime}. @pxref{SPV Detail format Element}.
2527 When @code{baseFormat} is @code{time}, the following attributes are
2530 @defvr {Attribute} hourFormat
2531 @defvrx {Attribute} hourPadding
2532 @defvrx {Attribute} minutePadding
2533 @defvrx {Attribute} monthFormat
2534 @defvrx {Attribute} separatorChars
2535 @defvrx {Attribute} showDay
2536 @defvrx {Attribute} showHour
2537 @defvrx {Attribute} showMinute
2538 @defvrx {Attribute} showMonth
2539 @defvrx {Attribute} showSecond
2540 @defvrx {Attribute} showYear
2541 @defvrx {Attribute} yearAbbreviation
2542 The syntax and meaning of these attributes is the same as on the
2543 @code{format} element when that element's @code{baseFormat} is
2544 @code{elapsedTime}. @pxref{SPV Detail format Element}.
2547 @node SPV Detail affix Element
2548 @subsubsection The @code{affix} Element
2550 Parent: @code{format} or @code{numberFormat} or @code{stringFormat} @*
2553 Possibly this element could have @code{dateTimeFormat} as a parent in
2554 a more diverse corpus.
2556 This defines a suffix (or, theoretically, a prefix) for a formatted
2557 value. It is used to insert a reference to a footnote. It has the
2558 following attributes:
2560 @defvr {Attribute} definesReference
2561 This specifies the footnote number as a natural number: 1 for the
2562 first footnote, 2 for the second, and so on.
2565 @defvr {Attribute} position
2566 Position for the footnote label. Always @code{superscript}.
2569 @defvr {Attribute} suffix
2570 Whether the affix is a suffix (@code{true}) or a prefix
2571 (@code{false}). Always @code{true}.
2574 @defvr {Attribute} value
2575 The text of the suffix or prefix. Typically a letter, e.g.@: @code{a}
2576 for footnote 1, @code{b} for footnote 2, @enddots{} The corpus
2577 contains other values: @code{*}, @code{**}, and a few that begin with
2578 at least one comma: @code{,b}, @code{,c}, @code{,,b}, and @code{,,c}.
2581 @node SPV Detail relabel Element
2582 @subsubsection The @code{relabel} Element
2584 Parent: @code{format} or @code{stringFormat} @*
2587 Possibly this element could have @code{numberFormat} or
2588 @code{dateTimeFormat} as a parent in a more diverse corpus.
2590 This specifies how to display a given value. It is used to implement
2591 value labels and to display the system-missing value in a
2592 human-readable way. It has the following attributes:
2594 @defvr {Attribute} from
2595 The value to map. In the corpus this is an integer or the
2596 system-missing value @code{-1.797693134862316E300}.
2599 @defvr {Attribute} to
2600 The string to display in place of the value of @code{from}. In the
2601 corpus this is a wide variety of value labels; the system-missing
2602 value is mapped to @samp{.}.
2605 @node SPV Detail union Element
2606 @subsubsection The @code{union} Element
2608 Parent: @code{setCellProperties} @*
2609 Contents: @code{intersect}@math{+}
2611 This element represents a set of cells, computed as the union of the
2612 sets represented by each of its children.
2614 @subsubheading The @code{intersect} Element
2616 Parent: @code{union} @*
2617 Contents: @code{where}@math{+} @math{|} @code{intersectWhere}?
2619 This element represents a set of cells, computed as the intersection
2620 of the sets represented by each of its children.
2622 Of the two possible children, in the corpus @code{where} is far more
2623 common, appearing thousands of times, whereas @code{intersectWhere}
2624 only appears 4 times.
2626 Most @code{intersect} elements have two or more children.
2628 @subsubheading The @code{where} Element
2630 Parent: @code{intersect} @*
2633 This element represents the set of cells in which the value of a
2634 specified variable falls within a specified set.
2636 @defvr {Attribute} variable
2637 The @code{id} of a variable, e.g.@: @code{dimension0categories} or
2638 @code{dimension0group0map}.
2641 @defvr {Attribute} include
2642 A value, or multiple values separated by semicolons,
2643 e.g.@: @code{0} or @code{13;14;15;16}.
2646 @subsubheading The @code{intersectWhere}
2648 Parent: @code{intersect} @*
2651 The meaning of this element is unknown.
2653 @defvr {Attribute} variable
2654 @defvrx {Attribute} variable2
2655 The meaning of these attributes is unknown. In the four examples in
2656 the corpus they always take the values @code{dimension2categories} and
2657 @code{dimension0categories}, respectively.