X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=spv-file-format.texi;h=a530ec9add14d0682ea14d87b7e6ff4602e9dd63;hb=acbc23b06be71e6341fe9434c2f2e55e76ddb282;hp=789a77707ce4d2894d80daec9f8af2975cd30ccb;hpb=c82a9402434b9fc310c85754a03cca114b69f04e;p=pspp diff --git a/spv-file-format.texi b/spv-file-format.texi index 789a77707c..a530ec9add 100644 --- a/spv-file-format.texi +++ b/spv-file-format.texi @@ -143,18 +143,18 @@ times. @end iftex @menu -* SPV heading Element:: -* SPV label Element:: -* SPV container Element:: -* SPV text Element (Inside @code{container}):: -* SPV html Element:: -* SPV table Element:: -* SPV tableStructure Element:: -* SPV dataPath Element:: -* SPV pageSetup Element:: -* SPV pageHeader and pageFooter Elements:: -* SPV pageParagraph Element:: -* SPV @code{text} Element (Inside @code{pageParagraph}):: +* SPV Structure heading Element:: +* SPV Structure label Element:: +* SPV Structure container Element:: +* SPV Structure text Element (Inside @code{container}):: +* SPV Structure html Element:: +* SPV Structure table Element:: +* SPV Structure tableStructure Element:: +* SPV Structure dataPath Element:: +* SPV Structure pageSetup Element:: +* SPV Structure pageHeader and pageFooter Elements:: +* SPV Structure pageParagraph Element:: +* SPV Structure @code{text} Element (Inside @code{pageParagraph}):: @end menu @node SPV Structure heading Element @@ -440,7 +440,7 @@ This element has no attributes. @node SPV Structure @code{text} Element (Inside @code{pageParagraph}) @subsection The @code{text} Element (Inside @code{pageParagraph}) -Parent: @code{pageParagraph} @* +Parent: @code{pageParagraph} Contents: CDATA? This @code{text} element is nested inside a @code{pageParagraph}. There @@ -1227,7 +1227,48 @@ label is the string @code{s}. Each label also includes a This format is still under investigation. -All elements have an optional @code{id} attribute. +The design of the detail XML format is not what one would end up with +for describing pivot tables. This is because it is a special case +of a much more general format (``visualization XML'' or ``VizML'') +that can describe a wide range of visualizations. Most of this +generality is overkill for tables, and so we end up with a funny +subset of a general-purpose format. + +The important elements of the detail XML format are: + +@itemize @bullet +@item +Variables. Variables in detail XML roughly correspond to the +dimensions in a light detail member. There is one variable for each +dimension, plus one variable for each level of labeling along an axis. + +The bulk of variables are defined with @code{sourceVariable} elements. +The data for these variables comes from the associated +@code{tableData.bin} member. Some variables are defined, with +@code{derivedVariable} elements, as a constant or in terms of a +mapping function from a source variable. + +@item +Assignment of variables to axes. A variable can appear as columns, or +rows, or layers. The @code{faceting} element and its sub-elements +describe this assignment. +@end itemize + +All elements have an optional @code{id} attribute. In practice many +elements are assigned @code{id} attributes that are never referenced. + +@menu +* SPV Detail visualization Element:: +* SPV Detail userSource Element:: +* SPV Detail sourceVariable Element:: +* SPV Detail derivedVariable Element:: +* SPV Detail extension Element:: +* SPV Detail graph Element:: +* SPV Detail location Element:: +* SPV Detail coordinates Element:: +* SPV Detail faceting Element:: +* SPV Detail facetLayout Element:: +@end menu @node SPV Detail visualization Element @subsection The @code{visualization} Element @@ -1267,6 +1308,7 @@ format used in Unix with the underscore replaced by a hyphen, e.g.@: @defvr {Required} name The title of the pivot table, localized to the output language. +@end defvr @defvr {Required} style The @code{id} of a @code{style} element (@pxref{SPV Detail style @@ -1288,10 +1330,8 @@ one of 2.4, 2.5, 2.7, and 2.8. @node SPV Detail userSource Element @subsection The @code{userSource} Element -@format Parent: @code{visualization} @* Contents: -@end format This element has the following attributes. @@ -1302,14 +1342,13 @@ Always @code{listwise}. @node SPV Detail sourceVariable Element @subsection The @code{sourceVariable} Element -@format Parent: @code{visualization} @* Contents: @code{extension}* (@code{format} @math{|} @code{stringFormat})? -@end format This element defines a variable whose values can be used elsewhere in the visualization. It ties this element's @code{id} to a variable -from the @file{.bin} member that corresponds to this @file{.xml}. +from the @file{tableData.bin} member that corresponds to this +@file{.xml}. This element has the following attributes. @@ -1319,12 +1358,14 @@ Always set to @code{true}. @defvr {Required} source Always set to @code{tableData}, the @code{source-name} in the -corresponding @file{.bin} member (@pxref{SPV Legacy Member Metadata}). +corresponding @file{tableData.bin} member (@pxref{SPV Legacy Member +Metadata}). @end defvr @defvr {Required} sourceName The name of a variable within the source, the @code{variable-name} in -the corresponding @file{.bin} member (@pxref{SPV Legacy Member Data}). +the corresponding @file{tableData.bin} member (@pxref{SPV Legacy +Member Data}). @end defvr @defvr {Optional} dependsOn @@ -1346,10 +1387,8 @@ as value labels. @node SPV Detail derivedVariable Element @subsection The @code{derivedVariable} Element -@format Parent: @code{visualization} @* Contents: @code{extension}* (@code{format} @math{|} @code{stringFormat} @code{valueMapEntry}*) -@end format Like @code{sourceVariable}, this element defines a variable whose values can be used elsewhere in the visualization. Instead of being @@ -1386,13 +1425,15 @@ viewer can work with them together. For a group variable, this is the name of the corresponding categorical variable. @end defvr +@menu +* SPV Detail valueMapEntry Element:: +@end menu + @node SPV Detail valueMapEntry Element @subsubsection The @code{valueMapEntry} Element -@format Parent: @code{derivedVariable} @* Contents: empty -@end format A @code{valueMapEntry} element defines a mapping from one or more values of a source expression to a target value. (In the corpus, the @@ -1469,3 +1510,794 @@ An integer or a name like ``dimension0''. @defvr {Required} helpId An identifier. @end defvr + +@node SPV Detail graph Element +@subsection The @code{graph} Element + +Parent: @code{visualization} @* +Contents: @code{location}@math{+} @code{coordinates} @code{faceting} @code{facetLayout} @code{interval} + +@code{graph} has the following attributes. + +@defvr {Required} cellStyle +@defvrx {Required} style +Each of these is the @code{id} of a @code{style} element (@pxref{SPV +Detail style element}). The former is the default style for +individual cells, the latter for the entire table. +@end defvr + +@node SPV Detail location Element +@subsection The @code{location} Element + +Parent: @code{graph} @* +Contents: empty + +Each instance of this element specifies where some part of the table +frame is located. All the examples in the corpus have four instances +of this element, one for each of the parts @code{height}, +@code{width}, @code{left}, and @code{top}. Some examples in the +corpus add a fifth for part @code{bottom}, even though it is not clear +how all of @code{top}, @code{bottom}, and @code{heigth} can be honored +at the same time. In any case, @code{location} seems to have little +importance in representing tables; a reader can safely ignore it. + +@defvr {Required} part +One of @code{height}, @code{width}, @code{top}, @code{bottom}, or +@code{left}. Presumably @code{right} is acceptable as well but the +corpus contains no examples. +@end defvr + +@defvr {Required} method +How the location is determined: + +@table @code +@item sizeToContent +Based on the natural size of the table. Observed only for +parts @code{height} and @code{width}. + +@item attach +Based on the location specified in @code{target}. Observed only for +parts @code{top} and @code{bottom}. + +@item fixed +Using the value in @code{value}. Observed only for parts @code{top}, +@code{bottom}, and @code{left}. + +@item same +Same as the specified @code{target}. Observed only for part +@code{left}. +@end table +@end defvr + +@defvr {Optional} min +Minimum size. Only observed with value @code{100pt}. Only observed +for part @code{width}. +@end defvr + +@defvr {Dependent} target +Required when @code{method} is @code{attach} or @code{same}, not +observed otherwise. This is the ID of an element to attach to. +Observed with the ID of @code{title}, @code{footnote}, @code{graph}, +and other elements. +@end defvr + +@defvr {Dependent} value +Required when @code{method} is @code{fixed}, not observed otherwise. +Observed values are @code{0%}, @code{0px}, @code{1px}, and @code{3px} +on parts @code{top} and @code{left}, and @code{100%} on part +@code{bottom}. +@end defvr + +@node SPV Detail coordinates Element +@subsection The @code{coordinates} Element + +Parent: @code{graph} @* +Contents: empty + +This element is always present and always empty, with no attributes +(except @code{id}). + +@node SPV Detail faceting Element +@subsection The @code{faceting} Element + +Parent: @code{graph} @* +Contents: @code{cross} @code{layer}* + +The @code{faceting} element describes the row, column, and layer +structure of the table. Its @code{cross} child determines the row and +column structure, and each @code{layer} child (if any) represents a +layer. + +@code{faceting} has no attributes (other than @code{id}). + +@subsubheading The @code{cross} Element + +Parent: @code{faceting} @* +Contents: @code{nest} @code{nest} + +The @code{cross} element describes the row and column structure of the +table. It has exactly two @code{nest} children, the first of which +describes the table's rows and the second the table's columns. + +@code{cross} has no attributes (other than @code{id}). + +@subsubheading The @code{nest} Element + +Parent: @code{cross} @* +Contents: @code{variableReference}@math{+} + +A given @code{nest} usually consists of one or more dimensions, each +of which is represented by @code{variableReference} child elements. +Minimally, a dimension has two @code{variableReference} children, one +for the categories, one for the data, e.g.: + +@example + + + + +@end example + +@noindent +Groups of categories introduce additional variable references, e.g.@: + +@example + + + + + +@end example + +@noindent +Grouping can be hierarchical, e.g.@: + +@example + + + + + + +@end example + +@noindent +XXX what are group maps? + +@example + + + + + + + + + + + +@end example + +@noindent +A @code{nest} can contain multiple dimensions: + +@example + + + + + + + +@end example + +One @code{nest} within a given @code{cross} may have no dimensions, in +which case it still has one @code{variableReference} child, which +references a @code{derivedVariable} whose @code{value} attribute is +@code{constant(0)}. In the corpus, such a @code{derivedVariable} has +@code{row} or @code{column}, respectively, as its @code{id}. + +@code{nest} has no attributes (other than @code{id}). + +@subsubheading The @code{variableReference} Element + +Parent: @code{nest} @* +Contents: empty + +@code{variableReference} has one attribute. + +@defvr {Required} ref +The @code{id} of a @code{sourceVariable} or @code{derivedVariable} +element. +@end defvr + +@subsubheading The @code{layer} Element + +Parent: @code{faceting} @* +Contents: empty + +Each layer is represented by a pair of @code{layer} elements. The +first of this pair is for a category variable, the second for the data +variable, e.g.: + +@example + + +@end example + +@noindent +@code{layer} has the following attributes. + +@defvr {Required} variable +The @code{id} of a @code{sourceVariable} or @code{derivedVariable} +element. +@end defvr + +@defvr {Required} value +The value to select. For a category variable, this is always +@code{0}; for a data variable, it is the same as the @code{variable} +attribute. +@end defvr + +@defvr {Optional} visible +Whether the layer is visible. Generally, category layers are visible +and data layers are not, but sometimes this attribute is omitted. +@end defvr + +@defvr {Optional} method +When present, this is always @code{nest}. +@end defvr + +@node SPV Detail facetLayout Element +@subsection The @code{facetLayout} Element + +Parent: @code{graph} @* +Contents: @code{tableLayout} @code{facetLevel}@math{+} @code{setCellProperties}* + +@subsubheading The @code{tableLayout} Element + +Parent: @code{facetLayout} @* +Contents: empty + +@defvr {Required} verticalTitlesInCorner +Always set to @code{true}. +@end defvr + +@defvr {Optional} style +The @code{id} of a @code{style} element. +@end defvr + +@defvr {Optional} fitCells +Always set to @code{ticks}. +@end defvr + +@subsubheading The @code{facetLevel} Element + +Parent: @code{facetLayout} @* +Contents: @code{axis} + +Each @code{facetLevel} describes a @code{variableReference} or +@code{layer}, and a table has one @code{facetLevel} element for +each such element. For example, an SPV detail member that contains +four @code{variableReference} elements and two @code{layer} elements +will contain six @code{facetLevel} elements. + +In the corpus, @code{facetLevel} elements and the elements that they +describe are always in the same order. The correspondence may also be +observed in two other ways. First, one may use the @code{level} +attribute, described below. Second, in the corpus, a +@code{facetLevel} always has an @code{id} that is the same as the +@code{id} of the element it describes with @code{_facetLevel} +appended. One should not formally rely on this, of course, but it is +usefully indicative. + +@defvr {Required} level +A 1-based index into the @code{variableReference} and @code{layer} +elements, e.g.@: a @code{facetLayout} with a @code{level} of 1 +describes the first @code{variableReference} in the SPV detail member, +and in a member with four @code{variableReference} elements, a +@code{facetLayout} with a @code{level} of 5 describes the first +@code{layer} in the member. +@end defvr + +@defvr {Required} gap +Always observed as @code{0pt}. +@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. + +@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}. +@end defvr + +@subsubheading The @code{setMetaData} Element + +Parent: @code{setCellProperties} @* +Contents: empty + +This element is not known to have any visible effect. + +@defvr {Required} target +The @code{id} of an element whose metadata is to be set. In the +corpus, this is always @code{graph}, the @code{id} used for the +@code{graph} element. +@end defvr + +@defvr {Required} key +@defvrx {Required} value +A key-value pair to set for the target. + +In the corpus, @code{key} is @code{cellPropId} or, rarely, +@code{diagProps}, and @code{value} is always the @code{id} of the +parent @code{setCellProperties}. +@end defvr + +@subsubheading The @code{setStyle} Element + +Parent: @code{setCellProperties} @* +Contents: empty + +This element associates a style with the target. + +@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{interval}, @code{labeling}, +or, rarely, @code{graph} element. +@end defvr + +@defvr {Required} style +The @code{id} of a @code{style} element that identifies the style to +set on the target. +@end defvr + +@subsubheading The @code{setFormat} Element + +@format +Parent: @code{setCellProperties} +Contents: + @code{format} + @math{|} @code{numberFormat} + @math{|} @code{stringFormat}@math{+} + @math{|} @code{dateTimeFormat} +@end format + +This element sets the format of the target, ``format'' in this case +meaning the SPSS print format for a variable. + +The details of this element vary depending on the schema version, as +declared in the root @code{visualization} element's @code{version} +attribute (@pxref{SPV Detail visualization Element}). In version 2.5 +and earlier, @code{setFormat} contains one of a number of child +elements that correspond to the different varieties of print formats. +In version 2.7 and later, @code{setFormat} instead always contains a +@code{format} element. + +XXX reinvestigate the above claim about versions: it appears to be +incorrect. + +@menu +* SPV Detail format Element:: +* SPV Detail numberFormat Element:: +* SPV Detail stringFormat Element:: +* SPV Detail dateTimeFormat Element:: +* SPV Detail affix Element:: +* SPV Detail relabel Element:: +@end menu + +@node SPV Detail format Element +@subsubsection The @code{format} Element + +Parent: @code{sourceVariable}, @code{derivedVariable}, @code{formatMapping}, @code{labeling}, @code{formatMapping}, @code{setFormat} @* +Contents: (@code{affix}@math{+} @math{|} @code{relabel}@math{+})? + +This element appears only in schema version 2.7 (@pxref{SPV Detail +visualization Element}). + +This element determines a format, equivalent to an SPSS print format. + +@subsubheading Attributes for All Formats + +These attributes apply to all kinds of formats. The most important of +these attributes determines the high-level kind of formatting in use: + +@defvr {Optional} baseFormat +Either @code{dateTime} or @code{elapsedTime}. When this attribute is +omitted, this element is a numeric or string format. +@end defvr + +@noindent +Whether, in the corpus, other attributes are always present (``yes''), +never present (``no''), or sometimes present (``opt'') depends on +@code{baseFormat}: + +@multitable {maximumFractionDigits} {@code{dateTime}} {@code{elapsedTime}} {number} {string} +@headitem Attribute @tab @code{dateTime} @tab @code{elapsedTime} @tab number @tab string +@item errorCharacter @tab yes @tab yes @tab yes @tab opt +@item @w{ } +@item separatorChars @tab yes @tab no @tab no @tab no +@item @w{ } +@item mdyOrder @tab yes @tab no @tab no @tab no +@item @w{ } +@item showYear @tab yes @tab no @tab no @tab no +@item yearAbbreviation @tab yes @tab no @tab no @tab no +@item @w{ } +@item showMonth @tab yes @tab no @tab no @tab no +@item monthFormat @tab yes @tab no @tab no @tab no +@item @w{ } +@item showDay @tab yes @tab opt @tab no @tab no +@item dayPadding @tab yes @tab opt @tab no @tab no +@item dayOfMonthPadding @tab yes @tab no @tab no @tab no +@item dayType @tab yes @tab no @tab no @tab no +@item @w{ } +@item showHour @tab yes @tab opt @tab no @tab no +@item hourFormat @tab yes @tab opt @tab no @tab no +@item hourPadding @tab yes @tab yes @tab no @tab no +@item @w{ } +@item showMinute @tab yes @tab yes @tab no @tab no +@item minutePadding @tab yes @tab yes @tab no @tab no +@item @w{ } +@item showSecond @tab yes @tab yes @tab no @tab no +@item secondPadding @tab no @tab yes @tab no @tab no +@item @w{ } +@item showMillis @tab no @tab yes @tab no @tab no +@item @w{ } +@item minimumIntegerDigits @tab no @tab no @tab yes @tab no +@item maximumFractionDigits @tab no @tab yes @tab yes @tab no +@item minimumFractionDigits @tab no @tab yes @tab yes @tab no +@item useGrouping @tab no @tab opt @tab yes @tab no +@item scientific @tab no @tab no @tab yes @tab no +@item small @tab no @tab no @tab opt @tab no +@item suffix @tab no @tab no @tab opt @tab no +@item @w{ } +@item tryStringsAsNumbers @tab no @tab no @tab no @tab yes +@item @w{ } +@end multitable + +@defvr {Attribute} errorCharacter +A character that replaces the formatted value when it cannot otherwise +be represented in the given format. Always @samp{*}. +@end defvr + +@subsubheading Date and Time Attributes + +These attributes are used with @code{dateTime} and @code{elapsedTime} +formats or both. + +@defvr {Attribute} separatorChars +Exactly four characters. In order, these are used for: decimal point, +grouping, date separator, time separator. Always @samp{.,-:}. +@end defvr + +@defvr {Attribute} mdyOrder +Within a date, the order of the days, months, and years. +@code{dayMonthYear} is the only observed value, but one would expect +that @code{monthDayYear} and @code{yearMonthDay} to be reasonable as +well. +@end defvr + +@defvr {Attribute} showYear +@defvrx {Attribute} yearAbbreviation +Whether to include the year and, if so, whether the year should be +shown abbreviated, that is, with only 2 digits. Each is @code{true} +or @code{false}; only values of @code{true} and @code{false}, +respectively, have been observed. +@end defvr + +@defvr {Attribute} showMonth +@defvrx {Attribute} monthFormat +Whether to include the month (@code{true} or @code{false}) and, if so, +how to format it. @code{monthFormat} is one of the following: + +@table @code +@item long +The full name of the month, e.g.@: in an English locale, +@code{September}. + +@item short +The abbreviated name of the month, e.g.@: in an English locale, +@code{Sep}. + +@item number +The number representing the month, e.g.@: 9 for September. + +@item paddedNumber +A two-digit number representing the month, e.g.@: 09 for September. +@end table + +Only values of @code{true} and @code{short}, respectively, have been +observed. +@end defvr + +@defvr {Attribute} dayPadding +@defvrx {Attribute} dayOfMonthPadding +@defvrx {Attribute} hourPadding +@defvrx {Attribute} minutePadding +@defvrx {Attribute} secondPadding +These attributes presumably control whether each field in the output +is padded with spaces to its maximum width, but the details are not +understood. The only observed value for any of these attributes is +@code{true}. +@end defvr + +@defvr {Attribute} showDay +@defvrx {Attribute} showHour +@defvrx {Attribute} showMinute +@defvrx {Attribute} showSecond +@defvrx {Attribute} showMillis +These attributes presumably control whether each field is displayed +in the output, but the details are not understood. The only +observed value for any of these attributes is @code{true}. +@end defvr + +@defvr {Attribute} dayType +This attribute is always @code{month} in the corpus, specifying that +the day of the month is to be displayed; a value of @code{year} is +supposed to indicate that the day of the year, where 1 is January 1, +is to be displayed instead. +@end defvr + +@defvr {Attribute} hourFormat +@code{hourFormat}, if present, is one of: + +@table @code +@item AMPM +The time is displayed with an @code{am} or @code{pm} suffix, e.g.@: +@code{10:15pm}. + +@item AS_24 +The time is displayed in a 24-hour format, e.g.@: @code{22:15}. + +This is the only value observed in the corpus. + +@item AS_12 +The time is displayed in a 12-hour format, without distinguishing +morning or evening, e.g.@: @code{10;15}. +@end table + +@code{hourFormat} is sometimes present for @code{elapsedTime} formats, +which is confusing since a time duration does not have a concept of AM +or PM. This might indicate a bug in the code that generated the XML +in the corpus, or it might indicate that @code{elapsedTime} is +sometimes used to format a time of day. +@end defvr + +@subsubheading Numeric Attributes + +These attributes are used for formats when @code{baseFormat} is +@code{number}. Attributes @code{maximumFractionDigits}, and +@code{minimumFractionDigits}, and @code{useGrouping} are also used +when @code{baseFormat} is @code{elapsedTime}. + +@defvr {Attribute} minimumIntegerDigits +Minimum number of digits to display before the decimal point. Always +observed as @code{0}. +@end defvr + +@defvr {Attribute} maximumFractionDigits +@defvrx {Attribute} maximumFractionDigits +Maximum or minimum, respectively, number of digits to display after +the decimal point. The observed values of each attribute range from 0 +to 9. +@end defvr + +@defvr {Attribute} useGrouping +Whether to use the grouping character to group digits in large +numbers. It would make sense for the grouping character to come from +the @code{separatorChars} attribute, but that attribute is only +present when @code{baseFormat} is @code{dateTime} or +@code{elapsedTime}, in the corpus at least. Perhaps that is because +this attribute has only been observed as @code{false}. +@end defvr + +@defvr {Attribute} scientific +This attribute controls when and whether the number is formatted in +scientific notation. It takes the following values: + +@table @code +@item onlyForSmall +Use scientific notation only when the number's magnitude is smaller +than the value of the @code{small} attribute. + +@item whenNeeded +Use scientific notation when the number will not otherwise fit in the +available space. + +@item true +Always use scientific notation. Not observed in the corpus. + +@item false +Never use scientific notation. A number that won't otherwise fit will +be replaced by an error indication (see the @code{errorCharacter} +attribute). Not observed in the corpus. +@end table +@end defvr + +@defvr {Optional} small +Only present when the @code{scientific} attribute is +@code{onlyForSmall}, this is a numeric magnitude below which the +number will be formatted in scientific notation. The values @code{0} +and @code{0.0001} have been observed. The value @code{0} seems like a +pathological choice, since no real number has a magnitude less than 0; +perhaps in practice such a choice is equivalent to setting +@code{scientific} to @code{false}. +@end defvr + +@defvr {Optional} prefix +@defvrx {Optional} suffix +Specifies a prefix or a suffix to apply to the formatted number. Only +@code{suffix} has been observed, with value @samp{%}. +@end defvr + +@subsubheading String Attributes + +These attributes are used for formats when @code{baseFormat} is +@code{string}. + +@defvr {Attribute} tryStringsAsNumbers +When this is @code{true}, it is supposed to indicate that string +values should be parsed as numbers and then displayed according to +numeric formatting rules. However, in the corpus it is always +@code{false}. +@end defvr + +@node SPV Detail numberFormat Element +@subsubsection The @code{numberFormat} Element + +Parent: @code{setFormat} @* +Contents: @code{affix}@math{+} + +This element appears only in schema version 2.5 and earlier +(@pxref{SPV Detail visualization Element}). Possibly this element +could also contain @code{relabel} elements in a more diverse corpus. + +This element has the following attributes. + +@defvr {Attribute} maximumFractionDigits +@defvrx {Attribute} minimumFractionDigits +@defvrx {Attribute} minimumIntegerDigits +@defvrx {Optional} scientific +@defvrx {Optional} small +@defvrx {Optional} suffix +@defvrx {Optional} useGroupging +The syntax and meaning of these attributes is the same as on the +@code{format} element for a numeric format. @pxref{SPV Detail format +element}. +@end defvr + +@node SPV Detail stringFormat Element +@subsubsection The @code{stringFormat} Element + +Parent: @code{setFormat} @* +Contents: (@code{affix}@math{+} @math{|} @code{relabel}@math{+})? + +This element appears only in schema version 2.5 and earlier +(@pxref{SPV Detail visualization Element}). + +This element has no attributes. + +@node SPV Detail dateTimeFormat Element +@subsubsection The @code{dateTimeFormat} Element + +Parent: @code{setFormat} @* +Contents: empty + +This element appears only in schema version 2.5 and earlier +(@pxref{SPV Detail visualization Element}). Possibly this element +could also contain @code{affix} and @code{relabel} elements in a more +diverse corpus. + +The following attribute is required. + +@defvr {Attribute} baseFormat +Either @code{dateTime} or @code{time}. +@end defvr + +When @code{baseFormat} is @code{dateTime}, the following attributes +are available. + +@defvr {Attribute} dayOfMonthPadding +@defvrx {Attribute} dayPadding +@defvrx {Attribute} dayType +@defvrx {Attribute} hourFormat +@defvrx {Attribute} hourPadding +@defvrx {Attribute} mdyOrder +@defvrx {Attribute} minutePadding +@defvrx {Attribute} monthFormat +@defvrx {Attribute} separatorChars +@defvrx {Attribute} showDay +@defvrx {Attribute} showHour +@defvrx {Attribute} showMinute +@defvrx {Attribute} showMonth +@defvrx {Attribute} showSecond +@defvrx {Attribute} showYear +@defvrx {Attribute} yearAbbreviation +The syntax and meaning of these attributes is the same as on the +@code{format} element when that element's @code{baseFormat} is +@code{dateTime}. @pxref{SPV Detail format Element}. +@end defvr + +When @code{baseFormat} is @code{time}, the following attributes are +available. + +@defvr {Attribute} hourFormat +@defvrx {Attribute} hourPadding +@defvrx {Attribute} minutePadding +@defvrx {Attribute} monthFormat +@defvrx {Attribute} separatorChars +@defvrx {Attribute} showDay +@defvrx {Attribute} showHour +@defvrx {Attribute} showMinute +@defvrx {Attribute} showMonth +@defvrx {Attribute} showSecond +@defvrx {Attribute} showYear +@defvrx {Attribute} yearAbbreviation +The syntax and meaning of these attributes is the same as on the +@code{format} element when that element's @code{baseFormat} is +@code{elapsedTime}. @pxref{SPV Detail format Element}. +@end defvr + +@node SPV Detail affix Element +@subsubsection The @code{affix} Element + +Parent: @code{format} or @code{numberFormat} or @code{stringFormat} @* +Contents: empty + +Possibly this element could have @code{dateTimeFormat} as a parent in +a more diverse corpus. + +This defines a suffix (or, theoretically, a prefix) for a formatted +value. It is used to insert a reference to a footnote. It has the +following attributes: + +@defvr {Attribute} definesReference +This specifies the footnote number as a natural number: 1 for the +first footnote, 2 for the second, and so on. +@end defvr + +@defvr {Attribute} position +Position for the footnote label. Always @code{superscript}. +@end defvr + +@defvr {Attribute} suffix +Whether the affix is a suffix (@code{true}) or a prefix +(@code{false}). Always @code{true}. +@end defvr + +@defvr {Attribute} value +The text of the suffix or prefix. Typically a letter, e.g.@: @code{a} +for footnote 1, @code{b} for footnote 2, @enddots{} The corpus +contains other values: @code{*}, @code{**}, and a few that begin with +at least one comma: @code{,b}, @code{,c}, @code{,,b}, and @code{,,c}. +@end defvr + +@node SPV Detail relabel Element +@subsubsection The @code{relabel} Element + +Parent: @code{format} or @code{stringFormat} @* +Contents: empty + +Possibly this element could have @code{numberFormat} or +@code{dateTimeFormat} as a parent in a more diverse corpus. + +This specifies how to display a given value. It is used to implement +value labels and to display the system-missing value in a +human-readable way. It has the following attributes: + +@defvr {Attribute} from +The value to map. In the corpus this is an integer or the +system-missing value @code{-1.797693134862316E300}. +@end defvr + +@defvr {Attribute} to +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