1 @c PSPP - a program for statistical analysis.
2 @c Copyright (C) 2019 Free Software Foundation, Inc.
3 @c Permission is granted to copy, distribute and/or modify this document
4 @c under the terms of the GNU Free Documentation License, Version 1.3
5 @c or any later version published by the Free Software Foundation;
6 @c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
7 @c A copy of the license is included in the section entitled "GNU
8 @c Free Documentation License".
11 @node SPSS Viewer File Format
12 @appendix SPSS Viewer File Format
14 SPSS Viewer or @file{.spv} files, here called SPV files, are written
15 by SPSS 16 and later to represent the contents of its output editor.
16 This chapter documents the format, based on examination of a corpus of
17 about 8,000 files from a variety of sources. This description is
18 detailed enough to both read and write SPV files.
20 SPSS 15 and earlier versions instead use @file{.spo} files, which have
21 a completely different output format based on the Microsoft Compound
22 Document Format. This format is not documented here.
24 An SPV file is a Zip archive that can be read with @command{zipinfo}
25 and @command{unzip} and similar programs. The final member in the Zip
26 archive is the @dfn{manifest}, a file named
27 @file{META-INF/MANIFEST.MF}. This structure makes SPV files resemble
28 Java ``JAR'' files (and ODF files), but whereas a JAR manifest
29 contains a sequence of colon-delimited key/value pairs, an SPV
30 manifest contains the string @samp{allowPivoting=true}, without a
31 new-line. PSPP uses this string to identify an SPV file; it is
32 invariant across the corpus.@footnote{SPV files always begin with the
33 7-byte sequence 50 4b 03 04 14 00 08, but this is not a useful magic
34 number because most Zip archives start the same way.}@footnote{SPSS
35 writes @file{META-INF/MANIFEST.MF} to every SPV file, but it does not
36 read it or even require it to exist, so using different contents,
37 e.g.@: as @samp{allowingPivot=false} has no effect.}
39 The rest of the members in an SPV file's Zip archive fall into two
40 categories: @dfn{structure} and @dfn{detail} members. Structure
41 member names begin with @file{outputViewer@var{nnnnnnnnnn}}, where
42 each @var{n} is a decimal digit, and end with @file{.xml}, and often
43 include the string @file{_heading} in between. Each of these members
44 represents some kind of output item (a table, a heading, a block of
45 text, etc.) or a group of them. The member whose output goes at the
46 beginning of the document is numbered 0, the next member in the output
47 is numbered 1, and so on.
49 Structure members contain XML. This XML is sometimes self-contained,
50 but it often references detail members in the Zip archive, which are
54 @item @file{@var{prefix}_table.xml} and @file{@var{prefix}_tableData.bin}
55 @itemx @file{@var{prefix}_lightTableData.bin}
56 The structure of a table plus its data. Older SPV files pair a
57 @file{@var{prefix}_table.xml} file that describes the table's
58 structure with a binary @file{@var{prefix}_tableData.bin} file that
59 gives its data. Newer SPV files (the majority of those in the corpus)
60 instead include a single @file{@var{prefix}_lightTableData.bin} file
61 that incorporates both into a single binary format.
63 @item @file{@var{prefix}_warning.xml} and @file{@var{prefix}_warningData.bin}
64 @itemx @file{@var{prefix}_lightWarningData.bin}
65 Same format used for tables, with a different name.
67 @item @file{@var{prefix}_notes.xml} and @file{@var{prefix}_notesData.bin}
68 @itemx @file{@var{prefix}_lightNotesData.bin}
69 Same format used for tables, with a different name.
71 @item @file{@var{prefix}_chartData.bin} and @file{@var{prefix}_chart.xml}
72 The structure of a chart plus its data. Charts do not have a
75 @item @file{@var{prefix}_Imagegeneric.png}
76 @itemx @file{@var{prefix}_PastedObjectgeneric.png}
77 @itemx @file{@var{prefix}_imageData.bin}
78 A PNG image referenced by an @code{object} element (in the first two
79 cases) or an @code{image} element (in the final case). @xref{SPV
80 Structure object and image Elements}.
82 @item @file{@var{prefix}_pmml.scf}
83 @itemx @file{@var{prefix}_stats.scf}
84 @item @file{@var{prefix}_model.xml}
85 Not yet investigated. The corpus contains few examples.
88 The @file{@var{prefix}} in the names of the detail members is
89 typically an 11-digit decimal number that increases for each item,
90 tending to skip values. Older SPV files use different naming
91 conventions. Structure member refer to detail members by name, and so
92 their exact names do not matter to readers as long as they are unique.
94 SPSS tolerates corrupted Zip archives that Zip reader libraries tend
95 to reject. These can be fixed up with @command{zip -FF}.
98 * SPV Structure Member Format::
99 * SPV Light Detail Member Format::
100 * SPV Legacy Detail Member Binary Format::
101 * SPV Legacy Detail Member XML Format::
104 @node SPV Structure Member Format
105 @section Structure Member Format
107 A structure member lays out the high-level structure for a group of
108 output items such as heading, tables, and charts. Structure members
109 do not include the details of tables and charts but instead refer to
110 them by their member names.
112 Structure members' XML files claim conformance with a collection of
113 XML Schemas. These schemas are distributed, under a nonfree license,
114 with SPSS binaries. Fortunately, the schemas are not necessary to
115 understand the structure members. The schemas can even
116 be deceptive because they document elements and attributes that are
117 not in the corpus and do not document elements and attributes that are
118 commonly found in the corpus.
120 Structure members use a different XML namespace for each schema, but
121 these namespaces are not entirely consistent. In some SPV files, for
122 example, the @code{viewer-tree} schema is associated with namespace
123 @indicateurl{http://xml.spss.com/spss/viewer-tree} and in others with
124 @indicateurl{http://xml.spss.com/spss/viewer/viewer-tree} (note the
125 additional @file{viewer/}). Under either name, the schema URIs are
126 not resolvable to obtain the schemas themselves.
128 One may ignore all of the above in interpreting a structure member.
129 The actual XML has a simple and straightforward form that does not
130 require a reader to take schemas or namespaces into account. A
131 structure member's root is @code{heading} element, which contains
132 @code{heading} or @code{container} elements (or a mix), forming a
133 tree. In turn, @code{container} holds a @code{label} and one more
134 child, usually @code{text} or @code{table}.
136 The following sections document the elements found in structure
137 members in a context-free grammar-like fashion. Consider the
138 following example, which specifies the attributes and content for the
139 @code{container} element:
143 :visibility=(visible | hidden)
144 :page-break-before=(always)?
145 :text-align=(left | center)?
147 => label (table | container_text | graph | model | object | image | tree)
150 Each attribute specification begins with @samp{:} followed by the
151 attribute's name. If the attribute's value has an easily specified
152 form, then @samp{=} and its description follows the name. Finally, if
153 the attribute is optional, the specification ends with @samp{?}. The
154 following value specifications are defined:
157 @item (@var{a} | @var{b} | @dots{})
158 One of the listed literal strings. If only one string is listed, it
159 is the only acceptable value. If @code{OTHER} is listed, then any
160 string not explicitly listed is also accepted.
163 Either @code{true} or @code{false}.
166 A floating-point number followed by a unit, e.g.@: @code{10pt}. Units
167 in the corpus include @code{in} (inch), @code{pt} (points, 72/inch),
168 @code{px} (``device-independent pixels'', 96/inch), and @code{cm}. If
169 the unit is omitted then points should be assumed. The number and
170 unit may be separated by white space.
172 The corpus also includes localized names for units. A reader must
173 understand these to properly interpret the dimension:
177 @code{인치}, @code{pol.}, @code{cala}, @code{cali}
187 A floating-point number.
193 A color in one of the forms @code{#@var{rr}@var{gg}@var{bb}} or
194 @code{@var{rr}@var{gg}@var{bb}}, or the string @code{transparent}, or
195 one of the standard Web color names.
198 @item ref @var{element}
199 @itemx ref(@var{elem1} | @var{elem2} | @dots{})
200 The name from the @code{id} attribute in some element. If one or more
201 elements are named, the name must refer to one of those elements,
202 otherwise any element is acceptable.
205 All elements have an optional @code{id} attribute. If present, its
206 value must be unique. In practice many elements are assigned
207 @code{id} attributes that are never referenced.
209 The content specification for an element supports the following
216 @item @var{a} @var{b}
217 @var{a} followed by @var{b}.
219 @item @var{a} | @var{b} | @var{c}
220 One of @var{a} or @var{b} or @var{c}.
223 Zero or one instances of @var{a}.
226 Zero or more instances of @var{a}.
229 One or more instances of @var{a}.
231 @item (@var{subexpression})
232 Grouping for a subexpression.
241 Element and attribute names are sometimes suffixed by another name in
242 square brackets to distinguish different uses of the same name. For
243 example, structure XML has two @code{text} elements, one inside
244 @code{container}, the other inside @code{pageParagraph}. The former
245 is defined as @code{text[container_text]} and referenced as
246 @code{container_text}, the latter defined as
247 @code{text[pageParagraph_text]} and referenced as
248 @code{pageParagraph_text}.
250 This language is used in the PSPP source code for parsing structure
251 and detail XML members. Refer to
252 @file{src/output/spv/structure-xml.grammar} and
253 @file{src/output/spv/detail-xml.grammar} for the full grammars.
255 The following example shows the contents of a typical structure member
256 for a @cmd{DESCRIPTIVES} procedure. A real structure member is not
257 indented. This example also omits most attributes, all XML namespace
258 information, and the CSS from the embedded HTML:
261 <?xml version="1.0" encoding="utf-8"?>
263 <label>Output</label>
264 <heading commandName="Descriptives">
265 <label>Descriptives</label>
268 <text commandName="Descriptives" type="title">
270 <![CDATA[<head><style type="text/css">...</style></head><BR>Descriptives]]>
274 <container visibility="hidden">
276 <table commandName="Descriptives" subType="Notes" type="note">
278 <dataPath>00000000001_lightNotesData.bin</dataPath>
283 <label>Descriptive Statistics</label>
284 <table commandName="Descriptives" subType="Descriptive Statistics"
287 <dataPath>00000000002_lightTableData.bin</dataPath>
296 * SPV Structure heading Element::
297 * SPV Structure label Element::
298 * SPV Structure container Element::
299 * SPV Structure text Element (Inside @code{container})::
300 * SPV Structure html Element::
301 * SPV Structure table Element::
302 * SPV Structure graph Element::
303 * SPV Structure model Element::
304 * SPV Structure object and image Elements::
305 * SPV Structure tree Element::
306 * SPV Structure Path Elements::
307 * SPV Structure pageSetup Element::
308 * SPV Structure @code{text} Element (Inside @code{pageParagraph})::
311 @node SPV Structure heading Element
312 @subsection The @code{heading} Element
315 heading[root_heading]
321 => label pageSetup? (container | heading)*
326 :visibility[heading_visibility]=(collapsed)?
329 => label (container | heading)*
332 The root of a structure member is a @code{heading}, which represents a
333 section of output beginning with a @code{label} and
334 ordinarily followed by content containers or further nested
335 (sub)-sections of output. Unlike heading elements in HTML and other
336 common document formats, which precede the content that they head,
337 @code{heading} contains the elements that appear below the heading.
339 The document root heading, only, may contain a @code{pageSetup}
342 The following attributes have been observed on both document root and
343 nested @code{heading} elements.
345 @defvr {Attribute} creator-version
346 The version of the software that created this SPV file. A string of
347 the form @code{xxyyzzww} represents software version xx.yy.zz.ww,
348 e.g.@: @code{21000001} is version 21.0.0.1. Trailing pairs of zeros
349 are sometimes omitted, so that @code{21}, @code{210000}, and
350 @code{21000000} are all version 21.0.0.0 (and the corpus contains all
351 three of those forms).
355 The following attributes have been observed on document root
356 @code{heading} elements only:
358 @defvr {Attribute} @code{creator}
359 The directory in the file system of the software that created this SPV
363 @defvr {Attribute} @code{creation-date-time}
364 The date and time at which the SPV file was written, in a
365 locale-specific format, e.g.@: @code{Friday, May 16, 2014 6:47:37 PM
366 PDT} or @code{lunedì 17 marzo 2014 3.15.48 CET} or even @code{Friday,
367 December 5, 2014 5:00:19 o'clock PM EST}.
370 @defvr {Attribute} @code{lockReader}
371 Whether a reader should be allowed to edit the output. The possible
372 values are @code{true} and @code{false}. The value @code{false} is by
376 @defvr {Attribute} @code{schemaLocation}
377 This is actually an XML Namespace attribute. A reader may ignore it.
381 The following attributes have been observed only on nested
382 @code{heading} elements:
384 @defvr {Attribute} @code{commandName}
385 A locale-invariant identifier for the command that produced the
386 output, e.g.@: @code{Frequencies}, @code{T-Test}, @code{Non Par Corr}.
389 @defvr {Attribute} @code{visibility}
390 To what degree the output represented by the element is visible.
393 @defvr {Attribute} @code{locale}
394 The locale used for output, in Windows format, which is similar to the
395 format used in Unix with the underscore replaced by a hyphen, e.g.@:
396 @code{en-US}, @code{en-GB}, @code{el-GR}, @code{sr-Cryl-RS}.
399 @defvr {Attribute} @code{olang}
400 The output language, e.g.@: @code{en}, @code{it}, @code{es},
401 @code{de}, @code{pt-BR}.
404 @node SPV Structure label Element
405 @subsection The @code{label} Element
411 Every @code{heading} and @code{container} holds a @code{label} as its
412 first child. The label text is what appears in the outline pane of
413 the GUI's viewer window. PSPP also puts it into the outline of PDF
414 output. The label text doesn't appear in the output itself.
416 The text in @code{label} describes what it labels, often by naming the
417 statistical procedure that was executed, e.g.@: ``Frequencies'' or
418 ``T-Test''. The root @code{heading} in a structure member is normally
419 ``Output''. Labels are often very generic, especially within a
420 @code{container}, e.g.@: ``Title'' or ``Warnings'' or ``Notes''.
421 Label text is localized according to the output language, e.g.@: in
422 Italian a frequency table procedure is labeled ``Frequenze''.
424 The user can edit labels to be anything they want. The corpus
425 contains a few examples of empty labels, ones that contain no text,
426 probably as a result of user editing.
428 @node SPV Structure container Element
429 @subsection The @code{container} Element
433 :visibility=(visible | hidden)
434 :page-break-before=(always)?
435 :text-align=(left | center)?
437 => label (table | container_text | graph | model | object | image | tree)
440 A @code{container} serves to contain and label a @code{table},
441 @code{text}, or other kind of item.
443 This element has the following attributes.
445 @defvr {Attribute} @code{visibility}
446 Whether the container's content is displayed. ``Notes'' tables are
447 often hidden; other data is usually
450 @defvr {Attribute} @code{text-align}
451 Alignment of text within the container. Observed with nested
452 @code{table} and @code{text} elements.
455 @defvr {Attribute} @code{width}
456 The width of the container, e.g.@: @code{1097px}.
459 @node SPV Structure text Element (Inside @code{container})
460 @subsection The @code{text} Element (Inside @code{container})
464 :type[text_type]=(title | log | text | page-title)
470 This @code{text} element is nested inside a @code{container}. There
471 is a different @code{text} element that is nested inside a
472 @code{pageParagraph}.
474 This element has the following attributes.
476 @defvr {Attribute} @code{type}
477 The semantics of the text.
480 @defvr {Attribute} @code{commandName}
481 As on the @code{heading} element. For output not specific to a
482 command, this is simply @code{log}. The corpus contains one example
483 of where @code{commandName} is present but set to the empty string.
486 @defvr {Attribute} @code{creator-version}
487 As on the @code{heading} element.
490 @node SPV Structure html Element
491 @subsection The @code{html} Element
494 html :lang=(en) => TEXT
497 The element contains an HTML document as text (or, in practice, as
498 CDATA). In some cases, the document starts with @code{<html>} and
499 ends with @code{</html>}; in others the @code{html} element is
500 implied. Generally the HTML includes a @code{head} element with a CSS
501 stylesheet. The HTML body often begins with @code{<BR>}.
503 The HTML document uses only the following elements:
507 Sometimes, the document is enclosed with
508 @code{<html>}@dots{}@code{</html>}.
511 The HTML body often begins with @code{<BR>} and may contain it as well.
519 The attributes @code{face}, @code{color}, and @code{size} are
520 observed. The value of @code{color} takes one of the forms
521 @code{#@var{rr}@var{gg}@var{bb}} or @code{rgb (@var{r}, @var{g},
522 @var{b})}. The value of @code{size} is a number between 1 and 7,
526 The CSS in the corpus is simple. To understand it, a parser only
527 needs to be able to skip white space, @code{<!--}, and @code{-->}, and
528 parse style only for @code{p} elements. Only the following properties
533 In the form @code{@var{rr}@var{gg}@var{bb}}, e.g. @code{000000}, with
537 Either @code{bold} or @code{normal}.
540 Either @code{italic} or @code{normal}.
542 @item text-decoration
543 Either @code{underline} or @code{normal}.
546 A font name, commonly @code{Monospaced} or @code{SansSerif}.
549 Values claim to be in points, e.g.@: @code{14pt}, but the values are
550 actually in ``device-independent pixels'' (px), at 96/inch.
553 This element has the following attributes.
555 @defvr {Attribute} @code{lang}
556 This always contains @code{en} in the corpus.
559 @node SPV Structure table Element
560 @subsection The @code{table} Element
569 :displayFiltering=bool?
571 :orphanTolerance=int?
576 :type[table_type]=(table | note | warning)
577 => tableProperties? tableStructure
579 tableStructure => path? dataPath csvPath?
582 This element has the following attributes.
584 @defvr {Attribute} @code{commandName}
585 As on the @code{heading} element.
588 @defvr {Attribute} @code{type}
589 One of @code{table}, @code{note}, or @code{warning}.
592 @defvr {Attribute} @code{subType}
593 The locale-invariant command ID for the particular kind of output that
594 this table represents in the procedure. This can be the same as
595 @code{commandName} e.g.@: @code{Frequencies}, or different, e.g.@:
596 @code{Case Processing Summary}. Generic subtypes @code{Notes} and
597 @code{Warnings} are often used.
600 @defvr {Attribute} @code{tableId}
601 A number that uniquely identifies the table within the SPV file,
602 typically a large negative number such as @code{-4147135649387905023}.
605 @defvr {Attribute} @code{creator-version}
606 As on the @code{heading} element. In the corpus, this is only present
607 for version 21 and up and always includes all 8 digits.
610 @xref{SPV Detail Legacy Properties}, for details on the
611 @code{tableProperties} element.
613 @node SPV Structure graph Element
614 @subsection The @code{graph} Element
629 => dataPath? path csvPath?
632 This element represents a graph. The @code{dataPath} and @code{path}
633 elements name the Zip members that give the details of the graph.
634 Normally, both elements are present; there is only one counterexample
637 @code{csvPath} only appears in one SPV file in the corpus, for two
638 graphs. In these two cases, @code{dataPath}, @code{path}, and
639 @code{csvPath} all appear. These @code{csvPath} name Zip members with
640 names of the form @file{@var{number}_csv.bin}, where @var{number} is a
641 many-digit number and the same as the @code{csvFileIds}. The named
642 Zip members are CSV text files (despite the @file{.bin} extension).
643 The CSV files are encoded in UTF-8 and begin with a U+FEFF byte-order
646 @node SPV Structure model Element
647 @subsection The @code{model} Element
659 => ViZml? dataPath? path | pmmlContainerPath statsContainerPath
661 pmmlContainerPath => TEXT
663 statsContainerPath => TEXT
665 ViZml :viewName? => TEXT
668 This element represents a model. The @code{dataPath} and @code{path}
669 elements name the Zip members that give the details of the model.
670 Normally, both elements are present; there is only one counterexample
673 The details are unexplored. The @code{ViZml} element contains base-64
674 encoded text, that decodes to a binary format with some embedded text
675 strings, and @code{path} names an Zip member that contains XML.
676 Alternatively, @code{pmmlContainerPath} and @code{statsContainerPath}
677 name Zip members with @file{.scf} extension.
679 @node SPV Structure object and image Elements
680 @subsection The @code{object} and @code{image} Elements
683 object :type[object_type]=(unknown)? :uri => EMPTY
685 image :VDPId :commandName => dataPath
688 These two elements represent an image in PNG format. They are
689 equivalent and the corpus contains examples of both. The only
690 difference is the syntax: for @code{object}, the @code{uri} attribute
691 names the Zip member that contains a PNG file; for @code{image}, the
692 text of the inner @code{dataPath} element names the Zip member.
694 PSPP writes @code{object} in output but there is no strong reason to
697 The corpus only contains PNG image files.
699 @node SPV Structure tree Element
700 @subsection The @code{tree} Element
711 This element represents a tree. The @code{dataPath} and @code{path}
712 elements name the Zip members that give the details of the tree.
713 The details are unexplored.
715 @node SPV Structure Path Elements
716 @subsection Path Elements
726 These element contain the name of the Zip members that hold details
727 for a container. For tables:
731 When a ``light'' format is used, only @code{dataPath} is present, and
732 it names a @file{.bin} member of the Zip file that has @code{light} in
733 its name, e.g.@: @code{0000000001437_lightTableData.bin} (@pxref{SPV
734 Light Detail Member Format}).
737 When the legacy format is used, both are present. In this case,
738 @code{dataPath} names a Zip member with a legacy binary format that
739 contains relevant data (@pxref{SPV Legacy Detail Member Binary
740 Format}), and @code{path} names a Zip member that uses an XML format
741 (@pxref{SPV Legacy Detail Member XML Format}).
744 Graphs normally follow the legacy approach described above. The
745 corpus contains one example of a graph with @code{path} but not
746 @code{dataPath}. The reason is unexplored.
748 Models use @code{path} but not @code{dataPath}. @xref{SPV Structure
749 graph Element}, for more information.
751 These elements have no attributes.
753 @node SPV Structure pageSetup Element
754 @subsection The @code{pageSetup} Element
758 :initial-page-number=int?
759 :chart-size=(as-is | full-height | half-height | quarter-height | OTHER)?
760 :margin-left=dimension?
761 :margin-right=dimension?
762 :margin-top=dimension?
763 :margin-bottom=dimension?
764 :paper-height=dimension?
765 :paper-width=dimension?
766 :reference-orientation?
767 :space-after=dimension?
768 => pageHeader pageFooter
770 pageHeader => pageParagraph?
772 pageFooter => pageParagraph?
774 pageParagraph => pageParagraph_text
777 The @code{pageSetup} element has the following attributes.
779 @defvr {Attribute} @code{initial-page-number}
780 The page number to put on the first page of printed output. Usually
784 @defvr {Attribute} @code{chart-size}
785 One of the listed, self-explanatory chart sizes,
786 @code{quarter-height}, or a localization (!) of one of these (e.g.@:
787 @code{dimensione attuale}, @code{Wie vorgegeben}).
790 @defvr {Attribute} @code{margin-left}
791 @defvrx {Attribute} @code{margin-right}
792 @defvrx {Attribute} @code{margin-top}
793 @defvrx {Attribute} @code{margin-bottom}
794 Margin sizes, e.g.@: @code{0.25in}.
797 @defvr {Attribute} @code{paper-height}
798 @defvrx {Attribute} @code{paper-width}
802 @defvr {Attribute} @code{reference-orientation}
803 Indicates the orientation of the output page. Either @code{0deg}
804 (portrait) or @code{90deg} (landscape),
807 @defvr {Attribute} @code{space-after}
808 The amount of space between printed objects, typically @code{12pt}.
811 @node SPV Structure @code{text} Element (Inside @code{pageParagraph})
812 @subsection The @code{text} Element (Inside @code{pageParagraph})
815 text[pageParagraph_text] :type=(title | text) => TEXT
818 This @code{text} element is nested inside a @code{pageParagraph}. There
819 is a different @code{text} element that is nested inside a
822 The element is either empty, or contains CDATA that holds almost-XHTML
823 text: in the corpus, either an @code{html} or @code{p} element. It is
824 @emph{almost}-XHTML because the @code{html} element designates the
826 @indicateurl{http://xml.spss.com/spss/viewer/viewer-tree} instead of
827 an XHTML namespace, and because the CDATA can contain substitution
828 variables. The following variables are supported:
833 The current date or time in the preferred format for the locale.
839 First-, second-, third-, or fourth-level heading.
845 Name of the output file.
851 @code{&[Page]} for the page number and @code{&[PageTitle]} for the
854 Typical contents (indented for clarity):
857 <html xmlns="http://xml.spss.com/spss/viewer/viewer-tree">
860 <p style="text-align:right; margin-top: 0">Page &[Page]</p>
865 This element has the following attributes.
867 @defvr {Attribute} @code{type}
871 @node SPV Light Detail Member Format
872 @section Light Detail Member Format
874 This section describes the format of ``light'' detail @file{.bin}
875 members. These members have a binary format which we describe here in
876 terms of a context-free grammar using the following conventions:
879 @item NonTerminal @result{} @dots{}
880 Nonterminals have CamelCaps names, and @result{} indicates a
881 production. The right-hand side of a production is often broken
882 across multiple lines. Break points are chosen for aesthetics only
883 and have no semantic significance.
885 @item 00, 01, @dots{}, ff.
886 A bytes with a fixed value, written as a pair of hexadecimal digits.
888 @item i0, i1, @dots{}, i9, i10, i11, @dots{}
889 @itemx ib0, ib1, @dots{}, ib9, ib10, ib11, @dots{}
890 A 32-bit integer in little-endian or big-endian byte order,
891 respectively, with a fixed value, written in decimal. Prefixed by
892 @samp{i} for little-endian or @samp{ib} for big-endian.
898 A byte with value 0 or 1.
902 A 16-bit unsigned integer in little-endian or big-endian byte order,
907 A 32-bit unsigned integer in little-endian or big-endian byte order,
912 A 64-bit unsigned integer in little-endian or big-endian byte order,
916 A 64-bit IEEE floating-point number.
919 A 32-bit IEEE floating-point number.
923 A 32-bit unsigned integer, in little-endian or big-endian byte order,
924 respectively, followed by the specified number of bytes of UTF-8
925 encoded character data.
928 @var{x} is optional, e.g.@: 00? is an optional zero byte.
930 @item @var{x}*@var{n}
931 @var{x} is repeated @var{n} times, e.g.@: byte*10 for ten arbitrary bytes.
933 @item @var{x}[@var{name}]
934 Gives @var{x} the specified @var{name}. Names are used in textual
935 explanations. They are also used, also bracketed, to indicate counts,
936 e.g.@: @code{int32[n] byte*[n]} for a 32-bit integer followed by the
937 specified number of arbitrary bytes.
939 @item @var{a} @math{|} @var{b}
940 Either @var{a} or @var{b}.
943 Parentheses are used for grouping to make precedence clear, especially
944 in the presence of @math{|}, e.g.@: in 00 (01 @math{|} 02 @math{|} 03)
948 @itemx becount(@var{x})
949 A 32-bit unsigned integer, in little-endian or big-endian byte order,
950 respectively, that indicates the number of bytes in @var{x}, followed
954 In a version 1 @file{.bin} member, @var{x}; in version 3, nothing.
955 (The @file{.bin} header indicates the version.)
958 In a version 3 @file{.bin} member, @var{x}; in version 1, nothing.
961 PSPP uses this grammar to parse light detail members. See
962 @file{src/output/spv/light-binary.grammar} in the PSPP source tree for
965 Little-endian byte order is far more common in this format, but a few
966 pieces of the format use big-endian byte order.
968 Light detail members express linear units in two ways: points (pt), at
969 72/inch, and ``device-independent pixels'' (px), at 96/inch. To
970 convert from pt to px, multiply by 1.33 and round up. To convert
971 from px to pt, divide by 1.33 and round down.
973 A ``light'' detail member @file{.bin} consists of a number of sections
974 concatenated together, terminated by an optional byte 01:
978 Header Titles Footnotes
979 Areas Borders PrintSettings TableSettings Formats
980 Dimensions Axes Cells
984 The following sections go into more detail.
987 * SPV Light Member Header::
988 * SPV Light Member Titles::
989 * SPV Light Member Footnotes::
990 * SPV Light Member Areas::
991 * SPV Light Member Borders::
992 * SPV Light Member Print Settings::
993 * SPV Light Member Table Settings::
994 * SPV Light Member Formats::
995 * SPV Light Member Dimensions::
996 * SPV Light Member Categories::
997 * SPV Light Member Axes::
998 * SPV Light Member Cells::
999 * SPV Light Member Value::
1000 * SPV Light Member ValueMod::
1003 @node SPV Light Member Header
1006 An SPV light member begins with a 39-byte header:
1011 (i1 @math{|} i3)[version]
1014 bool[rotate-inner-column-labels]
1015 bool[rotate-outer-row-labels]
1018 int32[min-col-width] int32[max-col-width]
1019 int32[min-row-width] int32[max-row-width]
1023 @code{version} is a version number that affects the interpretation of
1024 some of the other data in the member. We will refer to ``version 1''
1025 and ``version 3'' later on and use v1(@dots{}) and v3(@dots{}) for
1026 version-specific formatting (as described previously).
1028 If @code{rotate-inner-column-labels} is 1, then column labels closest
1029 to the data are rotated 90° counterclockwise; otherwise, they are
1030 shown in the normal way.
1032 If @code{rotate-outer-row-labels} is 1, then row labels farthest from
1033 the data are rotated 90° counterclockwise; otherwise, they are shown
1036 @code{min-col-width} is the minimum width that a column will be
1037 assigned automatically. @code{max-col-width} is the maximum width
1038 that a column will be assigned to accommodate a long column label.
1039 @code{min-row-width} and @code{max-row-width} are a similar range for
1040 the width of row labels. All of these measurements are in 1/96 inch
1041 units (called a ``device independent pixel'' unit in Windows).
1043 @code{table-id} is a binary version of the @code{tableId} attribute in
1044 the structure member that refers to the detail member. For example,
1045 if @code{tableId} is @code{-4122591256483201023}, then @code{table-id}
1046 would be 0xc6c99d183b300001.
1048 The meaning of the other variable parts of the header is not known. A
1049 writer may safely use version 3, true for @code{x0}, false for
1050 @code{x1}, true for @code{x2}, and 0x15 for @code{x3}.
1052 @node SPV Light Member Titles
1058 Value[subtype] 01? 31
1059 Value[user-title] 01?
1060 (31 Value[corner-text] @math{|} 58)
1061 (31 Value[caption] @math{|} 58)
1064 The Titles follow the Header and specify the table's title, caption,
1067 The @code{user-title} reflects any user
1068 editing of the title text or style. The @code{title} is the title
1069 originally generated by the procedure. Both of these are appropriate
1070 for presentation and localized to the user's language. For example,
1071 for a frequency table, @code{title} and @code{user-title} normally
1072 name the variable and @code{c} is simply ``Frequencies''.
1074 @code{subtype} is the same as the @code{subType} attribute in the
1075 @code{table} structure XML element that referred to this member.
1076 @xref{SPV Structure table Element}, for details.
1078 The @code{corner-text}, if present, is shown in the upper-left corner
1079 of the table, above the row headings and to the left of the column
1080 headings. It is usually absent. When row dimension labels are
1081 displayed in the corner (see @code{show-row-labels-in-corner}), corner
1084 The @code{caption}, if present, is shown below the table.
1085 @code{caption} reflects user editing of the caption.
1087 @node SPV Light Member Footnotes
1088 @subsection Footnotes
1091 Footnotes => int32[n-footnotes] Footnote*[n-footnotes]
1092 Footnote => Value[text] (58 @math{|} 31 Value[marker]) int32[show]
1095 Each footnote has @code{text} and an optional custom @code{marker}
1098 The syntax for Value would allow footnotes (and their markers) to
1099 reference other footnotes, but in practice this doesn't work.
1101 @code{show} is a 32-bit signed integer. It is positive to show the
1102 footnote or negative to hide it. Its magnitude is often 1, and in
1103 other cases tends to be the number of references to the footnote.
1105 @node SPV Light Member Areas
1112 string[typeface] float[size] int32[style] bool[underline]
1113 int32[halign] int32[valign]
1114 string[fg-color] string[bg-color]
1115 bool[alternate] string[alt-fg-color] string[alt-bg-color]
1116 v3(int32[left-margin] int32[right-margin] int32[top-margin] int32[bottom-margin])
1119 Each Area represents the style for a different area of the table, in
1120 the following order: title, caption, footer, corner, column labels,
1121 row labels, data, and layers.
1123 @code{index} is the 1-based index of the Area, i.e.@: 1 for the first
1124 Area, through 8 for the final Area.
1126 @code{typeface} is the string name of the font used in the area. In
1127 the corpus, this is @code{SansSerif} in over 99% of instances and
1128 @code{Times New Roman} in the rest.
1130 @code{size} is the size of the font, in px (@pxref{SPV Light Detail
1131 Member Format}). The most common size in the corpus is 12 px. Even
1132 though @code{size} has a floating-point type, in the corpus its values
1133 are always integers.
1135 @code{style} is a bit mask. Bit 0 (with value 1) is set for bold, bit
1136 1 (with value 2) is set for italic.
1138 @code{underline} is 1 if the font is underlined, 0 otherwise.
1140 @code{halign} specifies horizontal alignment: 0 for center, 2 for
1141 left, 4 for right, 61453 for decimal, 64173 for mixed. Mixed
1142 alignment varies according to type: string data is left-justified,
1143 numbers and most other formats are right-justified.
1145 @code{valign} specifies vertical alignment: 0 for center, 1 for top, 3
1148 @code{fg-color} and @code{bg-color} are the foreground color and
1149 background color, respectively. In the corpus, these are always
1150 @code{#000000} and @code{#ffffff}, respectively.
1152 @code{alternate} is 1 if rows should alternate colors, 0 if all rows
1153 should be the same color. When @code{alternate} is 1,
1154 @code{alt-fg-color} and @code{alt-bg-color} specify the colors for the
1155 alternate rows; otherwise they are empty strings.
1157 @code{left-margin}, @code{right-margin}, @code{top-margin}, and
1158 @code{bottom-margin} are measured in px.
1160 @node SPV Light Member Borders
1167 be32[n-borders] Border*[n-borders]
1168 bool[show-grid-lines]
1177 The Borders reflect how borders between regions are drawn.
1179 The fixed value of @code{endian} can be used to validate the
1182 @code{show-grid-lines} is 1 to draw grid lines, otherwise 0.
1184 Each Border describes one kind of border. @code{n-borders} seems to
1185 always be 19. Each @code{border-type} appears once (although in an
1186 unpredictable order) and correspond to the following borders:
1192 Left, top, right, and bottom outer frame.
1194 Left, top, right, and bottom inner frame.
1196 Left and top of data area.
1198 Horizontal and vertical dimension rows.
1200 Horizontal and vertical dimension columns.
1202 Horizontal and vertical category rows.
1204 Horizontal and vertical category columns.
1207 @code{stroke-type} describes how a border is drawn, as one of:
1224 @code{color} is an RGB color. Bits 24--31 are alpha, bits 16--23 are
1225 red, 8--15 are green, 0--7 are blue. An alpha of 255 indicates an
1226 opaque color, therefore opaque black is 0xff000000.
1228 @node SPV Light Member Print Settings
1229 @subsection Print Settings
1236 bool[paginate-layers]
1239 bool[top-continuation]
1240 bool[bottom-continuation]
1241 be32[n-orphan-lines]
1242 bestring[continuation-string])
1245 The PrintSettings reflect settings for printing. The fixed value of
1246 @code{endian} can be used to validate the endianness.
1248 @code{all-layers} is 1 to print all layers, 0 to print only the layer
1249 designated by @code{current-layer} in TableSettings (@pxref{SPV Light
1250 Member Table Settings}).
1252 @code{paginate-layers} is 1 to print each layer at the start of a new
1253 page, 0 otherwise. (This setting is honored only @code{all-layers} is
1254 1, since otherwise only one layer is printed.)
1256 @code{fit-width} and @code{fit-length} control whether the table is
1257 shrunk to fit within a page's width or length, respectively.
1259 @code{n-orphan-lines} is the minimum number of rows or columns to put
1260 in one part of a table that is broken across pages.
1262 If @code{top-continuation} is 1, then @code{continuation-string} is
1263 printed at the top of a page when a table is broken across pages for
1264 printing; similarly for @code{bottom-continuation} and the bottom of a
1265 page. Usually, @code{continuation-string} is empty.
1267 @node SPV Light Member Table Settings
1268 @subsection Table Settings
1278 bool[show-row-labels-in-corner]
1279 bool[show-alphabetic-markers]
1280 bool[footnote-marker-superscripts]
1283 Breakpoints[row-breaks] Breakpoints[column-breaks]
1284 Keeps[row-keeps] Keeps[column-keeps]
1285 PointKeeps[row-point-keeps] PointKeeps[column-point-keeps]
1288 bestring[table-look]
1291 Breakpoints => be32[n-breaks] be32*[n-breaks]
1293 Keeps => be32[n-keeps] Keep*[n-keeps]
1294 Keep => be32[offset] be32[n]
1296 PointKeeps => be32[n-point-keeps] PointKeep*[n-point-keeps]
1297 PointKeep => be32[offset] be32 be32
1300 The TableSettings reflect display settings. The fixed value of
1301 @code{endian} can be used to validate the endianness.
1303 @code{current-layer} is the displayed layer. The interpretation when
1304 there is more than one layer dimension is not yet known.
1306 If @code{omit-empty} is 1, empty rows or columns (ones with nothing in
1307 any cell) are hidden; otherwise, they are shown.
1309 If @code{show-row-labels-in-corner} is 1, then row labels are shown in
1310 the upper left corner; otherwise, they are shown nested.
1312 If @code{show-alphabetic-markers} is 1, markers are shown as letters
1313 (e.g.@: @samp{a}, @samp{b}, @samp{c}, @dots{}); otherwise, they are
1314 shown as numbers starting from 1.
1316 When @code{footnote-marker-superscripts} is 1, footnote markers are shown
1317 as superscripts, otherwise as subscripts.
1319 The Breakpoints are rows or columns after which there is a page break;
1320 for example, a row break of 1 requests a page break after the second
1321 row. Usually no breakpoints are specified, indicating that page
1322 breaks should be selected automatically.
1324 The Keeps are ranges of rows or columns to be kept together without a
1325 page break; for example, a row Keep with @code{offset} 1 and @code{n}
1326 10 requests that the 10 rows starting with the second row be kept
1327 together. Usually no Keeps are specified.
1329 The PointKeeps seem to be generated automatically based on
1330 user-specified Keeps. They seems to indicate a conversion from rows
1331 or columns to pixel or point offsets.
1333 @code{notes} is a text string that contains user-specified notes. It
1334 is displayed when the user hovers the cursor over the table, like text
1335 in the @code{title} attribute in HTML@. It is not printed. It is
1338 @code{table-look} is the name of a SPSS ``TableLook'' table style,
1339 such as ``Default'' or ``Academic''; it is often empty.
1341 TableSettings ends with an arbitrary number of null bytes. A writer
1342 may safely write 82 null bytes.
1344 A writer may safely use 4 for @code{x5} and 0 for @code{x6}.
1346 @node SPV Light Member Formats
1351 int32[n-widths] int32*[n-widths]
1353 int32[current-layer]
1354 bool[x7] bool[x8] bool[x9]
1359 v3(count(X1 count(X2)) count(X3)))
1360 Y0 => int32[epoch] byte[decimal] byte[grouping]
1361 CustomCurrency => int32[n-ccs] string*[n-ccs]
1364 If @code{n-widths} is nonzero, then the accompanying integers are
1365 column widths as manually adjusted by the user.
1367 @code{locale} is a locale including an encoding, such as
1368 @code{en_US.windows-1252} or @code{it_IT.windows-1252}. The encoding
1369 string (like other strings in the member) is encoded in UTF-8.
1371 @code{epoch} is the year that starts the epoch. A 2-digit year is
1372 interpreted as belonging to the 100 years beginning at the epoch. The
1373 default epoch year is 69 years prior to the current year; thus, in
1374 2017 this field by default contains 1948. In the corpus, @code{epoch}
1375 ranges from 1943 to 1948, plus some contain -1.
1377 @code{decimal} is the decimal point character. The observed values
1378 are @samp{.} and @samp{,}.
1380 @code{grouping} is the grouping character. Usually, it is @samp{,} if
1381 @code{decimal} is @samp{.}, and vice versa. Other observed values are
1382 @samp{'} (apostrophe), @samp{ } (space), and zero (presumably
1383 indicating that digits should not be grouped).
1385 @code{n-ccs} is observed as either 0 or 5. When it is 5, the
1386 following strings are CCA through CCE format strings. @xref{Custom
1387 Currency Formats,,, pspp, PSPP}. Most commonly these are all
1388 @code{-,,,} but other strings occur.
1390 A writer may safely use false for @code{x7}, @code{x8}, and @code{x9}.
1394 X0 only appears, optionally, in version 1 members.
1399 string[command] string[command-local]
1400 string[language] string[charset] string[locale]
1403 Y2 => CustomCurrency byte[missing] bool[x17]
1406 @code{command} describes the statistical procedure that generated the
1407 output, in English. It is not necessarily the literal syntax name of
1408 the procedure: for example, NPAR TESTS becomes ``Nonparametric
1409 Tests.'' @code{command-local} is the procedure's name, translated
1410 into the output language; it is often empty and, when it is not,
1411 sometimes the same as @code{command}.q
1413 @code{missing} is the character used to indicate that a cell contains
1414 a missing value. It is always observed as @samp{.}.
1416 A writer may safely use false for @code{x17}.
1420 X1 only appears in version 3 members.
1428 byte[show-variables]
1430 int32[x18] int32[x19]
1436 @code{lang} may indicate the language in use. Some values seem to be
1437 0: @t{en}, 1: @t{de}, 2: @t{es}, 3: @t{it}, 5: @t{ko}, 6: @t{pl}, 8:
1438 @t{zh-tw}, 10: @t{pt_BR}, 11: @t{fr}. The @code{locale} in Formats
1439 and the @code{language}, @code{charset}, and @code{locale} in X0 are
1440 more likely to be useful in practice.
1442 @code{show-variables} determines how variables are displayed by
1443 default. A value of 1 means to display variable names, 2 to display
1444 variable labels when available, 3 to display both (name followed by
1445 label, separated by a space). The most common value is 0, which
1446 probably means to use a global default.
1448 @code{show-values} is a similar setting for values. A value of 1
1449 means to display the value, 2 to display the value label when
1450 available, 3 to display both. Again, the most common value is 0,
1451 which probably means to use a global default.
1453 @code{show-title} is 1 to show the caption, 10 to hide it.
1455 @code{show-caption} is true to show the caption, false to hide it.
1457 A writer may safely use false for @code{x14}, false for @code{x16}, 0
1458 for @code{lang}, -1 for @code{x18} and @code{x19}, and false for
1463 X2 only appears in version 3 members.
1467 int32[n-row-heights] int32*[n-row-heights]
1468 int32[n-style-map] StyleMap*[n-style-map]
1469 int32[n-styles] StylePair*[n-styles]
1471 StyleMap => int64[cell-index] int16[style-index]
1474 If present, @code{n-row-heights} and the accompanying integers are row
1475 heights as manually adjusted by the user.
1477 The rest of X2 specifies styles for data cells. At first glance this
1478 is odd, because each data cell can have its own style embedded as part
1479 of the data, but in practice X2 specifies a style for a cell only if
1480 that cell is empty (and thus does not appear in the data at all).
1481 Each StyleMap specifies the index of a blank cell, calculated the same
1482 was as in the Cells (@pxref{SPV Light Member Cells}), along with a
1483 0-based index into the accompanying StylePair array.
1485 A writer may safely omit the optional @code{i0 i0} inside the
1486 @code{count(@dots{})}.
1490 X3 only appears in version 3 members.
1494 01 00 byte[x21] 00 00 00
1497 (string[dataset] string[datafile] i0 int32[date] i0)?
1502 @code{small} is a small real number. In the corpus, it overwhelmingly
1503 takes the value 0.0001, with zero occasionally seen. Nonzero numbers
1504 with format 40 (@pxref{SPV Light Member Value}) whose magnitudes are
1505 smaller than displayed in scientific notation. (Thus, a @code{small}
1506 of zero prevents scientific notation from being chosen.)
1508 @code{dataset} is the name of the dataset analyzed to produce the
1509 output, e.g.@: @code{DataSet1}, and @code{datafile} the name of the
1510 file it was read from, e.g.@: @file{C:\Users\foo\bar.sav}. The latter
1511 is sometimes the empty string.
1513 @code{date} is a date, as seconds since the epoch, i.e.@: since
1514 January 1, 1970. Pivot tables within an SPV file often have dates a
1515 few minutes apart, so this is probably a creation date for the table
1516 rather than for the file.
1518 Sometimes @code{dataset}, @code{datafile}, and @code{date} are present
1519 and other times they are absent. The reader can distinguish by
1520 assuming that they are present and then checking whether the
1521 presumptive @code{dataset} contains a null byte (a valid string never
1524 @code{x22} is usually 0 or 2000000.
1526 A writer may safely use 4 for @code{x21} and omit @code{x22} and the
1527 other optional bytes at the end.
1529 @node SPV Light Member Dimensions
1530 @subsection Dimensions
1532 A pivot table presents multidimensional data. A Dimension identifies
1533 the categories associated with each dimension.
1536 Dimensions => int32[n-dims] Dimension*[n-dims]
1538 Value[name] DimProperties
1539 int32[n-categories] Category*[n-categories]
1544 bool[hide-dim-label]
1545 bool[hide-all-labels]
1549 @code{name} is the name of the dimension, e.g.@: @code{Variables},
1550 @code{Statistics}, or a variable name.
1552 The meanings of @code{x1} and @code{x3} are unknown. @code{x1} is
1553 usually 0 but many other values have been observed. A writer may
1554 safely use 0 for @code{x1} and 2 for @code{x3}.
1556 @code{x2} is 0, 1, or 2. For a pivot table with @var{L} layer
1557 dimensions, @var{R} row dimensions, and @var{C} column dimensions,
1558 @code{x2} is 2 for the first @var{L} dimensions, 0 for the next
1559 @var{R} dimensions, and 1 for the remaining @var{C} dimensions. This
1560 does not mean that the layer dimensions must be presented first,
1561 followed by the row dimensions, followed by the column dimensions---on
1562 the contrary, they are frequently in a different order---but @code{x2}
1563 must follow this pattern to prevent the pivot table from being
1566 If @code{hide-dim-label} is 00, the pivot table displays a label for
1567 the dimension itself. Because usually the group and category labels
1568 are enough explanation, it is usually 01.
1570 If @code{hide-all-labels} is 01, the pivot table omits all labels for
1571 the dimension, including group and category labels. It is usually 00.
1572 When @code{hide-all-labels} is 01, @code{show-dim-label} is ignored.
1574 @code{dim-index} is usually the 0-based index of the dimension, e.g.@:
1575 0 for the first dimension, 1 for the second, and so on. Sometimes it
1576 is -1. There is no visible difference. A writer may safely use the
1579 @node SPV Light Member Categories
1580 @subsection Categories
1582 Categories are arranged in a tree. Only the leaf nodes in the tree
1583 are really categories; the others just serve as grouping constructs.
1586 Category => Value[name] (Leaf @math{|} Group)
1587 Leaf => 00 00 00 i2 int32[leaf-index] i0
1589 bool[merge] 00 01 int32[x23]
1590 i-1 int32[n-subcategories] Category*[n-subcategories]
1593 @code{name} is the name of the category (or group).
1595 A Leaf represents a leaf category. The Leaf's @code{leaf-index} is a
1596 nonnegative integer unique within the Dimension and less than
1597 @code{n-categories} in the Dimension. If the user does not sort or
1598 rearrange the categories, then @code{leaf-index} starts at 0 for the
1599 first Leaf in the dimension and increments by 1 with each successive
1600 Leaf. If the user does sorts or rearrange the categories, then the
1601 order of categories in the file reflects that change and
1602 @code{leaf-index} reflects the original order.
1604 A dimension can have no leaf categories at all. A table that
1605 contains such a dimension necessarily has no data at all.
1607 A Group is a group of nested categories. Usually a Group contains at
1608 least one Category, so that @code{n-subcategories} is positive, but
1609 Groups with zero subcategories have been observed.
1611 If a Group's @code{merge} is 00, the most common value, then the group
1612 is really a distinct group that should be represented as such in the
1613 visual representation and user interface. If @code{merge} is 01, the
1614 categories in this group should be shown and treated as if they were
1615 direct children of the group's containing group (or if it has no
1616 parent group, then direct children of the dimension), and this group's
1617 name is irrelevant and should not be displayed. (Merged groups can be
1620 Writers need not use merged groups.
1622 A Group's @code{x23} appears to be i2 when all of the categories
1623 within a group are leaf categories that directly represent data values
1624 for a variable (e.g.@: in a frequency table or crosstabulation, a group
1625 of values in a variable being tabulated) and i0 otherwise. A writer
1626 may safely write a constant 0 in this field.
1628 @node SPV Light Member Axes
1631 After the dimensions come assignment of each dimension to one of the
1632 axes: layers, rows, and columns.
1636 int32[n-layers] int32[n-rows] int32[n-columns]
1637 int32*[n-layers] int32*[n-rows] int32*[n-columns]
1640 The values of @code{n-layers}, @code{n-rows}, and @code{n-columns}
1641 each specifies the number of dimensions displayed in layers, rows, and
1642 columns, respectively. Any of them may be zero. Their values sum to
1643 @code{n-dimensions} from Dimensions (@pxref{SPV Light Member
1646 The following @code{n-dimensions} integers, in three groups, are a
1647 permutation of the 0-based dimension numbers. The first
1648 @code{n-layers} integers specify each of the dimensions represented by
1649 layers, the next @code{n-rows} integers specify the dimensions
1650 represented by rows, and the final @code{n-columns} integers specify
1651 the dimensions represented by columns. When there is more than one
1652 dimension of a given kind, the inner dimensions are given first.
1654 @node SPV Light Member Cells
1657 The final part of an SPV light member contains the actual data.
1660 Cells => int32[n-cells] Cell*[n-cells]
1661 Cell => int64[index] v1(00?) Value
1664 A Cell consists of an @code{index} and a Value. Suppose there are
1665 @math{d} dimensions, numbered 1 through @math{d} in the order given in
1666 the Dimensions previously, and that dimension @math{i} has @math{n_i}
1667 categories. Consider the cell at coordinates @math{x_i}, @math{1 \le
1668 i \le d}, and note that @math{0 \le x_i < n_i}. Then the index is
1669 calculated by the following algorithm:
1673 for each @math{i} from 1 to @math{d}:
1674 @i{index} = (@math{n_i \times} @i{index}) @math{+} @math{x_i}
1677 For example, suppose there are 3 dimensions with 3, 4, and 5
1678 categories, respectively. The cell at coordinates (1, 2, 3) has
1679 index @math{5 \times (4 \times (3 \times 0 + 1) + 2) + 3 = 33}.
1680 Within a given dimension, the index is the @code{leaf-index} in a Leaf.
1682 @node SPV Light Member Value
1685 Value is used throughout the SPV light member format. It boils down
1686 to a number or a string.
1689 Value => 00? 00? 00? 00? RawValue
1691 01 ValueMod int32[format] double[x]
1692 @math{|} 02 ValueMod int32[format] double[x]
1693 string[var-name] string[value-label] byte[show]
1694 @math{|} 03 string[local] ValueMod string[id] string[c] bool[fixed]
1695 @math{|} 04 ValueMod int32[format] string[value-label] string[var-name]
1696 byte[show] string[s]
1697 @math{|} 05 ValueMod string[var-name] string[var-label] byte[show]
1698 @math{|} 06 string[local] ValueMod string[id] string[c]
1699 @math{|} ValueMod string[template] int32[n-args] Argument*[n-args]
1702 @math{|} int32[x] i0 Value*[x] /* x > 0 */
1705 There are several possible encodings, which one can distinguish by the
1706 first nonzero byte in the encoding.
1710 The numeric value @code{x}, intended to be presented to the user
1711 formatted according to @code{format}, which is about the same as the
1712 format described for system files (@pxref{System File Output
1713 Formats}). The exception is that format 40 is not MTIME but instead
1714 approximately a synonym for F format with a different rule for whether
1715 a value is shown in scientific notation: a value in format 40 is shown
1716 in scientific notation if and only if it is nonzero and its magnitude
1717 is less than @code{small} (@pxref{SPV Light Member Formats}).
1719 Most commonly, @code{format} has width 40 (the maximum).
1721 An @code{x} with the maximum negative double value @code{-DBL_MAX}
1722 represents the system-missing value SYSMIS. (HIGHEST and LOWEST have
1723 not been observed.) See @ref{System File Format}, for more about
1724 these special values.
1727 Similar to @code{01}, with the additional information that @code{x} is
1728 a value of variable @code{var-name} and has value label
1729 @code{value-label}. Both @code{var-name} and @code{value-label} can
1730 be the empty string, the latter very commonly.
1732 @code{show} determines whether to show the numeric value or the value
1733 label. A value of 1 means to show the value, 2 to show the label, 3
1734 to show both, and 0 means to use the default specified in
1735 @code{show-values} (@pxref{SPV Light Member Formats}).
1738 A text string, in two forms: @code{c} is in English, and sometimes
1739 abbreviated or obscure, and @code{local} is localized to the user's
1740 locale. In an English-language locale, the two strings are often the
1741 same, and in the cases where they differ, @code{local} is more
1742 appropriate for a user interface, e.g.@: @code{c} of ``Not a PxP table
1743 for MCN...'' versus @code{local} of ``Computed only for a PxP table,
1744 where P must be greater than 1.''
1746 @code{c} and @code{local} are always either both empty or both
1749 @code{id} is a brief identifying string whose form seems to resemble a
1750 programming language identifier, e.g.@: @code{cumulative_percent} or
1751 @code{factor_14}. It is not unique.
1753 @code{fixed} is 00 for text taken from user input, such as syntax
1754 fragment, expressions, file names, data set names, and 01 for fixed
1755 text strings such as names of procedures or statistics. In the former
1756 case, @code{id} is always the empty string; in the latter case,
1757 @code{id} is still sometimes empty.
1760 The string value @code{s}, intended to be presented to the user
1761 formatted according to @code{format}. The format for a string is not
1762 too interesting, and the corpus contains many clearly invalid formats
1763 like A16.39 or A255.127 or A134.1, so readers should probably entirely
1764 disregard the format. PSPP only checks @code{format} to distinguish
1767 @code{s} is a value of variable @code{var-name} and has value label
1768 @code{value-label}. @code{var-name} is never empty but
1769 @code{value-label} is commonly empty.
1771 @code{show} has the same meaning as in the encoding for 02.
1774 Variable @code{var-name} with variable label @code{var-label}. In the
1775 corpus, @code{var-name} is rarely empty and @code{var-label} is often
1778 @code{show} determines whether to show the variable name or the
1779 variable label. A value of 1 means to show the name, 2 to show the
1780 label, 3 to show both, and 0 means to use the default specified in
1781 @code{show-variables} (@pxref{SPV Light Member Formats}).
1784 Similar to type 03, with @code{fixed} assumed to be true.
1787 When the first byte of a RawValue is not one of the above, the
1788 RawValue starts with a ValueMod, whose syntax is described in the next
1789 section. (A ValueMod always begins with byte 31 or 58.)
1791 This case is a template string, analogous to @code{printf}, followed
1792 by one or more Arguments, each of which has one or more values. The
1793 template string is copied directly into the output except for the
1794 following special syntax,
1801 Each of these expands to the character following @samp{\\}, to escape
1802 characters that have special meaning in template strings. These are
1803 effective inside and outside the @code{[@dots{}]} syntax forms
1807 Expands to a new-line, inside or outside the @code{[@dots{}]} forms
1811 Expands to a formatted version of argument @var{i}, which must have
1812 only a single value. For example, @code{^1} expands to the first
1813 argument's @code{value}.
1815 @item [:@var{a}:]@var{i}
1816 Expands @var{a} for each of the values in @var{i}. @var{a}
1817 should contain one or more @code{^@var{j}} conversions, which are
1818 drawn from the values for argument @var{i} in order. Some examples
1823 All of the values for the first argument, concatenated.
1826 Expands to the values for the first argument, each followed by
1830 Expands to @code{@var{x} = @var{y}} where @var{x} is the second
1831 argument's first value and @var{y} is its second value. (This would
1832 be used only if the argument has two values. If there were more
1833 values, the second and third values would be directly concatenated,
1834 which would look funny.)
1837 @item [@var{a}:@var{b}:]@var{i}
1838 This extends the previous form so that the first values are expanded
1839 using @var{a} and later values are expanded using @var{b}. For an
1840 unknown reason, within @var{a} the @code{^@var{j}} conversions are
1841 instead written as @code{%@var{j}}. Some examples from the corpus:
1845 Expands to all of the values for the first argument, separated by
1848 @item [%1 = %2:, ^1 = ^2:]1
1849 Given appropriate values for the first argument, expands to @code{X =
1853 Given appropriate values, expands to @code{1, 2, 3}.
1857 The template string is localized to the user's locale.
1860 A writer may safely omit all of the optional 00 bytes at the beginning
1861 of a Value, except that it should write a single 00 byte before a
1864 @node SPV Light Member ValueMod
1865 @subsection ValueMod
1867 A ValueMod can specify special modifications to a Value.
1873 int32[n-refs] int16*[n-refs]
1874 int32[n-subscripts] string*[n-subscripts]
1875 v1(00 (i1 | i2) 00? 00? int32 00? 00?)
1876 v3(count(TemplateString StylePair))
1878 TemplateString => count((count((i0 (58 @math{|} 31 55))?) (58 @math{|} 31 string[id]))?)
1885 bool[bold] bool[italic] bool[underline] bool[show]
1886 string[fg-color] string[bg-color]
1887 string[typeface] byte[size]
1890 int32[halign] int32[valign] double[decimal-offset]
1891 int16[left-margin] int16[right-margin]
1892 int16[top-margin] int16[bottom-margin]
1895 A ValueMod that begins with ``31'' specifies special modifications to
1898 Each of the @code{n-refs} integers is a reference to a Footnote
1899 (@pxref{SPV Light Member Footnotes}) by 0-based index. Footnote
1900 markers are shown appended to the main text of the Value, as
1901 superscripts or subscripts.
1903 The @code{subscripts}, if present, are strings to append to the main
1904 text of the Value, as subscripts. Each subscript text is a brief
1905 indicator, e.g.@: @samp{a} or @samp{b}, with its meaning indicated by
1906 the table caption. When multiple subscripts are present, they are
1907 displayed separated by commas.
1909 The @code{id} inside the TemplateString, if present, is a template
1910 string for substitutions using the syntax explained previously. It
1911 appears to be an English-language version of the localized template
1912 string in the Value in which the Template is nested. A writer may
1913 safely omit the optional fixed data in TemplateString.
1915 FontStyle and CellStyle, if present, change the style for this
1916 individual Value. In FontStyle, @code{bold}, @code{italic}, and
1917 @code{underline} control the particular style. @code{show} is
1918 ordinarily 1; if it is 0, then the cell data is not shown.
1919 @code{fg-color} and @code{bg-color} are strings in the format
1920 @code{#rrggbb}, e.g.@: @code{#ff0000} for red or @code{#ffffff} for
1921 white. The empty string is occasionally observed also. The
1922 @code{size} is a font size in units of 1/128 inch.
1924 In CellStyle, @code{halign} is 0 for center, 2 for left, 4 for right,
1925 6 for decimal, 0xffffffad for mixed. For decimal alignment,
1926 @code{decimal-offset} is the decimal point's offset from the right
1927 side of the cell, in pt (@pxref{SPV Light Detail Member Format}).
1928 @code{valign} specifies vertical alignment: 0 for center, 1 for top, 3
1929 for bottom. @code{left-margin}, @code{right-margin},
1930 @code{top-margin}, and @code{bottom-margin} are in pt.
1932 @node SPV Legacy Detail Member Binary Format
1933 @section Legacy Detail Member Binary Format
1935 Whereas the light binary format represents everything about a given
1936 pivot table, the legacy binary format conceptually consists of a
1937 number of named sources, each of which consists of a number of named
1938 variables, each of which is a 1-dimensional array of numbers or
1939 strings or a mix. Thus, the legacy binary member format is quite
1942 This section uses the same context-free grammar notation as in the
1943 previous section, with the following additions:
1947 In a version 0xaf legacy member, @var{x}; in other versions, nothing.
1948 (The legacy member header indicates the version; see below.)
1951 In a version 0xb0 legacy member, @var{x}; in other versions, nothing.
1954 A legacy detail member @file{.bin} has the following overall format:
1958 00 byte[version] int16[n-sources] int32[member-size]
1959 Metadata*[n-sources]
1964 @code{version} is a version number that affects the interpretation of
1965 some of the other data in the member. Versions 0xaf and 0xb0 are
1966 known. We will refer to ``version 0xaf'' and ``version 0xb0'' members
1969 A legacy member consists of @code{n-sources} data sources, each of
1970 which has Metadata and Data.
1972 @code{member-size} is the size of the legacy binary member, in bytes.
1974 The Data and Strings above are commented out because the Metadata has
1975 some oddities that mean that the Data sometimes seems to start at
1976 an unexpected place. The following section goes into detail.
1979 * SPV Legacy Member Metadata::
1980 * SPV Legacy Member Numeric Data::
1981 * SPV Legacy Member String Data::
1984 @node SPV Legacy Member Metadata
1985 @subsection Metadata
1989 int32[n-values] int32[n-variables] int32[data-offset]
1990 vAF(byte*28[source-name])
1991 vB0(byte*64[source-name] int32[x])
1994 A data source has @code{n-variables} variables, each with
1995 @code{n-values} data values.
1997 @code{source-name} is a 28- or 64-byte string padded on the right with
1998 0-bytes. The names that appear in the corpus are very generic:
1999 usually @code{tableData} for pivot table data or @code{source0} for
2002 A given Metadata's @code{data-offset} is the offset, in bytes, from
2003 the beginning of the member to the start of the corresponding Data.
2004 This allows programs to skip to the beginning of the data for a
2005 particular source. In every case in the corpus, the Data follow the
2006 Metadata in the same order, but it is important to use
2007 @code{data-offset} instead of reading sequentially through the file
2008 because of the exception described below.
2010 One SPV file in the corpus has legacy binary members with version 0xb0
2011 but a 28-byte @code{source-name} field (and only a single source). In
2012 practice, this means that the 64-byte @code{source-name} used in
2013 version 0xb0 has a lot of 0-bytes in the middle followed by the
2014 @code{variable-name} of the following Data. As long as a reader
2015 treats the first 0-byte in the @code{source-name} as terminating the
2016 string, it can properly interpret these members.
2018 The meaning of @code{x} in version 0xb0 is unknown.
2020 @node SPV Legacy Member Numeric Data
2021 @subsection Numeric Data
2024 Data => Variable*[n-variables]
2025 Variable => byte*288[variable-name] double*[n-values]
2028 Data follow the Metadata in the legacy binary format, with sources in
2029 the same order (but readers should use the @code{data-offset} in
2030 Metadata records, rather than reading sequentially). Each Variable
2031 begins with a @code{variable-name} that generally indicates its role
2032 in the pivot table, e.g.@: ``cell'', ``cellFormat'',
2033 ``dimension0categories'', ``dimension0group0'', followed by the
2034 numeric data, one double per datum. A double with the maximum
2035 negative double @code{-DBL_MAX} represents the system-missing value
2038 @node SPV Legacy Member String Data
2039 @subsection String Data
2042 Strings => SourceMaps[maps] Labels
2044 SourceMaps => int32[n-maps] SourceMap*[n-maps]
2046 SourceMap => string[source-name] int32[n-variables] VariableMap*[n-variables]
2047 VariableMap => string[variable-name] int32[n-data] DatumMap*[n-data]
2048 DatumMap => int32[value-idx] int32[label-idx]
2050 Labels => int32[n-labels] Label*[n-labels]
2051 Label => int32[frequency] string[label]
2054 Each variable may include a mix of numeric and string data values. If
2055 a legacy binary member contains any string data, Strings is present;
2056 otherwise, it ends just after the last Data element.
2058 The string data overlays the numeric data. When a variable includes
2059 any string data, its Variable represents the string values with a
2060 SYSMIS or NaN placeholder. (Not all such values need be
2063 Each SourceMap provides a mapping between SYSMIS or NaN values in source
2064 @code{source-name} and the string data that they represent.
2065 @code{n-variables} is the number of variables in the source that
2066 include string data. More precisely, it is the 1-based index of the
2067 last variable in the source that includes any string data; thus, it
2068 would be 4 if there are 5 variables and only the fourth one includes
2071 A VariableMap repeats its variable's name, but variables are always
2072 present in the same order as the source, starting from the first
2073 variable, without skipping any even if they have no string values.
2074 Each VariableMap contains DatumMap nonterminals, each of which maps
2075 from a 0-based index within its variable's data to a 0-based label
2076 index, e.g.@: pair @code{value-idx} = 2, @code{label-idx} = 3, means
2077 that the third data value (which must be SYSMIS or NaN) is to be
2078 replaced by the string of the fourth Label.
2080 The labels themselves follow the pairs. The valuable part of each
2081 label is the string @code{label}. Each label also includes a
2082 @code{frequency} that reports the number of DatumMaps that reference
2083 it (although this is not useful).
2085 @node SPV Legacy Detail Member XML Format
2086 @section Legacy Detail Member XML Format
2088 The design of the detail XML format is not what one would end up with
2089 for describing pivot tables. This is because it is a special case
2090 of a much more general format (``visualization XML'' or ``VizML'')
2091 that can describe a wide range of visualizations. Most of this
2092 generality is overkill for tables, and so we end up with a funny
2093 subset of a general-purpose format.
2095 An XML Schema for VizML is available, distributed with SPSS binaries,
2096 under a nonfree license. It contains documentation that is
2097 occasionally helpful.
2099 This section describes the detail XML format using the same notation
2100 already used for the structure XML format (@pxref{SPV Structure Member
2101 Format}). See @file{src/output/spv/detail-xml.grammar} in the PSPP
2102 source tree for the full grammar that it uses for parsing.
2104 The important elements of the detail XML format are:
2108 Variables. @xref{SPV Detail Variable Elements}.
2111 Assignment of variables to axes. A variable can appear as columns, or
2112 rows, or layers. The @code{faceting} element and its sub-elements
2113 describe this assignment.
2116 Styles and other annotations.
2119 This description is not detailed enough to write legacy tables.
2120 Instead, write tables in the light binary format.
2123 * SPV Detail visualization Element::
2124 * SPV Detail Variable Elements::
2125 * SPV Detail extension Element::
2126 * SPV Detail graph Element::
2127 * SPV Detail location Element::
2128 * SPV Detail faceting Element::
2129 * SPV Detail facetLayout Element::
2130 * SPV Detail label Element::
2131 * SPV Detail setCellProperties Element::
2132 * SPV Detail setFormat Element::
2133 * SPV Detail interval Element::
2134 * SPV Detail style Element::
2135 * SPV Detail labelFrame Element::
2136 * SPV Detail Legacy Properties::
2139 @node SPV Detail visualization Element
2140 @subsection The @code{visualization} Element
2148 :style[style_ref]=ref style
2152 => visualization_extension?
2154 (sourceVariable | derivedVariable)+
2163 extension[visualization_extension]
2166 :minWidthSet=(true)?
2167 :maxWidthSet=(true)?
2170 userSource :missing=(listwise | pairwise)? => EMPTY
2172 categoricalDomain => variableReference simpleSort
2174 simpleSort :method[sort_method]=(custom) => categoryOrder
2176 container :style=ref style => container_extension? location+ labelFrame*
2178 extension[container_extension] :combinedFootnotes=(true) => EMPTY
2186 The @code{visualization} element is the root of detail XML member. It
2187 has the following attributes:
2189 @defvr {Attribute} creator
2190 The version of the software that created this SPV file, as a string of
2191 the form @code{xxyyzz}, which represents software version xx.yy.zz,
2192 e.g.@: @code{160001} is version 16.0.1. The corpus includes major
2193 versions 16 through 19.
2196 @defvr {Attribute} date
2197 The date on the which the file was created, as a string of the form
2201 @defvr {Attribute} lang
2202 The locale used for output, in Windows format, which is similar to the
2203 format used in Unix with the underscore replaced by a hyphen, e.g.@:
2204 @code{en-US}, @code{en-GB}, @code{el-GR}, @code{sr-Cryl-RS}.
2207 @defvr {Attribute} name
2208 The title of the pivot table, localized to the output language.
2211 @defvr {Attribute} style
2212 The base style for the pivot table. In every example in the corpus,
2213 the @code{style} element has no attributes other than @code{id}.
2216 @defvr {Attribute} type
2217 A floating-point number. The meaning is unknown.
2220 @defvr {Attribute} version
2221 The visualization schema version number. In the corpus, the value is
2222 one of 2.4, 2.5, 2.7, and 2.8.
2225 The @code{userSource} element has no visible effect.
2227 The @code{extension} element as a child of @code{visualization} has
2228 the following attributes.
2230 @defvr {Attribute} numRows
2231 An integer that presumably defines the number of rows in the displayed
2235 @defvr {Attribute} showGridline
2236 Always set to @code{false} in the corpus.
2239 @defvr {Attribute} minWidthSet
2240 @defvrx {Attribute} maxWidthSet
2241 Always set to @code{true} in the corpus.
2244 The @code{extension} element as a child of @code{container} has the
2247 @defvr {Attribute} combinedFootnotes
2251 The @code{categoricalDomain} and @code{simpleSort} elements have no
2254 The @code{layerController} element has no visible effect.
2256 @node SPV Detail Variable Elements
2257 @subsection Variable Elements
2259 A ``variable'' in detail XML is a 1-dimensional array of data. Each
2260 element of the array may, independently, have string or numeric
2261 content. All of the variables in a given detail XML member either
2262 have the same number of elements or have zero elements.
2264 Two different elements define variables and their content:
2267 @item sourceVariable
2268 These variables' data comes from the associated @code{tableData.bin}
2271 @item derivedVariable
2272 These variables are defined in terms of a mapping function from a
2273 source variable, or they are empty.
2276 A variable named @code{cell} always exists. This variable holds the
2277 data displayed in the table.
2279 Variables in detail XML roughly correspond to the dimensions in a
2280 light detail member. Each dimension has the following variables with
2281 stylized names, where @var{n} is a number for the dimension starting
2285 @item dimension@var{n}categories
2286 The dimension's leaf categories (@pxref{SPV Light Member Categories}).
2288 @item dimension@var{n}group0
2289 Present only if the dimension's categories are grouped, this variable
2290 holds the group labels for the categories. Grouping is inferred
2291 through adjacent identical labels. Categories that are not part of a
2292 group have empty-string data in this variable.
2294 @item dimension@var{n}group1
2295 Present only if the first-level groups are further grouped, this
2296 variable holds the labels for the second-level groups. There can be
2297 additional variables with further levels of grouping.
2299 @item dimension@var{n}
2303 Determining the data for a (non-empty) variable is a multi-step
2308 Draw initial data from its source, for a @code{sourceVariable}, or
2309 from another named variable, for a @code{derivedVariable}.
2312 Apply mappings from @code{valueMapEntry} elements within the
2313 @code{derivedVariable} element, if any.
2316 Apply mappings from @code{relabel} elements within a @code{format} or
2317 @code{stringFormat} element in the @code{sourceVariable} or
2318 @code{derivedVariable} element, if any.
2321 If the variable is a @code{sourceVariable} with a @code{labelVariable}
2322 attribute, and there were no mappings to apply in previous steps, then
2323 replace each element of the variable by the corresponding value in the
2327 A single variable's data can be modified in two of the steps, if both
2328 @code{valueMapEntry} and @code{relabel} are used. The following
2329 example from the corpus maps several integers to 2, then maps 2 in
2330 turn to the string ``Input'':
2333 <derivedVariable categorical="true" dependsOn="dimension0categories"
2334 id="dimension0group0map" value="map(dimension0group0)">
2336 <relabel from="2" to="Input"/>
2337 <relabel from="10" to="Missing Value Handling"/>
2338 <relabel from="14" to="Resources"/>
2339 <relabel from="0" to=""/>
2340 <relabel from="1" to=""/>
2341 <relabel from="13" to=""/>
2343 <valueMapEntry from="2;3;5;6;7;8;9" to="2"/>
2344 <valueMapEntry from="10;11" to="10"/>
2345 <valueMapEntry from="14;15" to="14"/>
2346 <valueMapEntry from="0" to="0"/>
2347 <valueMapEntry from="1" to="1"/>
2348 <valueMapEntry from="13" to="13"/>
2353 * SPV Detail sourceVariable Element::
2354 * SPV Detail derivedVariable Element::
2355 * SPV Detail valueMapEntry Element::
2358 @node SPV Detail sourceVariable Element
2359 @subsubsection The @code{sourceVariable} Element
2366 :domain=ref categoricalDomain?
2368 :dependsOn=ref sourceVariable?
2370 :labelVariable=ref sourceVariable?
2371 => variable_extension* (format | stringFormat)?
2374 This element defines a variable whose data comes from the
2375 @file{tableData.bin} member that corresponds to this @file{.xml}.
2377 This element has the following attributes.
2379 @defvr {Attribute} id
2380 An @code{id} is always present because this element exists to be
2381 referenced from other elements.
2384 @defvr {Attribute} categorical
2385 Always set to @code{true}.
2388 @defvr {Attribute} source
2389 Always set to @code{tableData}, the @code{source-name} in the
2390 corresponding @file{tableData.bin} member (@pxref{SPV Legacy Member
2394 @defvr {Attribute} sourceName
2395 The name of a variable within the source, corresponding to the
2396 @code{variable-name} in the @file{tableData.bin} member (@pxref{SPV
2397 Legacy Member Numeric Data}).
2400 @defvr {Attribute} label
2401 The variable label, if any.
2404 @defvr {Attribute} labelVariable
2405 The @code{variable-name} of a variable whose string values correspond
2406 one-to-one with the values of this variable and are suitable for use
2410 @defvr {Attribute} dependsOn
2411 This attribute doesn't affect the display of a table.
2414 @node SPV Detail derivedVariable Element
2415 @subsubsection The @code{derivedVariable} Element
2422 :dependsOn=ref sourceVariable?
2423 => variable_extension* (format | stringFormat)? valueMapEntry*
2426 Like @code{sourceVariable}, this element defines a variable whose
2427 values can be used elsewhere in the visualization. Instead of being
2428 read from a data source, the variable's data are defined by a
2429 mathematical expression.
2431 This element has the following attributes.
2433 @defvr {Attribute} id
2434 An @code{id} is always present because this element exists to be
2435 referenced from other elements.
2438 @defvr {Attribute} categorical
2439 Always set to @code{true}.
2442 @defvr {Attribute} value
2443 An expression that defines the variable's value. In theory this could
2444 be an arbitrary expression in terms of constants, functions, and other
2445 variables, e.g.@: @math{(@var{var1} + @var{var2}) / 2}. In practice,
2446 the corpus contains only the following forms of expressions:
2450 @itemx constant(@var{variable})
2451 All zeros. The reason why a variable is sometimes named is unknown.
2452 Sometimes the ``variable name'' has spaces in it.
2454 @item map(@var{variable})
2455 Transforms the values in the named @var{variable} using the
2456 @code{valueMapEntry}s contained within the element.
2460 @defvr {Attribute} dependsOn
2461 This attribute doesn't affect the display of a table.
2464 @node SPV Detail valueMapEntry Element
2465 @subsubsection The @code{valueMapEntry} Element
2468 valueMapEntry :from :to => EMPTY
2471 A @code{valueMapEntry} element defines a mapping from one or more
2472 values of a source expression to a target value. (In the corpus, the
2473 source expression is always just the name of a variable.) Each target
2474 value requires a separate @code{valueMapEntry}. If multiple source
2475 values map to the same target value, they can be combined or separate.
2477 In the corpus, all of the source and target values are integers.
2479 @code{valueMapEntry} has the following attributes.
2481 @defvr {Attribute} from
2482 A source value, or multiple source values separated by semicolons,
2483 e.g.@: @code{0} or @code{13;14;15;16}.
2486 @defvr {Attribute} to
2487 The target value, e.g.@: @code{0}.
2490 @node SPV Detail extension Element
2491 @subsection The @code{extension} Element
2493 This is a general-purpose ``extension'' element. Readers that don't
2494 understand a given extension should be able to safely ignore it. The
2495 attributes on this element, and their meanings, vary based on the
2496 context. Each known usage is described separately below. The current
2497 extensions use attributes exclusively, without any nested elements.
2499 @subsubheading @code{container} Parent Element
2502 extension[container_extension] :combinedFootnotes=(true) => EMPTY
2505 With @code{container} as its parent element, @code{extension} has the
2506 following attributes.
2508 @defvr {Attribute} combinedFootnotes
2509 Always set to @code{true} in the corpus.
2512 @subsubheading @code{sourceVariable} and @code{derivedVariable} Parent Element
2515 extension[variable_extension] :from :helpId => EMPTY
2518 With @code{sourceVariable} or @code{derivedVariable} as its parent
2519 element, @code{extension} has the following attributes. A given
2520 parent element often contains several @code{extension} elements that
2521 specify the meaning of the source data's variables or sources, e.g.@:
2524 <extension from="0" helpId="corrected_model"/>
2525 <extension from="3" helpId="error"/>
2526 <extension from="4" helpId="total_9"/>
2527 <extension from="5" helpId="corrected_total"/>
2530 More commonly they are less helpful, e.g.@:
2533 <extension from="0" helpId="notes"/>
2534 <extension from="1" helpId="notes"/>
2535 <extension from="2" helpId="notes"/>
2536 <extension from="5" helpId="notes"/>
2537 <extension from="6" helpId="notes"/>
2538 <extension from="7" helpId="notes"/>
2539 <extension from="8" helpId="notes"/>
2540 <extension from="12" helpId="notes"/>
2541 <extension from="13" helpId="no_help"/>
2542 <extension from="14" helpId="notes"/>
2545 @defvr {Attribute} from
2546 An integer or a name like ``dimension0''.
2549 @defvr {Attribute} helpId
2553 @node SPV Detail graph Element
2554 @subsection The @code{graph} Element
2558 :cellStyle=ref style
2560 => location+ coordinates faceting facetLayout interval
2562 coordinates => EMPTY
2565 @code{graph} has the following attributes.
2567 @defvr {Attribute} cellStyle
2568 @defvrx {Attribute} style
2569 Each of these is the @code{id} of a @code{style} element (@pxref{SPV
2570 Detail style Element}). The former is the default style for
2571 individual cells, the latter for the entire table.
2574 @node SPV Detail location Element
2575 @subsection The @code{location} Element
2579 :part=(height | width | top | bottom | left | right)
2580 :method=(sizeToContent | attach | fixed | same)
2583 :target=ref (labelFrame | graph | container)?
2588 Each instance of this element specifies where some part of the table
2589 frame is located. All the examples in the corpus have four instances
2590 of this element, one for each of the parts @code{height},
2591 @code{width}, @code{left}, and @code{top}. Some examples in the
2592 corpus add a fifth for part @code{bottom}, even though it is not clear
2593 how all of @code{top}, @code{bottom}, and @code{height} can be honored
2594 at the same time. In any case, @code{location} seems to have little
2595 importance in representing tables; a reader can safely ignore it.
2597 @defvr {Attribute} part
2598 The part of the table being located.
2601 @defvr {Attribute} method
2602 How the location is determined:
2606 Based on the natural size of the table. Observed only for
2607 parts @code{height} and @code{width}.
2610 Based on the location specified in @code{target}. Observed only for
2611 parts @code{top} and @code{bottom}.
2614 Using the value in @code{value}. Observed only for parts @code{top},
2615 @code{bottom}, and @code{left}.
2618 Same as the specified @code{target}. Observed only for part
2623 @defvr {Attribute} min
2624 Minimum size. Only observed with value @code{100pt}. Only observed
2625 for part @code{width}.
2628 @defvr {Dependent} target
2629 Required when @code{method} is @code{attach} or @code{same}, not
2630 observed otherwise. This identifies an element to attach to.
2631 Observed with the ID of @code{title}, @code{footnote}, @code{graph},
2635 @defvr {Dependent} value
2636 Required when @code{method} is @code{fixed}, not observed otherwise.
2637 Observed values are @code{0%}, @code{0px}, @code{1px}, and @code{3px}
2638 on parts @code{top} and @code{left}, and @code{100%} on part
2642 @node SPV Detail faceting Element
2643 @subsection The @code{faceting} Element
2646 faceting => layer[layers1]* cross layer[layers2]*
2648 cross => (unity | nest) (unity | nest)
2652 nest => variableReference[vars]+
2654 variableReference :ref=ref (sourceVariable | derivedVariable) => EMPTY
2657 :variable=ref (sourceVariable | derivedVariable)
2660 :method[layer_method]=(nest)?
2665 The @code{faceting} element describes the row, column, and layer
2666 structure of the table. Its @code{cross} child determines the row and
2667 column structure, and each @code{layer} child (if any) represents a
2668 layer. Layers may appear before or after @code{cross}.
2670 The @code{cross} element describes the row and column structure of the
2671 table. It has exactly two children, the first of which describes the
2672 table's columns and the second the table's rows. Each child is a
2673 @code{nest} element if the table has any dimensions along the axis in
2674 question, otherwise a @code{unity} element.
2676 A @code{nest} element contains of one or more dimensions listed from
2677 innermost to outermost, each represented by @code{variableReference}
2678 child elements. Each variable in a dimension is listed in order.
2679 @xref{SPV Detail Variable Elements}, for information on the variables
2680 that comprise a dimension.
2682 A @code{nest} can contain a single dimension, e.g.:
2686 <variableReference ref="dimension0categories"/>
2687 <variableReference ref="dimension0group0"/>
2688 <variableReference ref="dimension0"/>
2693 A @code{nest} can contain multiple dimensions, e.g.:
2697 <variableReference ref="dimension1categories"/>
2698 <variableReference ref="dimension1group0"/>
2699 <variableReference ref="dimension1"/>
2700 <variableReference ref="dimension0categories"/>
2701 <variableReference ref="dimension0"/>
2705 A @code{nest} may have no dimensions, in which case it still has one
2706 @code{variableReference} child, which references a
2707 @code{derivedVariable} whose @code{value} attribute is
2708 @code{constant(0)}. In the corpus, such a @code{derivedVariable} has
2709 @code{row} or @code{column}, respectively, as its @code{id}. This is
2710 equivalent to using a @code{unity} element in place of @code{nest}.
2712 A @code{variableReference} element refers to a variable through its
2713 @code{ref} attribute.
2715 Each @code{layer} element represents a dimension, e.g.:
2718 <layer value="0" variable="dimension0categories" visible="true"/>
2719 <layer value="dimension0" variable="dimension0" visible="false"/>
2723 @code{layer} has the following attributes.
2725 @defvr {Attribute} variable
2726 Refers to a @code{sourceVariable} or @code{derivedVariable} element.
2729 @defvr {Attribute} value
2730 The value to select. For a category variable, this is always
2731 @code{0}; for a data variable, it is the same as the @code{variable}
2735 @defvr {Attribute} visible
2736 Whether the layer is visible. Generally, category layers are visible
2737 and data layers are not, but sometimes this attribute is omitted.
2740 @defvr {Attribute} method
2741 When present, this is always @code{nest}.
2744 @node SPV Detail facetLayout Element
2745 @subsection The @code{facetLayout} Element
2748 facetLayout => tableLayout setCellProperties[scp1]*
2749 facetLevel+ setCellProperties[scp2]*
2752 :verticalTitlesInCorner=bool
2754 :fitCells=(ticks both)?
2758 The @code{facetLayout} element and its descendants control styling for
2761 Its @code{tableLayout} child has the following attributes
2763 @defvr {Attribute} verticalTitlesInCorner
2764 If true, in the absence of corner text, row headings will be displayed
2768 @defvr {Attribute} style
2769 Refers to a @code{style} element.
2772 @defvr {Attribute} fitCells
2776 @subsubheading The @code{facetLevel} Element
2779 facetLevel :level=int :gap=dimension? => axis
2781 axis :style=ref style => label? majorTicks
2787 :tickFrameStyle=ref style
2788 :labelFrequency=int?
2798 Each @code{facetLevel} describes a @code{variableReference} or
2799 @code{layer}, and a table has one @code{facetLevel} element for
2800 each such element. For example, an SPV detail member that contains
2801 four @code{variableReference} elements and two @code{layer} elements
2802 will contain six @code{facetLevel} elements.
2804 In the corpus, @code{facetLevel} elements and the elements that they
2805 describe are always in the same order. The correspondence may also be
2806 observed in two other ways. First, one may use the @code{level}
2807 attribute, described below. Second, in the corpus, a
2808 @code{facetLevel} always has an @code{id} that is the same as the
2809 @code{id} of the element it describes with @code{_facetLevel}
2810 appended. One should not formally rely on this, of course, but it is
2811 usefully indicative.
2813 @defvr {Attribute} level
2814 A 1-based index into the @code{variableReference} and @code{layer}
2815 elements, e.g.@: a @code{facetLayout} with a @code{level} of 1
2816 describes the first @code{variableReference} in the SPV detail member,
2817 and in a member with four @code{variableReference} elements, a
2818 @code{facetLayout} with a @code{level} of 5 describes the first
2819 @code{layer} in the member.
2822 @defvr {Attribute} gap
2823 Always observed as @code{0pt}.
2826 Each @code{facetLevel} contains an @code{axis}, which in turn may
2827 contain a @code{label} for the @code{facetLevel} (@pxref{SPV Detail
2828 label Element}) and does contain a @code{majorTicks} element.
2830 @defvr {Attribute} labelAngle
2831 Normally 0. The value -90 causes inner column or outer row labels to
2832 be rotated vertically.
2835 @defvr {Attribute} style
2836 @defvrx {Attribute} tickFrameStyle
2837 Each refers to a @code{style} element. @code{style} is the style of
2838 the tick labels, @code{tickFrameStyle} the style for the frames around
2842 @node SPV Detail label Element
2843 @subsection The @code{label} Element
2848 :textFrameStyle=ref style?
2849 :purpose=(title | subTitle | subSubTitle | layer | footnote)?
2850 => text+ | descriptionGroup
2853 :target=ref faceting
2855 => (description | text)+
2857 description :name=(variable | value) => EMPTY
2861 :definesReference=int?
2862 :position=(subscript | superscript)?
2867 This element represents a label on some aspect of the table.
2869 @defvr {Attribute} style
2870 @defvrx {Attribute} textFrameStyle
2871 Each of these refers to a @code{style} element. @code{style} is the
2872 style of the label text, @code{textFrameStyle} the style for the frame
2876 @defvr {Attribute} purpose
2877 The kind of entity being labeled.
2880 A @code{descriptionGroup} concatenates one or more elements to form a
2881 label. Each element can be a @code{text} element, which contains
2882 literal text, or a @code{description} element that substitutes a value
2885 @defvr {Attribute} target
2886 The @code{id} of an element being described. In the corpus, this is
2887 always @code{faceting}.
2890 @defvr {Attribute} separator
2891 A string to separate the description of multiple groups, if the
2892 @code{target} has more than one. In the corpus, this is always a
2896 Typical contents for a @code{descriptionGroup} are a value by itself:
2898 <description name="value"/>
2900 @noindent or a variable and its value, separated by a colon:
2902 <description name="variable"/><text>:</text><description name="value"/>
2905 A @code{description} is like a macro that expands to some property of
2906 the target of its parent @code{descriptionGroup}. The @code{name}
2907 attribute specifies the property.
2909 @node SPV Detail setCellProperties Element
2910 @subsection The @code{setCellProperties} Element
2914 :applyToConverse=bool?
2915 => (setStyle | setFrameStyle | setFormat | setMetaData)* union[union_]?
2918 The @code{setCellProperties} element sets style properties of cells or
2919 row or column labels.
2921 Interpreting @code{setCellProperties} requires answering two
2922 questions: which cells or labels to style, and what styles to use.
2924 @subsubheading Which Cells?
2929 intersect => where+ | intersectWhere | alternating | EMPTY
2932 :variable=ref (sourceVariable | derivedVariable)
2937 :variable=ref (sourceVariable | derivedVariable)
2938 :variable2=ref (sourceVariable | derivedVariable)
2941 alternating => EMPTY
2944 When @code{union} is present with @code{intersect} children, each of
2945 those children specifies a group of cells that should be styled, and
2946 the total group is all those cells taken together. When @code{union}
2947 is absent, every cell is styled. One attribute on
2948 @code{setCellProperties} affects the choice of cells:
2950 @defvr {Attribute} applyToConverse
2951 If true, this inverts the meaning of the cell selection: the selected
2952 cells are the ones @emph{not} designated. This is confusing, given
2953 the additional restrictions of @code{union}, but in the corpus
2954 @code{applyToConverse} is never present along with @code{union}.
2957 An @code{intersect} specifies restrictions on the cells to be matched.
2958 Each @code{where} child specifies which values of a given variable to
2959 include. The attributes of @code{intersect} are:
2961 @defvr {Attribute} variable
2962 Refers to a variable, e.g.@: @code{dimension0categories}. Only
2963 ``categories'' variables make sense here, but other variables, e.g.@:
2964 @code{dimension0group0map}, are sometimes seen. The reader may ignore
2968 @defvr {Attribute} include
2969 A value, or multiple values separated by semicolons,
2970 e.g.@: @code{0} or @code{13;14;15;16}.
2973 PSPP ignores @code{setCellProperties} when @code{intersectWhere} is
2976 @subsubheading What Styles?
2980 :target=ref (labeling | graph | interval | majorTicks)
2984 setMetaData :target=ref graph :key :value => EMPTY
2987 :target=ref (majorTicks | labeling)
2989 => format | numberFormat | stringFormat+ | dateTimeFormat | elapsedTimeFormat
2993 :target=ref majorTicks
2997 The @code{set*} children of @code{setCellProperties} determine the
3000 When @code{setCellProperties} contains a @code{setFormat} whose
3001 @code{target} references a @code{labeling} element, or if it contains
3002 a @code{setStyle} that references a @code{labeling} or @code{interval}
3003 element, the @code{setCellProperties} sets the style for table cells.
3004 The format from the @code{setFormat}, if present, replaces the cells'
3005 format. The style from the @code{setStyle} that references
3006 @code{labeling}, if present, replaces the label's font and cell
3007 styles, except that the background color is taken instead from the
3008 @code{interval}'s style, if present.
3010 When @code{setCellProperties} contains a @code{setFormat} whose
3011 @code{target} references a @code{majorTicks} element, or if it
3012 contains a @code{setStyle} whose @code{target} references a
3013 @code{majorTicks}, or if it contains a @code{setFrameStyle} element,
3014 the @code{setCellProperties} sets the style for row or column labels.
3015 In this case, the @code{setCellProperties} always contains a single
3016 @code{where} element whose @code{variable} designates the variable
3017 whose labels are to be styled. The format from the @code{setFormat},
3018 if present, replaces the labels' format. The style from the
3019 @code{setStyle} that references @code{majorTicks}, if present,
3020 replaces the labels' font and cell styles, except that the background
3021 color is taken instead from the @code{setFrameStyle}'s style, if
3024 When @code{setCellProperties} contains a @code{setStyle} whose
3025 @code{target} references a @code{graph} element, and one that
3026 references a @code{labeling} element, and the @code{union} element
3027 contains @code{alternating}, the @code{setCellProperties} sets the
3028 alternate foreground and background colors for the data area. The
3029 foreground color is taken from the style referenced by the
3030 @code{setStyle} that targets the @code{graph}, the background color
3031 from the @code{setStyle} for @code{labeling}.
3033 A reader may ignore a @code{setCellProperties} that only contains
3034 @code{setMetaData}, as well as @code{setMetaData} within other
3035 @code{setCellProperties}.
3037 A reader may ignore a @code{setCellProperties} whose only @code{set*}
3038 child is a @code{setStyle} that targets the @code{graph} element.
3040 @subsubheading The @code{setStyle} Element
3044 :target=ref (labeling | graph | interval | majorTicks)
3049 This element associates a style with the target.
3051 @defvr {Attribute} target
3052 The @code{id} of an element whose style is to be set.
3055 @defvr {Attribute} style
3056 The @code{id} of a @code{style} element that identifies the style to
3060 @node SPV Detail setFormat Element
3061 @subsection The @code{setFormat} Element
3065 :target=ref (majorTicks | labeling)
3067 => format | numberFormat | stringFormat+ | dateTimeFormat | elapsedTimeFormat
3070 This element sets the format of the target, ``format'' in this case
3071 meaning the SPSS print format for a variable.
3073 The details of this element vary depending on the schema version, as
3074 declared in the root @code{visualization} element's @code{version}
3075 attribute (@pxref{SPV Detail visualization Element}). A reader can
3076 interpret the content without knowing the schema version.
3078 The @code{setFormat} element itself has the following attributes.
3080 @defvr {Attribute} target
3081 Refers to an element whose style is to be set.
3084 @defvr {Attribute} reset
3085 If this is @code{true}, this format replaces the target's previous
3086 format. If it is @code{false}, the modifies the previous format.
3090 * SPV Detail numberFormat Element::
3091 * SPV Detail stringFormat Element::
3092 * SPV Detail dateTimeFormat Element::
3093 * SPV Detail elapsedTimeFormat Element::
3094 * SPV Detail format Element::
3095 * SPV Detail affix Element::
3098 @node SPV Detail numberFormat Element
3099 @subsubsection The @code{numberFormat} Element
3103 :minimumIntegerDigits=int?
3104 :maximumFractionDigits=int?
3105 :minimumFractionDigits=int?
3107 :scientific=(onlyForSmall | whenNeeded | true | false)?
3114 Specifies a format for displaying a number. The available options are
3115 a superset of those available from PSPP print formats. PSPP chooses a
3116 print format type for a @code{numberFormat} as follows:
3120 If @code{scientific} is @code{true}, uses @code{E} format.
3123 If @code{prefix} is @code{$}, uses @code{DOLLAR} format.
3126 If @code{suffix} is @code{%}, uses @code{PCT} format.
3129 If @code{useGrouping} is @code{true}, uses @code{COMMA} format.
3132 Otherwise, uses @code{F} format.
3135 For translating to a print format, PSPP uses
3136 @code{maximumFractionDigits} as the number of decimals, unless that
3137 attribute is missing or out of the range [0,15], in which case it uses
3140 @defvr {Attribute} minimumIntegerDigits
3141 Minimum number of digits to display before the decimal point. Always
3142 observed as @code{0}.
3145 @defvr {Attribute} maximumFractionDigits
3146 @defvrx {Attribute} minimumFractionDigits
3147 Maximum or minimum, respectively, number of digits to display after
3148 the decimal point. The observed values of each attribute range from 0
3152 @defvr {Attribute} useGrouping
3153 Whether to use the grouping character to group digits in large
3157 @defvr {Attribute} scientific
3158 This attribute controls when and whether the number is formatted in
3159 scientific notation. It takes the following values:
3163 Use scientific notation only when the number's magnitude is smaller
3164 than the value of the @code{small} attribute.
3167 Use scientific notation when the number will not otherwise fit in the
3171 Always use scientific notation. Not observed in the corpus.
3174 Never use scientific notation. A number that won't otherwise fit will
3175 be replaced by an error indication (see the @code{errorCharacter}
3176 attribute). Not observed in the corpus.
3180 @defvr {Attribute} small
3181 Only present when the @code{scientific} attribute is
3182 @code{onlyForSmall}, this is a numeric magnitude below which the
3183 number will be formatted in scientific notation. The values @code{0}
3184 and @code{0.0001} have been observed. The value @code{0} seems like a
3185 pathological choice, since no real number has a magnitude less than 0;
3186 perhaps in practice such a choice is equivalent to setting
3187 @code{scientific} to @code{false}.
3190 @defvr {Attribute} prefix
3191 @defvrx {Attribute} suffix
3192 Specifies a prefix or a suffix to apply to the formatted number. Only
3193 @code{suffix} has been observed, with value @samp{%}.
3196 @node SPV Detail stringFormat Element
3197 @subsubsection The @code{stringFormat} Element
3200 stringFormat => relabel* affix*
3202 relabel :from=real :to => EMPTY
3205 The @code{stringFormat} element specifies how to display a string. By
3206 default, a string is displayed verbatim, but @code{relabel} can change
3209 The @code{relabel} element appears as a child of @code{stringFormat}
3210 (and of @code{format}, when it is used to format strings). It
3211 specifies how to display a given value. It is used to implement value
3212 labels and to display the system-missing value in a human-readable
3213 way. It has the following attributes:
3215 @defvr {Attribute} from
3216 The value to map. In the corpus this is an integer or the
3217 system-missing value @code{-1.797693134862316E300}.
3220 @defvr {Attribute} to
3221 The string to display in place of the value of @code{from}. In the
3222 corpus this is a wide variety of value labels; the system-missing
3223 value is mapped to @samp{.}.
3226 @node SPV Detail dateTimeFormat Element
3227 @subsubsection The @code{dateTimeFormat} Element
3231 :baseFormat[dt_base_format]=(date | time | dateTime)
3233 :mdyOrder=(dayMonthYear | monthDayYear | yearMonthDay)?
3235 :yearAbbreviation=bool?
3240 :monthFormat=(long | short | number | paddedNumber)?
3244 :showDayOfWeek=bool?
3245 :dayOfWeekAbbreviation=bool?
3247 :dayOfMonthPadding=bool?
3249 :minutePadding=bool?
3250 :secondPadding=bool?
3256 :dayType=(month | year)?
3257 :hourFormat=(AMPM | AS_24 | AS_12)?
3261 This element appears only in schema version 2.5 and earlier
3262 (@pxref{SPV Detail visualization Element}).
3264 Data to be formatted in date formats is stored as strings in legacy
3265 data, in the format @code{yyyy-mm-ddTHH:MM:SS.SSS} and must be parsed
3266 and reformatted by the reader.
3268 The following attribute is required.
3270 @defvr {Attribute} baseFormat
3271 Specifies whether a date and time are both to be displayed, or just
3275 Many of the attributes' meanings are obvious. The following seem to
3276 be worth documenting.
3278 @defvr {Attribute} separatorChars
3279 Exactly four characters. In order, these are used for: decimal point,
3280 grouping, date separator, time separator. Always @samp{.,-:}.
3283 @defvr {Attribute} mdyOrder
3284 Within a date, the order of the days, months, and years.
3285 @code{dayMonthYear} is the only observed value, but one would expect
3286 that @code{monthDayYear} and @code{yearMonthDay} to be reasonable as
3290 @defvr {Attribute} showYear
3291 @defvrx {Attribute} yearAbbreviation
3292 Whether to include the year and, if so, whether the year should be
3293 shown abbreviated, that is, with only 2 digits. Each is @code{true}
3294 or @code{false}; only values of @code{true} and @code{false},
3295 respectively, have been observed.
3298 @defvr {Attribute} showMonth
3299 @defvrx {Attribute} monthFormat
3300 Whether to include the month (@code{true} or @code{false}) and, if so,
3301 how to format it. @code{monthFormat} is one of the following:
3305 The full name of the month, e.g.@: in an English locale,
3309 The abbreviated name of the month, e.g.@: in an English locale,
3313 The number representing the month, e.g.@: 9 for September.
3316 A two-digit number representing the month, e.g.@: 09 for September.
3319 Only values of @code{true} and @code{short}, respectively, have been
3323 @defvr {Attribute} dayType
3324 This attribute is always @code{month} in the corpus, specifying that
3325 the day of the month is to be displayed; a value of @code{year} is
3326 supposed to indicate that the day of the year, where 1 is January 1,
3327 is to be displayed instead.
3330 @defvr {Attribute} hourFormat
3331 @code{hourFormat}, if present, is one of:
3335 The time is displayed with an @code{am} or @code{pm} suffix, e.g.@:
3339 The time is displayed in a 24-hour format, e.g.@: @code{22:15}.
3341 This is the only value observed in the corpus.
3344 The time is displayed in a 12-hour format, without distinguishing
3345 morning or evening, e.g.@: @code{10;15}.
3348 @code{hourFormat} is sometimes present for @code{elapsedTime} formats,
3349 which is confusing since a time duration does not have a concept of AM
3350 or PM. This might indicate a bug in the code that generated the XML
3351 in the corpus, or it might indicate that @code{elapsedTime} is
3352 sometimes used to format a time of day.
3355 For a @code{baseFormat} of @code{date}, PSPP chooses a print format
3356 type based on the following rules:
3360 If @code{showQuarter} is true: @code{QYR}.
3363 Otherwise, if @code{showWeek} is true: @code{WKYR}.
3366 Otherwise, if @code{mdyOrder} is @code{dayMonthYear}:
3370 If @code{monthFormat} is @code{number} or @code{paddedNumber}: @code{EDATE}.
3373 Otherwise: @code{DATE}.
3377 Otherwise, if @code{mdyOrder} is @code{yearMonthDay}: @code{SDATE}.
3380 Otherwise, @code{ADATE}.
3383 For a @code{baseFormat} of @code{dateTime}, PSPP uses @code{YMDHMS} if
3384 @code{mdyOrder} is @code{yearMonthDay} and @code{DATETIME} otherwise.
3385 For a @code{baseFormat} of @code{time}, PSPP uses @code{DTIME} if
3386 @code{showDay} is true, otherwise @code{TIME} if @code{showHour} is
3387 true, otherwise @code{MTIME}.
3389 For a @code{baseFormat} of @code{date}, the chosen width is the
3390 minimum for the format type, adding 2 if @code{yearAbbreviation} is
3391 false or omitted. For other base formats, the chosen width is the
3392 minimum for its type, plus 3 if @code{showSecond} is true, plus 4 more
3393 if @code{showMillis} is also true. Decimals are 0 by default, or 3
3394 if @code{showMillis} is true.
3396 @node SPV Detail elapsedTimeFormat Element
3397 @subsubsection The @code{elapsedTimeFormat} Element
3401 :baseFormat[dt_base_format]=(date | time | dateTime)
3404 :minutePadding=bool?
3405 :secondPadding=bool?
3415 This element specifies the way to display a time duration.
3417 Data to be formatted in elapsed time formats is stored as strings in
3418 legacy data, in the format @code{H:MM:SS.SSS}, with additional hour
3419 digits as needed for long durations, and must be parsed and
3420 reformatted by the reader.
3422 The following attribute is required.
3424 @defvr {Attribute} baseFormat
3425 Specifies whether a day and a time are both to be displayed, or just
3429 The remaining attributes specify exactly how to display the elapsed
3432 For @code{baseFormat} of @code{time}, PSPP converts this element to
3433 print format type @code{DTIME}; otherwise, if @code{showHour} is true,
3434 to @code{TIME}; otherwise, to @code{MTIME}. The chosen width is the
3435 minimum for the chosen type, adding 3 if @code{showSecond} is true,
3436 adding 4 more if @code{showMillis} is also true. Decimals are 0 by
3437 default, or 3 if @code{showMillis} is true.
3439 @node SPV Detail format Element
3440 @subsubsection The @code{format} Element
3444 :baseFormat[f_base_format]=(date | time | dateTime | elapsedTime)?
3447 :mdyOrder=(dayMonthYear | monthDayYear | yearMonthDay)?
3452 :yearAbbreviation=bool?
3454 :monthFormat=(long | short | number | paddedNumber)?
3456 :dayOfMonthPadding=bool?
3460 :showDayOfWeek=bool?
3461 :dayOfWeekAbbreviation=bool?
3463 :minutePadding=bool?
3464 :secondPadding=bool?
3470 :dayType=(month | year)?
3471 :hourFormat=(AMPM | AS_24 | AS_12)?
3472 :minimumIntegerDigits=int?
3473 :maximumFractionDigits=int?
3474 :minimumFractionDigits=int?
3476 :scientific=(onlyForSmall | whenNeeded | true | false)?
3480 :tryStringsAsNumbers=bool?
3481 :negativesOutside=bool?
3485 This element is the union of all of the more-specific format elements.
3486 It is interpreted in the same way as one of those format elements,
3487 using @code{baseFormat} to determine which kind of format to use.
3489 There are a few attributes not present in the more specific formats:
3491 @defvr {Attribute} tryStringsAsNumbers
3492 When this is @code{true}, it is supposed to indicate that string
3493 values should be parsed as numbers and then displayed according to
3494 numeric formatting rules. However, in the corpus it is always
3498 @defvr {Attribute} negativesOutside
3499 If true, the negative sign should be shown before the prefix; if
3500 false, it should be shown after.
3503 @node SPV Detail affix Element
3504 @subsubsection The @code{affix} Element
3508 :definesReference=int
3509 :position=(subscript | superscript)
3515 This defines a suffix (or, theoretically, a prefix) for a formatted
3516 value. It is used to insert a reference to a footnote. It has the
3517 following attributes:
3519 @defvr {Attribute} definesReference
3520 This specifies the footnote number as a natural number: 1 for the
3521 first footnote, 2 for the second, and so on.
3524 @defvr {Attribute} position
3525 Position for the footnote label. Always @code{superscript}.
3528 @defvr {Attribute} suffix
3529 Whether the affix is a suffix (@code{true}) or a prefix
3530 (@code{false}). Always @code{true}.
3533 @defvr {Attribute} value
3534 The text of the suffix or prefix. Typically a letter, e.g.@: @code{a}
3535 for footnote 1, @code{b} for footnote 2, @enddots{} The corpus
3536 contains other values: @code{*}, @code{**}, and a few that begin with
3537 at least one comma: @code{,b}, @code{,c}, @code{,,b}, and @code{,,c}.
3540 @node SPV Detail interval Element
3541 @subsection The @code{interval} Element
3544 interval :style=ref style => labeling footnotes?
3548 :variable=ref (sourceVariable | derivedVariable)
3549 => (formatting | format | footnotes)*
3551 formatting :variable=ref (sourceVariable | derivedVariable) => formatMapping*
3553 formatMapping :from=int => format?
3557 :variable=ref (sourceVariable | derivedVariable)
3560 footnoteMapping :definesReference=int :from=int :to => EMPTY
3563 The @code{interval} element and its descendants determine the basic
3564 formatting and labeling for the table's cells. These basic styles are
3565 overridden by more specific styles set using @code{setCellProperties}
3566 (@pxref{SPV Detail setCellProperties Element}).
3568 The @code{style} attribute of @code{interval} itself may be ignored.
3570 The @code{labeling} element may have a single @code{formatting} child.
3571 If present, its @code{variable} attribute refers to a variable whose
3572 values are format specifiers as numbers, e.g. value 0x050802 for F8.2.
3573 However, the numbers are not actually interpreted that way. Instead,
3574 each number actually present in the variable's data is mapped by a
3575 @code{formatMapping} child of @code{formatting} to a @code{format}
3576 that specifies how to display it.
3578 The @code{labeling} element may also have a @code{footnotes} child
3579 element. The @code{variable} attribute of this element refers to a
3580 variable whose values are comma-delimited strings that list the
3581 1-based indexes of footnote references. (Cells without any footnote
3582 references are numeric 0 instead of strings.)
3584 Each @code{footnoteMapping} child of the @code{footnotes} element
3585 defines the footnote marker to be its @code{to} attribute text for the
3586 footnote whose 1-based index is given in its @code{definesReference}
3589 @node SPV Detail style Element
3590 @subsection The @code{style} Element
3597 :border-bottom=(solid | thick | thin | double | none)?
3598 :border-top=(solid | thick | thin | double | none)?
3599 :border-left=(solid | thick | thin | double | none)?
3600 :border-right=(solid | thick | thin | double | none)?
3601 :border-bottom-color?
3604 :border-right-color?
3607 :font-weight=(regular | bold)?
3608 :font-style=(regular | italic)?
3609 :font-underline=(none | underline)?
3610 :margin-bottom=dimension?
3611 :margin-left=dimension?
3612 :margin-right=dimension?
3613 :margin-top=dimension?
3614 :textAlignment=(left | right | center | decimal | mixed)?
3615 :labelLocationHorizontal=(positive | negative | center)?
3616 :labelLocationVertical=(positive | negative | center)?
3617 :decimal-offset=dimension?
3624 A @code{style} element has an effect only when it is referenced by
3625 another element to set some aspect of the table's style. Most of the
3626 attributes are self-explanatory. The rest are described below.
3628 @defvr {Attribute} {color}
3629 In some cases, the text color; in others, the background color.
3632 @defvr {Attribute} {color2}
3636 @defvr {Attribute} {labelAngle}
3637 Normally 0. The value -90 causes inner column or outer row labels to
3638 be rotated vertically.
3641 @defvr {Attribute} {labelLocationHorizontal}
3645 @defvr {Attribute} {labelLocationVertical}
3646 The value @code{positive} corresponds to vertically aligning text to
3647 the top of a cell, @code{negative} to the bottom, @code{center} to the
3651 @node SPV Detail labelFrame Element
3652 @subsection The @code{labelFrame} Element
3655 labelFrame :style=ref style => location+ label? paragraph?
3657 paragraph :hangingIndent=dimension? => EMPTY
3660 A @code{labelFrame} element specifies content and style for some
3661 aspect of a table. Only @code{labelFrame} elements that have a
3662 @code{label} child are important. The @code{purpose} attribute in the
3663 @code{label} determines what the @code{labelFrame} affects:
3667 The table's title and its style.
3670 The table's caption and its style.
3673 The table's footnotes and the style for the footer area.
3676 The style for the layer area.
3682 The @code{style} attribute references the style to use for the area.
3684 The @code{label}, if present, specifies the text to put into the title
3685 or caption or footnotes. For footnotes, the label has two @code{text}
3686 children for every footnote, each of which has a @code{usesReference}
3687 attribute identifying the 1-based index of a footnote. The first,
3688 third, fifth, @dots{} @code{text} child specifies the content for a
3689 footnote; the second, fourth, sixth, @dots{} child specifies the
3690 marker. Content tends to end in a new-line, which the reader may wish
3691 to trim; similarly, markers tend to end in @samp{.}.
3693 The @code{paragraph}, if present, may be ignored, since it is always
3696 @node SPV Detail Legacy Properties
3697 @subsection Legacy Properties
3699 The detail XML format has features for styling most of the aspects of
3700 a table. It also inherits defaults for many aspects from structure
3701 XML, which has the following @code{tableProperties} element:
3706 => generalProperties footnoteProperties cellFormatProperties borderProperties printingProperties
3709 :hideEmptyRows=bool?
3710 :maximumColumnWidth=dimension?
3711 :maximumRowWidth=dimension?
3712 :minimumColumnWidth=dimension?
3713 :minimumRowWidth=dimension?
3714 :rowDimensionLabels=(inCorner | nested)?
3718 :markerPosition=(superscript | subscript)?
3719 :numberFormat=(alphabetic | numeric)?
3722 cellFormatProperties => cell_style+
3725 :alternatingColor=color?
3726 :alternatingTextColor=color?
3734 :font-style=(regular | italic)?
3735 :font-weight=(regular | bold)?
3736 :font-underline=(none | underline)?
3737 :labelLocationVertical=(positive | negative | center)?
3738 :margin-bottom=dimension?
3739 :margin-left=dimension?
3740 :margin-right=dimension?
3741 :margin-top=dimension?
3742 :textAlignment=(left | right | center | decimal | mixed)?
3743 :decimal-offset=dimension?
3746 borderProperties => border_style+
3749 :borderStyleType=(none | solid | dashed | thick | thin | double)?
3754 :printAllLayers=bool?
3755 :rescaleLongTableToFitPage=bool?
3756 :rescaleWideTableToFitPage=bool?
3757 :windowOrphanLines=int?
3759 :continuationTextAtBottom=bool?
3760 :continuationTextAtTop=bool?
3761 :printEachLayerOnSeparatePage=bool?
3765 The @code{name} attribute appears only in standalone @file{.stt} files
3766 (@pxref{SPSS TableLook STT Format}).