From acbc23b06be71e6341fe9434c2f2e55e76ddb282 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Sun, 24 Jul 2016 20:41:52 -0700 Subject: [PATCH] Document other format-related elements. --- spv-file-format.texi | 177 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 173 insertions(+), 4 deletions(-) diff --git a/spv-file-format.texi b/spv-file-format.texi index e96ce17cb9..a530ec9add 100644 --- a/spv-file-format.texi +++ b/spv-file-format.texi @@ -1880,10 +1880,26 @@ 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})? +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. @@ -1893,9 +1909,8 @@ 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 -One of @code{date}, @code{time}, @code{dateTime}, or -@code{elapsedTime}. When this attribute is omitted, this element is a -numeric or string format. +Either @code{dateTime} or @code{elapsedTime}. When this attribute is +omitted, this element is a numeric or string format. @end defvr @noindent @@ -2132,3 +2147,157 @@ 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 -- 2.30.2