X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=spv-file-format.texi;h=5e95b53a9e1491acc15326e297c70c47a5a07ba8;hb=eb5a888913207139985fcd85886b6b9c36aa01a0;hp=eac26048d9bab842283f70096fc31f645186a2c4;hpb=c5de9e3e53800a63a035b511dad9c577925867a0;p=pspp diff --git a/spv-file-format.texi b/spv-file-format.texi index eac26048d9..5e95b53a9e 100644 --- a/spv-file-format.texi +++ b/spv-file-format.texi @@ -93,12 +93,14 @@ require a reader to take schemas or namespaces into account. @table @code @item heading Parent: Document root or @code{heading} @* -Contents: @code{label} [@code{container} | @code{heading}]* +Contents: [@code{pageSetup}] @code{label} [@code{container} | @code{heading}]* The root of a structure member is a @code{heading}, which represents a section of output beginning with a title (the @code{label}) and -ordinarily followed by a container for content and possibly further -nested (sub)-sections of output. +ordinarily followed by content containers or further nested +(sub)-sections of output. + +The document root heading may also contain a @code{pageSetup} element. The following attributes have been observed on both document root and nested @code{heading} elements: @@ -202,6 +204,10 @@ The width of the container in the form @code{@var{n}px}, e.g.@: Parent: @code{container} @* Contents: @code{html} +This @code{text} element is nested inside a @code{container}. There +is a different @code{text} element that is nested inside a +@code{pageParagraph}. + @table @asis @item Required attribute: @code{type} One of @code{title}, @code{log}, or @code{text}. @@ -219,10 +225,45 @@ As on the @code{heading} element. Parent: @code{text} @* Contents: cdata +The cdata contains an HTML document. In some cases, the document +starts with @code{} and ends with @code{}. The actual content ranges from trivial to simple: +just discarding the CSS and tags yields readable results. + +@table @asis +@item Required attribute: @code{lang} +This always contains @code{en} in the corpus. +@end table + @item table Parent: @code{container} @* Contents: @code{tableStructure} +@table @asis +@item Required attribute: @code{commandName} +As on the @code{heading} element. + +@item Required attribute: @code{type} +One of @code{table}, @code{note}, or @code{warning}. + +@item Required attribute: @code{subType} +The locale-invariant name for the particular kind of output that this +table represents in the procedure. This can be the same as +@code{commandName} e.g.@: @code{Frequencies}, or different, e.g.@: +@code{Case Processing Summary}. Generic subtypes @code{Notes} and +@code{Warnings} are often used. + +@item Required attribute: @code{tableId} +A number that uniquely identifies the table within the SPV file, +typically a large negative number such as @code{-4147135649387905023}. + +@item Optional attribute: @code{creator-version} +As on the @code{heading} element. In the corpus, this is only present +for version 21 and up and always includes all 8 digits. +@end table + @item tableStructure Parent: @code{table} Contents: @code{dataPath} @@ -230,4 +271,85 @@ Contents: @code{dataPath} @item dataPath Parent: @code{tableStructure} Contents: text + +Contains the name of the Zip member that holds the table details, +e.g.@: @code{0000000001437_lightTableData.bin}. + +@item pageSetup +Parent: @code{heading} @* +Contents: @code{pageHeader} @code{pageFooter} + +@table @asis +@item Required attribute: @code{initial-page-number} +Always @code{1}. + +@item Optional attribute: @code{chart-size} +Always @code{as-is} or a localization (!) of it (e.g.@: @code{dimensione +attuale}, @code{Wie vorgegeben}). + +@item Optional attribute: @code{margin-left} +@itemx Optional attribute: @code{margin-right} +@itemx Optional attribute: @code{margin-top} +@itemx Optional attribute: @code{margin-bottom} +Margin sizes in the form @code{@var{size}in}, e.g.@: @code{0.25in}. + +@item Optional attribute: @code{paper-height} +@itemx Optional attribute: @code{paper-width} +Paper sizes in the form @code{@var{size}in}, e.g.@: @code{8.5in} by +@code{11in} for letter paper or @code{8.267in} by @code{11.692in} for +A4 paper. + +@item Optional attribute: @code{reference-orientation} +Always @code{0deg}. + +@item Optional attribute: @code{space-after} +Always @code{12pt}. +@end table + +@item pageHeader +@itemx pageFooter +Parent: @code{pageSetup} @* +Contents: @code{pageParagraph}* + +No attributes. + +@item pageParagraph +Parent: @code{pageHeader} or @code{pageFooter} @* +Contents: @code{text} + +Text to go at the top or bottom of a page, respectively. + +@item text +Parent: @code{pageParagraph} @* +Contents: [cdata] + +This @code{text} element is nested inside a @code{pageParagraph}. There +is a different @code{text} element that is nested inside a +@code{container}. + +The element is either empty, or contains cdata that holds almost-XHTML +text: in the corpus, either an @code{html} or @code{p} element. It is +@emph{almost}-XHTML because the @code{html} element designates the +default namespace as +@code{http://xml.spss.com/spss/viewer/viewer-tree} instead of an XHTML +namespace. + +The cdata can contain substitution variables: @code{&[Page]} for the +page number and @code{&[PageTitle]} for the page title. + +Typical contents (indented for clarity): + +@example + + + +

Page &[Page]

+ + +@end example + +@table @asis +@item Required attribute: @code{type} +Always @code{text}. +@end table @end table