..
/
download
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "s1kd2pdf" "1" "2019\-03\-26" "" "S1000D XSL Stylesheets"
.hy
.SH NAME
.PP
s1kd2pdf \- Create a PDF from S1000D data
.SH SYNOPSIS
.IP
.nf
\f[C]
s1kd2pdf\ [\-c\ <CFG>]\ [\-s\ <XSL>]\ [\-d\ <XSL>]\ [\-o\ <out>]\ [\-DFISh?]\ <src>
\ \ \ \ \ \ \ \ \ [<param>...]
\f[]
.fi
.SH DESCRIPTION
.PP
The \f[I]s1kd2pdf\f[] command will create a PDF from S1000D data modules
or publications using the S1000D XSL Stylesheets, xsltproc, and Apache
FOP.
.SH OPTIONS
.TP
.B \-c <CFG>
Specify a FOP XML configuration file.
By default, /etc/fop.xml will be used (if it exists).
.RS
.RE
.TP
.B \-D
Generate template XSLT for a custom DocBook\-to\-FO stylesheet (\-d).
.RS
.RE
.TP
.B \-d <XSL>
Use a custom stylesheet for DocBook\-to\-FO conversion.
.RS
.RE
.TP
.B \-F
Output the generated XSL\-FO instead of a PDF.
.RS
.RE
.TP
.B \-I
Output Apache FOP intermediary format instead of a PDF.
.RS
.RE
.TP
.B \-o <out>
Output to <out> instead of <src>.pdf (or <src>.fo if the \-F option is
used).
.RS
.RE
.TP
.B \-S
Generate template XSLT for a custom S1000D\-to\-DocBook stylesheet
(\-s).
.RS
.RE
.TP
.B \-s <XSL>
Use a custom stylesheet for S1000D\-to\-DocBook conversion.
.RS
.RE
.TP
.B <src>
Source S1000D module to create a PDF from.
.RS
.RE
.TP
.B <param>...
xsltproc parameters to pass to both stylesheets.
.RS
.RE
.SS Adding customizations to the stylesheets
.PP
To add project\-specific customizations to the PDF output:
.IP "1." 3
Use the \-D/\-S options to create a template XSLT file which imports the
installed default stylesheets.
.IP "2." 3
Add customizations to this file.
.IP "3." 3
Use the \-d/\-s options to apply this custom stylesheet.
.PP
Example:
.IP
.nf
\f[C]
$\ s1kd2pdf\ \-S\ >\ custom.xsl
\f[]
.fi
.IP
.nf
\f[C]
<?xml\ version="1.0"?>
<xsl:stylesheet
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version="1.0">
<xsl:import\ href="/path/to/original/stylesheet.xsl"/>
<!\-\-\ Present\ verbatimText\ type\ vs51\ as\ green.\ \-\->
<xsl:template\ match="verbatimText[\@verbatimStyle\ =\ \[aq]vs51\[aq]]">
<fo:inline\ color="green">
<xsl:apply\-imports/>
</fo:inline>
</xsl:template>
</xsl:stylesheet>
\f[]
.fi
.IP
.nf
\f[C]
$\ s1kd2pdf\ \-s\ custom.xsl\ ...
\f[]
.fi
.SH PARAMETERS
.PP
The following parameters can be supplied at the end of the command with
the \-param or \-stringparam flags to customize the PDF output:
.TP
.B applic.prefix
The prefix before applicability annotations.
Default is "Applicable to: ".
.RS
.RE
.TP
.B auto.expand.acronyms
Choose how to expand acronyms:
.RS
.IP \[bu] 2
"no" \- Only show the term
.IP \[bu] 2
"before" \- Show the definition followed by the term in parentheses
(default)
.IP \[bu] 2
"after" \- Show the term followed by the definition in parentheses
.RE
.TP
.B bridgehead.in.toc
Whether to include default headings in each data module\[aq]s TOC.
.RS
.RE
.TP
.B data.module.index
Include an index section in each data module.
.RS
.RE
.TP
.B date.time
When set, add the "Printed $date.time" statement to the left margin.
.RS
.RE
.TP
.B definition.list.term.width
Width of the term column in a definition list.
.RS
.RE
.TP
.B double.sided
Whether to use alternating headers/footers for double\-sided printing.
.RS
.RE
.TP
.B end.of.data.module.position
Where to present the "End of data module" statement.
.RS
.RE
.TP
.B end.of.text
How the text of the "End of data module" statement is determined.
.RS
.RE
.TP
.B external.pub.ref.inline
How external publication references are presented.
.RS
.RE
.TP
.B font.family
The default font family for all elements.
.RS
.RE
.TP
.B footer.show.applic
Whether to show the "Applicability" statement in the footer.
.RS
.RE
.TP
.B footer.show.dmc
Whether to show the data module code in the footer.
.RS
.RE
.TP
.B footer.show.end.of.data.module
Whether to show the "End of data module" statement in the footer.
.RS
.RE
.TP
.B footer.show.security
Whether to show the security statement in the footer.
.RS
.RE
.TP
.B footnote.font.size
The font size of a footnote.
.RS
.RE
.TP
.B front.matter.info.codes
Descriptive data modules with any of these info codes are presented as
front matter.
.RS
.RE
.TP
.B generate.barcode
Use the barCodeCode element of the title page to generate a barcode
graphic using Barcode4j if no barCodeSymbol element is included.
.RS
.RE
.TP
.B generate.display.text
If set to "0", display text for applicability annotations that have none
will not be automatically generated, and no annotation will be displayed
on elements referencing it.
.RS
.RE
.TP
.B generate.highlights
Generate a Highlights section when encountering a descriptive data
module with info code 00U.
.RS
.RE
.TP
.B generate.index
Generate an index when encountering a descriptive data module with info
code 014.
.RS
.RE
.TP
.B generate.list.of.datamodules
Generate a List of effective data modules when encountering a
descriptive data module with info code 00S.
.RS
.RE
.TP
.B generate.list.of.illustrations
Generate a List of illustrations when encountering a descriptive data
module with info code 00A.
.RS
.RE
.TP
.B generate.list.of.tables
Generate a List of tables when encountering a descriptive data module
with info code 00Z.
.RS
.RE
.TP
.B generate.table.of.contents
Generate a Table of contents when encountering a descriptive data module
with info code 009.
.RS
.RE
.TP
.B generate.title.page
Generate a Title page when encountering a descriptive data module with
info code 001.
.RS
.RE
.TP
.B generated.hierarchical.toc.indent
The indentation of each level of the hierarchical table of contents.
.RS
.RE
.TP
.B header.show.security
Whether to show the security statement in the header.
.RS
.RE
.TP
.B hide.deleted.content
.IP \[bu] 2
"0" \- Present "deleted" content as struck\-through.
.IP \[bu] 2
"1" \- Hide "deleted" content.
.RS
.RE
.TP
.B hide.empty.proced.rqmts
Hide empty tables in the preliminary requirements section.
.RS
.RE
.TP
.B hide.empty.refs.table
Hide the References table if it is empty.
.RS
.RE
.TP
.B hierarchical.table.of.contents
Generate a hierarchical table of contents.
.RS
.RE
.TP
.B highlight.applic
Highlight applicability statements by colouring them blue.
.RS
.RE
.TP
.B include.pmentry.bookmarks
Include pmEntry levels and titles in the PDF bookmarks.
.RS
.RE
.TP
.B include.title.in.toc
Whether and how to include the data module title in the data
module\[aq]s TOC.
.RS
.RE
.TP
.B index.type
What kind of index to generate.
.RS
.RE
.TP
.B part.no.prefix
Prefix part numbers with the text "Part No."
.RS
.RE
.TP
.B printedin.blurb
When set, adds a "Printed in" statement after the "Published by"
statement, indicating the country the document was produced in.
.RS
.RE
.TP
.B printedin.blurb.before
The text between the "Produced by" and the "Printed in" statements.
.RS
.RE
.TP
.B producedby.blurb
Set the "Produced by" statement for the whole publication manually,
rather than deriving it from each data module\[aq]s responsible partner
company.
.RS
.RE
.TP
.B producedby.blurb.before
The text label of the "Produced by" statement.
.RS
.RE
.TP
.B producedby.blurb.on.titlepage
Whether or not to show the "Produced by" statement on the title page.
Often this can be redundant as the title page also includes the name of
the producer.
.RS
.RE
.TP
.B publication.code
Set the publication code manually instead of using the one derived from
the publication module.
.RS
.RE
.TP
.B quantity.decimal.format
The format to use when presenting quantity values.
.RS
.IP \[bu] 2
"SI" \- comma for decimal separator, space for grouping (default)
.IP \[bu] 2
"imperial" \- period for decimal separator, comma for grouping
.RE
.TP
.B quantity.decimal.separator
Decimal separator in formatted quantity values.
.RS
.RE
.TP
.B quantity.format
The picture string passed to format\-number() when reformat.quantities =
custom.
.RS
.RE
.TP
.B quantity.grouping.separator
Grouping separator in formatted quantity values.
.RS
.RE
.TP
.B reformat.quantities
Controls whether and how quantities are reformatted for presentation.
.RS
.IP \[bu] 2
"normal" \- Use appropriate decimal separator, add thousands separators,
preserve leading and trailing zeroes (default).
.IP \[bu] 2
"custom" \- Completely reformat all values using the format string
$quantity.format.
Removes leading and trailing zeroes.
.IP \[bu] 2
"basic" \- Use the appropriate decimal separator, preserve leading and
trailing zeroes, but do not add thousands separators.
.RE
.TP
.B running.pagination
Whether to use normal or running pagination.
.RS
.RE
.TP
.B running.pagination
Whether to use normal or running pagination.
.RS
.RE
.TP
.B show.content.applic
Whether content applicability annotations are shown.
.RS
.IP \[bu] 2
"0" \- Do not show content applicability annotations
.IP \[bu] 2
"1" \- Show content applicability annotations (default)
.RE
.TP
.B show.graphic.icn
Whether to show the ICN below a graphic.
.RS
.RE
.TP
.B show.schema.heading
Whether to include the default heading related to the S1000D schema of a
data module.
.RS
.RE
.TP
.B show.unclassified
Whether to show the text "UNCLASSIFIED" when a document is not
classified.
.RS
.RE
.TP
.B simple.info.codes
Descriptive data modules with these info codes will be presented with a
minimal stylesheet, without the standard lists, tables, or headings.
.RS
.RE
.TP
.B title.fontset
Default font for titles.
.RS
.RE
.TP
.B title.page.barcode.symbology
When title.page.barcode.value is specified, this is the type of barcode
to generate.
Can either be one of the S1000D project configurable attribute values
for barCodeSymbology (e.g., bcs13) or the name of a Barcode4j format
(e.g., code128).
.RS
.RE
.TP
.B title.page.barcode.value
When this is set, a barcode will be automatically generated for the
title page using the given value.
The type of barcode can be specified with title.page.barcode.symbology.
If using a frontmatter schema title page, this will override the barCode
element.
.RS
.RE
.TP
.B title.page.illustration
Product illustration to show on the title page.
Can be used to provide an illustration when the title page is generated
with a descriptive DM placeholder (as opposed to a frontmatter DM) or to
override the illustration specified in a frontmatter title page DM.
.RS
.RE
.TP
.B title.page.illustration.height
When title.page.illustration is specified, use this as the reproduction
height of the illustration.
.RS
.RE
.TP
.B title.page.illustration.scale
When title.page.illustration is specified, use this as the reproduction
scale of the illustration.
.RS
.RE
.TP
.B title.page.illustration.width
When title.page.illustration is specified, use this as the reproduction
width of the illustration.
.RS
.RE
.TP
.B title.page.issue.date
Show the issue date of the publication module on the generated title
page.
.RS
.RE
.TP
.B title.page.publisher
Show the responsible partner company on the generated title page.
.RS
.RE
.TP
.B titled.labelled.para.toc
Include "labelled paras" besides levelledPara in the data module\[aq]s
TOC.
For example, steps with titles.
.RS
.RE
.TP
.B toc.section.depth
The depth of each data module\[aq]s TOC.
.RS
.RE
.TP
.B ulink.footnotes
Whether to present external publication hyperlinks as footnotes.
.RS
.RE
.TP
.B ulink.show
Whether to show external publication hyperlinks inline.
.RS
.RE
.TP
.B use.unparsed.entity.uri
Use the unparsed entity URI to resolve an ICN reference rather than the
InfoEntityResolver and info\-entity\-map concept.
.RS
.RE
.TP
.B want.inwork.blurb
Whether to include a statement in the left margin when a data module is
a draft issue.
.RS
.RE
.TP
.B want.producedby.blurb
Whether to include the "Produced by" statement in the left margin.
.RS
.RE
.SH EXAMPLE
.IP
.nf
\f[C]
$\ s1kd2pdf\ \-o\ test.pdf\ test.xml\ \-param\ show.unclassified\ 0
\f[]
.fi
.SH AUTHORS
khzae.net.
gopher://khzae.net/0/s1kd/S1000D-XSL-Stylesheets/src/doc/s1kd2pdf.1