1 @node SPSS Viewer File Format
2 @chapter SPSS Viewer File Format
4 SPSS Viewer or @file{.spv} files, here called SPV files, are written
5 by SPSS 16 and later to represent the contents of its output editor.
6 This chapter documents the format, based on examination of a corpus of
7 about 500 files from a variety of sources. This description is
8 detailed enough to read SPV files, but probably not enough to write
11 SPSS 15 and earlier versions use a completely different output format
12 based on the Microsoft Compound Document Format. This format is not
15 An SPV file is a Zip archive that can be read with @command{zipinfo}
16 and @command{unzip} and similar programs. The final member in the Zip
17 archive is a file named @file{META-INF/MANIFEST.MF}. This structure
18 makes SPV files resemble Java ``JAR'' files (and ODF files), but
19 whereas a JAR manifest contains a sequence of colon-delimited
20 key/value pairs, an SPV manifest contains the string
21 @samp{allowPivoting=true}, without a new-line. (This string may be
22 the best way to identify an SPV file; it is invariant across the
25 The rest of the members in an SPV file's Zip archive fall into two
26 categories: @dfn{structure} and @dfn{detail} members. Structure
27 member names begin with @file{outputViewer@var{nnnnnnnnnn}}, where
28 each @var{n} is a decimal digit, and end with @file{.xml}, and often
29 include the string @file{_heading} in between. Each of these members
30 represents some kind of output item (a table, a heading, a block of
31 text, etc.) or a group of them. The member whose output goes at the
32 beginning of the document is numbered 0, the next member in the output
33 is numbered 1, and so on.
35 Structure members contain XML. This XML is sometimes self-contained,
36 but it often references detail members in the Zip archive, which are
40 @item @file{@var{prefix}_table.xml} and @file{@var{prefix}_tableData.bin}
41 @itemx @file{@var{prefix}_lightTableData.bin}
42 The structure of a table plus its data. Older SPV files pair a
43 @file{@var{prefix}_table.xml} file that describes the table's
44 structure with a binary @file{@var{prefix}_tableData.bin} file that
45 gives its data. Newer SPV files (the majority of those in the corpus)
46 instead include a single @file{@var{prefix}_lightTableData.bin} file
47 that incorporates both into a single binary format.
49 @item @file{@var{prefix}_warning.xml} and @file{@var{prefix}_warningData.bin}
50 @itemx @file{@var{prefix}_lightWarningData.bin}
51 Same format used for tables, with a different name.
53 @item @file{@var{prefix}_notes.xml} and @file{@var{prefix}_notesData.bin}
54 @itemx @file{@var{prefix}_lightNotesData.bin}
55 Same format used for tables, with a different name.
57 @item @file{@var{prefix}_chartData.bin} and @file{@var{prefix}_chart.xml}
58 The structure of a chart plus its data. Charts do not have a
61 @item @file{@var{prefix}_pmml.scf}
62 @itemx @file{@var{prefix}_stats.scf}
63 @item @file{@var{prefix}_model.xml}
64 Not yet investigated. The corpus contains few examples.
67 The @file{@var{prefix}} in the names of the detail members is
68 typically an 11-digit decimal number that increases for each item,
69 tending to skip values. Older SPV files use different naming
70 conventions. Structure member refer to detail members by name, and so
71 their exact names do not matter to readers as long as they are unique.
74 * SPV Structure Member Format::
75 * SPV Light Detail Member Format::
76 * SPV Legacy Detail Member Binary Format::
77 * SPV Legacy Detail Member XML Format::
80 @node SPV Structure Member Format
81 @section Structure Member Format
83 Structure members' XML files claim conformance with a collection of
84 XML Schemas. These schemas are distributed, under a nonfree license,
85 with SPSS binaries. Fortunately, the schemas are not necessary to
86 understand the structure members. To a degree, the schemas can even
87 be deceptive because they document elements and attributes that are
88 not in the corpus and do not document elements and attributes that are
91 Structure members use a different XML namespace for each schema, but
92 these namespaces are not entirely consistent. In some SPV files, for
93 example, the @code{viewer-tree} schema is associated with namespace
94 @indicateurl{http://xml.spss.com/spss/viewer-tree} and in others with
95 @indicateurl{http://xml.spss.com/spss/viewer/viewer-tree} (note the
96 additional @file{viewer/}). Under either name, the schema URIs are
97 not resolvable to obtain the schemas themselves.
99 One may ignore all of the above in interpreting a structure member.
100 The actual XML has a simple and straightforward form that does not
101 require a reader to take schemas or namespaces into account.
103 The elements found in structure members are documented below. For
104 each element, we note the possible parent elements and the element's
105 contents. The contents are specified as pseudo-regular expressions
106 with the following conventions:
119 Grouping multiple elements.
124 @item @var{a} @math{|} @var{b}
125 A choice between @var{a} and @var{b}.
128 Zero or more @var{x}.
132 For a diagram illustrating the hierarchy of elements within an SPV
133 structure member, please refer to a PDF version of the manual.
137 The following diagram shows the hierarchy of elements within an SPV
138 structure member. Edges point from parent to child elements.
139 Unlabeled edges indicate that the child appears exactly once; edges
140 labeled with *, zero or more times; edges labeled with ?, zero or one
142 @center @image{dev/spv-structure, 5in}
146 * SPV Structure heading Element::
147 * SPV Structure label Element::
148 * SPV Structure container Element::
149 * SPV Structure text Element (Inside @code{container})::
150 * SPV Structure html Element::
151 * SPV Structure table Element::
152 * SPV Structure tableStructure Element::
153 * SPV Structure dataPath Element::
154 * SPV Structure pageSetup Element::
155 * SPV Structure pageHeader and pageFooter Elements::
156 * SPV Structure pageParagraph Element::
157 * SPV Structure @code{text} Element (Inside @code{pageParagraph})::
160 @node SPV Structure heading Element
161 @subsection The @code{heading} Element
163 Parent: Document root or @code{heading} @*
164 Contents: @code{pageSetup}? @code{label} (@code{container} @math{|} @code{heading})*
166 The root of a structure member is a @code{heading}, which represents a
167 section of output beginning with a title (the @code{label}) and
168 ordinarily followed by content containers or further nested
169 (sub)-sections of output.
171 The document root heading, only, may also contain a @code{pageSetup}
174 The following attributes have been observed on both document root and
175 nested @code{heading} elements.
177 @defvr {Optional} creator-version
178 The version of the software that created this SPV file. A string of
179 the form @code{xxyyzzww} represents software version xx.yy.zz.ww,
180 e.g.@: @code{21000001} is version 21.0.0.1. Trailing pairs of zeros
181 are sometimes omitted, so that @code{21}, @code{210000}, and
182 @code{21000000} are all version 21.0.0.0 (and the corpus contains all
183 three of those forms).
187 The following attributes have been observed on document root
188 @code{heading} elements only:
190 @defvr {Optional} @code{creator}
191 The directory in the file system of the software that created this SPV
195 @defvr {Optional} @code{creation-date-time}
196 The date and time at which the SPV file was written, in a
197 locale-specific format, e.g.@: @code{Friday, May 16, 2014 6:47:37 PM
198 PDT} or @code{lunedì 17 marzo 2014 3.15.48 CET} or even @code{Friday,
199 December 5, 2014 5:00:19 o'clock PM EST}.
202 @defvr {Optional} @code{lockReader}
203 Whether a reader should be allowed to edit the output. The possible
204 values are @code{true} and @code{false}, but the corpus only contains
208 @defvr {Optional} @code{schemaLocation}
209 This is actually an XML Namespace attribute. A reader may ignore it.
213 The following attributes have been observed only on nested
214 @code{heading} elements:
216 @defvr {Required} @code{commandName}
217 The locale-invariant name of the command that produced the output,
218 e.g.@: @code{Frequencies}, @code{T-Test}, @code{Non Par Corr}.
221 @defvr {Optional} @code{visibility}
222 To what degree the output represented by the element is visible. The
223 only observed value is @code{collapsed}.
226 @defvr {Optional} @code{locale}
227 The locale used for output, in Windows format, which is similar to the
228 format used in Unix with the underscore replaced by a hyphen, e.g.@:
229 @code{en-US}, @code{en-GB}, @code{el-GR}, @code{sr-Cryl-RS}.
232 @defvr {Optional} @code{olang}
233 The output language, e.g.@: @code{en}, @code{it}, @code{es},
234 @code{de}, @code{pt-BR}.
237 @node SPV Structure label Element
238 @subsection The @code{label} Element
240 Parent: @code{heading} or @code{container} @*
243 Every @code{heading} and @code{container} holds a @code{label} as its
244 first child. The root @code{heading} in a structure member always
245 contains the string ``Output''. Otherwise, the text in @code{label}
246 describes what it labels, often by naming the statistical procedure
247 that was executed, e.g.@: ``Frequencies'' or ``T-Test''. Labels are
248 often very generic, especially within a @code{container}, e.g.@:
249 ``Title'' or ``Warnings'' or ``Notes''. Label text is localized
250 according to the output language, e.g.@: in Italian a frequency table
251 procedure is labeled ``Frequenze''.
253 The corpus contains one example of an empty label, one that contains
256 This element has no attributes.
258 @node SPV Structure container Element
259 @subsection The @code{container} Element
261 Parent: @code{heading} @*
262 Contents: @code{label} (@code{table} @math{|} @code{text})?
264 A @code{container} serves to label a @code{table} or a @code{text}
267 This element has the following attributes.
269 @defvr {Required} @code{visibility}
270 Either @code{visible} or @code{hidden}, this indicates whether the
271 container's content is displayed.
274 @defvr {Optional} @code{text-align}
275 Presumably indicates the alignment of text within the container. The
276 only observed value is @code{left}. Observed with nested @code{table}
277 and @code{text} elements.
280 @defvr {Optional} @code{width}
281 The width of the container in the form @code{@var{n}px}, e.g.@:
285 @node SPV Structure text Element (Inside @code{container})
286 @subsection The @code{text} Element (Inside @code{container})
288 Parent: @code{container} @*
289 Contents: @code{html}
291 This @code{text} element is nested inside a @code{container}. There
292 is a different @code{text} element that is nested inside a
293 @code{pageParagraph}.
295 This element has the following attributes.
297 @defvr {Required} @code{type}
298 One of @code{title}, @code{log}, or @code{text}.
301 @defvr {Optional} @code{commandName}
302 As on the @code{heading} element. For output not specific to a
303 command, this is simply @code{log}. The corpus contains one example
304 of where @code{commandName} is present but set to the empty string.
307 @defvr {Optional} @code{creator-version}
308 As on the @code{heading} element.
311 @node SPV Structure html Element
312 @subsection The @code{html} Element
314 Parent: @code{text} @*
317 The CDATA contains an HTML document. In some cases, the document
318 starts with @code{<html>} and ends with @code{</html}; in others the
319 @code{html} element is implied. Generally the HTML includes a
320 @code{head} element with a CSS stylesheet. The HTML body often begins
321 with @code{<BR>}. The actual content ranges from trivial to simple:
322 just discarding the CSS and tags yields readable results.
324 This element has the following attributes.
326 @defvr {Required} @code{lang}
327 This always contains @code{en} in the corpus.
330 @node SPV Structure table Element
331 @subsection The @code{table} Element
333 Parent: @code{container} @*
334 Contents: @code{tableStructure}
336 This element has the following attributes.
338 @defvr {Required} @code{commandName}
339 As on the @code{heading} element.
342 @defvr {Required} @code{type}
343 One of @code{table}, @code{note}, or @code{warning}.
346 @defvr {Required} @code{subType}
347 The locale-invariant name for the particular kind of output that this
348 table represents in the procedure. This can be the same as
349 @code{commandName} e.g.@: @code{Frequencies}, or different, e.g.@:
350 @code{Case Processing Summary}. Generic subtypes @code{Notes} and
351 @code{Warnings} are often used.
354 @defvr {Required} @code{tableId}
355 A number that uniquely identifies the table within the SPV file,
356 typically a large negative number such as @code{-4147135649387905023}.
359 @defvr {Optional} @code{creator-version}
360 As on the @code{heading} element. In the corpus, this is only present
361 for version 21 and up and always includes all 8 digits.
364 @node SPV Structure tableStructure Element
365 @subsection The @code{tableStructure} Element
367 Parent: @code{table} @*
368 Contents: @code{dataPath}
370 This element has no attributes.
372 @node SPV Structure dataPath Element
373 @subsection The @code{dataPath} Element
375 Parent: @code{tableStructure} @*
378 Contains the name of the Zip member that holds the table details,
379 e.g.@: @code{0000000001437_lightTableData.bin}.
381 This element has no attributes.
383 @node SPV Structure pageSetup Element
384 @subsection The @code{pageSetup} Element
386 Parent: @code{heading} @*
387 Contents: @code{pageHeader} @code{pageFooter}
389 This element has the following attributes.
391 @defvr {Required} @code{initial-page-number}
395 @defvr {Optional} @code{chart-size}
396 Always @code{as-is} or a localization (!) of it (e.g.@: @code{dimensione
397 attuale}, @code{Wie vorgegeben}).
400 @defvr {Optional} @code{margin-left}
401 @defvrx {Optional} @code{margin-right}
402 @defvrx {Optional} @code{margin-top}
403 @defvrx {Optional} @code{margin-bottom}
404 Margin sizes in the form @code{@var{size}in}, e.g.@: @code{0.25in}.
407 @defvr {Optional} @code{paper-height}
408 @defvrx {Optional} @code{paper-width}
409 Paper sizes in the form @code{@var{size}in}, e.g.@: @code{8.5in} by
410 @code{11in} for letter paper or @code{8.267in} by @code{11.692in} for
414 @defvr {Optional} @code{reference-orientation}
418 @defvr {Optional} @code{space-after}
422 @node SPV Structure pageHeader and pageFooter Elements
423 @subsection The @code{pageHeader} and @code{pageFooter} Elements
425 Parent: @code{pageSetup} @*
426 Contents: @code{pageParagraph}*
428 This element has no attributes.
430 @node SPV Structure pageParagraph Element
431 @subsection The @code{pageParagraph} Element
433 Parent: @code{pageHeader} or @code{pageFooter} @*
434 Contents: @code{text}
436 Text to go at the top or bottom of a page, respectively.
438 This element has no attributes.
440 @node SPV Structure @code{text} Element (Inside @code{pageParagraph})
441 @subsection The @code{text} Element (Inside @code{pageParagraph})
443 Parent: @code{pageParagraph}
446 This @code{text} element is nested inside a @code{pageParagraph}. There
447 is a different @code{text} element that is nested inside a
450 The element is either empty, or contains CDATA that holds almost-XHTML
451 text: in the corpus, either an @code{html} or @code{p} element. It is
452 @emph{almost}-XHTML because the @code{html} element designates the
454 @code{http://xml.spss.com/spss/viewer/viewer-tree} instead of an XHTML
455 namespace, and because the CDATA can contain substitution variables:
456 @code{&[Page]} for the page number and @code{&[PageTitle]} for the
459 Typical contents (indented for clarity):
462 <html xmlns="http://xml.spss.com/spss/viewer/viewer-tree">
465 <p style="text-align:right; margin-top: 0">Page &[Page]</p>
470 This element has the following attributes.
472 @defvr {Required} @code{type}
476 @node SPV Light Detail Member Format
477 @section Light Detail Member Format
479 This section describes the format of ``light'' detail @file{.bin}
480 members. These members have a binary format which we describe here in
481 terms of a context-free grammar using the following conventions:
484 @item NonTerminal @result{} @dots{}
485 Nonterminals have CamelCaps names, and @result{} indicates a
486 production. The right-hand side of a production is often broken
487 across multiple lines. Break points are chosen for aesthetics only
488 and have no semantic significance.
490 @item 00, 01, @dots{}, ff.
491 A bytes with a fixed value, written as a pair of hexadecimal digits.
493 @item i0, i1, @dots{}, i9, i10, i11, @dots{}
494 @itemx b0, b1, @dots{}, b9, b10, b11, @dots{}
495 A 32-bit integer in little-endian or big-endian byte order,
496 respectively, with a fixed value, written in decimal, prefixed by
503 A byte with value 0 or 1.
507 A 16-bit integer in little-endian or big-endian byte order,
512 A 32-bit integer in little-endian or big-endian byte order,
517 A 64-bit integer in little-endian or big-endian byte order,
521 A 64-bit IEEE floating-point number.
524 A 32-bit IEEE floating-point number.
528 A 32-bit integer, in little-endian or big-endian byte order,
529 respectively, followed by the specified number of bytes of character
530 data. (The encoding is indicated by the Formats nonterminal.)
533 @var{x} is optional, e.g.@: 00? is an optional zero byte.
535 @item @var{x}*@var{n}
536 @var{x} is repeated @var{n} times, e.g. byte*10 for ten arbitrary bytes.
538 @item @var{x}[@var{name}]
539 Gives @var{x} the specified @var{name}. Names are used in textual
540 explanations. They are also used, also bracketed, to indicate counts,
541 e.g.@: int[@t{n}] byte*[@t{n}] for a 32-bit integer followed by the
542 specified number of arbitrary bytes.
544 @item @var{a} @math{|} @var{b}
545 Either @var{a} or @var{b}.
548 Parentheses are used for grouping to make precedence clear, especially
549 in the presence of @math{|}, e.g.@: in 00 (01 @math{|} 02 @math{|} 03)
553 A 32-bit integer that indicates the number of bytes in @var{x},
554 followed by @var{x} itself.
557 In a version 1 @file{.bin} member, @var{x}; in version 3, nothing.
558 (The @file{.bin} header indicates the version.)
561 In a version 3 @file{.bin} member, @var{x}; in version 1, nothing.
564 Little-endian byte order is far more common in this format, but a few
565 pieces of the format use big-endian byte order.
567 A ``light'' detail member @file{.bin} consists of a number of sections
568 concatenated together, terminated by a byte 01:
572 LightMember @result{}
575 Fonts Borders PrintSettings TableSettings Formats
581 The following sections go into more detail.
584 * SPV Light Member Header::
585 * SPV Light Member Title::
586 * SPV Light Member Caption::
587 * SPV Light Member Footnotes::
588 * SPV Light Member Fonts::
589 * SPV Light Member Borders::
590 * SPV Light Member Print Settings::
591 * SPV Light Member Table Settings::
592 * SPV Light Member Formats::
593 * SPV Light Member Dimensions::
594 * SPV Light Member Categories::
595 * SPV Light Member Data::
596 * SPV Light Member Value::
597 * SPV Light Member ValueMod::
600 @node SPV Light Member Header
603 An SPV light member begins with a 39-byte header:
609 (i1 @math{|} i3)[@t{version}]
611 int[@t{min-column-width}] int[@t{max-column-width}]
612 int[@t{min-row-width}] int[@t{max-row-width}]
617 @code{version} is a version number that affects the interpretation of
618 some of the other data in the member. We will refer to ``version 1''
619 and ``version 3'' later on and use v1(@dots{}) and v3(@dots{}) for
620 version-specific formatting (as described previously).
622 @code{table-id} is a binary version of the @code{tableId} attribute in
623 the structure member that refers to the detail member. For example,
624 if @code{tableId} is @code{-4122591256483201023}, then @code{table-id}
625 would be 0xc6c99d183b300001.
627 @code{min-column-width} is the minimum width that a column will be
628 assigned automatically. @code{max-column-width} is the maximum width
629 that a column will be assigned to accommodate a long column label.
630 @code{min-row-width} and @code{max-row-width} are a similar range for
631 the width of row labels. All of these measurements are in 1/96 inch
634 The meaning of the other variable parts of the header is not known.
636 @node SPV Light Member Title
642 Value[@t{title1}] 01?
644 Value[@t{title2}] 01?
648 The Title, which follows the Header, specifies the pivot table's title
649 twice, as @code{title1} and @code{title2}. In the corpus, they are
652 Whereas the Value in @code{title1} and in @code{title2} are
653 appropriate for presentation, and localized to the user's language,
654 @code{c} is in English, sometimes less specific, and sometimes less
655 well formatted. For example, for a frequency table, @code{title1} and
656 @code{title2} name the variable and @code{c} is simply ``Frequencies''.
658 @node SPV Light Member Caption
663 Caption @result{} Caption1 Caption2
664 Caption1 @result{} 31 Value @math{|} 58
665 Caption2 @result{} 31 Value @math{|} 58
669 The Caption, if present, is shown below the table. Caption2 is
670 normally present. Caption1 is only rarely nonempty; it might reflect
671 user editing of the caption.
673 @node SPV Light Member Footnotes
674 @subsection Footnotes
678 Footnotes @result{} int[@t{n}] Footnote*[@t{n}]
679 Footnote @result{} Value[@t{text}] (58 @math{|} 31 Value[@t{marker}]) byte*4
683 Each footnote has @code{text} and an optional customer @code{marker}
686 @node SPV Light Member Fonts
691 Fonts @result{} 00 Font*8
694 string[@t{typeface}] float[@t{size}] int[@t{style}] bool[@t{underline}]
695 int[@t{halign}] int[@t{valign}]
696 string[@t{fgcolor}] string[@t{bgcolor}]
697 byte[@t{alternate}] string[@t{altfg}] string[@t{altbg}]
698 v3(int[@t{left-margin}] int[@t{right-margin}] int[@t{top-margin}] int[@t{bottom-margin}])
702 Each Font represents the font style for a different element, in the
703 following order: title, caption, footer, corner, column
704 labels, row labels, data, and layers.
706 @code{index} is the 1-based index of the Font, i.e. 1 for the first
707 Font, through 8 for the final Font.
709 @code{typeface} is the string name of the font. In the corpus, this
710 is @code{SansSerif} in over 99% of instances and @code{Times New
713 @code{size} is the size of the font, in points. The most common size
714 in the corpus is 12 points.
716 @code{style} is a bit mask. Bit 0 (with value 1) is set for bold, bit
717 1 (with value 2) is set for italic.
719 @code{underline} is 1 if the font is underlined, 0 otherwise.
721 @code{halign} specifies horizontal alignment: 0 for center, 2 for
722 left, 4 for right, 61453 for decimal, 64173 for mixed. Mixed
723 alignment varies according to type: string data is left-justified,
724 numbers and most other formats are right-justified.
726 @code{valign} specifies vertical alignment: 0 for center, 1 for top, 3
729 @code{fgcolor} and @code{bgcolor} are the foreground color and
730 background color, respectively. In the corpus, these are always
731 @code{#000000} and @code{#ffffff}, respectively.
733 @code{alternate} is 01 if rows should alternate colors, 00 if all rows
734 should be the same color. When @code{alternate} is 01, @code{altfg}
735 and @code{altbg} specify the colors for the alternate rows.
737 @code{left-margin}, @code{right-margin}, @code{top-margin}, and
738 @code{bottom-margin} are measured in multiples of 1/96 inch.
740 @node SPV Light Member Borders
747 be32[@t{n-borders}] Border*[@t{n-borders}]
748 bool[@t{show-grid-lines}]
752 be32[@t{border-type}]
753 be32[@t{stroke-type}]
758 The Borders reflect how borders between regions are drawn.
760 The fixed value of @code{endian} can be used to validate the
763 @code{show-grid-lines} is 1 to draw grid lines, otherwise 0.
765 Each Border describes one kind of border. @code{n-borders} seems to
766 always be 19. Each @code{border-type} appears once (although in an
767 unpredictable order) and correspond to the following borders:
773 Left, top, right, and bottom outer frame.
775 Left, top, right, and bottom inner frame.
777 Left and top of data area.
779 Horizontal and vertical dimension rows.
781 Horizontal and vertical dimension columns.
783 Horizontal and vertical category rows.
785 Horizontal and vertical category columns.
788 @code{stroke-type} describes how a border is drawn, as one of:
805 @code{color} is an RGB color. Bits 24--31 are alpha, bits 16--23 are
806 red, 8--15 are green, 0--7 are blue. An alpha of 255 indicates an
807 opaque color, therefore opaque black is 0xff000000.
809 @node SPV Light Member Print Settings
810 @subsection Print Settings
814 PrintSettings @result{}
817 bool[@t{paginate-layers}]
820 bool[@t{top-continuation}]
821 bool[@t{bottom-continuation}]
822 be32[@t{n-orphan-lines}]
823 bestring[@t{continuation-string}]
827 The PrintSettings reflect settings for printing. The fixed value of
828 @code{endian} can be used to validate the endianness.
830 @code{all-layers} is 1 to print all layers, 0 to print only the
833 @code{paginate-layers} is 1 to print each layer at the start of a new
834 page, 0 otherwise. (This setting is honored only @code{all-layers} is
835 1, since otherwise only one layer is printed.)
837 @code{fit-width} and @code{fit-length} control whether the table is
838 shrunk to fit within a page's width or length, respectively.
840 @code{n-orphan-lines} is the minimum number of rows or columns to put
841 in one part of a table that is broken across pages.
843 If @code{top-continuation} is 1, then @code{continuation-string} is
844 printed at the top of a page when a table is broken across pages for
845 printing; similarly for @code{bottom-continuation} and the bottom of a
846 page. Usually, @code{continuation-string} is empty.
848 @node SPV Light Member Table Settings
849 @subsection Table Settings
853 TableSettings @result{}
856 be32[@t{current-layer}]
858 bool[@t{show-row-labels-in-corner}]
859 bool[@t{show-alphabetic-markers}]
860 bool[@t{footnote-marker-position}]
863 be32[@t{n}] byte*[@t{n}]
865 bestring[@t{table-look}]
871 The TableSettings reflect display settings. The fixed value of
872 @code{endian} can be used to validate the endianness.
874 @code{current-layer} is the displayed layer.
876 If @code{omit-empty} is 1, empty rows or columns (ones with nothing in
877 any cell) are hidden; otherwise, they are shown.
879 If @code{show-row-labels-in-corner} is 1, then row labels are shown in
880 the upper left corner; otherwise, they are shown nested.
882 If @code{show-alphabetic-markers} is 1, markers are shown as letters
883 (e.g. @samp{a}, @samp{b}, @samp{c}, @dots{}); otherwise, they are
884 shown as numbers starting from 1.
886 When @code{footnote-marker-position} is 1, footnote markers are shown
887 as superscripts, otherwise as subscripts.
889 @code{notes} is a text string that contains user-specified notes. It
890 is displayed when the user hovers the cursor over the table, like
891 ``alt text'' on a webpage. It is not printed. It is usually empty.
893 @code{table-look} is the name of a SPSS ``TableLook'' table style,
894 such as ``Default'' or ``Academic''; it is often empty.
896 TableSettings ends with an arbitrary number of null bytes.
898 @node SPV Light Member Formats
904 int[@t{nwidths}] int*[@t{nwidths}]
906 int (00 @math{|} 01) 00 (00 @math{|} 01)
908 byte[@t{decimal}] byte[@t{grouping}]
911 v3(count(count(X5) count(X6)))
913 CustomCurrency @result{} int[@t{n-ccs}] string*[@t{n-ccs}]
915 X5 @result{} byte*33 int[@t{n}] int*[@t{n}]
917 01 00 (03 @math{|} 04) 00 00 00
918 string[@t{command}] string[@t{subcommand}]
919 string[@t{language}] string[@t{charset}] string[@t{locale}]
920 (00 @math{|} 01) 00 bool bool
922 byte[@t{decimal}] byte[@t{grouping}]
924 (string[@t{dataset}] string[@t{datafile}] i0 int[@t{date}] i0)?
926 byte[@t{missing}] bool (i2000000 i0)?
930 If @code{nwidths} is nonzero, then the accompanying integers are
931 column widths as manually adjusted by the user. (Row heights are
932 computed automatically based on the widths.)
934 @code{encoding} is a character encoding, usually a Windows code page
935 such as @code{en_US.windows-1252} or @code{it_IT.windows-1252}. The
936 rest of the character strings in the member use this encoding. The
937 encoding string is itself encoded in US-ASCII.
939 @code{epoch} is the year that starts the epoch. A 2-digit year is
940 interpreted as belonging to the 100 years beginning at the epoch. The
941 default epoch year is 69 years prior to the current year; thus, in
942 2017 this field by default contains 1948. In the corpus, @code{epoch}
943 ranges from 1943 to 1948, plus some contain -1.
945 @code{decimal} is the decimal point character. The observed values
946 are @samp{.} and @samp{,}.
948 @code{grouping} is the grouping character. Usually, it is @samp{,} if
949 @code{decimal} is @samp{.}, and vice versa. Other observed values are
950 @samp{'} (apostrophe), @samp{ } (space), and zero (presumably
951 indicating that digits should not be grouped).
953 @code{dataset} is the name of the dataset analyzed to produce the
954 output, e.g.@: @code{DataSet1}, and @code{datafile} the name of the
955 file it was read from, e.g.@: @file{C:\Users\foo\bar.sav}. The latter
956 is sometimes the empty string.
958 @code{date} is a date, as seconds since the epoch, i.e.@: since
959 January 1, 1970. Pivot tables within an SPV files often have dates a
960 few minutes apart, so this is probably a creation date for the tables
961 rather than for the file.
963 Sometimes @code{dataset}, @code{datafile}, and @code{date} are present
964 and other times they are absent. The reader can distinguish by
965 assuming that they are present and then checking whether the
966 presumptive @code{dataset} contains a null byte (a valid string never
969 @code{n-ccs} is observed as either 0 or 5. When it is 5, the
970 following strings are CCA through CCE format strings. @xref{Custom
971 Currency Formats,,, pspp, PSPP}. Most commonly these are all
972 @code{-,,,} but other strings occur.
974 @node SPV Light Member Dimensions
975 @subsection Dimensions
977 A pivot table presents multidimensional data. A Dimension identifies
978 the categories associated with each dimension.
982 Dimensions @result{} int[@t{n-dims}] Dimension*[@t{n-dims}]
983 Dimension @result{} Value[@t{name}] DimUnknown int[@t{n-categories}] Category*[@t{n-categories}]
986 (00 @math{|} 01 @math{|} 02)[@t{d2}]
987 (i0 @math{|} i2)[@t{d3}]
988 (00 @math{|} 01)[@t{d4}]
989 (00 @math{|} 01)[@t{d5}]
995 @code{name} is the name of the dimension, e.g. @code{Variables},
996 @code{Statistics}, or a variable name.
998 @code{d1} is usually 0 but many other values have been observed.
1000 @code{d3} is 2 over 99% of the time.
1002 @code{d5} is 0 over 99% of the time.
1004 @code{d6} is either -1 or the 0-based index of the dimension, e.g.@: 0
1005 for the first dimension, 1 for the second, and so on. The latter is
1006 the case 98% of the time in the corpus.
1008 @node SPV Light Member Categories
1009 @subsection Categories
1011 Categories are arranged in a tree. Only the leaf nodes in the tree
1012 are really categories; the others just serve as grouping constructs.
1016 Category @result{} Value[@t{name}] (Leaf @math{|} Group)
1017 Leaf @result{} 00 00 00 i2 int[@t{index}] i0
1019 (00 @math{|} 01)[@t{merge}] 00 01 (i0 @math{|} i2)[@t{data}]
1020 i-1 int[@t{n-subcategories}] Category*[@t{n-subcategories}]
1024 @code{name} is the name of the category (or group).
1026 A Leaf represents a leaf category. The Leaf's @code{index} is a
1027 nonnegative integer less than @code{n-categories} in the Dimension in
1028 which the Category is nested (directly or indirectly).
1030 A Group represents a Group of nested categories. Usually a Group
1031 contains at least one Category, so that @code{n-subcategories} is
1032 positive, but a few Groups with @code{n-subcategories} 0 has been
1035 If a Group's @code{merge} is 00, the most common value, then the group
1036 is really a distinct group that should be represented as such in the
1037 visual representation and user interface. If @code{merge} is 01, the
1038 categories in this group should be shown and treated as if they were
1039 direct children of the group's containing group (or if it has no
1040 parent group, then direct children of the dimension), and this group's
1041 name is irrelevant and should not be displayed. (Merged groups can be
1044 A Group's @code{data} appears to be i2 when all of the categories
1045 within a group are leaf categories that directly represent data values
1046 for a variable (e.g. in a frequency table or crosstabulation, a group
1047 of values in a variable being tabulated) and i0 otherwise.
1049 @node SPV Light Member Data
1052 The final part of an SPV light member contains the actual data.
1057 int[@t{layers}] int[@t{rows}] int[@t{columns}] int*[@t{n-dimensions}]
1058 int[@t{n-data}] Datum*[@t{n-data}]
1059 Datum @result{} int64[@t{index}] v3(00?) Value
1063 The values of @code{layers}, @code{rows}, and @code{columns} each
1064 specifies the number of dimensions displayed in layers, rows, and
1065 columns, respectively. Any of them may be zero. Their values sum to
1066 @code{n-dimensions} from Dimensions (@pxref{SPV Light Member
1069 The @code{n-dimensions} integers are a permutation of the 0-based
1070 dimension numbers. The first @code{layers} integers specify each of
1071 the dimensions represented by layers, the next @code{rows} integers
1072 specify the dimensions represented by rows, and the final
1073 @code{columns} integers specify the dimensions represented by columns.
1074 When there is more than one dimension of a given kind, the inner
1075 dimensions are given first.
1077 The format of a Datum varies slightly from version 1 to version 3: in
1078 version 1 it allows for an extra optional 00 byte.
1080 A Datum consists of an @code{index} and a Value. Suppose there are
1081 @math{d} dimensions and dimension @math{i}, @math{0 \le i < d}, has
1082 @math{n_i} categories. Consider the datum at coordinates @math{x_i},
1083 @math{0 \le i < d}, and note that @math{0 \le x_i < n_i}. Then the
1084 index is calculated by the following algorithm:
1088 for each @math{i} from 0 to @math{d - 1}:
1089 @i{index} = (@math{n_i \times} @i{index}) @math{+} @math{x_i}
1092 For example, suppose there are 3 dimensions with 3, 4, and 5
1093 categories, respectively. The datum at coordinates (1, 2, 3) has
1094 index @math{5 \times (4 \times (3 \times 0 + 1) + 2) + 3 = 33}.
1096 @node SPV Light Member Value
1099 Value is used throughout the SPV light member format. It boils down
1100 to a number or a string.
1104 Value @result{} 00? 00? 00? 00? RawValue
1106 01 ValueMod int[@t{format}] double[@t{x}]
1107 @math{|} 02 ValueMod int[@t{format}] double[@t{x}]
1108 string[@t{varname}] string[@t{vallab}] (01 @math{|} 02 @math{|} 03)
1109 @math{|} 03 string[@t{local}] ValueMod string[@t{id}] string[@t{c}] (00 @math{|} 01)[@t{type}]
1110 @math{|} 04 ValueMod int[@t{format}] string[@t{vallab}] string[@t{varname}]
1111 (01 @math{|} 02 @math{|} 03) string[@t{s}]
1112 @math{|} 05 ValueMod string[@t{varname}] string[@t{varlabel}] (01 @math{|} 02 @math{|} 03)
1113 @math{|} ValueMod string[@t{format}] int[@t{n-args}] Argument*[@t{n-args}]
1116 @math{|} int[@t{x}] i0 Value*[@t{x}@math{+}1] /* @t{x} @math{>} 0 */
1120 There are several possible encodings, which one can distinguish by the
1121 first nonzero byte in the encoding.
1125 The numeric value @code{x}, intended to be presented to the user
1126 formatted according to @code{format}, which is in the format described
1127 for system files. @xref{System File Output Formats}, for details.
1128 Most commonly, @code{format} has width 40 (the maximum).
1130 An @code{x} with the maximum negative double value @code{-DBL_MAX}
1131 represents the system-missing value SYSMIS. (HIGHEST and LOWEST have
1132 not been observed.) @xref{System File Format}, for more about these
1136 Similar to @code{01}, with the additional information that @code{x} is
1137 a value of variable @code{varname} and has value label @code{vallab}.
1138 Both @code{varname} and @code{vallab} can be the empty string, the
1139 latter very commonly.
1141 The meaning of the final byte is unknown. Possibly it is connected to
1142 whether the value or the label should be displayed.
1145 A text string, in two forms: @code{c} is in English, and sometimes
1146 abbreviated or obscure, and @code{local} is localized to the user's
1147 locale. In an English-language locale, the two strings are often the
1148 same, and in the cases where they differ, @code{local} is more
1149 appropriate for a user interface, e.g.@: @code{c} of ``Not a PxP table
1150 for MCN...'' versus @code{local} of ``Computed only for a PxP table,
1151 where P must be greater than 1.''
1153 @code{c} and @code{local} are always either both empty or both
1156 @code{id} is a brief identifying string whose form seems to resemble a
1157 programming language identifier, e.g.@: @code{cumulative_percent} or
1158 @code{factor_14}. It is not unique.
1160 @code{type} is 00 for text taken from user input, such as syntax
1161 fragment, expressions, file names, data set names, and 01 for fixed
1162 text strings such as names of procedures or statistics. In the former
1163 case, @code{id} is always the empty string; in the latter case,
1164 @code{id} is still sometimes empty.
1167 The string value @code{s}, intended to be presented to the user
1168 formatted according to @code{format}. The format for a string is not
1169 too interesting, and the corpus contains many clearly invalid formats
1170 like A16.39 or A255.127 or A134.1, so readers should probably ignore
1171 the format entirely.
1173 @code{s} is a value of variable @code{varname} and has value label
1174 @code{vallab}. @code{varname} is never empty but @code{vallab} is
1177 The meaning of the final byte is unknown.
1180 Variable @code{varname}, which is rarely observed as empty in the
1181 corpus, with variable label @code{varlabel}, which is often empty.
1183 The meaning of the final byte is unknown.
1186 (These bytes begin a ValueMod.) A format string, analogous to
1187 @code{printf}, followed by one or more Arguments, each of which has
1188 one or more values. The format string uses the following syntax:
1195 Each of these expands to the character following @samp{\\}, to escape
1196 characters that have special meaning in format strings. These are
1197 effective inside and outside the @code{[@dots{}]} syntax forms
1201 Expands to a new-line, inside or outside the @code{[@dots{}]} forms
1205 Expands to a formatted version of argument @var{i}, which must have
1206 only a single value. For example, @code{^1} expands to the first
1207 argument's @code{value}.
1209 @item [:@var{a}:]@var{i}
1210 Expands @var{a} for each of the values in @var{i}. @var{a}
1211 should contain one or more @code{^@var{j}} conversions, which are
1212 drawn from the values for argument @var{i} in order. Some examples
1217 All of the values for the first argument, concatenated.
1220 Expands to the values for the first argument, each followed by
1224 Expands to @code{@var{x} = @var{y}} where @var{x} is the second
1225 argument's first value and @var{y} is its second value. (This would
1226 be used only if the argument has two values. If there were more
1227 values, the second and third values would be directly concatenated,
1228 which would look funny.)
1231 @item [@var{a}:@var{b}:]@var{i}
1232 This extends the previous form so that the first values are expanded
1233 using @var{a} and later values are expanded using @var{b}. For an
1234 unknown reason, within @var{a} the @code{^@var{j}} conversions are
1235 instead written as @code{%@var{j}}. Some examples from the corpus:
1239 Expands to all of the values for the first argument, separated by
1242 @item [%1 = %2:, ^1 = ^2:]1
1243 Given appropriate values for the first argument, expands to @code{X =
1247 Given appropriate values, expands to @code{1, 2, 3}.
1251 The format string is localized to the user's locale.
1254 @node SPV Light Member ValueMod
1255 @subsection ValueMod
1257 A ValueMod can specify special modifications to a Value.
1262 31 i0 (i0 @math{|} i1 string[@t{subscript}])
1263 v1(00 (i1 @math{|} i2) 00 00 int 00 00)
1264 v3(count(FormatString Style ValueModUnknown))
1265 @math{|} 31 int[@t{n-refs}] int16*[@t{n-refs}] Format
1267 Style @result{} 58 @math{|} 31 01? 00? 00? 00? 01 string[@t{fgcolor}] string[@t{bgcolor}] string[@t{typeface}] byte[@t{size}]
1268 Format @result{} 00 00 count(FormatString Style 58)
1269 FormatString @result{} count((i0 (58 @math{|} 31 string))?)
1270 ValueModUnknown @result{} 58 @math{|} 31 i0 i0 i0 i0 01 00 (01 @math{|} 02 @math{|} 08) 00 08 00 0a 00)
1274 A ValueMod that begins with ``31 i0'' specifies a string to append to
1275 the main text of the Value, as a subscript. The subscript text is a
1276 brief indicator, e.g.@: @samp{a} or @samp{a,b}, with its meaning
1277 indicated by the table caption. In this usage, subscripts are similar
1278 to footnotes. One apparent difference is that a Value can only
1279 reference one footnote but a subscript can list more than one letter.
1281 A ValueMod that begins with 31 followed by a nonzero ``int'' specifies
1282 a footnote or footnotes that the Value references. Footnote markers
1283 are shown appended to the main text of the Value, as superscripts.
1285 The Format, if present, is a format string for substitutions using the
1286 syntax explained previously. It appears to be an English-language
1287 version of the localized format string in the Value in which the
1290 The Style, if present, changes the style for this individual Value.
1291 The @code{size} is a font size in units of 1/96 inch.
1293 @node SPV Legacy Detail Member Binary Format
1294 @section Legacy Detail Member Binary Format
1296 Whereas the light binary format represents everything about a given
1297 pivot table, the legacy binary format conceptually consists of a
1298 number of named sources, each of which consists of a number of named
1299 variables, each of which is a 1-dimensional array of numbers or
1300 strings or a mix. Thus, the legacy binary member format is quite
1303 This section uses the same context-free grammar notation as in the
1304 previous section, with the following additions:
1308 In a version 0xaf legacy member, @var{x}; in other versions, nothing.
1309 (The legacy member header indicates the version; see below.)
1312 In a version 0xb0 legacy member, @var{x}; in other versions, nothing.
1315 A legacy detail member @file{.bin} has the following overall format:
1319 LegacyBinary @result{}
1320 00 byte[@t{version}] int16[@t{n-sources}] int[@t{member-size}]
1321 Metadata*[@t{n-sources}] Data*[@t{n-sources}]
1325 @code{version} is a version number that affects the interpretation of
1326 some of the other data in the member. Versions 0xaf and 0xb0 are
1327 known. We will refer to ``version 0xaf'' and ``version 0xb0'' members
1330 A legacy member consists of @code{n-sources} data sources, each of
1331 which has Metadata and Data.
1333 @code{member-size} is the size of the legacy binary member, in bytes.
1335 The following sections go into more detail.
1338 * SPV Legacy Member Metadata::
1339 * SPV Legacy Member Data::
1342 @node SPV Legacy Member Metadata
1343 @subsection Metadata
1348 int[@t{n-data}] int[@t{n-variables}] int[@t{offset}]
1349 vAF(byte*32[@t{source-name}])
1350 vB0(byte*64[@t{source-name}] int[@t{x}])
1354 A data source has @code{n-variables} variables, each with
1355 @code{n-data} data values.
1357 @code{source-name} is a 32- or 64-byte string padded on the right with
1358 zero bytes. The names that appear in the corpus are very generic:
1359 usually @code{tableData} for pivot table data or @code{source0} for
1362 A given Metadata's @code{offset} is the offset, in bytes, from the
1363 beginning of the member to the start of the corresponding Data. This
1364 allows programs to skip to the beginning of the data for a particular
1365 source; it is also important to determine whether a source includes
1366 any string data (@pxref{SPV Legacy Member Data}).
1368 The meaning of @code{x} in version 0xb0 is unknown.
1370 @node SPV Legacy Member Data
1375 Data @result{} NumericData*[@t{n-variables}] StringData?
1376 NumericData @result{} byte*288[@t{variable-name}] double*[@t{n-data}]
1380 Data follow the Metadata in the legacy binary format, with sources in
1381 the same order. Each NumericSeries begins with a @code{variable-name}
1382 that generally indicates its role in the pivot table, e.g.@: ``cell'',
1383 ``cellFormat'', ``dimension0categories'', ``dimension0group0'',
1384 followed by the numeric data, one double per datum. A double with the
1385 maximum negative double @code{-DBL_MAX} represents the system-missing
1390 StringData @result{} i1 string[@t{source-name}] Pairs Labels
1392 Pairs @result{} int[@t{n-string-vars}] PairSeries*[@t{n-string-vars}]
1393 PairVar @result{} string[@t{pair-var-name}] int[@t{n-pairs}] Pair*[@t{n-pairs}]
1394 Pair @result{} int[@t{i}] int[@t{j}]
1396 Labels @result{} int[@t{n-labels}] Label*[@t{n-labels}]
1397 Label @result{} int[@t{frequency}] int[@t{s}]
1401 A source may include a mix of numeric and string data values. When a
1402 source includes any string data, the data values that are strings are
1403 set to SYSMIS in the NumericData, and StringData follows the
1404 NumericData. A source that contains no string data omits the
1405 StringData. To reliably determine whether a source includes
1406 StringData, the reader should check whether the offset following the
1407 NumericData is the offset of the next source, as indicated by its
1408 Metadata (or the end of the member, in the case of the last source).
1410 StringData repeats the name of the source (from Metadata).
1412 The string data overlays the numeric data. @code{n-string-vars} is
1413 the number of variables in the source that include string data. More
1414 precisely, it is the 1-based index of the last variable in the source
1415 that includes any string data; thus, it would be 4 if there are 5
1416 variables and only the fourth one includes string data.
1418 Each PairVar consists a sequence of 0 or more Pair nonterminals, each
1419 of which maps from a 0-based index within variable @code{i} to a
1420 0-based label index @code{j}, e.g.@: pair @code{i} = 2, @code{j} = 3,
1421 means that the third data value (with value SYSMIS) is to be replaced
1422 by the string of the fourth Label.
1424 The labels themselves follow the pairs. The valuable part of each
1425 label is the string @code{s}. Each label also includes a
1426 @code{frequency} that reports the number of pairs that reference it
1427 (although this is not useful).
1429 @node SPV Legacy Detail Member XML Format
1430 @section Legacy Detail Member XML Format
1432 This format is still under investigation.
1434 The design of the detail XML format is not what one would end up with
1435 for describing pivot tables. This is because it is a special case
1436 of a much more general format (``visualization XML'' or ``VizML'')
1437 that can describe a wide range of visualizations. Most of this
1438 generality is overkill for tables, and so we end up with a funny
1439 subset of a general-purpose format.
1441 The important elements of the detail XML format are:
1445 Variables. Variables in detail XML roughly correspond to the
1446 dimensions in a light detail member. There is one variable for each
1447 dimension, plus one variable for each level of labeling along an axis.
1449 The bulk of variables are defined with @code{sourceVariable} elements.
1450 The data for these variables comes from the associated
1451 @code{tableData.bin} member. Some variables are defined, with
1452 @code{derivedVariable} elements, as a constant or in terms of a
1453 mapping function from a source variable.
1456 Assignment of variables to axes. A variable can appear as columns, or
1457 rows, or layers. The @code{faceting} element and its sub-elements
1458 describe this assignment.
1461 All elements have an optional @code{id} attribute. In practice many
1462 elements are assigned @code{id} attributes that are never referenced.
1465 * SPV Detail visualization Element::
1466 * SPV Detail userSource Element::
1467 * SPV Detail sourceVariable Element::
1468 * SPV Detail derivedVariable Element::
1469 * SPV Detail extension Element::
1470 * SPV Detail graph Element::
1471 * SPV Detail location Element::
1472 * SPV Detail coordinates Element::
1473 * SPV Detail faceting Element::
1474 * SPV Detail facetLayout Element::
1477 @node SPV Detail visualization Element
1478 @subsection The @code{visualization} Element
1481 Parent: Document root
1485 (sourceVariable @math{|} derivedVariable)@math{+}
1493 This element has the following attributes.
1495 @defvr {Required} creator
1496 The version of the software that created this SPV file, as a string of
1497 the form @code{xxyyzz}, which represents software version xx.yy.zz,
1498 e.g.@: @code{160001} is version 16.0.1. The corpus includes major
1499 versions 16 through 19.
1502 @defvr {Required} date
1503 The date on the which the file was created, as a string of the form
1507 @defvr {Required} lang
1508 The locale used for output, in Windows format, which is similar to the
1509 format used in Unix with the underscore replaced by a hyphen, e.g.@:
1510 @code{en-US}, @code{en-GB}, @code{el-GR}, @code{sr-Cryl-RS}.
1513 @defvr {Required} name
1514 The title of the pivot table, localized to the output language.
1517 @defvr {Required} style
1518 The @code{id} of a @code{style} element (@pxref{SPV Detail style
1519 element}). This is the base style for the entire pivot table. In
1520 every example in the corpus, the value is @code{visualizationStyle}
1521 and the corresponding @code{style} element has no attributes other
1525 @defvr {Required} type
1526 A floating-point number. The meaning is unknown.
1529 @defvr {Required} version
1530 The visualization schema version number. In the corpus, the value is
1531 one of 2.4, 2.5, 2.7, and 2.8.
1534 @node SPV Detail userSource Element
1535 @subsection The @code{userSource} Element
1537 Parent: @code{visualization} @*
1540 This element has the following attributes.
1542 @defvr {Optional} missing
1543 Always @code{listwise}.
1546 @node SPV Detail sourceVariable Element
1547 @subsection The @code{sourceVariable} Element
1549 Parent: @code{visualization} @*
1550 Contents: @code{extension}* (@code{format} @math{|} @code{stringFormat})?
1552 This element defines a variable whose values can be used elsewhere in
1553 the visualization. It ties this element's @code{id} to a variable
1554 from the @file{tableData.bin} member that corresponds to this
1557 This element has the following attributes.
1559 @defvr {Required} categorical
1560 Always set to @code{true}.
1563 @defvr {Required} source
1564 Always set to @code{tableData}, the @code{source-name} in the
1565 corresponding @file{tableData.bin} member (@pxref{SPV Legacy Member
1569 @defvr {Required} sourceName
1570 The name of a variable within the source, the @code{variable-name} in
1571 the corresponding @file{tableData.bin} member (@pxref{SPV Legacy
1575 @defvr {Optional} dependsOn
1576 The @code{variable-name} of a variable linked to this one, so that a
1577 viewer can work with them together. For a group variable, this is the
1578 name of the corresponding categorical variable.
1581 @defvr {Optional} label
1582 The variable label, if any
1585 @defvr {Optional} labelVariable
1586 The @code{variable-name} of a variable whose string values correspond
1587 one-to-one with the values of this variable and are suitable for use
1591 @node SPV Detail derivedVariable Element
1592 @subsection The @code{derivedVariable} Element
1594 Parent: @code{visualization} @*
1595 Contents: @code{extension}* (@code{format} @math{|} @code{stringFormat} @code{valueMapEntry}*)
1597 Like @code{sourceVariable}, this element defines a variable whose
1598 values can be used elsewhere in the visualization. Instead of being
1599 read from a data source, the variable's data are defined by a
1600 mathematical expression.
1602 This element has the following attributes.
1604 @defvr {Required} categorical
1605 Always set to @code{true}.
1608 @defvr {Required} value
1609 An expression that defines the variable's value. In theory this could
1610 be an arbitrary expression in terms of constants, functions, and other
1611 variables, e.g.@: @math{(@var{var1} + @var{var2}) / 2}. In practice,
1612 the corpus contains only the following forms of expressions:
1615 @item constant(@var{number})
1616 @itemx constant(@var{variable})
1617 A constant. The meaning when a variable is named is unknown.
1618 Sometimes the ``variable name'' has spaces in it.
1620 @item map(@var{variable})
1621 Transforms the values in the named @var{variable} using the
1622 @code{valueMapEntry}s contained within the element.
1626 @defvr {Optional} dependsOn
1627 The @code{variable-name} of a variable linked to this one, so that a
1628 viewer can work with them together. For a group variable, this is the
1629 name of the corresponding categorical variable.
1633 * SPV Detail valueMapEntry Element::
1636 @node SPV Detail valueMapEntry Element
1637 @subsubsection The @code{valueMapEntry} Element
1639 Parent: @code{derivedVariable} @*
1642 A @code{valueMapEntry} element defines a mapping from one or more
1643 values of a source expression to a target value. (In the corpus, the
1644 source expression is always just the name of a variable.) Each target
1645 value requires a separate @code{valueMapEntry}. If multiple source
1646 values map to the same target value, they can be combined or separate.
1648 @code{valueMapEntry} has the following attributes.
1650 @defvr {Required} from
1651 A source value, or multiple source values separated by semicolons,
1652 e.g.@: @code{0} or @code{13;14;15;16}.
1655 @defvr {Required} to
1659 @node SPV Detail extension Element
1660 @subsection The @code{extension} Element
1662 This is a general-purpose ``extension'' element. Readers that don't
1663 understand a given extension should be able to safely ignore it. The
1664 attributes on this element, and their meanings, vary based on the
1665 context. Each known usage is described separately below. The current
1666 extensions use attributes exclusively, without any nested elements.
1668 @subsubheading @code{visualization} Parent Element
1670 With @code{visualization} as its parent element, @code{extension} has
1671 the following attributes.
1673 @defvr {Optional} numRows
1674 An integer that presumably defines the number of rows in the displayed
1678 @defvr {Optional} showGridline
1679 Always set to @code{false} in the corpus.
1682 @defvr {Optional} minWidthSet
1683 @defvrx {Optional} maxWidthSet
1684 Always set to @code{true} in the corpus.
1687 @subsubheading @code{container} Parent Element
1689 With @code{container} as its parent element, @code{extension} has the
1690 following attributes.
1692 @defvr {Required} combinedFootnotes
1693 Always set to @code{true} in the corpus.
1696 @subsubheading @code{sourceVariable} and @code{derivedVariable} Parent Element
1698 With @code{sourceVariable} or @code{derivedVariable} as its parent
1699 element, @code{extension} has the following attributes. A given
1700 parent element often contains several @code{extension} elements that
1701 specify the meaning of the source data's variables or sources, e.g.@:
1704 <extension from="0" helpId="corrected_model"/>
1705 <extension from="3" helpId="error"/>
1706 <extension from="4" helpId="total_9"/>
1707 <extension from="5" helpId="corrected_total"/>
1710 @defvr {Required} from
1711 An integer or a name like ``dimension0''.
1714 @defvr {Required} helpId
1718 @node SPV Detail graph Element
1719 @subsection The @code{graph} Element
1721 Parent: @code{visualization} @*
1722 Contents: @code{location}@math{+} @code{coordinates} @code{faceting} @code{facetLayout} @code{interval}
1724 @code{graph} has the following attributes.
1726 @defvr {Required} cellStyle
1727 @defvrx {Required} style
1728 Each of these is the @code{id} of a @code{style} element (@pxref{SPV
1729 Detail style element}). The former is the default style for
1730 individual cells, the latter for the entire table.
1733 @node SPV Detail location Element
1734 @subsection The @code{location} Element
1736 Parent: @code{graph} @*
1739 Each instance of this element specifies where some part of the table
1740 frame is located. All the examples in the corpus have four instances
1741 of this element, one for each of the parts @code{height},
1742 @code{width}, @code{left}, and @code{top}. Some examples in the
1743 corpus add a fifth for part @code{bottom}, even though it is not clear
1744 how all of @code{top}, @code{bottom}, and @code{heigth} can be honored
1745 at the same time. In any case, @code{location} seems to have little
1746 importance in representing tables; a reader can safely ignore it.
1748 @defvr {Required} part
1749 One of @code{height}, @code{width}, @code{top}, @code{bottom}, or
1750 @code{left}. Presumably @code{right} is acceptable as well but the
1751 corpus contains no examples.
1754 @defvr {Required} method
1755 How the location is determined:
1759 Based on the natural size of the table. Observed only for
1760 parts @code{height} and @code{width}.
1763 Based on the location specified in @code{target}. Observed only for
1764 parts @code{top} and @code{bottom}.
1767 Using the value in @code{value}. Observed only for parts @code{top},
1768 @code{bottom}, and @code{left}.
1771 Same as the specified @code{target}. Observed only for part
1776 @defvr {Optional} min
1777 Minimum size. Only observed with value @code{100pt}. Only observed
1778 for part @code{width}.
1781 @defvr {Dependent} target
1782 Required when @code{method} is @code{attach} or @code{same}, not
1783 observed otherwise. This is the ID of an element to attach to.
1784 Observed with the ID of @code{title}, @code{footnote}, @code{graph},
1788 @defvr {Dependent} value
1789 Required when @code{method} is @code{fixed}, not observed otherwise.
1790 Observed values are @code{0%}, @code{0px}, @code{1px}, and @code{3px}
1791 on parts @code{top} and @code{left}, and @code{100%} on part
1795 @node SPV Detail coordinates Element
1796 @subsection The @code{coordinates} Element
1798 Parent: @code{graph} @*
1801 This element is always present and always empty, with no attributes
1804 @node SPV Detail faceting Element
1805 @subsection The @code{faceting} Element
1807 Parent: @code{graph} @*
1808 Contents: @code{cross} @code{layer}*
1810 The @code{faceting} element describes the row, column, and layer
1811 structure of the table. Its @code{cross} child determines the row and
1812 column structure, and each @code{layer} child (if any) represents a
1815 @code{faceting} has no attributes (other than @code{id}).
1817 @subsubheading The @code{cross} Element
1819 Parent: @code{faceting} @*
1820 Contents: @code{nest} @code{nest}
1822 The @code{cross} element describes the row and column structure of the
1823 table. It has exactly two @code{nest} children, the first of which
1824 describes the table's rows and the second the table's columns.
1826 @code{cross} has no attributes (other than @code{id}).
1828 @subsubheading The @code{nest} Element
1830 Parent: @code{cross} @*
1831 Contents: @code{variableReference}@math{+}
1833 A given @code{nest} usually consists of one or more dimensions, each
1834 of which is represented by @code{variableReference} child elements.
1835 Minimally, a dimension has two @code{variableReference} children, one
1836 for the categories, one for the data, e.g.:
1840 <variableReference ref="dimension0categories"/>
1841 <variableReference ref="dimension0"/>
1846 Groups of categories introduce additional variable references, e.g.@:
1850 <variableReference ref="dimension0categories"/>
1851 <variableReference ref="dimension0group0"/>
1852 <variableReference ref="dimension0"/>
1857 Grouping can be hierarchical, e.g.@:
1861 <variableReference ref="dimension0categories"/>
1862 <variableReference ref="dimension0group1"/>
1863 <variableReference ref="dimension0group0"/>
1864 <variableReference ref="dimension0"/>
1869 XXX what are group maps?
1872 <nest id="nest_1973">
1873 <variableReference ref="dimension1categories"/>
1874 <variableReference ref="dimension1group1map"/>
1875 <variableReference ref="dimension1group0map"/>
1876 <variableReference ref="dimension1"/>
1879 <variableReference ref="dimension0categories"/>
1880 <variableReference ref="dimension0group0map"/>
1881 <variableReference ref="dimension0"/>
1886 A @code{nest} can contain multiple dimensions:
1890 <variableReference ref="dimension1categories"/>
1891 <variableReference ref="dimension1group0"/>
1892 <variableReference ref="dimension1"/>
1893 <variableReference ref="dimension0categories"/>
1894 <variableReference ref="dimension0"/>
1898 One @code{nest} within a given @code{cross} may have no dimensions, in
1899 which case it still has one @code{variableReference} child, which
1900 references a @code{derivedVariable} whose @code{value} attribute is
1901 @code{constant(0)}. In the corpus, such a @code{derivedVariable} has
1902 @code{row} or @code{column}, respectively, as its @code{id}.
1904 @code{nest} has no attributes (other than @code{id}).
1906 @subsubheading The @code{variableReference} Element
1908 Parent: @code{nest} @*
1911 @code{variableReference} has one attribute.
1913 @defvr {Required} ref
1914 The @code{id} of a @code{sourceVariable} or @code{derivedVariable}
1918 @subsubheading The @code{layer} Element
1920 Parent: @code{faceting} @*
1923 Each layer is represented by a pair of @code{layer} elements. The
1924 first of this pair is for a category variable, the second for the data
1928 <layer value="0" variable="dimension0categories" visible="true"/>
1929 <layer value="dimension0" variable="dimension0" visible="false"/>
1933 @code{layer} has the following attributes.
1935 @defvr {Required} variable
1936 The @code{id} of a @code{sourceVariable} or @code{derivedVariable}
1940 @defvr {Required} value
1941 The value to select. For a category variable, this is always
1942 @code{0}; for a data variable, it is the same as the @code{variable}
1946 @defvr {Optional} visible
1947 Whether the layer is visible. Generally, category layers are visible
1948 and data layers are not, but sometimes this attribute is omitted.
1951 @defvr {Optional} method
1952 When present, this is always @code{nest}.
1955 @node SPV Detail facetLayout Element
1956 @subsection The @code{facetLayout} Element
1958 Parent: @code{graph} @*
1959 Contents: @code{tableLayout} @code{facetLevel}@math{+} @code{setCellProperties}*
1961 @subsubheading The @code{tableLayout} Element
1963 Parent: @code{facetLayout} @*
1966 @defvr {Required} verticalTitlesInCorner
1967 Always set to @code{true}.
1970 @defvr {Optional} style
1971 The @code{id} of a @code{style} element.
1974 @defvr {Optional} fitCells
1975 Always set to @code{ticks}.
1978 @subsubheading The @code{facetLevel} Element
1980 Parent: @code{facetLayout} @*
1981 Contents: @code{axis}
1983 Each @code{facetLevel} describes a @code{variableReference} or
1984 @code{layer}, and a table has one @code{facetLevel} element for
1985 each such element. For example, an SPV detail member that contains
1986 four @code{variableReference} elements and two @code{layer} elements
1987 will contain six @code{facetLevel} elements.
1989 In the corpus, @code{facetLevel} elements and the elements that they
1990 describe are always in the same order. The correspondence may also be
1991 observed in two other ways. First, one may use the @code{level}
1992 attribute, described below. Second, in the corpus, a
1993 @code{facetLevel} always has an @code{id} that is the same as the
1994 @code{id} of the element it describes with @code{_facetLevel}
1995 appended. One should not formally rely on this, of course, but it is
1996 usefully indicative.
1998 @defvr {Required} level
1999 A 1-based index into the @code{variableReference} and @code{layer}
2000 elements, e.g.@: a @code{facetLayout} with a @code{level} of 1
2001 describes the first @code{variableReference} in the SPV detail member,
2002 and in a member with four @code{variableReference} elements, a
2003 @code{facetLayout} with a @code{level} of 5 describes the first
2004 @code{layer} in the member.
2007 @defvr {Required} gap
2008 Always observed as @code{0pt}.
2011 @subsubheading The @code{axis} Element
2013 Parent: @code{facetLevel} @*
2014 Contents: @code{label}? @code{majorTicks}
2016 @defvr {Attribute} style
2017 The @code{id} of a @code{style} element.
2020 @subsubheading The @code{label} Element
2022 Parent: @code{axis} or @code{labelFrame} @*
2023 Contents: @code{text}@math{+} @math{|} @code{descriptionGroup}
2025 This element represents a label on some aspect of the table. For example,
2026 the table's title is a @code{label}.
2028 The contents of the label can be one or more @code{text} elements or a
2029 @code{descriptionGroup}.
2031 @defvr {Attribute} style
2032 @defvrx {Optional} textFrameStyle
2033 Each of these is the @code{id} of a @code{style} element.
2034 @code{style} is the style of the label text, @code{textFrameStyle} the
2035 style for the frame around the label.
2038 @defvr {Optional} purpose
2039 The kind of entity being labeled, one of @code{title},
2040 @code{subTitle}, @code{layer}, or @code{footnote}.
2043 @subsubheading The @code{descriptionGroup} Element
2045 Parent: @code{label} @*
2046 Contents: (@code{description} @math{|} @code{text})@math{+}
2048 A @code{descriptionGroup} concatenates one or more elements to form a
2049 label. Each element can be a @code{text} element, which contains
2050 literal text, or a @code{description} element that substitutes a value
2053 @defvr {Attribute} target
2054 The @code{id} of an element being described. In the corpus, this is
2055 always @code{faceting}.
2058 @defvr {Attribute} separator
2059 A string to separate the description of multiple groups, if the
2060 @code{target} has more than one. In the corpus, this is always a
2064 Typical contents for a @code{descriptionGroup} are a value by itself:
2066 <description name="value"/>
2068 @noindent or a variable and its value, separated by a colon:
2070 <description name="variable"/><text>:</text><description name="value"/>
2073 @subsubheading The @code{description} Element
2075 Parent: @code{descriptionGroup} @*
2078 A @code{description} is like a macro that expands to some property of
2079 the target of its parent @code{descriptionGroup}.
2081 @defvr {Attribute} name
2082 The name of the property. Only @code{variable} and @code{value}
2083 appear in the corpus.
2086 @subsubheading The @code{majorTicks} Element
2088 Parent: @code{axis} @*
2089 Contents: @code{gridline}?
2091 @defvr {Attribute} labelAngle
2092 @defvrx {Attribute} length
2093 Both always defined to @code{0}.
2096 @defvr {Attribute} style
2097 @defvrx {Attribute} tickFrameStyle
2098 Each of these is the @code{id} of a @code{style} element.
2099 @code{style} is the style of the tick labels, @code{tickFrameStyle}
2100 the style for the frames around the labels.
2103 @subsubheading The @code{gridline} Element
2105 Parent: @code{majorTicks} @*
2108 Represents ``gridlines,'' which for a table represents the lines
2109 between the rows or columns of a table (XXX?).
2111 @defvr {Attribute} style
2112 The style for the gridline.
2115 @defvr {Attribute} zOrder
2116 Observed as a number between 28 and 31. Does not seem to be
2120 @subsubheading The @code{setCellProperties} Element
2122 Parent: @code{facetLayout} @*
2123 Contents: @code{setMetaData} @code{setStyle}* @code{setFormat}@math{+} @code{union}?
2125 This element sets style properties of cells designated by the
2126 @code{target} attribute of its child elements, as further restricted
2127 by the optional @code{union} element if present. The @code{target}
2128 values often used, e.g.@: @code{graph} or @code{labeling}, actually
2129 affect every cell, so the @code{union} element is a useful
2132 @defvr {Optional} applyToConverse
2133 If present, always @code{true}. This appears to invert the meaning of
2134 the @code{target} of sub-elements: the selected cells are the ones
2135 @emph{not} designated by @code{target}. This is confusing, given the
2136 additional restrictions of @code{union}, but in the corpus
2137 @code{applyToConverse} is never present along with @code{union}.
2140 @subsubheading The @code{setMetaData} Element
2142 Parent: @code{setCellProperties} @*
2145 This element is not known to have any visible effect.
2147 @defvr {Required} target
2148 The @code{id} of an element whose metadata is to be set. In the
2149 corpus, this is always @code{graph}, the @code{id} used for the
2150 @code{graph} element.
2153 @defvr {Required} key
2154 @defvrx {Required} value
2155 A key-value pair to set for the target.
2157 In the corpus, @code{key} is @code{cellPropId} or, rarely,
2158 @code{diagProps}, and @code{value} is always the @code{id} of the
2159 parent @code{setCellProperties}.
2162 @subsubheading The @code{setStyle} Element
2164 Parent: @code{setCellProperties} @*
2167 This element associates a style with the target.
2169 @defvr {Required} target
2170 The @code{id} of an element whose style is to be set. In the corpus,
2171 this is always the @code{id} of an @code{interval}, @code{labeling},
2172 or, rarely, @code{graph} element.
2175 @defvr {Required} style
2176 The @code{id} of a @code{style} element that identifies the style to
2180 @subsubheading The @code{setFormat} Element
2183 Parent: @code{setCellProperties}
2186 @math{|} @code{numberFormat}
2187 @math{|} @code{stringFormat}@math{+}
2188 @math{|} @code{dateTimeFormat}
2191 This element sets the format of the target, ``format'' in this case
2192 meaning the SPSS print format for a variable.
2194 The details of this element vary depending on the schema version, as
2195 declared in the root @code{visualization} element's @code{version}
2196 attribute (@pxref{SPV Detail visualization Element}). In version 2.5
2197 and earlier, @code{setFormat} contains one of a number of child
2198 elements that correspond to the different varieties of print formats.
2199 In version 2.7 and later, @code{setFormat} instead always contains a
2200 @code{format} element.
2202 XXX reinvestigate the above claim about versions: it appears to be
2205 The @code{setFormat} element itself has the following attributes.
2207 @defvr {Required} target
2208 The @code{id} of an element whose style is to be set. In the corpus,
2209 this is always the @code{id} of an @code{majorTicks} or
2210 @code{labeling} element.
2213 @defvr {Optional} reset
2214 If this is @code{true}, this format overrides the target's previous
2215 format. If it is @code{false}, the adds to the previous format. In
2216 the corpus this is always @code{true}. The default behavior is
2221 * SPV Detail format Element::
2222 * SPV Detail numberFormat Element::
2223 * SPV Detail stringFormat Element::
2224 * SPV Detail dateTimeFormat Element::
2225 * SPV Detail affix Element::
2226 * SPV Detail relabel Element::
2227 * SPV Detail union Element::
2230 @node SPV Detail format Element
2231 @subsubsection The @code{format} Element
2233 Parent: @code{sourceVariable}, @code{derivedVariable}, @code{formatMapping}, @code{labeling}, @code{formatMapping}, @code{setFormat} @*
2234 Contents: (@code{affix}@math{+} @math{|} @code{relabel}@math{+})?
2236 This element appears only in schema version 2.7 (@pxref{SPV Detail
2237 visualization Element}).
2239 This element determines a format, equivalent to an SPSS print format.
2241 @subsubheading Attributes for All Formats
2243 These attributes apply to all kinds of formats. The most important of
2244 these attributes determines the high-level kind of formatting in use:
2246 @defvr {Optional} baseFormat
2247 Either @code{dateTime} or @code{elapsedTime}. When this attribute is
2248 omitted, this element is a numeric or string format.
2252 Whether, in the corpus, other attributes are always present (``yes''),
2253 never present (``no''), or sometimes present (``opt'') depends on
2256 @multitable {maximumFractionDigits} {@code{dateTime}} {@code{elapsedTime}} {number} {string}
2257 @headitem Attribute @tab @code{dateTime} @tab @code{elapsedTime} @tab number @tab string
2258 @item errorCharacter @tab yes @tab yes @tab yes @tab opt
2260 @item separatorChars @tab yes @tab no @tab no @tab no
2262 @item mdyOrder @tab yes @tab no @tab no @tab no
2264 @item showYear @tab yes @tab no @tab no @tab no
2265 @item yearAbbreviation @tab yes @tab no @tab no @tab no
2267 @item showMonth @tab yes @tab no @tab no @tab no
2268 @item monthFormat @tab yes @tab no @tab no @tab no
2270 @item showDay @tab yes @tab opt @tab no @tab no
2271 @item dayPadding @tab yes @tab opt @tab no @tab no
2272 @item dayOfMonthPadding @tab yes @tab no @tab no @tab no
2273 @item dayType @tab yes @tab no @tab no @tab no
2275 @item showHour @tab yes @tab opt @tab no @tab no
2276 @item hourFormat @tab yes @tab opt @tab no @tab no
2277 @item hourPadding @tab yes @tab yes @tab no @tab no
2279 @item showMinute @tab yes @tab yes @tab no @tab no
2280 @item minutePadding @tab yes @tab yes @tab no @tab no
2282 @item showSecond @tab yes @tab yes @tab no @tab no
2283 @item secondPadding @tab no @tab yes @tab no @tab no
2285 @item showMillis @tab no @tab yes @tab no @tab no
2287 @item minimumIntegerDigits @tab no @tab no @tab yes @tab no
2288 @item maximumFractionDigits @tab no @tab yes @tab yes @tab no
2289 @item minimumFractionDigits @tab no @tab yes @tab yes @tab no
2290 @item useGrouping @tab no @tab opt @tab yes @tab no
2291 @item scientific @tab no @tab no @tab yes @tab no
2292 @item small @tab no @tab no @tab opt @tab no
2293 @item suffix @tab no @tab no @tab opt @tab no
2295 @item tryStringsAsNumbers @tab no @tab no @tab no @tab yes
2299 @defvr {Attribute} errorCharacter
2300 A character that replaces the formatted value when it cannot otherwise
2301 be represented in the given format. Always @samp{*}.
2304 @subsubheading Date and Time Attributes
2306 These attributes are used with @code{dateTime} and @code{elapsedTime}
2309 @defvr {Attribute} separatorChars
2310 Exactly four characters. In order, these are used for: decimal point,
2311 grouping, date separator, time separator. Always @samp{.,-:}.
2314 @defvr {Attribute} mdyOrder
2315 Within a date, the order of the days, months, and years.
2316 @code{dayMonthYear} is the only observed value, but one would expect
2317 that @code{monthDayYear} and @code{yearMonthDay} to be reasonable as
2321 @defvr {Attribute} showYear
2322 @defvrx {Attribute} yearAbbreviation
2323 Whether to include the year and, if so, whether the year should be
2324 shown abbreviated, that is, with only 2 digits. Each is @code{true}
2325 or @code{false}; only values of @code{true} and @code{false},
2326 respectively, have been observed.
2329 @defvr {Attribute} showMonth
2330 @defvrx {Attribute} monthFormat
2331 Whether to include the month (@code{true} or @code{false}) and, if so,
2332 how to format it. @code{monthFormat} is one of the following:
2336 The full name of the month, e.g.@: in an English locale,
2340 The abbreviated name of the month, e.g.@: in an English locale,
2344 The number representing the month, e.g.@: 9 for September.
2347 A two-digit number representing the month, e.g.@: 09 for September.
2350 Only values of @code{true} and @code{short}, respectively, have been
2354 @defvr {Attribute} dayPadding
2355 @defvrx {Attribute} dayOfMonthPadding
2356 @defvrx {Attribute} hourPadding
2357 @defvrx {Attribute} minutePadding
2358 @defvrx {Attribute} secondPadding
2359 These attributes presumably control whether each field in the output
2360 is padded with spaces to its maximum width, but the details are not
2361 understood. The only observed value for any of these attributes is
2365 @defvr {Attribute} showDay
2366 @defvrx {Attribute} showHour
2367 @defvrx {Attribute} showMinute
2368 @defvrx {Attribute} showSecond
2369 @defvrx {Attribute} showMillis
2370 These attributes presumably control whether each field is displayed
2371 in the output, but the details are not understood. The only
2372 observed value for any of these attributes is @code{true}.
2375 @defvr {Attribute} dayType
2376 This attribute is always @code{month} in the corpus, specifying that
2377 the day of the month is to be displayed; a value of @code{year} is
2378 supposed to indicate that the day of the year, where 1 is January 1,
2379 is to be displayed instead.
2382 @defvr {Attribute} hourFormat
2383 @code{hourFormat}, if present, is one of:
2387 The time is displayed with an @code{am} or @code{pm} suffix, e.g.@:
2391 The time is displayed in a 24-hour format, e.g.@: @code{22:15}.
2393 This is the only value observed in the corpus.
2396 The time is displayed in a 12-hour format, without distinguishing
2397 morning or evening, e.g.@: @code{10;15}.
2400 @code{hourFormat} is sometimes present for @code{elapsedTime} formats,
2401 which is confusing since a time duration does not have a concept of AM
2402 or PM. This might indicate a bug in the code that generated the XML
2403 in the corpus, or it might indicate that @code{elapsedTime} is
2404 sometimes used to format a time of day.
2407 @subsubheading Numeric Attributes
2409 These attributes are used for formats when @code{baseFormat} is
2410 @code{number}. Attributes @code{maximumFractionDigits}, and
2411 @code{minimumFractionDigits}, and @code{useGrouping} are also used
2412 when @code{baseFormat} is @code{elapsedTime}.
2414 @defvr {Attribute} minimumIntegerDigits
2415 Minimum number of digits to display before the decimal point. Always
2416 observed as @code{0}.
2419 @defvr {Attribute} maximumFractionDigits
2420 @defvrx {Attribute} maximumFractionDigits
2421 Maximum or minimum, respectively, number of digits to display after
2422 the decimal point. The observed values of each attribute range from 0
2426 @defvr {Attribute} useGrouping
2427 Whether to use the grouping character to group digits in large
2428 numbers. It would make sense for the grouping character to come from
2429 the @code{separatorChars} attribute, but that attribute is only
2430 present when @code{baseFormat} is @code{dateTime} or
2431 @code{elapsedTime}, in the corpus at least. Perhaps that is because
2432 this attribute has only been observed as @code{false}.
2435 @defvr {Attribute} scientific
2436 This attribute controls when and whether the number is formatted in
2437 scientific notation. It takes the following values:
2441 Use scientific notation only when the number's magnitude is smaller
2442 than the value of the @code{small} attribute.
2445 Use scientific notation when the number will not otherwise fit in the
2449 Always use scientific notation. Not observed in the corpus.
2452 Never use scientific notation. A number that won't otherwise fit will
2453 be replaced by an error indication (see the @code{errorCharacter}
2454 attribute). Not observed in the corpus.
2458 @defvr {Optional} small
2459 Only present when the @code{scientific} attribute is
2460 @code{onlyForSmall}, this is a numeric magnitude below which the
2461 number will be formatted in scientific notation. The values @code{0}
2462 and @code{0.0001} have been observed. The value @code{0} seems like a
2463 pathological choice, since no real number has a magnitude less than 0;
2464 perhaps in practice such a choice is equivalent to setting
2465 @code{scientific} to @code{false}.
2468 @defvr {Optional} prefix
2469 @defvrx {Optional} suffix
2470 Specifies a prefix or a suffix to apply to the formatted number. Only
2471 @code{suffix} has been observed, with value @samp{%}.
2474 @subsubheading String Attributes
2476 These attributes are used for formats when @code{baseFormat} is
2479 @defvr {Attribute} tryStringsAsNumbers
2480 When this is @code{true}, it is supposed to indicate that string
2481 values should be parsed as numbers and then displayed according to
2482 numeric formatting rules. However, in the corpus it is always
2486 @node SPV Detail numberFormat Element
2487 @subsubsection The @code{numberFormat} Element
2489 Parent: @code{setFormat} @*
2490 Contents: @code{affix}@math{+}
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{relabel} elements in a more diverse corpus.
2496 This element has the following attributes.
2498 @defvr {Attribute} maximumFractionDigits
2499 @defvrx {Attribute} minimumFractionDigits
2500 @defvrx {Attribute} minimumIntegerDigits
2501 @defvrx {Optional} scientific
2502 @defvrx {Optional} small
2503 @defvrx {Optional} suffix
2504 @defvrx {Optional} useGroupging
2505 The syntax and meaning of these attributes is the same as on the
2506 @code{format} element for a numeric format. @pxref{SPV Detail format
2510 @node SPV Detail stringFormat Element
2511 @subsubsection The @code{stringFormat} Element
2513 Parent: @code{setFormat} @*
2514 Contents: (@code{affix}@math{+} @math{|} @code{relabel}@math{+})?
2516 This element appears only in schema version 2.5 and earlier
2517 (@pxref{SPV Detail visualization Element}).
2519 This element has no attributes.
2521 @node SPV Detail dateTimeFormat Element
2522 @subsubsection The @code{dateTimeFormat} Element
2524 Parent: @code{setFormat} @*
2527 This element appears only in schema version 2.5 and earlier
2528 (@pxref{SPV Detail visualization Element}). Possibly this element
2529 could also contain @code{affix} and @code{relabel} elements in a more
2532 The following attribute is required.
2534 @defvr {Attribute} baseFormat
2535 Either @code{dateTime} or @code{time}.
2538 When @code{baseFormat} is @code{dateTime}, the following attributes
2541 @defvr {Attribute} dayOfMonthPadding
2542 @defvrx {Attribute} dayPadding
2543 @defvrx {Attribute} dayType
2544 @defvrx {Attribute} hourFormat
2545 @defvrx {Attribute} hourPadding
2546 @defvrx {Attribute} mdyOrder
2547 @defvrx {Attribute} minutePadding
2548 @defvrx {Attribute} monthFormat
2549 @defvrx {Attribute} separatorChars
2550 @defvrx {Attribute} showDay
2551 @defvrx {Attribute} showHour
2552 @defvrx {Attribute} showMinute
2553 @defvrx {Attribute} showMonth
2554 @defvrx {Attribute} showSecond
2555 @defvrx {Attribute} showYear
2556 @defvrx {Attribute} yearAbbreviation
2557 The syntax and meaning of these attributes is the same as on the
2558 @code{format} element when that element's @code{baseFormat} is
2559 @code{dateTime}. @pxref{SPV Detail format Element}.
2562 When @code{baseFormat} is @code{time}, the following attributes are
2565 @defvr {Attribute} hourFormat
2566 @defvrx {Attribute} hourPadding
2567 @defvrx {Attribute} minutePadding
2568 @defvrx {Attribute} monthFormat
2569 @defvrx {Attribute} separatorChars
2570 @defvrx {Attribute} showDay
2571 @defvrx {Attribute} showHour
2572 @defvrx {Attribute} showMinute
2573 @defvrx {Attribute} showMonth
2574 @defvrx {Attribute} showSecond
2575 @defvrx {Attribute} showYear
2576 @defvrx {Attribute} yearAbbreviation
2577 The syntax and meaning of these attributes is the same as on the
2578 @code{format} element when that element's @code{baseFormat} is
2579 @code{elapsedTime}. @pxref{SPV Detail format Element}.
2582 @node SPV Detail affix Element
2583 @subsubsection The @code{affix} Element
2585 Parent: @code{format} or @code{numberFormat} or @code{stringFormat} @*
2588 Possibly this element could have @code{dateTimeFormat} as a parent in
2589 a more diverse corpus.
2591 This defines a suffix (or, theoretically, a prefix) for a formatted
2592 value. It is used to insert a reference to a footnote. It has the
2593 following attributes:
2595 @defvr {Attribute} definesReference
2596 This specifies the footnote number as a natural number: 1 for the
2597 first footnote, 2 for the second, and so on.
2600 @defvr {Attribute} position
2601 Position for the footnote label. Always @code{superscript}.
2604 @defvr {Attribute} suffix
2605 Whether the affix is a suffix (@code{true}) or a prefix
2606 (@code{false}). Always @code{true}.
2609 @defvr {Attribute} value
2610 The text of the suffix or prefix. Typically a letter, e.g.@: @code{a}
2611 for footnote 1, @code{b} for footnote 2, @enddots{} The corpus
2612 contains other values: @code{*}, @code{**}, and a few that begin with
2613 at least one comma: @code{,b}, @code{,c}, @code{,,b}, and @code{,,c}.
2616 @node SPV Detail relabel Element
2617 @subsubsection The @code{relabel} Element
2619 Parent: @code{format} or @code{stringFormat} @*
2622 Possibly this element could have @code{numberFormat} or
2623 @code{dateTimeFormat} as a parent in a more diverse corpus.
2625 This specifies how to display a given value. It is used to implement
2626 value labels and to display the system-missing value in a
2627 human-readable way. It has the following attributes:
2629 @defvr {Attribute} from
2630 The value to map. In the corpus this is an integer or the
2631 system-missing value @code{-1.797693134862316E300}.
2634 @defvr {Attribute} to
2635 The string to display in place of the value of @code{from}. In the
2636 corpus this is a wide variety of value labels; the system-missing
2637 value is mapped to @samp{.}.
2640 @node SPV Detail union Element
2641 @subsubsection The @code{union} Element
2643 Parent: @code{setCellProperties} @*
2644 Contents: @code{intersect}@math{+}
2646 This element represents a set of cells, computed as the union of the
2647 sets represented by each of its children.
2649 @subsubheading The @code{intersect} Element
2651 Parent: @code{union} @*
2652 Contents: @code{where}@math{+} @math{|} @code{intersectWhere}?
2654 This element represents a set of cells, computed as the intersection
2655 of the sets represented by each of its children.
2657 Of the two possible children, in the corpus @code{where} is far more
2658 common, appearing thousands of times, whereas @code{intersectWhere}
2659 only appears 4 times.
2661 Most @code{intersect} elements have two or more children.
2663 @subsubheading The @code{where} Element
2665 Parent: @code{intersect} @*
2668 This element represents the set of cells in which the value of a
2669 specified variable falls within a specified set.
2671 @defvr {Attribute} variable
2672 The @code{id} of a variable, e.g.@: @code{dimension0categories} or
2673 @code{dimension0group0map}.
2676 @defvr {Attribute} include
2677 A value, or multiple values separated by semicolons,
2678 e.g.@: @code{0} or @code{13;14;15;16}.
2681 @subsubheading The @code{intersectWhere}
2683 Parent: @code{intersect} @*
2686 The meaning of this element is unknown.
2688 @defvr {Attribute} variable
2689 @defvrx {Attribute} variable2
2690 The meaning of these attributes is unknown. In the four examples in
2691 the corpus they always take the values @code{dimension2categories} and
2692 @code{dimension0categories}, respectively.