X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=spv-file-format.texi;h=ecc5f8e1b5df4fb3ebe5a9cf25ddbe08bc30b2a2;hb=91e1d822895e84a15e17b15762c6d33629f83342;hp=a530ec9add14d0682ea14d87b7e6ff4602e9dd63;hpb=acbc23b06be71e6341fe9434c2f2e55e76ddb282;p=pspp diff --git a/spv-file-format.texi b/spv-file-format.texi index a530ec9add..ecc5f8e1b5 100644 --- a/spv-file-format.texi +++ b/spv-file-format.texi @@ -194,7 +194,7 @@ file. @defvr {Optional} @code{creation-date-time} The date and time at which the SPV file was written, in a -locale-specific format, e.g. @code{Friday, May 16, 2014 6:47:37 PM +locale-specific format, e.g.@: @code{Friday, May 16, 2014 6:47:37 PM PDT} or @code{lunedì 17 marzo 2014 3.15.48 CET} or even @code{Friday, December 5, 2014 5:00:19 o'clock PM EST}. @end defvr @@ -1804,18 +1804,133 @@ and in a member with four @code{variableReference} elements, a Always observed as @code{0pt}. @end defvr +@subsubheading The @code{axis} Element + +Parent: @code{facetLevel} @* +Contents: @code{label}? @code{majorTicks} + +@defvr {Attribute} style +The @code{id} of a @code{style} element. +@end defvr + +@subsubheading The @code{label} Element + +Parent: @code{axis} or @code{labelFrame} @* +Contents: @code{text}@math{+} @math{|} @code{descriptionGroup} + +This element represents a label on some aspect of the table. For example, +the table's title is a @code{label}. + +The contents of the label can be one or more @code{text} elements or a +@code{descriptionGroup}. + +@defvr {Attribute} style +@defvrx {Optional} textFrameStyle +Each of these is the @code{id} of a @code{style} element. +@code{style} is the style of the label text, @code{textFrameStyle} the +style for the frame around the label. +@end defvr + +@defvr {Optional} purpose +The kind of entity being labeled, one of @code{title}, +@code{subTitle}, @code{layer}, or @code{footnote}. +@end defvr + +@subsubheading The @code{descriptionGroup} Element + +Parent: @code{label} @* +Contents: (@code{description} @math{|} @code{text})@math{+} + +A @code{descriptionGroup} concatenates one or more elements to form a +label. Each element can be a @code{text} element, which contains +literal text, or a @code{description} element that substitutes a value +or a variable name. + +@defvr {Attribute} target +The @code{id} of an element being described. In the corpus, this is +always @code{faceting}. +@end defvr + +@defvr {Attribute} separator +A string to separate the description of multiple groups, if the +@code{target} has more than one. In the corpus, this is always a +new-line. +@end defvr + +Typical contents for a @code{descriptionGroup} are a value by itself: +@example + +@end example +@noindent or a variable and its value, separated by a colon: +@example +: +@end example + +@subsubheading The @code{description} Element + +Parent: @code{descriptionGroup} @* +Contents: empty + +A @code{description} is like a macro that expands to some property of +the target of its parent @code{descriptionGroup}. + +@defvr {Attribute} name +The name of the property. Only @code{variable} and @code{value} +appear in the corpus. +@end defvr + +@subsubheading The @code{majorTicks} Element + +Parent: @code{axis} @* +Contents: @code{gridline}? + +@defvr {Attribute} labelAngle +@defvrx {Attribute} length +Both always defined to @code{0}. +@end defvr + +@defvr {Attribute} style +@defvrx {Attribute} tickFrameStyle +Each of these is the @code{id} of a @code{style} element. +@code{style} is the style of the tick labels, @code{tickFrameStyle} +the style for the frames around the labels. +@end defvr + +@subsubheading The @code{gridline} Element + +Parent: @code{majorTicks} @* +Contents: empty + +Represents ``gridlines,'' which for a table represents the lines +between the rows or columns of a table (XXX?). + +@defvr {Attribute} style +The style for the gridline. +@end defvr + +@defvr {Attribute} zOrder +Observed as a number between 28 and 31. Does not seem to be +important. +@end defvr + @subsubheading The @code{setCellProperties} Element Parent: @code{facetLayout} @* Contents: @code{setMetaData} @code{setStyle}* @code{setFormat}@math{+} @code{union}? This element sets style properties of cells designated by the -@code{target} attribute of its child elements. +@code{target} attribute of its child elements, as further restricted +by the optional @code{union} element if present. The @code{target} +values often used, e.g.@: @code{graph} or @code{labeling}, actually +affect every cell, so the @code{union} element is a useful +restriction. @defvr {Optional} applyToConverse If present, always @code{true}. This appears to invert the meaning of the @code{target} of sub-elements: the selected cells are the ones -@emph{not} designated by @code{target}. +@emph{not} designated by @code{target}. This is confusing, given the +additional restrictions of @code{union}, but in the corpus +@code{applyToConverse} is never present along with @code{union}. @end defvr @subsubheading The @code{setMetaData} Element @@ -1883,6 +1998,21 @@ In version 2.7 and later, @code{setFormat} instead always contains a XXX reinvestigate the above claim about versions: it appears to be incorrect. +The @code{setFormat} element itself has the following attributes. + +@defvr {Required} target +The @code{id} of an element whose style is to be set. In the corpus, +this is always the @code{id} of an @code{majorTicks} or +@code{labeling} element. +@end defvr + +@defvr {Optional} reset +If this is @code{true}, this format overrides the target's previous +format. If it is @code{false}, the adds to the previous format. In +the corpus this is always @code{true}. The default behavior is +unknown. +@end defvr + @menu * SPV Detail format Element:: * SPV Detail numberFormat Element:: @@ -1890,6 +2020,7 @@ incorrect. * SPV Detail dateTimeFormat Element:: * SPV Detail affix Element:: * SPV Detail relabel Element:: +* SPV Detail union Element:: @end menu @node SPV Detail format Element @@ -2301,3 +2432,58 @@ The string to display in place of the value of @code{from}. In the corpus this is a wide variety of value labels; the system-missing value is mapped to @samp{.}. @end defvr + +@node SPV Detail union Element +@subsubsection The @code{union} Element + +Parent: @code{setCellProperties} @* +Contents: @code{intersect}@math{+} + +This element represents a set of cells, computed as the union of the +sets represented by each of its children. + +@subsubheading The @code{intersect} Element + +Parent: @code{union} @* +Contents: @code{where}@math{+} @math{|} @code{intersectWhere}? + +This element represents a set of cells, computed as the intersection +of the sets represented by each of its children. + +Of the two possible children, in the corpus @code{where} is far more +common, appearing thousands of times, whereas @code{intersectWhere} +only appears 4 times. + +Most @code{intersect} elements have two or more children. + +@subsubheading The @code{where} Element + +Parent: @code{intersect} @* +Contents: empty + +This element represents the set of cells in which the value of a +specified variable falls within a specified set. + +@defvr {Attribute} variable +The @code{id} of a variable, e.g.@: @code{dimension0categories} or +@code{dimension0group0map}. +@end defvr + +@defvr {Attribute} include +A value, or multiple values separated by semicolons, +e.g.@: @code{0} or @code{13;14;15;16}. +@end defvr + +@subsubheading The @code{intersectWhere} + +Parent: @code{intersect} @* +Contents: empty + +The meaning of this element is unknown. + +@defvr {Attribute} variable +@defvrx {Attribute} variable2 +The meaning of these attributes is unknown. In the four examples in +the corpus they always take the values @code{dimension2categories} and +@code{dimension0categories}, respectively. +@end defvr