diff options
Diffstat (limited to 'kdoctools/docbook/xsl/params')
403 files changed, 12138 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/ChangeLog b/kdoctools/docbook/xsl/params/ChangeLog new file mode 100644 index 000000000..348b17460 --- /dev/null +++ b/kdoctools/docbook/xsl/params/ChangeLog @@ -0,0 +1,830 @@ +2004-11-23 Michael Smith <xmldoc@users.sourceforge.net> + + * footnote.number.symbols.xml, formal.title.placement.xml, menuchoice.menu.separator.xml, menuchoice.separator.xml, table.footnote.number.symbols.xml: + Filled out refpurposes + + * htmlhelp.hhc.binary.xml, htmlhelp.hhc.folders.instead.books.xml: + Filled out a couple of empty refpurpose's + + * process.empty.source.toc.xml, process.source.toc.xml: + Ref. doc change; Filled in a couple of FIXMEs + + * simplesect.in.toc.xml: New file. + +2004-11-22 Jirka Kosek <kosek@users.sourceforge.net> + + * index.prefer.titleabbrev.xml: New file. + +2004-11-18 Robert Stayton <bobstayton@users.sourceforge.net> + + * component.title.properties.xml: Moved the hardwired properties from the component.title template to + this attribute-set. + +2004-11-08 Michael Smith <xmldoc@users.sourceforge.net> + + * ebnf.assignment.xml: Replace <tt></tt> output with <code></code> + +2004-10-29 Norman Walsh <nwalsh@users.sourceforge.net> + + * shade.verbatim.xml: Added description + +2004-10-26 Robert Stayton <bobstayton@users.sourceforge.net> + + * callout.graphics.number.limit.xml: Changed the default from 10 to 15. + +2004-10-21 Michael Smith <xmldoc@users.sourceforge.net> + + * admon.textlabel.xml, article.appendix.title.properties.xml, htmlhelp.display.progress.xml, htmlhelp.enhanced.decompilation.xml, htmlhelp.hhc.width.xml, htmlhelp.hhp.windows.xml, htmlhelp.remember.window.position.xml, htmlhelp.show.toolbar.text.xml, htmlhelp.window.geometry.xml, index.preferred.page.properties.xml, manifest.in.base.dir.xml, qanda.title.properties.xml, textdata.default.encoding.xml: + Bug #865551 (release 1.64.1 contains executable xml files) + + Changed perms to 644 & added newline to end of each to force commit + +2004-10-20 Jirka Kosek <kosek@users.sourceforge.net> + + * hyphenate.verbatim.xml: New file. + +2004-10-19 Norman Walsh <nwalsh@users.sourceforge.net> + + * verbatim.properties.xml: Add hyphenate=false to verbatim.properties + +2004-10-04 <balls@users.sourceforge.net> + + * wordml.template.xml: New file. + +2004-09-23 Robert Stayton <bobstayton@users.sourceforge.net> + + * chunk.separate.lots.xml: fixed misworded reference. + +2004-08-26 Robert Stayton <bobstayton@users.sourceforge.net> + + * component.label.includes.part.label.xml: New file. + +2004-08-19 Jirka Kosek <kosek@users.sourceforge.net> + + * footnote.sep.leader.properties.xml: Fixed WF error + +2004-08-15 Robert Stayton <bobstayton@users.sourceforge.net> + + * footnote.sep.leader.properties.xml: New file. + +2004-08-12 Robert Stayton <bobstayton@users.sourceforge.net> + + * arbortext.extensions.xml, axf.extensions.xml, fop.extensions.xml, passivetex.extensions.xml, xep.extensions.xml: + Mentioned that the parameter also affects which graphics + file formats are supported. + + * img.src.path.xml: New file. + +2004-08-09 Robert Stayton <bobstayton@users.sourceforge.net> + + * insert.olink.page.number.xml, insert.olink.pdf.frag.xml, olink.debug.xml, olink.doctitle.xml, olink.lang.fallback.sequence.xml, olink.properties.xml, prefer.internal.olink.xml: + New parameters to support new olink features. + +2004-06-22 Robert Stayton <bobstayton@users.sourceforge.net> + + * index.on.role.xml: Mentioned index.on.type for 4.3 users. + + * index.on.role.xml, index.on.type.xml: Changed the default value to zero. + +2004-06-21 Robert Stayton <bobstayton@users.sourceforge.net> + + * informalequation.properties.xml, informalexample.properties.xml, informalfigure.properties.xml, informaltable.properties.xml: + New file. + +2004-06-20 Robert Stayton <bobstayton@users.sourceforge.net> + + * section.autolabel.max.depth.xml: New file. + +2004-06-13 Robert Stayton <bobstayton@users.sourceforge.net> + + * index.on.type.xml: New file. + +2004-04-19 Robert Stayton <bobstayton@users.sourceforge.net> + + * chunk.separate.lots.xml: New file. + +2004-04-18 Robert Stayton <bobstayton@users.sourceforge.net> + + * index.on.role.xml: New file. + +2004-03-25 Jirka Kosek <kosek@users.sourceforge.net> + + * component.title.properties.xml: Added new attribute set component.title.properties for easy modifications of component's title formatting in FO output. + + * monospace.verbatim.properties.xml: wrap property for monospaced verbatim environments moved to attribute set so it can be overriden in customization layer. + +2004-03-24 Jirka Kosek <kosek@users.sourceforge.net> + + * textdata.default.encoding.xml: New file. + +2004-03-04 Norman Walsh <nwalsh@users.sourceforge.net> + + * root.properties.xml: Added line-height-shift-adjustment=disregard-shifts to the root properties + + * table.properties.xml: Clarified description pointing to the distinction between table.properties and table.table.properties + + * table.table.properties.xml: New file. + +2004-02-13 Michael Smith <xmldoc@users.sourceforge.net> + + * htmlhelp.hhp.windows.xml, htmlhelp.show.toolbar.text.xml: + remove stray single quotes for ID values; + was causing generation of invalid filenames & breaking downstream builds + +2004-01-31 Norman Walsh <nwalsh@users.sourceforge.net> + + * footer.column.widths.xml, header.column.widths.xml: Add quotes to make the parameters strings; '1 1 1' is not a valid number + +2004-01-29 Robert Stayton <bobstayton@users.sourceforge.net> + + * footer.column.widths.xml, header.column.widths.xml: New file. + +2003-12-15 Norman Walsh <nwalsh@users.sourceforge.net> + + * article.appendix.title.properties.xml: Fixed typo in use-attribute-sets attribute + + * title.margin.left.xml: Fix typo in parameter end tag + +2003-12-10 Robert Stayton <bobstayton@users.sourceforge.net> + + * marker.section.level.xml: New file. + +2003-12-07 Robert Stayton <bobstayton@users.sourceforge.net> + + * article.appendix.title.properties.xml: New file. + +2003-12-05 Robert Stayton <bobstayton@users.sourceforge.net> + + * refentry.pagebreak.xml: New file. + + * refentry.title.properties.xml: Added space-before properties since page breaks are now optional. + Added a description paragraph. + +2003-12-04 Norman Walsh <nwalsh@users.sourceforge.net> + + * subscript.properties.xml, superscript.properties.xml: + New file. + +2003-11-29 Jirka Kosek <kosek@users.sourceforge.net> + + * htmlhelp.display.progress.xml, htmlhelp.enhanced.decompilation.xml, htmlhelp.hhc.width.xml, htmlhelp.hhp.windows.xml, htmlhelp.remember.window.position.xml, htmlhelp.show.toolbar.text.xml, htmlhelp.window.geometry.xml: + New file. + +2003-11-25 Robert Stayton <bobstayton@users.sourceforge.net> + + * title.margin.left.xml: Set to zero if passivetex.extensions != 0 since PassiveTeX + cannot handle the math expression with negative values. + +2003-10-04 Jirka Kosek <kosek@users.sourceforge.net> + + * index.preferred.page.properties.xml: New file. + +2003-09-28 Norman Walsh <nwalsh@users.sourceforge.net> + + * formal.object.properties.xml: Use keep-together.within-column, not keep-together as that's a compound property inherited by fo:inline and other elements with bad effects + +2003-09-24 Robert Stayton <bobstayton@users.sourceforge.net> + + * xep.index.item.properties.xml: Fixed the ulink reference to xep. + +2003-09-23 Jirka Kosek <kosek@users.sourceforge.net> + + * manifest.in.base.dir.xml: New file. + +2003-09-10 Robert Stayton <bobstayton@users.sourceforge.net> + + * section.level1.properties.xml, section.level2.properties.xml, section.level3.properties.xml, section.level4.properties.xml, section.level5.properties.xml, section.level6.properties.xml: + Add use-attribute-set="section.properties" to each set. + +2003-09-09 Robert Stayton <bobstayton@users.sourceforge.net> + + * section.level1.properties.xml, section.level2.properties.xml, section.level3.properties.xml, section.level4.properties.xml, section.level5.properties.xml, section.level6.properties.xml: + New file. + + * section.properties.xml: New file. + +2003-09-02 Robert Stayton <bobstayton@users.sourceforge.net> + + * title.margin.left.xml: Must add unit indicator if set value to zero. + +2003-08-29 Robert Stayton <bobstayton@users.sourceforge.net> + + * footer.content.properties.xml, header.content.properties.xml: + Changed $body.font.family to $body.fontset to include + symbol.font.family fonts in headers and footers. + +2003-08-28 Robert Stayton <bobstayton@users.sourceforge.net> + + * root.properties.xml: Changed body.font.family to body.fontset and + title.font.family to title.fontset in font-family property + attributes, in order to append symbol.font.family parameter value. + + * symbol.font.family.xml: New file. + +2003-08-27 Norman Walsh <nwalsh@users.sourceforge.net> + + * formal.title.placement.xml: Added task + +2003-08-14 Robert Stayton <bobstayton@users.sourceforge.net> + + * variablelist.max.termlength.xml: New file. + +2003-07-25 Robert Stayton <bobstayton@users.sourceforge.net> + + * insert.xref.page.number.xml: Changed from a boolean to a string with values yes, no, maybe + to support xrefstyle attribute on xrefs. + + * xref.label-page.separator.xml, xref.label-title.separator.xml, xref.title-page.separator.xml: + New file. + +2003-07-22 Jirka Kosek <kosek@users.sourceforge.net> + + * eclipse.autolabel.xml, eclipse.plugin.id.xml, eclipse.plugin.name.xml, eclipse.plugin.provider.xml: + New file. + +2003-06-22 Robert Stayton <bobstayton@users.sourceforge.net> + + * qanda.title.level1.properties.xml, qanda.title.level2.properties.xml, qanda.title.level3.properties.xml, qanda.title.level4.properties.xml, qanda.title.level5.properties.xml, qanda.title.level6.properties.xml, qanda.title.properties.xml: + New file. + +2003-06-21 Norman Walsh <nwalsh@users.sourceforge.net> + + * column.gap.back.xml, column.gap.body.xml, column.gap.front.xml, column.gap.index.xml, column.gap.lot.xml, column.gap.titlepage.xml: + New file. + + * suppress.footer.navigation.xml, suppress.header.navigation.xml: + Fixed id values + + * use.role.for.mediaobject.xml: Editorial nit. + +2003-05-27 Jirka Kosek <kosek@users.sourceforge.net> + + * htmlhelp.hhc.folders.instead.books.xml: Notice of HTML Help limitation. + +2003-05-15 Jirka Kosek <kosek@users.sourceforge.net> + + * axf.extensions.xml, xep.extensions.xml: Added support for AntennaHouse XSL Formatter. You can use axf.extensions=1 setting to generate bookmarks, document info and to merge duplicate page numbers in index. + +2003-05-14 Jirka Kosek <kosek@users.sourceforge.net> + + * xep.index.item.properties.xml: New file. + +2003-05-08 Norman Walsh <nwalsh@users.sourceforge.net> + + * formal.object.properties.xml: Keep formal object titles together + +2003-05-07 Robert Stayton <bobstayton@users.sourceforge.net> + + * admon.textlabel.xml: New file. + + * admon.textlabel.xml: Set default to 1. + + * admon.textlabel.xml: Changed admon.textlabel doc. + +2003-04-12 Norman Walsh <nwalsh@users.sourceforge.net> + + * ebnf.assignment.xml, ebnf.statement.terminator.xml, root.properties.xml: + New file. + + * generate.section.toc.level.xml: Whitespace + +2003-02-14 Norman Walsh <nwalsh@users.sourceforge.net> + + * component.title.properties.xml: No longer used; causes confusion. Buh-bye. + +2003-02-07 Jirka Kosek <kosek@users.sourceforge.net> + + * toc.max.depth.xml: New file. + +2003-01-31 Norman Walsh <nwalsh@users.sourceforge.net> + + * footer.content.properties.xml, header.content.properties.xml: + Don't set the margin-right to the title.margin.left. D'Oh. + + * monospace.properties.xml: Remove font-size; it just looks ugly in the general case + +2003-01-28 Norman Walsh <nwalsh@users.sourceforge.net> + + * glossterm.auto.link.xml: Whitespace + +2003-01-20 Norman Walsh <nwalsh@users.sourceforge.net> + + * entry.propagates.style.xml: New file. + + * footnote.number.format.xml, footnote.number.symbols.xml, table.footnote.number.format.xml, table.footnote.number.symbols.xml: + New file. + + * glossentry.show.acronym.xml: New file. + + * section.title.level1.properties.xml, section.title.level2.properties.xml, section.title.level3.properties.xml, section.title.level4.properties.xml, section.title.level5.properties.xml, section.title.level6.properties.xml: + Make section title font sizes a function of the body size, not an absolute size. And let's use magsteps while we're at it. + + * ulink.footnote.number.format.xml: New file. + + * ulink.footnotes.xml: It is too implemented. :-) + + * verbatim.properties.xml: Put space below verbatim blocks too. + + * xref.with.number.and.title.xml: New file. + +2003-01-17 Norman Walsh <nwalsh@users.sourceforge.net> + + * body.font.master.xml, css.decoration.xml, double.sided.xml: + Whitespace + + * formal.title.properties.xml: Make font size 1.2 times the body size, not a fixed 12pt + +2003-01-01 Norman Walsh <nwalsh@users.sourceforge.net> + + * equation.properties.xml, example.properties.xml, figure.properties.xml, procedure.properties.xml, table.properties.xml: + New file. + + * formal.object.properties.xml: Whitespace and documentation changes + + * ignore.image.scaling.xml: New file. + +2002-12-29 Norman Walsh <nwalsh@users.sourceforge.net> + + * use.role.as.xrefstyle.xml: Updated documentation; added an example showing how to use xrefstyle in the stylesheets + +2002-12-28 Norman Walsh <nwalsh@users.sourceforge.net> + + * admonition.properties.xml, admonition.title.properties.xml: + Whitespace and documentation tweaks + +2002-12-17 Jirka Kosek <kosek@users.sourceforge.net> + + * preferred.mediaobject.role.xml: Fixed build problems with new parameters. + + * profile.role.xml: Ooops. No DTD, no entites :-( + + * profile.role.xml: Added warning against usage of role attribute for profiling. + +2002-12-06 Robert Stayton <bobstayton@users.sourceforge.net> + + * preferred.mediaobject.role.xml, use.role.for.mediaobject.xml: + New file. + +2002-10-31 Norman Walsh <nwalsh@users.sourceforge.net> + + * table.frame.border.thickness.xml, toc.margin.properties.xml, verbatim.properties.xml, xref.properties.xml: + Documentation updates + +2002-10-21 Norman Walsh <nwalsh@users.sourceforge.net> + + * footer.content.properties.xml, header.content.properties.xml: + Updated header/footer properties to avoid missmatched margins caused by title.margin.left + +2002-10-20 Norman Walsh <nwalsh@users.sourceforge.net> + + * monospace.properties.xml: Bug #589631: Make monospace font size 0.9em rather than 0.9*body.font.size so that it works in different contexts (like chapter titles + +2002-10-19 Norman Walsh <nwalsh@users.sourceforge.net> + + * footer.content.properties.xml, header.content.properties.xml: + New file. + +2002-10-04 Norman Walsh <nwalsh@users.sourceforge.net> + + * generate.toc.xml: Specify titles for ToCs + + * table.border.color.xml, table.border.padding.xml, table.border.style.xml, table.border.thickness.xml, table.cell.border.color.xml, table.cell.border.style.xml, table.cell.border.thickness.xml, table.frame.border.color.xml, table.frame.border.style.xml, table.frame.border.thickness.xml: + Made separate parameters for table frame and table cell border properties + +2002-10-01 Robert Stayton <bobstayton@users.sourceforge.net> + + * section.title.level1.properties.xml, section.title.level2.properties.xml, section.title.level3.properties.xml, section.title.level4.properties.xml, section.title.level5.properties.xml: + Moved font sizes one level to compensate for change of + the section.level template returning a number that + matches the section level. The result should be no + change in output font sizes for section titles. + +2002-09-30 <dcramer@users.sourceforge.net> + + * list.block.spacing.xml: Adding space-after so there will be space after lists within paras (where there's text after the list. + +2002-09-27 Norman Walsh <nwalsh@users.sourceforge.net> + + * default.float.class.xml: New file. + + * default.image.width.xml: New file. + + * funcsynopsis.tabular.threshold.xml: New file. + +2002-09-19 Robert Stayton <bobstayton@users.sourceforge.net> + + * formal.title.properties.xml: Removed 'keep-with-next' from 'formal.title.properties' because + template now uses $placement value to determine if keep-with-next + or keep-with-previous should be used. + +2002-09-05 Norman Walsh <nwalsh@users.sourceforge.net> + + * monospace.verbatim.properties.xml: Make monospaced verbatim environments text-aligned to the start. + +2002-09-04 Norman Walsh <nwalsh@users.sourceforge.net> + + * generate.toc.xml: Suppress ToC in article/appendix by default + + * graphicsize.extension.xml, l10n.gentext.default.language.xml, l10n.gentext.language.xml, l10n.gentext.use.xref.language.xml: + New file. + +2002-09-01 Norman Walsh <nwalsh@users.sourceforge.net> + + * body.font.family.xml, dingbat.font.family.xml, monospace.font.family.xml, sans.font.family.xml, title.font.family.xml: + Roll-back font families to single words + +2002-08-26 Norman Walsh <nwalsh@users.sourceforge.net> + + * chunk.tocs.and.lots.xml: New file. + + * generate.toc.xml: Fixed typo in parameter reference + +2002-08-22 Jirka Kosek <kosek@users.sourceforge.net> + + * htmlhelp.use.hhk.xml: New file. + +2002-08-21 Norman Walsh <nwalsh@users.sourceforge.net> + + * make.index.markup.xml: Fixed typo + + * make.index.markup.xml: New file. + +2002-07-26 Norman Walsh <nwalsh@users.sourceforge.net> + + * headers.on.blank.pages.xml: With the new scheme, this should be 1 + +2002-07-22 Robert Stayton <bobstayton@users.sourceforge.net> + + * html.extra.head.links.xml: Changed the default from 1 to 0 because this feature + is not supported in all browsers, and because it + reduces processing performance by 20-30%. + +2002-07-19 Norman Walsh <nwalsh@users.sourceforge.net> + + * bibliography.numbered.xml, menuchoice.menu.separator.xml, menuchoice.separator.xml, section.title.level1.properties.xml, section.title.level2.properties.xml, section.title.level3.properties.xml, section.title.level4.properties.xml, section.title.level5.properties.xml, section.title.level6.properties.xml: + New file. + + * monospace.properties.xml, monospace.verbatim.properties.xml: + Split monospaced properties from verbatim properties + + * section.title.properties.xml: Tweaked documentation + +2002-07-18 Norman Walsh <nwalsh@users.sourceforge.net> + + * html.cellpadding.xml, html.cellspacing.xml: New file. + + * para.propagates.style.xml: New file. + +2002-07-17 Norman Walsh <nwalsh@users.sourceforge.net> + + * body.margin.bottom.xml, body.margin.top.xml, page.margin.bottom.xml, page.margin.top.xml, region.after.extent.xml, region.before.extent.xml: + Tweak page head/foot margins + +2002-07-09 Norman Walsh <nwalsh@users.sourceforge.net> + + * glossary.collection.xml: Bug #522017: describe how to make intra-glossary cross references + +2002-07-08 Norman Walsh <nwalsh@users.sourceforge.net> + + * sidebar.properties.xml: New file. + +2002-07-06 Robert Stayton <bobstayton@users.sourceforge.net> + + * target.database.document.xml: Changed the default value to empty string to remove + error message about trying to open a non-existent file. + + * target.database.document.xml: Changed name of default master data file to olinkdb.xml + because it was too similar to targets.db used for + the document data files. + +2002-07-05 Robert Stayton <bobstayton@users.sourceforge.net> + + * collect.xref.targets.xml, current.docid.xml, olink.base.uri.xml, olink.doctitle.xml, target.database.document.xml, targets.filename.xml, use.local.olink.style.xml: + Removed the xml declaration at the top of the new param files + as it seems to trouble the parser. + + * collect.xref.targets.xml, current.docid.xml, olink.base.uri.xml, olink.doctitle.xml, target.database.document.xml, targets.filename.xml, use.local.olink.style.xml: + New file. + +2002-07-04 Norman Walsh <nwalsh@users.sourceforge.net> + + * chunk.datafile.xml: Removed parameter: no longer (never?) used + +2002-07-03 Norman Walsh <nwalsh@users.sourceforge.net> + + * footer.rule.xml, footers.on.blank.pages.xml, header.rule.xml, headers.on.blank.pages.xml: + New file. + + * insert.xref.page.number.xml: Improve description especially now that it works + +2002-07-02 Norman Walsh <nwalsh@users.sourceforge.net> + + * column.count.back.xml, column.count.body.xml, column.count.front.xml, column.count.index.xml, column.count.lot.xml, column.count.of.index.xml, column.count.titlepage.xml, column.count.xml, draft.mode.xml: + Completely rewrote pagesetup.xsl: new/changed column count, draft mode, and margin parameters + +2002-07-02 Robert Stayton <bobstayton@users.sourceforge.net> + + * generate.toc.xml: Added sect1 through sect5, which allows such section ToCs to be + controlled by just setting the generate.section.toc.level + parameter. + + * generate.toc.xml: Forgot to close my <para> tag. + +2002-07-02 Norman Walsh <nwalsh@users.sourceforge.net> + + * page.margin.top.xml, region.before.extent.xml: Completely rewrote pagesetup.xsl: new/changed column count, draft mode, and margin parameters + +2002-06-29 Norman Walsh <nwalsh@users.sourceforge.net> + + * admon.graphics.xml, callout.graphics.path.xml, callout.graphics.xml: + Whitespace + +2002-06-27 Norman Walsh <nwalsh@users.sourceforge.net> + + * glossary.as.blocks.xml, glosslist.as.blocks.xml, glossterm.separation.xml, glossterm.width.xml: + New file. + +2002-06-26 Norman Walsh <nwalsh@users.sourceforge.net> + + * table.border.color.xml: Don't set table border color in HTML; allow a top-level CSS stylesheet to set it + +2002-06-13 Norman Walsh <nwalsh@users.sourceforge.net> + + * chunker.output.cdata-section-elements.xml, chunker.output.doctype-public.xml, chunker.output.doctype-system.xml, chunker.output.encoding.xml, chunker.output.indent.xml, chunker.output.media-type.xml, chunker.output.method.xml, chunker.output.omit-xml-declaration.xml, chunker.output.standalone.xml, default.encoding.xml: + Created a complete and consistent set of chunking parameters + +2002-06-13 Jirka Kosek <kosek@users.sourceforge.net> + + * htmlhelp.button.back.xml, htmlhelp.button.forward.xml, htmlhelp.button.hideshow.xml, htmlhelp.button.home.url.xml, htmlhelp.button.home.xml, htmlhelp.button.jump1.title.xml, htmlhelp.button.jump1.url.xml, htmlhelp.button.jump1.xml, htmlhelp.button.jump2.title.xml, htmlhelp.button.jump2.url.xml, htmlhelp.button.jump2.xml, htmlhelp.button.locate.xml, htmlhelp.button.next.xml, htmlhelp.button.options.xml, htmlhelp.button.prev.xml, htmlhelp.button.print.xml, htmlhelp.button.refresh.xml, htmlhelp.button.stop.xml, htmlhelp.button.zoom.xml, htmlhelp.hhc.binary.xml, htmlhelp.hhk.xml, htmlhelp.hhp.window.xml, htmlhelp.show.advanced.search.xml, htmlhelp.show.favorities.xml, htmlhelp.show.menu.xml: + New file. + + * htmlhelp.only.xml: New file. + +2002-06-13 Norman Walsh <nwalsh@users.sourceforge.net> + + * output.method.xml, saxon.character.representation.xml: + Created a complete and consistent set of chunking parameters + +2002-06-12 Jirka Kosek <kosek@users.sourceforge.net> + + * refentry.generate.name.xml, refentry.generate.title.xml: + Clarified explanation so no one else reports bugs like #563473. + + * suppress.footer.navigation.xml, suppress.header.navigation.xml: + New file. + +2002-06-11 Norman Walsh <nwalsh@users.sourceforge.net> + + * body.font.family.xml, dingbat.font.family.xml, monospace.font.family.xml, sans.font.family.xml, title.font.family.xml: + Add generic fallbacks to font family specifications + + * make.graphic.viewport.xml, nominal.image.depth.xml, nominal.image.width.xml, use.embed.for.svg.xml: + New file. + + * refentry.title.properties.xml, section.title.properties.xml: + New file. + + * use.embed.for.svg.xml: Turn off use.embed.for.svg by default (it generates invalid html) + +2002-06-09 Norman Walsh <nwalsh@users.sourceforge.net> + + * html.stylesheet.xml: Updated documentation to reflect that html.stylesheet can now take a list of URIs + +2002-06-07 <dcramer@users.sourceforge.net> + + * variablelist.as.blocks.xml: Fixing a couple of typos I made + +2002-06-06 Norman Walsh <nwalsh@users.sourceforge.net> + + * generate.meta.abstract.xml, use.role.as.xrefstyle.xml: + New file. + + * variablelist.as.blocks.xml: Patch 521141: document variablelist pi + +2002-05-24 <dcramer@users.sourceforge.net> + + * callout.unicode.number.limit.xml, callout.unicode.start.character.xml: + Updating docs. + +2002-05-23 Norman Walsh <nwalsh@users.sourceforge.net> + + * use.svg.xml: New file. + +2002-05-14 Michael Smith <xmldoc@users.sourceforge.net> + + * generate.manifest.xml, manifest.xml: added descriptions + +2002-05-13 Norman Walsh <nwalsh@users.sourceforge.net> + + * compact.list.item.spacing.xml: New file. + + * html.extra.head.links.xml: New file. + +2002-05-10 Jirka Kosek <kosek@users.sourceforge.net> + + * generate.manifest.xml, manifest.xml: New file. + +2002-05-10 Norman Walsh <nwalsh@users.sourceforge.net> + + * points.per.em.xml: New file. + + * using.chunker.xml: Obsolete parameter + +2002-04-20 Norman Walsh <nwalsh@users.sourceforge.net> + + * generate.toc.xml: Improve documentation + + * shade.verbatim.style.xml: Support shade.verbatim in FO; stop using vendor test to decide what extension function to call for line numbering + + * verbatim.properties.xml: Whitespace + +2002-03-18 Norman Walsh <nwalsh@users.sourceforge.net> + + * emphasis.propagates.style.xml: Whitespace + + * generate.appendix.toc.xml, generate.article.toc.xml, generate.book.equation.lot.xml, generate.book.example.lot.xml, generate.book.figure.lot.xml, generate.book.table.lot.xml, generate.book.toc.xml, generate.chapter.toc.xml, generate.component.toc.xml, generate.division.equation.lot.xml, generate.division.example.lot.xml, generate.division.figure.lot.xml, generate.division.table.lot.xml, generate.division.toc.xml, generate.part.toc.xml, generate.preface.toc.xml, generate.qandadiv.toc.xml, generate.qandaset.toc.xml, generate.reference.toc.xml, generate.section.toc.xml, generate.set.toc.xml, generate.toc.xml: + Replace generate.*.toc and generate.*.lot with single generate.toc parameter. + +2002-03-14 Norman Walsh <nwalsh@users.sourceforge.net> + + * formal.procedures.xml: Fixed typos + + * formal.title.placement.xml: New file. + +2002-03-10 Norman Walsh <nwalsh@users.sourceforge.net> + + * generate.id.attributes.xml: New file. + +2002-03-03 Jirka Kosek <kosek@users.sourceforge.net> + + * profile.arch.xml, profile.attribute.xml, profile.condition.xml, profile.conformance.xml, profile.lang.xml, profile.os.xml, profile.revision.xml, profile.revisionflag.xml, profile.role.xml, profile.security.xml, profile.separator.xml, profile.userlevel.xml, profile.value.xml, profile.vendor.xml: + New file. + +2002-03-01 Norman Walsh <nwalsh@users.sourceforge.net> + + * blockquote.properties.xml: Added space-after properties to blockquotes + + * formal.title.properties.xml: Added space-after properties + + * stylesheet.result.type.xml: Move stylesheet.result.type out of param and put it explicitly in each stylesheet because it has to be different + + * table.cell.padding.xml: New file. + + * ulink.hyphenate.xml: Make ulink hyphenation character the empty string by default + +2002-02-25 Robert Stayton <bobstayton@users.sourceforge.net> + + * chunk.quietly.xml: New file. + +2002-02-21 Jirka Kosek <kosek@users.sourceforge.net> + + * tex.math.delims.xml, tex.math.file.xml, tex.math.in.alt.xml: + Better control over delimiters for TeX equations. Added parameter tex.math.delims, when is set to 0, no delimiters (like $ and $$) are output. Same can be done for single equation by <?dbtex delims="no"?>. + +2002-02-11 Norman Walsh <nwalsh@users.sourceforge.net> + + * column.count.of.index.xml: New file. + +2002-02-10 Jirka Kosek <kosek@users.sourceforge.net> + + * htmlhelp.default.topic.xml: New file. + +2002-02-09 Jirka Kosek <kosek@users.sourceforge.net> + + * htmlhelp.hhc.show.root.xml: New file. + +2002-02-07 Norman Walsh <nwalsh@users.sourceforge.net> + + * chunk.toc.xml, manual.toc.xml: New file. + + * informal.object.properties.xml: New file. + +2002-02-03 Jirka Kosek <kosek@users.sourceforge.net> + + * htmlhelp.title.xml: New file. + +2002-01-29 Norman Walsh <nwalsh@users.sourceforge.net> + + * draft.watermark.image.xml: New file. + +2002-01-28 Norman Walsh <nwalsh@users.sourceforge.net> + + * html.cleanup.xml, make.valid.html.xml: Added html.cleanup parameter; if non-zero, do some post-processing of RTFs to improve formatting + + * ulink.hyphenate.xml: New file. + +2002-01-22 Jirka Kosek <kosek@users.sourceforge.net> + + * htmlhelp.hhc.folders.instead.books.xml: New file. + +2002-01-10 Norman Walsh <nwalsh@users.sourceforge.net> + + * body.margin.bottom.xml, body.margin.top.xml, page.margin.bottom.xml, page.margin.outer.xml, page.margin.top.xml, page.width.xml, region.after.extent.xml, region.before.extent.xml: + Rationalize margins; see new docs in the FO section + + * formal.object.properties.xml: Removed bogus keep + + * pixels.per.inch.xml: New file. + + * ulink.footnotes.xml, ulink.show.xml: New file. + +2002-01-06 Norman Walsh <nwalsh@users.sourceforge.net> + + * bibliography.collection.xml, glossary.collection.xml: + Added documentation + +2002-01-04 Norman Walsh <nwalsh@users.sourceforge.net> + + * firstterm.only.link.xml, glossary.collection.xml: New file. + +2002-01-03 Norman Walsh <nwalsh@users.sourceforge.net> + + * format.variablelist.as.list.xml, variablelist.as.table.xml: + Renamed format.variablelist.as.table to variablelist.as.table + + * variablelist.as.blocks.xml: New file. + + * variablelist.as.table.xml: Fixed doc typos + +2002-01-01 Norman Walsh <nwalsh@users.sourceforge.net> + + * blockquote.properties.xml, make.valid.html.xml, output.method.xml, refentry.generate.name.xml, refentry.generate.title.xml: + New and updated parameters + +2001-12-15 Jirka Kosek <kosek@users.sourceforge.net> + + * tex.math.in.alt.xml: Improved support for TeX math inside equations. + +2001-12-06 Jirka Kosek <kosek@users.sourceforge.net> + + * tex.math.file.xml, tex.math.in.alt.xml: New file. + +2001-12-04 Norman Walsh <nwalsh@users.sourceforge.net> + + * admonition.properties.xml: New file. + + * admonition.title.properties.xml, chunk.first.sections.xml, chunk.section.depth.xml, line-height.xml: + New parameters + + * toc.indent.width.xml: New file. + +2001-11-28 Jirka Kosek <kosek@users.sourceforge.net> + + * htmlhelp.alias.file.xml, htmlhelp.force.map.and.alias.xml, htmlhelp.map.file.xml: + New file. + + * htmlhelp.hhc.section.depth.xml: New file. + +2001-11-28 Norman Walsh <nwalsh@users.sourceforge.net> + + * punct.honorific.xml: New file. + + * segmentedlist.as.table.xml: New file. + +2001-11-18 Jirka Kosek <kosek@users.sourceforge.net> + + * glossterm.auto.link.xml: New file. + +2001-11-09 Norman Walsh <nwalsh@users.sourceforge.net> + + * admon.graphics.extension.xml, admon.graphics.path.xml, admon.graphics.xml, admon.style.xml, admonition.title.properties.xml, alignment.xml, annotate.toc.xml, appendix.autolabel.xml, arbortext.extensions.xml, author.othername.in.middle.xml, autotoc.label.separator.xml, base.dir.xml, biblioentry.item.separator.xml, bibliography.collection.xml, body.font.family.xml, body.font.master.xml, body.font.size.xml, body.margin.bottom.xml, body.margin.top.xml, bridgehead.in.toc.xml, callout.defaultcolumn.xml, callout.graphics.extension.xml, callout.graphics.number.limit.xml, callout.graphics.path.xml, callout.graphics.xml, callout.list.table.xml, callout.unicode.font.xml, callout.unicode.number.limit.xml, callout.unicode.start.character.xml, callout.unicode.xml, callouts.extension.xml, chapter.autolabel.xml, chunk.datafile.xml, chunk.first.sections.xml, chunk.sections.xml, citerefentry.link.xml, column.count.xml, component.title.properties.xml, css.decoration.xml, default.encoding.xml, default.table.width.xml, default.units.xml, dingbat.font.family.xml, double.sided.xml, ebnf.table.bgcolor.xml, ebnf.table.border.xml, emphasis.propagates.style.xml, footnote.font.size.xml, fop.extensions.xml, formal.object.properties.xml, formal.procedures.xml, formal.title.properties.xml, format.variablelist.as.list.xml, funcsynopsis.decoration.xml, funcsynopsis.style.xml, function.parens.xml, generate.appendix.toc.xml, generate.article.toc.xml, generate.book.equation.lot.xml, generate.book.example.lot.xml, generate.book.figure.lot.xml, generate.book.table.lot.xml, generate.book.toc.xml, generate.chapter.toc.xml, generate.component.toc.xml, generate.division.equation.lot.xml, generate.division.example.lot.xml, generate.division.figure.lot.xml, generate.division.table.lot.xml, generate.division.toc.xml, generate.index.xml, generate.legalnotice.link.xml, generate.part.toc.xml, generate.preface.toc.xml, generate.qandadiv.toc.xml, generate.qandaset.toc.xml, generate.reference.toc.xml, generate.section.toc.level.xml, generate.section.toc.xml, generate.set.toc.xml, graphic.default.extension.xml, html.base.xml, html.ext.xml, html.longdesc.link.xml, html.longdesc.xml, html.stylesheet.type.xml, html.stylesheet.xml, htmlhelp.autolabel.xml, htmlhelp.chm.xml, htmlhelp.encoding.xml, htmlhelp.enumerate.images.xml, htmlhelp.hhc.xml, htmlhelp.hhp.tail.xml, htmlhelp.hhp.xml, hyphenate.xml, inherit.keywords.xml, insert.xref.page.number.xml, label.from.part.xml, linenumbering.everyNth.xml, linenumbering.extension.xml, linenumbering.separator.xml, linenumbering.width.xml, link.mailto.url.xml, list.block.spacing.xml, list.item.spacing.xml, make.single.year.ranges.xml, make.year.ranges.xml, monospace.font.family.xml, monospace.verbatim.properties.xml, navig.graphics.extension.xml, navig.graphics.path.xml, navig.graphics.xml, navig.showtitles.xml, nominal.table.width.xml, normal.para.spacing.xml, olink.fragid.xml, olink.outline.ext.xml, olink.pubid.xml, olink.resolver.xml, olink.sysid.xml, page.height.portrait.xml, page.height.xml, page.margin.bottom.xml, page.margin.inner.xml, page.margin.outer.xml, page.margin.top.xml, page.orientation.xml, page.width.portrait.xml, page.width.xml, paper.type.xml, part.autolabel.xml, passivetex.extensions.xml, phrase.propagates.style.xml, preface.autolabel.xml, process.empty.source.toc.xml, process.source.toc.xml, qanda.defaultlabel.xml, qanda.inherit.numeration.xml, qandadiv.autolabel.xml, refentry.generate.name.xml, refentry.separator.xml, refentry.xref.manvolnum.xml, region.after.extent.xml, region.before.extent.xml, root.filename.xml, rootid.xml, runinhead.default.title.end.punct.xml, runinhead.title.end.punct.xml, sans.font.family.xml, saxon.callouts.xml, saxon.character.representation.xml, saxon.linenumbering.xml, saxon.tablecolumns.xml, section.autolabel.xml, section.label.includes.component.label.xml, shade.verbatim.style.xml, shade.verbatim.xml, show.comments.xml, show.revisionflag.xml, spacing.paras.xml, stylesheet.result.type.xml, suppress.navigation.xml, table.border.color.xml, table.border.padding.xml, table.border.style.xml, table.border.thickness.xml, table.borders.with.css.xml, table.entry.padding.xml, tablecolumns.extension.xml, template.xml, textinsert.extension.xml, title.font.family.xml, title.margin.left.xml, toc.list.type.xml, toc.margin.properties.xml, toc.section.depth.xml, ulink.target.xml, use.extensions.xml, use.id.as.filename.xml, use.id.function.xml, using.chunker.xml, verbatim.properties.xml, xep.extensions.xml, xref.properties.xml: + Move the obvious ID value from the src:fragment to the refentry in parameter reference pages + +2001-11-06 Norman Walsh <nwalsh@users.sourceforge.net> + + * admonition.title.properties.xml, autotoc.label.separator.xml, body.margin.top.xml, callout.unicode.xml, component.title.properties.xml, formal.object.properties.xml, formal.title.properties.xml, generate.appendix.toc.xml, generate.article.toc.xml, generate.book.equation.lot.xml, generate.book.example.lot.xml, generate.book.figure.lot.xml, generate.book.table.lot.xml, generate.book.toc.xml, generate.chapter.toc.xml, generate.index.xml, generate.part.toc.xml, generate.preface.toc.xml, generate.reference.toc.xml, generate.set.toc.xml, list.block.spacing.xml, list.item.spacing.xml, monospace.verbatim.properties.xml: + Documentation improvements from Dave Pawson + +2001-11-06 Robert Stayton <bobstayton@users.sourceforge.net> + + * navig.graphics.extension.xml, navig.graphics.path.xml, navig.graphics.xml, navig.showtitles.xml: + New file. + +2001-11-06 Norman Walsh <nwalsh@users.sourceforge.net> + + * normal.para.spacing.xml: Documentation improvements from Dave Pawson + +2001-11-05 Jirka Kosek <kosek@users.sourceforge.net> + + * htmlhelp.autolabel.xml, htmlhelp.chm.xml, htmlhelp.encoding.xml, htmlhelp.enumerate.images.xml, htmlhelp.hhc.xml, htmlhelp.hhp.tail.xml, htmlhelp.hhp.xml: + New file. + +2001-10-16 Norman Walsh <nwalsh@users.sourceforge.net> + + * html.longdesc.link.xml, html.longdesc.xml: New file. + +2001-10-15 Norman Walsh <nwalsh@users.sourceforge.net> + + * table.borders.with.css.xml, table.entry.padding.xml: + New file. + +2001-10-08 Norman Walsh <nwalsh@users.sourceforge.net> + + * table.border.color.xml, table.border.padding.xml, table.border.style.xml, table.border.thickness.xml, template.xml, title.margin.left.xml: + New params for FOs + +2001-10-07 Norman Walsh <nwalsh@users.sourceforge.net> + + * admon.graphics.extension.xml, admon.graphics.path.xml, admon.graphics.xml, admon.style.xml, admonition.title.properties.xml, alignment.xml, annotate.toc.xml, appendix.autolabel.xml, arbortext.extensions.xml, author.othername.in.middle.xml, autotoc.label.separator.xml, base.dir.xml, biblioentry.item.separator.xml, bibliography.collection.xml, body.font.family.xml, body.font.master.xml, body.font.size.xml, body.margin.bottom.xml, body.margin.top.xml, bridgehead.in.toc.xml, callout.defaultcolumn.xml, callout.graphics.extension.xml, callout.graphics.number.limit.xml, callout.graphics.path.xml, callout.graphics.xml, callout.list.table.xml, callout.unicode.font.xml, callout.unicode.number.limit.xml, callout.unicode.start.character.xml, callout.unicode.xml, callouts.extension.xml, chapter.autolabel.xml, chunk.datafile.xml, chunk.first.sections.xml, chunk.sections.xml, citerefentry.link.xml, column.count.xml, component.title.properties.xml, css.decoration.xml, default.encoding.xml, default.table.width.xml, default.units.xml, dingbat.font.family.xml, double.sided.xml, ebnf.table.bgcolor.xml, ebnf.table.border.xml, emphasis.propagates.style.xml, footnote.font.size.xml, fop.extensions.xml, formal.object.properties.xml, formal.procedures.xml, formal.title.properties.xml, format.variablelist.as.list.xml, funcsynopsis.decoration.xml, funcsynopsis.style.xml, function.parens.xml, generate.appendix.toc.xml, generate.article.toc.xml, generate.book.equation.lot.xml, generate.book.example.lot.xml, generate.book.figure.lot.xml, generate.book.table.lot.xml, generate.book.toc.xml, generate.chapter.toc.xml, generate.component.toc.xml, generate.division.equation.lot.xml, generate.division.example.lot.xml, generate.division.figure.lot.xml, generate.division.table.lot.xml, generate.division.toc.xml, generate.index.xml, generate.legalnotice.link.xml, generate.part.toc.xml, generate.preface.toc.xml, generate.qandadiv.toc.xml, generate.qandaset.toc.xml, generate.reference.toc.xml, generate.section.toc.level.xml, generate.section.toc.xml, generate.set.toc.xml, graphic.default.extension.xml, html.base.xml, html.ext.xml, html.stylesheet.type.xml, html.stylesheet.xml, hyphenate.xml, inherit.keywords.xml, insert.xref.page.number.xml, label.from.part.xml, linenumbering.everyNth.xml, linenumbering.extension.xml, linenumbering.separator.xml, linenumbering.width.xml, link.mailto.url.xml, list.block.spacing.xml, list.item.spacing.xml, make.single.year.ranges.xml, make.year.ranges.xml, monospace.font.family.xml, monospace.verbatim.properties.xml, nominal.table.width.xml, normal.para.spacing.xml, olink.fragid.xml, olink.outline.ext.xml, olink.pubid.xml, olink.resolver.xml, olink.sysid.xml, page.height.portrait.xml, page.height.xml, page.margin.bottom.xml, page.margin.inner.xml, page.margin.outer.xml, page.margin.top.xml, page.orientation.xml, page.width.portrait.xml, page.width.xml, paper.type.xml, part.autolabel.xml, passivetex.extensions.xml, phrase.propagates.style.xml, preface.autolabel.xml, process.empty.source.toc.xml, process.source.toc.xml, qanda.defaultlabel.xml, qanda.inherit.numeration.xml, qandadiv.autolabel.xml, refentry.generate.name.xml, refentry.separator.xml, refentry.xref.manvolnum.xml, region.after.extent.xml, region.before.extent.xml, root.filename.xml, rootid.xml, runinhead.default.title.end.punct.xml, runinhead.title.end.punct.xml, sans.font.family.xml, saxon.callouts.xml, saxon.character.representation.xml, saxon.linenumbering.xml, saxon.tablecolumns.xml, section.autolabel.xml, section.label.includes.component.label.xml, shade.verbatim.style.xml, shade.verbatim.xml, show.comments.xml, show.revisionflag.xml, spacing.paras.xml, stylesheet.result.type.xml, suppress.navigation.xml, tablecolumns.extension.xml, template.xml, textinsert.extension.xml, title.font.family.xml, toc.list.type.xml, toc.margin.properties.xml, toc.section.depth.xml, ulink.target.xml, use.extensions.xml, use.id.as.filename.xml, use.id.function.xml, using.chunker.xml, verbatim.properties.xml, xep.extensions.xml, xref.properties.xml: + New file. + diff --git a/kdoctools/docbook/xsl/params/admon.graphics.extension.xml b/kdoctools/docbook/xsl/params/admon.graphics.extension.xml new file mode 100644 index 000000000..3eb973f0a --- /dev/null +++ b/kdoctools/docbook/xsl/params/admon.graphics.extension.xml @@ -0,0 +1,20 @@ +<refentry id="admon.graphics.extension"> +<refmeta> +<refentrytitle>admon.graphics.extension</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.graphics.extension</refname> +<refpurpose>Extension for admonition graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='admon.graphics.extension.frag'><xsl:param name="admon.graphics.extension" select="'.png'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Sets the extension to use on admonition graphics.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/admon.graphics.path.xml b/kdoctools/docbook/xsl/params/admon.graphics.path.xml new file mode 100644 index 000000000..a0df85b4d --- /dev/null +++ b/kdoctools/docbook/xsl/params/admon.graphics.path.xml @@ -0,0 +1,22 @@ +<refentry id="admon.graphics.path"> +<refmeta> +<refentrytitle>admon.graphics.path</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.graphics.path</refname> +<refpurpose>Path to admonition graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='admon.graphics.path.frag'><xsl:param name="admon.graphics.path">images/</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Sets the path, probably relative to the directory where the HTML +files are created, to the admonition graphics. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/admon.graphics.xml b/kdoctools/docbook/xsl/params/admon.graphics.xml new file mode 100644 index 000000000..eb2bc2b19 --- /dev/null +++ b/kdoctools/docbook/xsl/params/admon.graphics.xml @@ -0,0 +1,24 @@ +<refentry id="admon.graphics"> +<refmeta> +<refentrytitle>admon.graphics</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.graphics</refname> +<refpurpose>Use graphics in admonitions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='admon.graphics.frag'> +<xsl:param name="admon.graphics" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), admonitions are presented in an alternate style that uses +a graphic. Default graphics are provided in the distribution. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/admon.style.xml b/kdoctools/docbook/xsl/params/admon.style.xml new file mode 100644 index 000000000..a49c7f34b --- /dev/null +++ b/kdoctools/docbook/xsl/params/admon.style.xml @@ -0,0 +1,24 @@ +<refentry id="admon.style"> +<refmeta> +<refentrytitle>admon.style</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.style</refname> +<refpurpose>CSS style attributes for admonitions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='admon.style.frag'><xsl:param name="admon.style"> + <xsl:text>margin-left: 0.5in; margin-right: 0.5in;</xsl:text> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the value of the <sgmltag class="attribute">STYLE</sgmltag> +attribute that should be added to admonitions. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/admon.textlabel.xml b/kdoctools/docbook/xsl/params/admon.textlabel.xml new file mode 100644 index 000000000..744b258ab --- /dev/null +++ b/kdoctools/docbook/xsl/params/admon.textlabel.xml @@ -0,0 +1,28 @@ +<refentry id="admon.textlabel"> +<refmeta> +<refentrytitle>admon.textlabel</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>admon.textlabel</refname> +<refpurpose>Use text label in admonitions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='admon.textlabel.frag'> +<xsl:param name="admon.textlabel" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), admonitions are presented with a generated +text label such as Note or Warning in the appropriate language. +If zero, such labels are turned off, but any title child +of the admonition element are still output. +The default value is 1. +</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/admonition.properties.xml b/kdoctools/docbook/xsl/params/admonition.properties.xml new file mode 100644 index 000000000..e127e5652 --- /dev/null +++ b/kdoctools/docbook/xsl/params/admonition.properties.xml @@ -0,0 +1,16 @@ +<refentry id="admonition.properties"> +<refnamediv> +<refname>admonition.properties</refname> +<refpurpose>To set the style for admonitions.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='admonition.properties.frag'><xsl:attribute-set name="admonition.properties"/> +</src:fragment> +</refsynopsisdiv> +<refsect1><title>Description</title> +<para>How do you want admonitions styled? </para> +<para>Set the font-size, weight, etc. to the style required</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/admonition.title.properties.xml b/kdoctools/docbook/xsl/params/admonition.title.properties.xml new file mode 100644 index 000000000..851391b36 --- /dev/null +++ b/kdoctools/docbook/xsl/params/admonition.title.properties.xml @@ -0,0 +1,22 @@ +<refentry id="admonition.title.properties"> +<refnamediv> +<refname>admonition.title.properties</refname> +<refpurpose>To set the style for admonitions titles.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='admonition.title.properties.frag'> +<xsl:attribute-set name="admonition.title.properties"> + <xsl:attribute name="font-size">14pt</xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsect1><title>Description</title> +<para>How do you want admonitions titles styled? </para> +<para>Set the font-size, weight etc to the style required.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/alignment.xml b/kdoctools/docbook/xsl/params/alignment.xml new file mode 100644 index 000000000..ab304dcf6 --- /dev/null +++ b/kdoctools/docbook/xsl/params/alignment.xml @@ -0,0 +1,21 @@ +<refentry id="alignment"> +<refmeta> +<refentrytitle>alignment</refentrytitle> + +</refmeta> +<refnamediv> +<refname>alignment</refname> +<refpurpose>Specify the default text alignment</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='alignment.frag'><xsl:param name="alignment">justify</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The default text alignment is used for most body text. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/annotate.toc.xml b/kdoctools/docbook/xsl/params/annotate.toc.xml new file mode 100644 index 000000000..a6dec4ad6 --- /dev/null +++ b/kdoctools/docbook/xsl/params/annotate.toc.xml @@ -0,0 +1,23 @@ +<refentry id="annotate.toc"> +<refmeta> +<refentrytitle>annotate.toc</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>annotate.toc</refname> +<refpurpose>Annotate the Table of Contents?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='annotate.toc.frag'><xsl:param name="annotate.toc" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, TOCs will be annotated. At present, this just means +that the <sgmltag>RefPurpose</sgmltag> of <sgmltag>RefEntry</sgmltag> +TOC entries will be displayed. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/appendix.autolabel.xml b/kdoctools/docbook/xsl/params/appendix.autolabel.xml new file mode 100644 index 000000000..08195a056 --- /dev/null +++ b/kdoctools/docbook/xsl/params/appendix.autolabel.xml @@ -0,0 +1,22 @@ +<refentry id="appendix.autolabel"> +<refmeta> +<refentrytitle>appendix.autolabel</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>appendix.autolabel</refname> +<refpurpose>Are Appendixes automatically enumerated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='appendix.autolabel.frag'><xsl:param name="appendix.autolabel" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), unlabeled appendixes will be +enumerated. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/arbortext.extensions.xml b/kdoctools/docbook/xsl/params/arbortext.extensions.xml new file mode 100644 index 000000000..69755e967 --- /dev/null +++ b/kdoctools/docbook/xsl/params/arbortext.extensions.xml @@ -0,0 +1,25 @@ +<refentry id="arbortext.extensions"> +<refmeta> +<refentrytitle>arbortext.extensions</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>arbortext.extensions</refname> +<refpurpose>Enable Arbortext extensions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='arbortext.extensions.frag'><xsl:param name="arbortext.extensions" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, +<ulink url="http://www.arbortext.com/">Arbortext</ulink> +extensions will be used. +</para> +<para>This parameter can also affect which graphics file formats +are supported</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/article.appendix.title.properties.xml b/kdoctools/docbook/xsl/params/article.appendix.title.properties.xml new file mode 100644 index 000000000..006f2bb45 --- /dev/null +++ b/kdoctools/docbook/xsl/params/article.appendix.title.properties.xml @@ -0,0 +1,31 @@ +<refentry id="article.appendix.title.properties"> +<refmeta> +<refentrytitle>article.appendix.title.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>article.appendix.title.properties</refname> +<refpurpose>Properties for appendix titles that appear in an article</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='article.appendix.title.properties.frag'> +<xsl:attribute-set name="article.appendix.title.properties" + use-attribute-sets="section.title.properties + section.title.level1.properties"> + <xsl:attribute name="margin-left"> + <xsl:value-of select="$title.margin.left"/> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties for the title of an appendix that +appears inside an article. The default is to use +the properties of sect1 titles.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/author.othername.in.middle.xml b/kdoctools/docbook/xsl/params/author.othername.in.middle.xml new file mode 100644 index 000000000..60300224b --- /dev/null +++ b/kdoctools/docbook/xsl/params/author.othername.in.middle.xml @@ -0,0 +1,25 @@ +<refentry id="author.othername.in.middle"> +<refmeta> +<refentrytitle>author.othername.in.middle</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>author.othername.in.middle</refname> +<refpurpose>Is <sgmltag>othername</sgmltag> in <sgmltag>author</sgmltag> a +middle name?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='author.othername.in.middle.frag'><xsl:param name="author.othername.in.middle" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), the <sgmltag>othername</sgmltag> of an <sgmltag>author</sgmltag> +appears between the <sgmltag>firstname</sgmltag> and +<sgmltag>surname</sgmltag>. Otherwise, <sgmltag>othername</sgmltag> +is suppressed. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/autotoc.label.separator.xml b/kdoctools/docbook/xsl/params/autotoc.label.separator.xml new file mode 100644 index 000000000..20a8f0039 --- /dev/null +++ b/kdoctools/docbook/xsl/params/autotoc.label.separator.xml @@ -0,0 +1,20 @@ +<refentry id="autotoc.label.separator"> +<refmeta> +<refentrytitle>autotoc.label.separator</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>autotoc.label.separator</refname> +<refpurpose>Separator between labels and titles in the ToC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='autotoc.label.separator.frag'><xsl:param name="autotoc.label.separator" select="'. '"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>String to use to seperate labels and title in a table of contents.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/axf.extensions.xml b/kdoctools/docbook/xsl/params/axf.extensions.xml new file mode 100644 index 000000000..b5c6c52b4 --- /dev/null +++ b/kdoctools/docbook/xsl/params/axf.extensions.xml @@ -0,0 +1,28 @@ +<refentry id="axf.extensions"> +<refmeta> +<refentrytitle>axf.extensions</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>axf.extensions</refname> +<refpurpose>Enable XSL Formatter extensions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='axf.extensions.frag'> +<xsl:param name="axf.extensions" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, +<ulink url="http://www.antennahouse.com/">XSL Formatter</ulink> +extensions will be used. XSL Formatter extensions consists of PDF bookmarks, +document information and better index processing.</para> + +<para>This parameter can also affect which graphics file formats +are supported</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/base.dir.xml b/kdoctools/docbook/xsl/params/base.dir.xml new file mode 100644 index 000000000..704e91c82 --- /dev/null +++ b/kdoctools/docbook/xsl/params/base.dir.xml @@ -0,0 +1,22 @@ +<refentry id="base.dir"> +<refmeta> +<refentrytitle>base.dir</refentrytitle> + +</refmeta> +<refnamediv> +<refname>base.dir</refname> +<refpurpose>The base directory of chunks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='base.dir.frag'><xsl:param name="base.dir" select="''"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If specified, the <literal>base.dir</literal> identifies +the output directory for chunks. (If not specified, the output directory +is system dependent.)</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/biblioentry.item.separator.xml b/kdoctools/docbook/xsl/params/biblioentry.item.separator.xml new file mode 100644 index 000000000..0146e6936 --- /dev/null +++ b/kdoctools/docbook/xsl/params/biblioentry.item.separator.xml @@ -0,0 +1,21 @@ +<refentry id="biblioentry.item.separator"> +<refmeta> +<refentrytitle>biblioentry.item.separator</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>biblioentry.item.separator</refname> +<refpurpose>Text to separate bibliography entries</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='biblioentry.item.separator.frag'><xsl:param name="biblioentry.item.separator">. </xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Text to separate bibliography entries +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/bibliography.collection.xml b/kdoctools/docbook/xsl/params/bibliography.collection.xml new file mode 100644 index 000000000..2e69e7ddd --- /dev/null +++ b/kdoctools/docbook/xsl/params/bibliography.collection.xml @@ -0,0 +1,96 @@ +<refentry id="bibliography.collection"> +<refmeta> +<refentrytitle>bibliography.collection</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bibliography.collection</refname> +<refpurpose>Name of the bibliography collection file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='bibliography.collection.frag'><xsl:param name="bibliography.collection" select="'http://docbook.sourceforge.net/release/bibliography/bibliography.xml'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Maintaining bibliography entries across a set of documents is tedious, time +consuming, and error prone. It makes much more sense, usually, to store all of +the bibliography entries in a single place and simply <quote>extract</quote> +the ones you need in each document.</para> + +<para>That's the purpose of the +<parameter>bibliography.collection</parameter> parameter. To setup a global +bibliography <quote>database</quote>, follow these steps:</para> + +<para>First, create a stand-alone bibliography document that contains all of +the documents that you wish to reference. Make sure that each bibliography +entry (whether you use <sgmltag>biblioentry</sgmltag> or <sgmltag>bibliomixed</sgmltag>) +has an ID.</para> + +<para>My global bibliography, <filename>~/bibliography.xml</filename> begins +like this:</para> + +<informalexample> +<programlisting><![CDATA[<!DOCTYPE bibliography + PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<bibliography><title>References</title> + +<bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray, +Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors. +<citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Markup +Language (XML) 1.0 Second Edition</ulink></citetitle>. +World Wide Web Consortium, 2000. +</bibliomixed> + +<bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bray, +Dave Hollander, +and Andrew Layman, editors. +<citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespaces in +XML</ulink></citetitle>. +World Wide Web Consortium, 1999. +</bibliomixed> + +<!-- ... --> +</bibliography> +]]></programlisting> +</informalexample> + +<para>When you create a bibliography in your document, simply +provide <emphasis>empty</emphasis> <sgmltag>bibliomixed</sgmltag> +entries for each document that you wish to cite. Make sure that these +elements have the same ID as the corresponding <quote>real</quote> +entry in your global bibliography.</para> + +<para>For example:</para> + +<informalexample> +<programlisting><![CDATA[<bibliography><title>Bibliography</title> + +<bibliomixed id="xml-rec"/> +<bibliomixed id="xml-names"/> +<bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and +Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley, +1986. ISBN 0-201-13437-3. +</bibliomixed> +<bibliomixed id="relaxng"/> + +</bibliography>]]></programlisting> +</informalexample> + +<para>Note that it's perfectly acceptable to mix entries from your +global bibliography with <quote>normal</quote> entries. You can use +<sgmltag>xref</sgmltag> or other elements to cross-reference your +bibliography entries in exactly the same way you do now.</para> + +<para>Finally, when you are ready to format your document, simply set the +<parameter>bibliography.collection</parameter> parameter (in either a +customization layer or directly through your processor's interface) to +point to your global bibliography.</para> + +<para>The stylesheets will format the bibliography in your document as if +all of the entries referenced appeared there literally.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/bibliography.numbered.xml b/kdoctools/docbook/xsl/params/bibliography.numbered.xml new file mode 100644 index 000000000..13cc104ec --- /dev/null +++ b/kdoctools/docbook/xsl/params/bibliography.numbered.xml @@ -0,0 +1,22 @@ +<refentry id="bibliography.numbered"> +<refmeta> +<refentrytitle>bibliography.numbered</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bibliography.numbered</refname> +<refpurpose>Should bibliography entries be numbered?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='bibliography.numbered.frag'> +<xsl:param name="bibliography.numbered" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero bibliography entries will be numbered</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/blockquote.properties.xml b/kdoctools/docbook/xsl/params/blockquote.properties.xml new file mode 100644 index 000000000..1803adb18 --- /dev/null +++ b/kdoctools/docbook/xsl/params/blockquote.properties.xml @@ -0,0 +1,25 @@ +<refentry id="blockquote.properties"> +<refnamediv> +<refname>blockquote.properties</refname> +<refpurpose>To set the style for block quotations.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='blockquote.properties.frag'> +<xsl:attribute-set name="blockquote.properties"> +<xsl:attribute name="start-indent">0.5in</xsl:attribute> +<xsl:attribute name="end-indent">0.5in</xsl:attribute> +<xsl:attribute name="space-after.minimum">0.5em</xsl:attribute> +<xsl:attribute name="space-after.optimum">1em</xsl:attribute> +<xsl:attribute name="space-after.maximum">2em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>blockquote.properties</parameter> attribute set specifies +the formating properties of block quotations.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/body.font.family.xml b/kdoctools/docbook/xsl/params/body.font.family.xml new file mode 100644 index 000000000..b5e75fe3d --- /dev/null +++ b/kdoctools/docbook/xsl/params/body.font.family.xml @@ -0,0 +1,23 @@ +<refentry id="body.font.family"> +<refmeta> +<refentrytitle>body.font.family</refentrytitle> + +</refmeta> +<refnamediv> +<refname>body.font.family</refname> +<refpurpose>The default font family for body text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='body.font.family.frag'> +<xsl:param name="body.font.family" select="'serif'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The body font family is the default font used for text in the page body. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/body.font.master.xml b/kdoctools/docbook/xsl/params/body.font.master.xml new file mode 100644 index 000000000..4c532b80d --- /dev/null +++ b/kdoctools/docbook/xsl/params/body.font.master.xml @@ -0,0 +1,25 @@ +<refentry id="body.font.master"> +<refmeta> +<refentrytitle>body.font.master</refentrytitle> + +</refmeta> +<refnamediv> +<refname>body.font.master</refname> +<refpurpose>Specifies the default point size for body text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='body.font.master.frag'> +<xsl:param name="body.font.master">10</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The body font size is specified in two parameters +(<varname>body.font.master</varname> and <varname>body.font.size</varname>) +so that math can be performed on the font size by XSLT. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/body.font.size.xml b/kdoctools/docbook/xsl/params/body.font.size.xml new file mode 100644 index 000000000..56134c879 --- /dev/null +++ b/kdoctools/docbook/xsl/params/body.font.size.xml @@ -0,0 +1,25 @@ +<refentry id="body.font.size"> +<refmeta> +<refentrytitle>body.font.size</refentrytitle> + +</refmeta> +<refnamediv> +<refname>body.font.size</refname> +<refpurpose>Specifies the default font size for body text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='body.font.size.frag'><xsl:param name="body.font.size"> + <xsl:value-of select="$body.font.master"/><xsl:text>pt</xsl:text> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The body font size is specified in two parameters +(<varname>body.font.master</varname> and <varname>body.font.size</varname>) +so that math can be performed on the font size by XSLT. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/body.margin.bottom.xml b/kdoctools/docbook/xsl/params/body.margin.bottom.xml new file mode 100644 index 000000000..98d1233b3 --- /dev/null +++ b/kdoctools/docbook/xsl/params/body.margin.bottom.xml @@ -0,0 +1,24 @@ +<refentry id="body.margin.bottom"> +<refmeta> +<refentrytitle>body.margin.bottom</refentrytitle> + +</refmeta> +<refnamediv> +<refname>body.margin.bottom</refname> +<refpurpose>The bottom margin of the body text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='body.margin.bottom.frag'> +<xsl:param name="body.margin.bottom" select="'0.5in'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The body bottom margin is the distance from the last line of text +in the page body to the bottom of the region-after. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/body.margin.top.xml b/kdoctools/docbook/xsl/params/body.margin.top.xml new file mode 100644 index 000000000..96ea6906b --- /dev/null +++ b/kdoctools/docbook/xsl/params/body.margin.top.xml @@ -0,0 +1,24 @@ +<refentry id="body.margin.top"> +<refmeta> +<refentrytitle>body.margin.top</refentrytitle> + +</refmeta> +<refnamediv> +<refname>body.margin.top</refname> +<refpurpose>To specify the size of the top margin of a page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='body.margin.top.frag'> +<xsl:param name="body.margin.top" select="'0.5in'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The body top margin is the distance from the top of the region-before +to the first line of text in the page body. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/bridgehead.in.toc.xml b/kdoctools/docbook/xsl/params/bridgehead.in.toc.xml new file mode 100644 index 000000000..4fbc4f6d4 --- /dev/null +++ b/kdoctools/docbook/xsl/params/bridgehead.in.toc.xml @@ -0,0 +1,23 @@ +<refentry id="bridgehead.in.toc"> +<refmeta> +<refentrytitle>bridgehead.in.toc</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>bridgehead.in.toc</refname> +<refpurpose>Should bridgehead elements appear in the TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='bridgehead.in.toc.frag'><xsl:param name="bridgehead.in.toc" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, bridgeheads appear in the TOC. Note that this option +is not fully supported and may be removed in a future version of the +stylesheets. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callout.defaultcolumn.xml b/kdoctools/docbook/xsl/params/callout.defaultcolumn.xml new file mode 100644 index 000000000..059a5e5d1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/callout.defaultcolumn.xml @@ -0,0 +1,23 @@ +<refentry id="callout.defaultcolumn"> +<refmeta> +<refentrytitle>callout.defaultcolumn</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.defaultcolumn</refname> +<refpurpose>Indicates what column callouts appear in by default</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callout.defaultcolumn.frag'><xsl:param name="callout.defaultcolumn" select="'60'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If a callout does not identify a column (for example, if it uses +the <literal>linerange</literal> <sgmltag class="attribute">unit</sgmltag>), +it will appear in the default column. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callout.graphics.extension.xml b/kdoctools/docbook/xsl/params/callout.graphics.extension.xml new file mode 100644 index 000000000..4503569ea --- /dev/null +++ b/kdoctools/docbook/xsl/params/callout.graphics.extension.xml @@ -0,0 +1,20 @@ +<refentry id="callout.graphics.extension"> +<refmeta> +<refentrytitle>callout.graphics.extension</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics.extension</refname> +<refpurpose>Extension for callout graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callout.graphics.extension.frag'><xsl:param name="callout.graphics.extension" select="'.png'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Sets the extension to use on callout graphics.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callout.graphics.number.limit.xml b/kdoctools/docbook/xsl/params/callout.graphics.number.limit.xml new file mode 100644 index 000000000..f3d78030b --- /dev/null +++ b/kdoctools/docbook/xsl/params/callout.graphics.number.limit.xml @@ -0,0 +1,28 @@ +<refentry id="callout.graphics.number.limit"> +<refmeta> +<refentrytitle>callout.graphics.number.limit</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics.number.limit</refname> +<refpurpose>Number of the largest callout graphic</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callout.graphics.number.limit.frag'><xsl:param name="callout.graphics.number.limit" select="'15'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>callout.graphics</parameter> +is non-zero, graphics are used to represent +callout numbers. The value of +<parameter>callout.graphics.number.limit</parameter> +is +the largest number for which a graphic exists. If the callout number +exceeds this limit, the default presentation "(nnn)" will always +be used. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callout.graphics.path.xml b/kdoctools/docbook/xsl/params/callout.graphics.path.xml new file mode 100644 index 000000000..33f5a15bf --- /dev/null +++ b/kdoctools/docbook/xsl/params/callout.graphics.path.xml @@ -0,0 +1,24 @@ +<refentry id="callout.graphics.path"> +<refmeta> +<refentrytitle>callout.graphics.path</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics.path</refname> +<refpurpose>Path to callout graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callout.graphics.path.frag'> +<xsl:param name="callout.graphics.path" select="'images/callouts/'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Sets the path, probably relative to the directory where the HTML +files are created, to the callout graphics. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callout.graphics.xml b/kdoctools/docbook/xsl/params/callout.graphics.xml new file mode 100644 index 000000000..ed54e9705 --- /dev/null +++ b/kdoctools/docbook/xsl/params/callout.graphics.xml @@ -0,0 +1,25 @@ +<refentry id="callout.graphics"> +<refmeta> +<refentrytitle>callout.graphics</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.graphics</refname> +<refpurpose>Use graphics for callouts?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callout.graphics.frag'> +<xsl:param name="callout.graphics" select="'1'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, callouts are presented with graphics (e.g., reverse-video +circled numbers instead of "(1)", "(2)", etc.). +Default graphics are provided in the distribution. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callout.list.table.xml b/kdoctools/docbook/xsl/params/callout.list.table.xml new file mode 100644 index 000000000..bbfcb7aca --- /dev/null +++ b/kdoctools/docbook/xsl/params/callout.list.table.xml @@ -0,0 +1,25 @@ +<refentry id="callout.list.table"> +<refmeta> +<refentrytitle>callout.list.table</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.list.table</refname> +<refpurpose>Present callout lists using a table?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callout.list.table.frag'><xsl:param name="callout.list.table" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The default presentation of <sgmltag>CalloutList</sgmltag>s uses +an HTML <sgmltag>DL</sgmltag>. Some browsers don't align DLs very well +if <parameter>callout.graphics</parameter> are used. With this option +turned on, <sgmltag>CalloutList</sgmltag>s are presented in an HTML +<sgmltag>TABLE</sgmltag>, which usually results in better alignment +of the callout number with the callout description.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callout.unicode.font.xml b/kdoctools/docbook/xsl/params/callout.unicode.font.xml new file mode 100644 index 000000000..efcbdd08d --- /dev/null +++ b/kdoctools/docbook/xsl/params/callout.unicode.font.xml @@ -0,0 +1,22 @@ +<refentry id="callout.unicode.font"> +<refmeta> +<refentrytitle>callout.unicode.font</refentrytitle> + +</refmeta> +<refnamediv> +<refname>callout.unicode.font</refname> +<refpurpose>Specify a font for Unicode glyphs</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callout.unicode.font.frag'><xsl:param name="callout.unicode.font" select="'ZapfDingbats'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The name of the font to specify around Unicode callout glyphs. +If set to the empty string, no font change will occur. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callout.unicode.number.limit.xml b/kdoctools/docbook/xsl/params/callout.unicode.number.limit.xml new file mode 100644 index 000000000..f02ae3dfe --- /dev/null +++ b/kdoctools/docbook/xsl/params/callout.unicode.number.limit.xml @@ -0,0 +1,28 @@ +<refentry id="callout.unicode.number.limit"> +<refmeta> +<refentrytitle>callout.unicode.number.limit</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.unicode.number.limit</refname> +<refpurpose>Number of the largest callout graphic</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callout.unicode.number.limit.frag'><xsl:param name="callout.unicode.number.limit" select="'10'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>callout.unicode</parameter> +is non-zero, unicode characters are used to represent +callout numbers. The value of +<parameter>callout.unicode.number.limit</parameter> +is +the largest number for which a unicode character exists. If the callout number +exceeds this limit, the default presentation "(nnn)" will always +be used. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callout.unicode.start.character.xml b/kdoctools/docbook/xsl/params/callout.unicode.start.character.xml new file mode 100644 index 000000000..6423eb5f9 --- /dev/null +++ b/kdoctools/docbook/xsl/params/callout.unicode.start.character.xml @@ -0,0 +1,26 @@ +<refentry id="callout.unicode.start.character"> +<refmeta> +<refentrytitle>callout.unicode.start.character</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.unicode.start.character</refname> +<refpurpose>First Unicode character to use, decimal value.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callout.unicode.start.character.frag'><xsl:param name="callout.unicode.start.character" select="10102"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter> +is non-zero, unicode characters are used to represent +callout numbers. The value of +<parameter>callout.unicode.start.character</parameter> +is the decimal unicode value used for callout number one. Currently, +only 10102 is supported in the stylesheets for this parameter. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callout.unicode.xml b/kdoctools/docbook/xsl/params/callout.unicode.xml new file mode 100644 index 000000000..f0a00b06d --- /dev/null +++ b/kdoctools/docbook/xsl/params/callout.unicode.xml @@ -0,0 +1,21 @@ +<refentry id="callout.unicode"> +<refmeta> +<refentrytitle>callout.unicode</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callout.unicode</refname> +<refpurpose>Use Unicode characters rather than images for callouts.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callout.unicode.frag'><xsl:param name="callout.unicode" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The stylesheets can use either an image of the numbers one to ten, or the single Unicode character which represents the numeral, in white on a black background. Use this to select the Unicode character option. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/callouts.extension.xml b/kdoctools/docbook/xsl/params/callouts.extension.xml new file mode 100644 index 000000000..848087089 --- /dev/null +++ b/kdoctools/docbook/xsl/params/callouts.extension.xml @@ -0,0 +1,23 @@ +<refentry id="callouts.extension"> +<refmeta> +<refentrytitle>callouts.extension</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>callouts.extension</refname> +<refpurpose>Enable the callout extension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='callouts.extension.frag'><xsl:param name="callouts.extension" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The callouts extension processes <sgmltag>areaset</sgmltag> +elements in <sgmltag>ProgramListingCO</sgmltag> and other text-based +callout elements. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chapter.autolabel.xml b/kdoctools/docbook/xsl/params/chapter.autolabel.xml new file mode 100644 index 000000000..309e61831 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chapter.autolabel.xml @@ -0,0 +1,21 @@ +<refentry id="chapter.autolabel"> +<refmeta> +<refentrytitle>chapter.autolabel</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chapter.autolabel</refname> +<refpurpose>Are chapters automatically enumerated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='chapter.autolabel.frag'><xsl:param name="chapter.autolabel" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), unlabeled chapters will be enumerated. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunk.first.sections.xml b/kdoctools/docbook/xsl/params/chunk.first.sections.xml new file mode 100644 index 000000000..f1f9a0a47 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunk.first.sections.xml @@ -0,0 +1,26 @@ +<refentry id="chunk.first.sections"> +<refmeta> +<refentrytitle>chunk.first.sections</refentrytitle> + +</refmeta> +<refnamediv> +<refname>chunk.first.sections</refname> +<refpurpose>Chunk the first top-level section?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='chunk.first.sections.frag'> +<xsl:param name="chunk.first.sections" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, a chunk will be created for the first top-level +<sgmltag>sect1</sgmltag> or <sgmltag>section</sgmltag> elements in +each component. Otherwise, that section will be part of the chunk for +its parent. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunk.quietly.xml b/kdoctools/docbook/xsl/params/chunk.quietly.xml new file mode 100644 index 000000000..78200a5e7 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunk.quietly.xml @@ -0,0 +1,25 @@ +<refentry id="chunk.quietly"> +<refmeta> +<refentrytitle>chunk.quietly</refentrytitle> + +</refmeta> +<refnamediv> +<refname>chunk.quietly</refname> +<refpurpose>Omit the chunked filename messages.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='chunk.quietly.frag'> +<xsl:param name="chunk.quietly" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If zero (the default), the XSL processor emits a message naming +each separate chunk filename as it is being output. +If nonzero, then the messages are suppressed. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunk.section.depth.xml b/kdoctools/docbook/xsl/params/chunk.section.depth.xml new file mode 100644 index 000000000..af29641b9 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunk.section.depth.xml @@ -0,0 +1,22 @@ +<refentry id="chunk.section.depth"> +<refmeta> +<refentrytitle>chunk.section.depth</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.section.depth</refname> +<refpurpose>Depth to which sections should be chunked</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='chunk.section.depth.frag'> +<xsl:param name="chunk.section.depth" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter sets the depth of section chunking.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunk.sections.xml b/kdoctools/docbook/xsl/params/chunk.sections.xml new file mode 100644 index 000000000..38bf39ece --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunk.sections.xml @@ -0,0 +1,23 @@ +<refentry id="chunk.sections"> +<refmeta> +<refentrytitle>chunk.sections</refentrytitle> + +</refmeta> +<refnamediv> +<refname>chunk.sections</refname> +<refpurpose>Should top-level sections be chunks in their own right?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='chunk.sections.frag'><xsl:param name="chunk.sections" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, chunks will be created for top-level +<sgmltag>sect1</sgmltag> and <sgmltag>section</sgmltag> elements in +each component. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunk.separate.lots.xml b/kdoctools/docbook/xsl/params/chunk.separate.lots.xml new file mode 100644 index 000000000..3a0c8c224 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunk.separate.lots.xml @@ -0,0 +1,31 @@ +<refentry id="chunk.separate.lots"> +<refmeta> +<refentrytitle>chunk.separate.lots</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.separate.lots</refname> +<refpurpose>Should each LoT be in its own separate chunk?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='chunk.separate.lots.frag'> +<xsl:param name="chunk.separate.lots" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, each of the ToC and LoTs +(List of Examples, List of Figures, etc.) +will be put in its own separate chunk. +The title page includes generated links to each of the separate files. +</para> +<para> +This feature depends on the +<literal>chunk.tocs.and.lots</literal> +parameter also being non-zero. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunk.toc.xml b/kdoctools/docbook/xsl/params/chunk.toc.xml new file mode 100644 index 000000000..279b1c2cc --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunk.toc.xml @@ -0,0 +1,25 @@ +<refentry id="chunk.toc"> +<refmeta> +<refentrytitle>chunk.toc</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.toc</refname> +<refpurpose>An explicit TOC to be used for chunking</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='chunk.toc.frag'> +<xsl:param name="chunk.toc" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that +will be used for chunking. This parameter is only used by the +<filename>chunktoc.xsl</filename> stylesheet (and customization layers built +from it).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunk.tocs.and.lots.xml b/kdoctools/docbook/xsl/params/chunk.tocs.and.lots.xml new file mode 100644 index 000000000..655b3ffb0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunk.tocs.and.lots.xml @@ -0,0 +1,27 @@ +<refentry id="chunk.tocs.and.lots"> +<refmeta> +<refentrytitle>chunk.tocs.and.lots</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunk.tocs.and.lots</refname> +<refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='chunk.tocs.and.lots.frag'> +<xsl:param name="chunk.tocs.and.lots" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.) +will be put in a separate chunk. At the moment, this chunk is not in the +normal forward/backward navigation list. Instead, a new link is added to the +navigation footer.</para> + +<para>This feature is still somewhat experimental. Feedback welcome.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunker.output.cdata-section-elements.xml b/kdoctools/docbook/xsl/params/chunker.output.cdata-section-elements.xml new file mode 100644 index 000000000..0f77056a0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunker.output.cdata-section-elements.xml @@ -0,0 +1,27 @@ +<refentry id="chunker.output.cdata-section-elements"> +<refmeta> +<refentrytitle>chunker.output.cdata-section-elements</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.cdata-section-elements</refname> +<refpurpose>List of elements to escape with CDATA sections</refpurpose> +</refnamediv> + +<refsynopsisdiv><xsl:param name="chunker.output.cdata-section-elements" select="''"/> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the list of elements that should be escaped +as CDATA sections by the chunking stylesheet. Not all processors support +specification of this parameter. +</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunker.output.doctype-public.xml b/kdoctools/docbook/xsl/params/chunker.output.doctype-public.xml new file mode 100644 index 000000000..06e342354 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunker.output.doctype-public.xml @@ -0,0 +1,28 @@ +<refentry id="chunker.output.doctype-public"> +<refmeta> +<refentrytitle>chunker.output.doctype-public</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.doctype-public</refname> +<refpurpose>Public identifer to use in the document type of generated pages</refpurpose> +</refnamediv> + +<refsynopsisdiv><xsl:param name="chunker.output.doctype-public" select="''"/> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the public identifier that should be used by +the chunking stylesheet in the document type declaration of chunked pages. +Not all processors support specification of +this parameter. +</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunker.output.doctype-system.xml b/kdoctools/docbook/xsl/params/chunker.output.doctype-system.xml new file mode 100644 index 000000000..6147e0d7a --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunker.output.doctype-system.xml @@ -0,0 +1,28 @@ +<refentry id="chunker.output.doctype-system"> +<refmeta> +<refentrytitle>chunker.output.doctype-system</refentrytitle> +<refmiscinfo role="type">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.doctype-system</refname> +<refpurpose>System identifier to use for the document type in generated pages</refpurpose> +</refnamediv> + +<refsynopsisdiv><xsl:param name="chunker.output.doctype-system" select="''"/> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the system identifier that should be used by +the chunking stylesheet in the document type declaration of chunked pages. +Not all processors support specification of +this parameter. +</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunker.output.encoding.xml b/kdoctools/docbook/xsl/params/chunker.output.encoding.xml new file mode 100644 index 000000000..c10b13703 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunker.output.encoding.xml @@ -0,0 +1,29 @@ +<refentry id="chunker.output.encoding"> +<refmeta> +<refentrytitle>chunker.output.encoding</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.encoding</refname> +<refpurpose>Encoding used in generated pages</refpurpose> +</refnamediv> + +<refsynopsisdiv><xsl:param name="chunker.output.encoding" select="'ISO-8859-1'"/> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the encoding to be used in files +generated by the chunking stylesheet. Not all processors support +specification of this parameter. +</para> + +<para>This parameter used to be named <literal>default.encoding</literal>.</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunker.output.indent.xml b/kdoctools/docbook/xsl/params/chunker.output.indent.xml new file mode 100644 index 000000000..3dadc0528 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunker.output.indent.xml @@ -0,0 +1,27 @@ +<refentry id="chunker.output.indent"> +<refmeta> +<refentrytitle>chunker.output.indent</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.indent</refname> +<refpurpose>Specification of indentation on generated pages</refpurpose> +</refnamediv> + +<refsynopsisdiv><xsl:param name="chunker.output.indent" select="'no'"/> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the value of the indent +specification for generated pages. Not all processors support +specification of this parameter. +</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunker.output.media-type.xml b/kdoctools/docbook/xsl/params/chunker.output.media-type.xml new file mode 100644 index 000000000..5b07e0e8b --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunker.output.media-type.xml @@ -0,0 +1,27 @@ +<refentry id="chunker.output.media-type"> +<refmeta> +<refentrytitle>chunker.output.media-type</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.media-type</refname> +<refpurpose>Media type to use in generated pages</refpurpose> +</refnamediv> + +<refsynopsisdiv><xsl:param name="chunker.output.media-type" select="''"/> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the media type that should be used by +the chunking stylesheet. Not all processors support specification of +this parameter. +</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunker.output.method.xml b/kdoctools/docbook/xsl/params/chunker.output.method.xml new file mode 100644 index 000000000..df16f0629 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunker.output.method.xml @@ -0,0 +1,30 @@ +<refentry id="chunker.output.method"> +<refmeta> +<refentrytitle>chunker.output.method</refentrytitle> +<refmiscinfo role="type">list</refmiscinfo> +<refmiscinfo role="value">html</refmiscinfo> +<refmiscinfo role="value">xml</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.method</refname> +<refpurpose>Method used in generated pages</refpurpose> +</refnamediv> + +<refsynopsisdiv><xsl:param name="chunker.output.method" select="'html'"/> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the output method to be used in files +generated by the chunking stylesheet. +</para> + +<para>This parameter used to be named <literal>output.method</literal>.</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunker.output.omit-xml-declaration.xml b/kdoctools/docbook/xsl/params/chunker.output.omit-xml-declaration.xml new file mode 100644 index 000000000..84ed80a44 --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunker.output.omit-xml-declaration.xml @@ -0,0 +1,27 @@ +<refentry id="chunker.output.omit-xml-declaration"> +<refmeta> +<refentrytitle>chunker.output.omit-xml-declaration</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.omit-xml-declaration</refname> +<refpurpose>Omit-xml-declaration for generated pages</refpurpose> +</refnamediv> + +<refsynopsisdiv><xsl:param name="chunker.output.omit-xml-declaration" select="'no'"/> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the value of the omit-xml-declaration +specification for generated pages. Not all processors support +specification of this parameter. +</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/chunker.output.standalone.xml b/kdoctools/docbook/xsl/params/chunker.output.standalone.xml new file mode 100644 index 000000000..bfd145c6a --- /dev/null +++ b/kdoctools/docbook/xsl/params/chunker.output.standalone.xml @@ -0,0 +1,27 @@ +<refentry id="chunker.output.standalone"> +<refmeta> +<refentrytitle>chunker.output.standalone</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>chunker.output.standalone</refname> +<refpurpose>Standalone declaration for generated pages</refpurpose> +</refnamediv> + +<refsynopsisdiv><xsl:param name="chunker.output.standalone" select="'no'"/> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the value of the standalone +specification for generated pages. Not all processors support +specification of this parameter. +</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/citerefentry.link.xml b/kdoctools/docbook/xsl/params/citerefentry.link.xml new file mode 100644 index 000000000..bd413c49f --- /dev/null +++ b/kdoctools/docbook/xsl/params/citerefentry.link.xml @@ -0,0 +1,23 @@ +<refentry id="citerefentry.link"> +<refmeta> +<refentrytitle>citerefentry.link</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>citerefentry.link</refname> +<refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='citerefentry.link.frag'><xsl:param name="citerefentry.link" select="'0'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, a web link will be generated, presumably +to an online man->HTML gateway. The text of the link is +generated by the generate.citerefentry.link template. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/collect.xref.targets.xml b/kdoctools/docbook/xsl/params/collect.xref.targets.xml new file mode 100644 index 000000000..846a01fd4 --- /dev/null +++ b/kdoctools/docbook/xsl/params/collect.xref.targets.xml @@ -0,0 +1,25 @@ +<refentry id="collect.xref.targets"> +<refmeta> +<refentrytitle>collect.xref.targets</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>collect.xref.targets</refname> +<refpurpose>Controls whether cross reference data is +collected</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment id="collect.xref.targets.frag"> +<xsl:param name="collect.xref.targets" select="'no'"/> +</src:fragment> +</refsynopsisdiv> +<refsect1> +<title>Description</title> +<para> +In order to resolve olinks efficiently, the stylesheets can +generate an external data file containing information about +all potential cross reference endpoints in a document. +This parameter determines whether the collection process is run when the document is processed by the stylesheet. The default value is <literal>no</literal>, which means the data file is not generated during processing. The other choices are <literal>yes</literal>, which means the data file is created and the document is processed for output, and <literal>only</literal>, which means the data file is created but the document is not processed for output. +See also <parameter>targets.filename</parameter>. +</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.count.back.xml b/kdoctools/docbook/xsl/params/column.count.back.xml new file mode 100644 index 000000000..ee30af946 --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.count.back.xml @@ -0,0 +1,22 @@ +<refentry id="column.count.back"> +<refmeta> +<refentrytitle>column.count.back</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.back</refname> +<refpurpose>Number of columns on back matter pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.count.back.frag'> +<xsl:param name="column.count.back" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Number of columns on back matter (appendix, glossary, etc.) pages.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.count.body.xml b/kdoctools/docbook/xsl/params/column.count.body.xml new file mode 100644 index 000000000..d76b0d768 --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.count.body.xml @@ -0,0 +1,22 @@ +<refentry id="column.count.body"> +<refmeta> +<refentrytitle>column.count.body</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.body</refname> +<refpurpose>Number of columns on body pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.count.body.frag'> +<xsl:param name="column.count.body" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Number of columns on body pages.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.count.front.xml b/kdoctools/docbook/xsl/params/column.count.front.xml new file mode 100644 index 000000000..1fd023a2b --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.count.front.xml @@ -0,0 +1,22 @@ +<refentry id="column.count.front"> +<refmeta> +<refentrytitle>column.count.front</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.front</refname> +<refpurpose>Number of columns on front matter pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.count.front.frag'> +<xsl:param name="column.count.front" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Number of columns on front matter (dedication, preface, etc.) pages.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.count.index.xml b/kdoctools/docbook/xsl/params/column.count.index.xml new file mode 100644 index 000000000..26d0c1eeb --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.count.index.xml @@ -0,0 +1,22 @@ +<refentry id="column.count.index"> +<refmeta> +<refentrytitle>column.count.index</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.index</refname> +<refpurpose>Number of columns on index pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.count.index.frag'> +<xsl:param name="column.count.index" select="2"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Number of columns on index pages.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.count.lot.xml b/kdoctools/docbook/xsl/params/column.count.lot.xml new file mode 100644 index 000000000..611482768 --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.count.lot.xml @@ -0,0 +1,23 @@ +<refentry id="column.count.lot"> +<refmeta> +<refentrytitle>column.count.lot</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.lot</refname> +<refpurpose>Number of columns on a 'List-of-Titles' page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.count.lot.frag'> +<xsl:param name="column.count.lot" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Number of columns on a page sequence containing the Table of Contents, +List of Figures, etc.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.count.titlepage.xml b/kdoctools/docbook/xsl/params/column.count.titlepage.xml new file mode 100644 index 000000000..2718058ed --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.count.titlepage.xml @@ -0,0 +1,22 @@ +<refentry id="column.count.titlepage"> +<refmeta> +<refentrytitle>column.count.titlepage</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.count.titlepage</refname> +<refpurpose>Number of columns on a title page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.count.titlepage.frag'> +<xsl:param name="column.count.titlepage" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Number of columns on a title page</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.gap.back.xml b/kdoctools/docbook/xsl/params/column.gap.back.xml new file mode 100644 index 000000000..051548188 --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.gap.back.xml @@ -0,0 +1,23 @@ +<refentry id="column.gap.back"> +<refmeta> +<refentrytitle>column.gap.back</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.back</refname> +<refpurpose>Gap between columns in back matter</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.gap.back.frag'> +<xsl:param name="column.gap.back" select="'12pt'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the gap between columns in back matter (if +<parameter>column.count.back</parameter> is greater than one).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.gap.body.xml b/kdoctools/docbook/xsl/params/column.gap.body.xml new file mode 100644 index 000000000..4a7bd10a5 --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.gap.body.xml @@ -0,0 +1,23 @@ +<refentry id="column.gap.body"> +<refmeta> +<refentrytitle>column.gap.body</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.body</refname> +<refpurpose>Gap between columns in the body</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.gap.body.frag'> +<xsl:param name="column.gap.body" select="'12pt'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the gap between columns in body matter (if +<parameter>column.count.body</parameter> is greater than one).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.gap.front.xml b/kdoctools/docbook/xsl/params/column.gap.front.xml new file mode 100644 index 000000000..9a7f19d53 --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.gap.front.xml @@ -0,0 +1,23 @@ +<refentry id="column.gap.front"> +<refmeta> +<refentrytitle>column.gap.front</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.front</refname> +<refpurpose>Gap between columns in the front matter</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.gap.front.frag'> +<xsl:param name="column.gap.front" select="'12pt'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the gap between columns in front matter (if +<parameter>column.count.front</parameter> is greater than one).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.gap.index.xml b/kdoctools/docbook/xsl/params/column.gap.index.xml new file mode 100644 index 000000000..f21221e85 --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.gap.index.xml @@ -0,0 +1,23 @@ +<refentry id="column.gap.index"> +<refmeta> +<refentrytitle>column.gap.index</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.index</refname> +<refpurpose>Gap between columns in the index</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.gap.index.frag'> +<xsl:param name="column.gap.index" select="'12pt'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the gap between columns in indexes (if +<parameter>column.count.index</parameter> is greater than one).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.gap.lot.xml b/kdoctools/docbook/xsl/params/column.gap.lot.xml new file mode 100644 index 000000000..a620e7553 --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.gap.lot.xml @@ -0,0 +1,23 @@ +<refentry id="column.gap.lot"> +<refmeta> +<refentrytitle>column.gap.lot</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.lot</refname> +<refpurpose>Gap between columns on a 'List-of-Titles' page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.gap.lot.frag'> +<xsl:param name="column.gap.lot" select="'12pt'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the gap between columns on 'List-of-Titles' pages (if +<parameter>column.count.lot</parameter> is greater than one).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/column.gap.titlepage.xml b/kdoctools/docbook/xsl/params/column.gap.titlepage.xml new file mode 100644 index 000000000..f37902011 --- /dev/null +++ b/kdoctools/docbook/xsl/params/column.gap.titlepage.xml @@ -0,0 +1,24 @@ +<refentry id="column.gap.titlepage"> +<refmeta> +<refentrytitle>column.gap.titlepage</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>column.gap.titlepage</refname> +<refpurpose>Gap between columns on title pages</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='column.gap.titlepage.frag'> +<xsl:param name="column.gap.titlepage" select="'12pt'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the gap between columns on title pages (if +<parameter>column.count.titlepage</parameter> is greater than one).</para> + + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/compact.list.item.spacing.xml b/kdoctools/docbook/xsl/params/compact.list.item.spacing.xml new file mode 100644 index 000000000..43a1b6951 --- /dev/null +++ b/kdoctools/docbook/xsl/params/compact.list.item.spacing.xml @@ -0,0 +1,19 @@ +<refentry id="compact.list.item.spacing"> +<refnamediv> +<refname>compact.list.item.spacing</refname> +<refpurpose>What space do you want between list items (when spacing=compact)?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='compact.list.item.spacing.frag'><xsl:attribute-set name="compact.list.item.spacing"> + <xsl:attribute name="space-before.optimum">0em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0em</xsl:attribute> + <xsl:attribute name="space-before.maximum">0.2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsect1><title>Description</title> +<para>Specify what spacing you want between each list item when +<sgmltag class="attribute">spacing</sgmltag> is +<quote><literal>compact</literal></quote>.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/component.label.includes.part.label.xml b/kdoctools/docbook/xsl/params/component.label.includes.part.label.xml new file mode 100644 index 000000000..eef3eae10 --- /dev/null +++ b/kdoctools/docbook/xsl/params/component.label.includes.part.label.xml @@ -0,0 +1,33 @@ +<refentry id="component.label.includes.part.label"> +<refmeta> +<refentrytitle>component.label.includes.part.label</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>component.label.includes.part.label</refname> +<refpurpose>Do section labels include the component label?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='component.label.includes.part.label.frag'><xsl:param name="component.label.includes.part.label" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), labels for chapters, appendices, and other component +elements are prefixed with the label of the +part element that contains them. +Also, the labels for formal elements such as table and figure will +include the part label. +If there is no part element container, then no prefix is generated. +</para> +<para> +This feature is most useful when the +<literal>label.from.part</literal> parameter is turned on. +In that case, there would be more than one chapter +<quote>1</quote>, and the extra part label prefix will identify +each chapter unambiguously. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/component.title.properties.xml b/kdoctools/docbook/xsl/params/component.title.properties.xml new file mode 100644 index 000000000..f119212e8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/component.title.properties.xml @@ -0,0 +1,31 @@ +<refentry id="component.title.properties"> +<refmeta> +<refentrytitle>component.title.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>component.title.properties</refname> +<refpurpose>Properties for component titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='component.title.properties.frag'> +<xsl:attribute-set name="component.title.properties"> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="space-before.optimum"><xsl:value-of + select="concat($body.font.master, 'pt')"/></xsl:attribute> + <xsl:attribute name="space-before.minimum"><xsl:value-of + select="concat($body.font.master, 'pt * 0.8')"/></xsl:attribute> + <xsl:attribute name="space-before.maximum"><xsl:value-of + select="concat($body.font.master, 'pt * 1.2')"/></xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties common to all component titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/css.decoration.xml b/kdoctools/docbook/xsl/params/css.decoration.xml new file mode 100644 index 000000000..645e7a4dc --- /dev/null +++ b/kdoctools/docbook/xsl/params/css.decoration.xml @@ -0,0 +1,28 @@ +<refentry id="css.decoration"> +<refmeta> +<refentrytitle>css.decoration</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>css.decoration</refname> +<refpurpose>Enable CSS decoration of elements</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='css.decoration.frag'> +<xsl:param name="css.decoration" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para> +If <literal>css.decoration</literal> is turned on, then HTML elements +produced by the +stylesheet may be decorated with STYLE attributes. For example, the +LI tags produced for list items may include a fragment of CSS in the +STYLE attribute which sets the CSS property "list-style-type". +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/current.docid.xml b/kdoctools/docbook/xsl/params/current.docid.xml new file mode 100644 index 000000000..86593e134 --- /dev/null +++ b/kdoctools/docbook/xsl/params/current.docid.xml @@ -0,0 +1,21 @@ +<refentry id="current.docid"> +<refmeta> +<refentrytitle>current.docid</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>current.docid</refname> +<refpurpose>targetdoc identifier for the document being +processed</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment id="current.docid.frag"> +<xsl:param name="current.docid" select="''"/> </src:fragment> +</refsynopsisdiv> +<refsect1> +<title>Description</title> +<para>When olinks between documents are resolved for HTML output, the stylesheet can compute the relative path between the current document and the target document. The stylesheet needs to know the <literal>targetdoc</literal> identifiers for both documents, as they appear in the <parameter>target.database.document</parameter> database file. This parameter passes to the stylesheet +the targetdoc identifier of the current document, since that +identifier does not appear in the document itself. </para> +<para>This parameter can also be used for print output. If an olink's <literal>targetdoc</literal> id differs from the <literal>current.docid</literal>, then the stylesheet can append the target document's title to the generated olink text. That identifies to the reader that the link is to a different document, not the current document. See also <parameter>olink.doctitle</parameter> to enable that feature.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/default.float.class.xml b/kdoctools/docbook/xsl/params/default.float.class.xml new file mode 100644 index 000000000..fc66a2961 --- /dev/null +++ b/kdoctools/docbook/xsl/params/default.float.class.xml @@ -0,0 +1,22 @@ +<refentry id="default.float.class"> +<refmeta> +<refentrytitle>default.float.class</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.float.class</refname> +<refpurpose>Specifies the default float class</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='default.float.class.frag'> +<xsl:param name="default.float.class" select="'before'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/default.image.width.xml b/kdoctools/docbook/xsl/params/default.image.width.xml new file mode 100644 index 000000000..edda404cc --- /dev/null +++ b/kdoctools/docbook/xsl/params/default.image.width.xml @@ -0,0 +1,26 @@ +<refentry id="default.image.width"> +<refmeta> +<refentrytitle>default.image.width</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.image.width</refname> +<refpurpose>The default width of images</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='default.image.width.frag'> +<xsl:param name="default.image.width" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If specified, this value will be used for the +<sgmltag class="attribute">width</sgmltag> attribute on +images that do not specify any +<ulink url="http://docbook.org/tdg/en/html/imagedata.html#viewport.area">viewport +dimensions</ulink>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/default.table.width.xml b/kdoctools/docbook/xsl/params/default.table.width.xml new file mode 100644 index 000000000..f908e3edb --- /dev/null +++ b/kdoctools/docbook/xsl/params/default.table.width.xml @@ -0,0 +1,22 @@ +<refentry id="default.table.width"> +<refmeta> +<refentrytitle>default.table.width</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.table.width</refname> +<refpurpose>The default width of tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='default.table.width.frag'><xsl:param name="default.table.width" select="''"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If specified, this value will be used for the WIDTH attribute on +tables that do not specify an alternate width (with the dbhtml processing +instruction).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/default.units.xml b/kdoctools/docbook/xsl/params/default.units.xml new file mode 100644 index 000000000..16e74a109 --- /dev/null +++ b/kdoctools/docbook/xsl/params/default.units.xml @@ -0,0 +1,30 @@ +<refentry id="default.units"> +<refmeta> +<refentrytitle>default.units</refentrytitle> +<refmiscinfo role="type">list</refmiscinfo> +<refmiscinfo role="value">cm</refmiscinfo> +<refmiscinfo role="value">mm</refmiscinfo> +<refmiscinfo role="value">in</refmiscinfo> +<refmiscinfo role="value">pt</refmiscinfo> +<refmiscinfo role="value">pc</refmiscinfo> +<refmiscinfo role="value">px</refmiscinfo> +<refmiscinfo role="value">em</refmiscinfo> +</refmeta> +<refnamediv> +<refname>default.units</refname> +<refpurpose>Default units for an unqualified dimension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='default.units.frag'><xsl:param name="default.units" select="'pt'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If an unqualified dimension is encountered (for example, in a +graphic width), the <parameter>default-units</parameter> will be used for the +units. Unqualified dimensions are not allowed in XSL Formatting Objects. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/dingbat.font.family.xml b/kdoctools/docbook/xsl/params/dingbat.font.family.xml new file mode 100644 index 000000000..3136ae9e0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/dingbat.font.family.xml @@ -0,0 +1,24 @@ +<refentry id="dingbat.font.family"> +<refmeta> +<refentrytitle>dingbat.font.family</refentrytitle> + +</refmeta> +<refnamediv> +<refname>dingbat.font.family</refname> +<refpurpose>The font family for copyright, quotes, and other symbols</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='dingbat.font.family.frag'> +<xsl:param name="dingbat.font.family" select="'serif'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The dingbat font family is used for dingbats. If it is defined +as the empty string, no font change is effected around dingbats. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/double.sided.xml b/kdoctools/docbook/xsl/params/double.sided.xml new file mode 100644 index 000000000..3c676b98b --- /dev/null +++ b/kdoctools/docbook/xsl/params/double.sided.xml @@ -0,0 +1,26 @@ +<refentry id="double.sided"> +<refmeta> +<refentrytitle>double.sided</refentrytitle> + +</refmeta> +<refnamediv> +<refname>double.sided</refname> +<refpurpose>Is the document to be printed double sided?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='double.sided.frag'> +<xsl:param name="double.sided" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Double-sided documents are printed with a slightly wider margin +on the binding edge of the page. +</para> +<para>FIXME: The current set of parameters does not take writing direction +into account.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/draft.mode.xml b/kdoctools/docbook/xsl/params/draft.mode.xml new file mode 100644 index 000000000..542efa0dd --- /dev/null +++ b/kdoctools/docbook/xsl/params/draft.mode.xml @@ -0,0 +1,28 @@ +<refentry id="draft.mode"> +<refmeta> +<refentrytitle>draft.mode</refentrytitle> +<refmiscinfo role="type">list</refmiscinfo> +</refmeta> +<refnamediv> +<refname>draft.mode</refname> +<refpurpose>Select draft mode</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='draft.mode.frag'> +<xsl:param name="draft.mode" select="'maybe'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Selects draft mode. If <parameter>draft.mode</parameter> is +<quote><literal>yes</literal></quote>, the entire document will be treated +as a draft. If it is <quote><literal>no</literal></quote>, the entire document +will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>, +individual sections will be treated as draft or final independently, depending +on how their <sgmltag class="attribute">status</sgmltag> attribute is set. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/draft.watermark.image.xml b/kdoctools/docbook/xsl/params/draft.watermark.image.xml new file mode 100644 index 000000000..1f5aa8946 --- /dev/null +++ b/kdoctools/docbook/xsl/params/draft.watermark.image.xml @@ -0,0 +1,22 @@ +<refentry id="draft.watermark.image"> +<refmeta> +<refentrytitle>draft.watermark.image</refentrytitle> +<refmiscinfo role="type">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>draft.watermark.image</refname> +<refpurpose>The URI of the image to be used for draft watermarks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='draft.watermark.image.frag'> +<xsl:param name="draft.watermark.image" select="'http://docbook.sourceforge.net/release/images/draft.png'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The image to be used for draft watermarks.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/ebnf.assignment.xml b/kdoctools/docbook/xsl/params/ebnf.assignment.xml new file mode 100644 index 000000000..516a9cc44 --- /dev/null +++ b/kdoctools/docbook/xsl/params/ebnf.assignment.xml @@ -0,0 +1,35 @@ +<refentry id="ebnf.assignment"> +<refmeta> +<refentrytitle>ebnf.assignment</refentrytitle> +<refmiscinfo role="type">rtf</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.assignment</refname> +<refpurpose>The EBNF production assignment operator</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='ebnf.assignment.frag'> +<xsl:param condition="html" name="ebnf.assignment"> +<code>::=</code> +</xsl:param> +<xsl:param condition="fo" name="ebnf.assignment" + xmlns:fo="http://www.w3.org/1999/XSL/Format"> + <fo:inline font-family="{$monospace.font.family}"> + <xsl:text>::=</xsl:text> + </fo:inline> +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>ebnf.assignment</parameter> parameter determines what +text is used to show <quote>assignment</quote> in <sgmltag>production</sgmltag>s +in <sgmltag>productionset</sgmltag>s.</para> + +<para>While <quote><literal>::=</literal></quote> is common, so are several +other operators.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/ebnf.statement.terminator.xml b/kdoctools/docbook/xsl/params/ebnf.statement.terminator.xml new file mode 100644 index 000000000..b3a8d8615 --- /dev/null +++ b/kdoctools/docbook/xsl/params/ebnf.statement.terminator.xml @@ -0,0 +1,27 @@ +<refentry id="ebnf.statement.terminator"> +<refmeta> +<refentrytitle>ebnf.statement.terminator</refentrytitle> +<refmiscinfo role="type">rtf</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.statement.terminator</refname> +<refpurpose>Punctuation that ends an EBNF statement.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='ebnf.statement.terminator.frag'> +<xsl:param condition="html" name="ebnf.statement.terminator"/> +<xsl:param condition="fo" name="ebnf.statement.terminator"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what +text is used to terminate each <sgmltag>production</sgmltag> +in <sgmltag>productionset</sgmltag>.</para> + +<para>Some notations end each statement with a period.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/ebnf.table.bgcolor.xml b/kdoctools/docbook/xsl/params/ebnf.table.bgcolor.xml new file mode 100644 index 000000000..82c89967c --- /dev/null +++ b/kdoctools/docbook/xsl/params/ebnf.table.bgcolor.xml @@ -0,0 +1,23 @@ +<refentry id="ebnf.table.bgcolor"> +<refmeta> +<refentrytitle>ebnf.table.bgcolor</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.table.bgcolor</refname> +<refpurpose>Background color for EBNF tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='ebnf.table.bgcolor.frag'><xsl:param name="ebnf.table.bgcolor" select="'#F5DCB3'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Sets the background color for EBNF tables. No <sgmltag>bgcolor</sgmltag> +attribute is output if <varname>ebnf.table.bgcolor</varname> is set to +the null string. The default value matches the value used in recent +online versions of the W3C's XML Spec productions.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/ebnf.table.border.xml b/kdoctools/docbook/xsl/params/ebnf.table.border.xml new file mode 100644 index 000000000..80916c25a --- /dev/null +++ b/kdoctools/docbook/xsl/params/ebnf.table.border.xml @@ -0,0 +1,21 @@ +<refentry id="ebnf.table.border"> +<refmeta> +<refentrytitle>ebnf.table.border</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>ebnf.table.border</refname> +<refpurpose>Selects border on EBNF tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='ebnf.table.border.frag'><xsl:param name="ebnf.table.border" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Selects the border on EBNF tables. If non-zero, the tables have +borders, otherwise they don't.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/eclipse.autolabel.xml b/kdoctools/docbook/xsl/params/eclipse.autolabel.xml new file mode 100644 index 000000000..480aa3778 --- /dev/null +++ b/kdoctools/docbook/xsl/params/eclipse.autolabel.xml @@ -0,0 +1,23 @@ +<refentry id="eclipse.autolabel"> +<refmeta> +<refentrytitle>eclipse.autolabel</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.autolabel</refname> +<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='eclipse.autolabel.frag'> +<xsl:param name="eclipse.autolabel" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want to include chapter and section numbers into ToC in +the left panel, set this parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/eclipse.plugin.id.xml b/kdoctools/docbook/xsl/params/eclipse.plugin.id.xml new file mode 100644 index 000000000..11718d748 --- /dev/null +++ b/kdoctools/docbook/xsl/params/eclipse.plugin.id.xml @@ -0,0 +1,23 @@ +<refentry id="eclipse.plugin.id"> +<refmeta> +<refentrytitle>eclipse.plugin.id</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.plugin.id</refname> +<refpurpose>Eclipse Help plugin id</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='eclipse.plugin.id.frag'> +<xsl:param name="eclipse.plugin.id">com.example.help</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Eclipse Help plugin id. You should change this id to something +unique for each help.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/eclipse.plugin.name.xml b/kdoctools/docbook/xsl/params/eclipse.plugin.name.xml new file mode 100644 index 000000000..f7b10a89b --- /dev/null +++ b/kdoctools/docbook/xsl/params/eclipse.plugin.name.xml @@ -0,0 +1,22 @@ +<refentry id="eclipse.plugin.name"> +<refmeta> +<refentrytitle>eclipse.plugin.name</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.plugin.name</refname> +<refpurpose>Eclipse Help plugin name</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='eclipse.plugin.name.frag'> +<xsl:param name="eclipse.plugin.name">DocBook Online Help Sample</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Eclipse Help plugin name.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/eclipse.plugin.provider.xml b/kdoctools/docbook/xsl/params/eclipse.plugin.provider.xml new file mode 100644 index 000000000..b3156da65 --- /dev/null +++ b/kdoctools/docbook/xsl/params/eclipse.plugin.provider.xml @@ -0,0 +1,22 @@ +<refentry id="eclipse.plugin.provider"> +<refmeta> +<refentrytitle>eclipse.plugin.provider</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>eclipse.plugin.provider</refname> +<refpurpose>Eclipse Help plugin provider name</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='eclipse.plugin.provider.frag'> +<xsl:param name="eclipse.plugin.provider">Example provider</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Eclipse Help plugin provider name.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/emphasis.propagates.style.xml b/kdoctools/docbook/xsl/params/emphasis.propagates.style.xml new file mode 100644 index 000000000..5a2c70ced --- /dev/null +++ b/kdoctools/docbook/xsl/params/emphasis.propagates.style.xml @@ -0,0 +1,24 @@ +<refentry id="emphasis.propagates.style"> +<refmeta> +<refentrytitle>emphasis.propagates.style</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>emphasis.propagates.style</refname> +<refpurpose>Pass emphasis role attribute through to HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='emphasis.propagates.style.frag'> +<xsl:param name="emphasis.propagates.style" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, the role attribute of <sgmltag>emphasis</sgmltag> elements +will be passed through to the HTML as a class attribute on a +<sgmltag>span</sgmltag> that surrounds the emphasis.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/entry.propagates.style.xml b/kdoctools/docbook/xsl/params/entry.propagates.style.xml new file mode 100644 index 000000000..02853c620 --- /dev/null +++ b/kdoctools/docbook/xsl/params/entry.propagates.style.xml @@ -0,0 +1,25 @@ +<refentry id="entry.propagates.style"> +<refmeta> +<refentrytitle>entry.propagates.style</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>entry.propagates.style</refname> +<refpurpose>Pass entry role attribute through to HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='entry.propagates.style.frag'> +<xsl:param name="entry.propagates.style" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, the role attribute of <sgmltag>entry</sgmltag> elements +will be passed through to the HTML as a class attribute on the +<sgmltag>td</sgmltag> or <sgmltag>th</sgmltag> generated for the table +cell.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/equation.properties.xml b/kdoctools/docbook/xsl/params/equation.properties.xml new file mode 100644 index 000000000..8dc70ddc7 --- /dev/null +++ b/kdoctools/docbook/xsl/params/equation.properties.xml @@ -0,0 +1,18 @@ +<refentry id="equation.properties"> +<refnamediv> +<refname>equation.properties</refname> +<refpurpose>Properties associated with a equation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='equation.properties.frag'> +<xsl:attribute-set name="equation.properties" use-attribute-sets="formal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for equations.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/example.properties.xml b/kdoctools/docbook/xsl/params/example.properties.xml new file mode 100644 index 000000000..116c58d90 --- /dev/null +++ b/kdoctools/docbook/xsl/params/example.properties.xml @@ -0,0 +1,18 @@ +<refentry id="example.properties"> +<refnamediv> +<refname>example.properties</refname> +<refpurpose>Properties associated with a example</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='example.properties.frag'> +<xsl:attribute-set name="example.properties" use-attribute-sets="formal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for examples.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/figure.properties.xml b/kdoctools/docbook/xsl/params/figure.properties.xml new file mode 100644 index 000000000..e232e123c --- /dev/null +++ b/kdoctools/docbook/xsl/params/figure.properties.xml @@ -0,0 +1,18 @@ +<refentry id="figure.properties"> +<refnamediv> +<refname>figure.properties</refname> +<refpurpose>Properties associated with a figure</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='figure.properties.frag'> +<xsl:attribute-set name="figure.properties" use-attribute-sets="formal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for figures.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/firstterm.only.link.xml b/kdoctools/docbook/xsl/params/firstterm.only.link.xml new file mode 100644 index 000000000..eb53b36d9 --- /dev/null +++ b/kdoctools/docbook/xsl/params/firstterm.only.link.xml @@ -0,0 +1,24 @@ +<refentry id="firstterm.only.link"> +<refmeta> +<refentrytitle>firstterm.only.link</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>firstterm.only.link</refname> +<refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='firstterm.only.link.frag'> +<xsl:param name="firstterm.only.link" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, only <sgmltag>firstterm</sgmltag>s will be automatically linked +to the glossary. If glossary linking is not enabled, this parameter +has no effect.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/footer.column.widths.xml b/kdoctools/docbook/xsl/params/footer.column.widths.xml new file mode 100644 index 000000000..63c647886 --- /dev/null +++ b/kdoctools/docbook/xsl/params/footer.column.widths.xml @@ -0,0 +1,69 @@ +<refentry id="footer.column.widths"> +<refmeta> +<refentrytitle>footer.column.widths</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footer.column.widths</refname> +<refpurpose>Specify relative widths of footer areas</refpurpose> +</refnamediv> + +<refsynopsisdiv><src:fragment id='footer.column.widths.frag'> +<xsl:param name="footer.column.widths" select="'1 1 1'"/> +</src:fragment></refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Page footers in print output use a three column table +to position text at the left, center, and right side of +the footer on the page. +This parameter lets you specify the relative sizes of the +three columns. The default value is +"1 1 1".</para> + +<para>The parameter value must be three numbers, separated +by white space. The first number represents the relative +width of the left footer for +single-sided output, or the inside footer for +double-sided output. The second number is the relative +width of the center footer. The third number is the +relative width of the right footer for +single-sided output, or the outside footer for +double-sided output. +</para> + +<para>The numbers are used to specify the column widths +for the table that makes up the footer area. +In the FO output, this looks like: +</para> + +<programlisting> +<fo:table-column column-number="1" + column-width="proportional-column-width(1)"/> +</programlisting> + +<para> +The <literal>proportional-column-width()</literal> +function computes a column width by dividing its +argument by the total of the arguments for all the columns, and +then multiplying the result by the width of the whole table +(assuming all the column specs use the function). +Its argument can be any positive integer or floating point number. +Zero is an acceptable value, although some FO processors +may warn about it, in which case using a very small number might +be more satisfactory. +</para> + +<para>For example, the value "1 2 1" means the center +footer should have twice the width of the other areas. +A value of "0 0 1" means the entire footer area +is reserved for the right (or outside) footer text. +Note that to keep the center area centered on +the page, the left and right values must be +the same. A specification like "1 2 3" means the +center area is no longer centered on the page +since the right area is three times the width of the left area. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/footer.content.properties.xml b/kdoctools/docbook/xsl/params/footer.content.properties.xml new file mode 100644 index 000000000..d31c4ed9b --- /dev/null +++ b/kdoctools/docbook/xsl/params/footer.content.properties.xml @@ -0,0 +1,29 @@ +<refentry id="footer.content.properties"> +<refmeta> +<refentrytitle>footer.content.properties</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>footer.content.properties</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='footer.content.properties.frag'> +<xsl:attribute-set name="footer.content.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$body.fontset"/> + </xsl:attribute> + <xsl:attribute name="margin-left"> + <xsl:value-of select="$title.margin.left"/> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Properties of page footer content.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/footer.rule.xml b/kdoctools/docbook/xsl/params/footer.rule.xml new file mode 100644 index 000000000..f34b9ac10 --- /dev/null +++ b/kdoctools/docbook/xsl/params/footer.rule.xml @@ -0,0 +1,22 @@ +<refentry id="footer.rule"> +<refmeta> +<refentrytitle>footer.rule</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footer.rule</refname> +<refpurpose>Rule over footers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='footer.rule.frag'> +<xsl:param name="footer.rule" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, a rule will be drawn above the page footers.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/footers.on.blank.pages.xml b/kdoctools/docbook/xsl/params/footers.on.blank.pages.xml new file mode 100644 index 000000000..fbf2ff8a3 --- /dev/null +++ b/kdoctools/docbook/xsl/params/footers.on.blank.pages.xml @@ -0,0 +1,22 @@ +<refentry id="footers.on.blank.pages"> +<refmeta> +<refentrytitle>footers.on.blank.pages</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footers.on.blank.pages</refname> +<refpurpose>Put footers on blank pages?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='footers.on.blank.pages.frag'> +<xsl:param name="footers.on.blank.pages" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, footers will be placed on blank pages.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/footnote.font.size.xml b/kdoctools/docbook/xsl/params/footnote.font.size.xml new file mode 100644 index 000000000..9ab2a4153 --- /dev/null +++ b/kdoctools/docbook/xsl/params/footnote.font.size.xml @@ -0,0 +1,23 @@ +<refentry id="footnote.font.size"> +<refmeta> +<refentrytitle>footnote.font.size</refentrytitle> + +</refmeta> +<refnamediv> +<refname>footnote.font.size</refname> +<refpurpose>The font size for footnotes</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='footnote.font.size.frag'><xsl:param name="footnote.font.size"> + <xsl:value-of select="$body.font.master * 0.8"/><xsl:text>pt</xsl:text> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The footnote font size is used for...footnotes! +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/footnote.number.format.xml b/kdoctools/docbook/xsl/params/footnote.number.format.xml new file mode 100644 index 000000000..672cfec52 --- /dev/null +++ b/kdoctools/docbook/xsl/params/footnote.number.format.xml @@ -0,0 +1,23 @@ +<refentry id="footnote.number.format"> +<refmeta> +<refentrytitle>footnote.number.format</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>footnote.number.format</refname> +<refpurpose>Identifies the format used for footnote numbers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='footnote.number.format.frag'> +<xsl:param name="footnote.number.format" select="'1'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>footnote.number.format</parameter> specifies the format +to use for footnote numeration (1, i, I, a, or A).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/footnote.number.symbols.xml b/kdoctools/docbook/xsl/params/footnote.number.symbols.xml new file mode 100644 index 000000000..f02351177 --- /dev/null +++ b/kdoctools/docbook/xsl/params/footnote.number.symbols.xml @@ -0,0 +1,34 @@ +<refentry id="footnote.number.symbols"> +<refmeta> +<refentrytitle>footnote.number.symbols</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>footnote.number.symbols</refname> +<refpurpose>Special characters to use as footnote markers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='footnote.number.symbols.frag'> +<xsl:param name="footnote.number.symbols" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>footnote.number.symbols</parameter> is not the empty string, +footnotes will use the characters it contains as footnote symbols. For example, +<quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify +footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>, +<quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes +than symbols, the stylesheets will fall back to numbered footnotes using +<parameter>footnote.number.format</parameter>.</para> + +<para>The use of symbols for footnotes depends on the ability of your +processor (or browser) to render the symbols you select. Not all systems are +capable of displaying the full range of Unicode characters. If the quoted characters +in the preceding paragraph are not displayed properly, that's a good indicator +that you may have trouble using those symbols for footnotes.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/footnote.sep.leader.properties.xml b/kdoctools/docbook/xsl/params/footnote.sep.leader.properties.xml new file mode 100644 index 000000000..10ade858e --- /dev/null +++ b/kdoctools/docbook/xsl/params/footnote.sep.leader.properties.xml @@ -0,0 +1,30 @@ +<refentry id="footnote.sep.leader.properties"> +<refnamediv> +<refname>footnote.sep.leader.properties</refname> +<refpurpose>Properties associated with a procedure</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='footnote.sep.leader.properties.frag'> +<xsl:attribute-set name="footnote.sep.leader.properties"> + <xsl:attribute name="color">black</xsl:attribute> + <xsl:attribute name="leader-pattern">rule</xsl:attribute> + <xsl:attribute name="leader-length">1in</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for the rule line that separates the +footnotes from the body text. +These are properties applied to the fo:leader used as +the separator. +</para> +<para>If you want to do more than just set properties on +the leader element, then you can customize the template +named <literal>footnote.separator</literal> in +<filename>fo/pagesetup.xsl</filename>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/fop.extensions.xml b/kdoctools/docbook/xsl/params/fop.extensions.xml new file mode 100644 index 000000000..42f567763 --- /dev/null +++ b/kdoctools/docbook/xsl/params/fop.extensions.xml @@ -0,0 +1,25 @@ +<refentry id="fop.extensions"> +<refmeta> +<refentrytitle>fop.extensions</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>fop.extensions</refname> +<refpurpose>Enable FOP extensions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='fop.extensions.frag'><xsl:param name="fop.extensions" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, +<ulink url="http://xml.apache.org/fop/">FOP</ulink> +extensions will be used. At present, this consists of PDF bookmarks. +</para> + +<para>This parameter can also affect which graphics file formats +are supported</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/formal.object.properties.xml b/kdoctools/docbook/xsl/params/formal.object.properties.xml new file mode 100644 index 000000000..d8b7c4217 --- /dev/null +++ b/kdoctools/docbook/xsl/params/formal.object.properties.xml @@ -0,0 +1,27 @@ +<refentry id="formal.object.properties"> +<refnamediv> +<refname>formal.object.properties</refname> +<refpurpose>Properties associated with a formal object such as a figure, or other component that has a title</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='formal.object.properties.frag'> +<xsl:attribute-set name="formal.object.properties"> + <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.maximum">2em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.maximum">2em</xsl:attribute> + <xsl:attribute name="keep-together.within-column">always</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for formal objects in docbook. Specify the spacing +before and after the object.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/formal.procedures.xml b/kdoctools/docbook/xsl/params/formal.procedures.xml new file mode 100644 index 000000000..04286747f --- /dev/null +++ b/kdoctools/docbook/xsl/params/formal.procedures.xml @@ -0,0 +1,23 @@ +<refentry id="formal.procedures"> +<refmeta> +<refentrytitle>formal.procedures</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>formal.procedures</refname> +<refpurpose>Selects formal or informal procedures</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='formal.procedures.frag'> +<xsl:param name="formal.procedures" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Formal procedures are numbered and always have a title. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/formal.title.placement.xml b/kdoctools/docbook/xsl/params/formal.title.placement.xml new file mode 100644 index 000000000..4786894b9 --- /dev/null +++ b/kdoctools/docbook/xsl/params/formal.title.placement.xml @@ -0,0 +1,36 @@ +<refentry id="formal.title.placement"> +<refmeta> +<refentrytitle>formal.title.placement</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>formal.title.placement</refname> +<refpurpose>Specifies where formal object titles should occur</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='formal.title.placement.frag'> +<xsl:param name="formal.title.placement"> +figure before +example before +equation before +table before +procedure before +task before +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies where formal object titles should occur. For each formal object +type (<sgmltag>figure</sgmltag>, +<sgmltag>example</sgmltag>, +<sgmltag>equation</sgmltag>, +<sgmltag>table</sgmltag>, and <sgmltag>procedure</sgmltag>) +you can specify either the keyword +<quote><literal>before</literal></quote> or +<quote><literal>after</literal></quote>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/formal.title.properties.xml b/kdoctools/docbook/xsl/params/formal.title.properties.xml new file mode 100644 index 000000000..25edc7207 --- /dev/null +++ b/kdoctools/docbook/xsl/params/formal.title.properties.xml @@ -0,0 +1,26 @@ +<refentry id="formal.title.properties"> +<refnamediv> +<refname>formal.title.properties</refname> +<refpurpose>Style the title element of formal object such as a figure.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='formal.title.properties.frag'> +<xsl:attribute-set name="formal.title.properties" + use-attribute-sets="normal.para.spacing"> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.2"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute> + <xsl:attribute name="space-after.optimum">0.6em</xsl:attribute> + <xsl:attribute name="space-after.maximum">0.8em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsect1><title>Description</title> +<para>Specify how the title should be styled. Specify the font size and weight of the title of the formal object.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/funcsynopsis.decoration.xml b/kdoctools/docbook/xsl/params/funcsynopsis.decoration.xml new file mode 100644 index 000000000..6aabbdfc5 --- /dev/null +++ b/kdoctools/docbook/xsl/params/funcsynopsis.decoration.xml @@ -0,0 +1,23 @@ +<refentry id="funcsynopsis.decoration"> +<refmeta> +<refentrytitle>funcsynopsis.decoration</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>funcsynopsis.decoration</refname> +<refpurpose>Decorate elements of a FuncSynopsis?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='funcsynopsis.decoration.frag'><xsl:param name="funcsynopsis.decoration" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), elements of the FuncSynopsis will be decorated (e.g. bold or +italic). The decoration is controlled by functions that can be redefined +in a customization layer. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/funcsynopsis.style.xml b/kdoctools/docbook/xsl/params/funcsynopsis.style.xml new file mode 100644 index 000000000..cb21392a9 --- /dev/null +++ b/kdoctools/docbook/xsl/params/funcsynopsis.style.xml @@ -0,0 +1,26 @@ +<refentry id="funcsynopsis.style"> +<refmeta> +<refentrytitle>funcsynopsis.style</refentrytitle> +<refmiscinfo role="type">list</refmiscinfo> +<refmiscinfo role="value">ansi</refmiscinfo> +<refmiscinfo role="value">kr</refmiscinfo> +</refmeta> +<refnamediv> +<refname>funcsynopsis.style</refname> +<refpurpose>What style of 'FuncSynopsis' should be generated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='funcsynopsis.style.frag'><xsl:param name="funcsynopsis.style">kr</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <varname>funcsynopsis.style</varname> is <literal>ansi</literal>, +ANSI-style function synopses are generated for a +<sgmltag>funcsynopsis</sgmltag>, otherwise K&R-style +function synopses are generated. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/funcsynopsis.tabular.threshold.xml b/kdoctools/docbook/xsl/params/funcsynopsis.tabular.threshold.xml new file mode 100644 index 000000000..9760b9d30 --- /dev/null +++ b/kdoctools/docbook/xsl/params/funcsynopsis.tabular.threshold.xml @@ -0,0 +1,24 @@ +<refentry id="funcsynopsis.tabular.threshold"> +<refmeta> +<refentrytitle>funcsynopsis.tabular.threshold</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>funcsynopsis.tabular.threshold</refname> +<refpurpose>Width beyond which a tabular presentation will be used</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='funcsynopsis.tabular.threshold.frag'> +<xsl:param name="funcsynopsis.tabular.threshold" select="40"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>funcsynopsis.tabular.threshold</parameter> is greater than +zero then if a <sgmltag>funcprototype</sgmltag> is wider than the threshold +value, it will be presented in a table.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/function.parens.xml b/kdoctools/docbook/xsl/params/function.parens.xml new file mode 100644 index 000000000..4856045b1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/function.parens.xml @@ -0,0 +1,23 @@ +<refentry id="function.parens"> +<refmeta> +<refentrytitle>function.parens</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>function.parens</refname> +<refpurpose>Generate parens after a function?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='function.parens.frag'><xsl:param name="function.parens">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If not 0, the formatting of +a <sgmltag class="starttag">function</sgmltag> element will include +generated parenthesis. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/generate.id.attributes.xml b/kdoctools/docbook/xsl/params/generate.id.attributes.xml new file mode 100644 index 000000000..6c638dca7 --- /dev/null +++ b/kdoctools/docbook/xsl/params/generate.id.attributes.xml @@ -0,0 +1,54 @@ +<refentry id="generate.id.attributes"> +<refmeta> +<refentrytitle>generate.id.attributes</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.id.attributes</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='generate.id.attributes.frag'> +<xsl:param name="generate.id.attributes" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, the HTML stylesheet will generate ID attributes on +containers. For example, the markup:</para> + +<screen><![CDATA[<section id="foo"><title>Some Title</title> +<para>Some para.</para> +</section>]]></screen> + +<para>might produce:</para> + +<screen><![CDATA[<div class="section" id="foo"> +<h2>Some Title</h2> +<p>Some para.</p> +</div>]]></screen> + +<para>The alternative is to generate anchors:</para> + +<screen><![CDATA[<div class="section"> +<h2><a name="foo"></a>Some Title</h2> +<p>Some para.</p> +</div>]]></screen> + +<para>Because the <sgmltag class="attribute">name</sgmltag> attribute of +the <sgmltag>a</sgmltag> element and the <sgmltag class="attribute">id</sgmltag> +attribute of other tags are both of type <quote>ID</quote>, producing both +generates invalid documents.</para> + +<para>As of version 1.50, you can use this switch to control which type of +identifier is generated. For backwards-compatibility, generating +<sgmltag>a</sgmltag> anchors is preferred.</para> + +<para>Note: at present, this switch is incompletely implemented. +Disabling ID attributes will suppress them, but enabling ID attributes +will not suppress the anchors.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/generate.index.xml b/kdoctools/docbook/xsl/params/generate.index.xml new file mode 100644 index 000000000..0dc205879 --- /dev/null +++ b/kdoctools/docbook/xsl/params/generate.index.xml @@ -0,0 +1,20 @@ +<refentry id="generate.index"> +<refmeta> +<refentrytitle>generate.index</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.index</refname> +<refpurpose>Do you want an index?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='generate.index.frag'><xsl:param name="generate.index" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specify if an index should be generated. </para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/generate.legalnotice.link.xml b/kdoctools/docbook/xsl/params/generate.legalnotice.link.xml new file mode 100644 index 000000000..5b51cbf46 --- /dev/null +++ b/kdoctools/docbook/xsl/params/generate.legalnotice.link.xml @@ -0,0 +1,20 @@ +<refentry id="generate.legalnotice.link"> +<refmeta> +<refentrytitle>generate.legalnotice.link</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.legalnotice.link</refname> +<refpurpose>TBD</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='generate.legalnotice.link.frag'><xsl:param name="generate.legalnotice.link" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>TBD</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/generate.manifest.xml b/kdoctools/docbook/xsl/params/generate.manifest.xml new file mode 100644 index 000000000..44344afcc --- /dev/null +++ b/kdoctools/docbook/xsl/params/generate.manifest.xml @@ -0,0 +1,23 @@ +<refentry id="generate.manifest"> + <refmeta> + <refentrytitle>generate.manifest</refentrytitle> + <refmiscinfo role="type">boolean</refmiscinfo> + </refmeta> + <refnamediv> + <refname>generate.manifest</refname> + <refpurpose>Generate a manifest file?</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <src:fragment id='generate.manifest.frag' + ><xsl:param name="generate.manifest" select="0"/></src:fragment> + </refsynopsisdiv> + + <refsect1><title>Description</title> + + <para>If non-zero, a list of HTML files generated by the + stylesheet transformation is written to the file named by + the <parameter>manifest</parameter> parameter.</para> + + </refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/generate.meta.abstract.xml b/kdoctools/docbook/xsl/params/generate.meta.abstract.xml new file mode 100644 index 000000000..6cf689194 --- /dev/null +++ b/kdoctools/docbook/xsl/params/generate.meta.abstract.xml @@ -0,0 +1,23 @@ +<refentry id="generate.meta.abstract"> +<refmeta> +<refentrytitle>generate.meta.abstract</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.meta.abstract</refname> +<refpurpose>Generate HTML <sgmltag>META</sgmltag> element from <sgmltag>abstract</sgmltag>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='generate.meta.abstract.frag'> +<xsl:param name="generate.meta.abstract" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, document abstracts will be reproduced in the HTML +<sgmltag>HEAD</sgmltag> with <sgmltag class="starttag">meta name="description" content="..."</sgmltag>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/generate.section.toc.level.xml b/kdoctools/docbook/xsl/params/generate.section.toc.level.xml new file mode 100644 index 000000000..ba9bf294d --- /dev/null +++ b/kdoctools/docbook/xsl/params/generate.section.toc.level.xml @@ -0,0 +1,30 @@ +<refentry id="generate.section.toc.level"> +<refmeta> +<refentrytitle>generate.section.toc.level</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.section.toc.level</refname> +<refpurpose>Control depth of TOC generation in sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='generate.section.toc.level.frag'> +<xsl:param name="generate.section.toc.level" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>generate.section.toc.level</parameter> parameter +controls the depth of section in which TOCs will be generated. Note +that this is related to, but not the same as +<parameter>toc.section.depth</parameter>, which controls the depth to +which TOC entries will be generated in a given TOC.</para> +<para>If, for example, <parameter>generate.section.toc.level</parameter> +is <literal>3</literal>, TOCs will be generated in first, second, and third +level sections, but not in fourth level sections. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/generate.toc.xml b/kdoctools/docbook/xsl/params/generate.toc.xml new file mode 100644 index 000000000..aa8e3d590 --- /dev/null +++ b/kdoctools/docbook/xsl/params/generate.toc.xml @@ -0,0 +1,105 @@ +<refentry id="generate.toc"> +<refmeta> +<refentrytitle>generate.toc</refentrytitle> +<refmiscinfo role="type">table</refmiscinfo> +</refmeta> +<refnamediv> +<refname>generate.toc</refname> +<refpurpose>Control generation of ToCs and LoTs</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='generate.toc.frag'> +<xsl:param condition="html" name="generate.toc"> +appendix toc,title +article/appendix nop +article toc,title +book toc,title,figure,table,example,equation +chapter toc,title +part toc,title +preface toc,title +qandadiv toc +qandaset toc +reference toc,title +sect1 toc +sect2 toc +sect3 toc +sect4 toc +sect5 toc +section toc +set toc,title +</xsl:param> +<xsl:param condition="fo" name="generate.toc"> +/appendix toc,title +article/appendix nop +/article toc,title +book toc,title,figure,table,example,equation +/chapter toc,title +part toc,title +/preface toc,title +qandadiv toc +qandaset toc +reference toc,title +/sect1 toc +/sect2 toc +/sect3 toc +/sect4 toc +/sect5 toc +/section toc +set toc,title +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter has a structured value. It is a table of space-delimited +path/value pairs. Each path identifies some element in the source document +using a restricted subset of XPath (only the implicit child axis, no wildcards, +no predicates). Paths can be either relative or absolute.</para> + +<para>When processing a particular element, the stylesheets consult this table to +determine if a ToC (or LoT(s)) should be generated.</para> + +<para>For example, consider the entry:</para> + +<screen>book toc,figure</screen> + +<para>This indicates that whenever a <sgmltag>book</sgmltag> is formatted, a +Table Of Contents and a List of Figures should be generated. Similarly,</para> + +<screen>/chapter toc</screen> + +<para>indicates that whenever a document <emphasis>that has a root +of</emphasis> <sgmltag>chapter</sgmltag> is formatted, a Table of +Contents should be generated. The entry <literal>chapter</literal> would match +all chapters, but <literal>/chapter</literal> matches only <sgmltag>chapter</sgmltag> +document elements.</para> + +<para>Generally, the longest match wins. So, for example, if you want to distinguish +articles in books from articles in parts, you could use these two entries:</para> + +<screen>book/article toc,figure +part/article toc</screen> + +<para>Note that an article in a part can never match a <literal>book/article</literal>, +so if you want nothing to be generated for articles in parts, you can simply leave +that rule out.</para> + +<para>If you want to leave the rule in, to make it explicit that you're turning +something off, use the value <quote>nop</quote>. For example, the following +entry disables ToCs and LoTs for articles:</para> + +<screen>article nop</screen> + +<para>Do not simply leave the word <quote>article</quote> in the file +without a matching value. That'd be just begging the silly little +path/value parser to get confused.</para> + +<para>Section ToCs are further controlled by the +<parameter>generate.section.toc.level</parameter> parameter. +For a given section level to have a ToC, it must have both an entry in +<parameter>generate.toc</parameter> and be within the range enabled by +<parameter>generate.section.toc.level</parameter>.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/glossary.as.blocks.xml b/kdoctools/docbook/xsl/params/glossary.as.blocks.xml new file mode 100644 index 000000000..dd92f0563 --- /dev/null +++ b/kdoctools/docbook/xsl/params/glossary.as.blocks.xml @@ -0,0 +1,33 @@ +<refentry id="glossary.as.blocks"> +<refmeta> +<refentrytitle>glossary.as.blocks</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossary.as.blocks</refname> +<refpurpose>Present glossarys using blocks instead of lists?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='glossary.as.blocks.frag'> +<xsl:param name="glossary.as.blocks" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, <sgmltag>glossary</sgmltag>s will be formatted as +blocks.</para> + +<para>If you have long <sgmltag>glossterm</sgmltag>s, proper list +markup in the FO case may produce unattractive lists. By setting this +parameter, you can force the stylesheets to produce block markup +instead of proper lists.</para> + +<para>You can override this setting with a processing instruction as the +child of <sgmltag>glossary</sgmltag>: <sgmltag class="pi">dbfo +glossary-presentation="blocks"</sgmltag> or <sgmltag class="pi">dbfo +glossary-presentation="list"</sgmltag></para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/glossary.collection.xml b/kdoctools/docbook/xsl/params/glossary.collection.xml new file mode 100644 index 000000000..eb26556ce --- /dev/null +++ b/kdoctools/docbook/xsl/params/glossary.collection.xml @@ -0,0 +1,247 @@ +<refentry id="glossary.collection"> +<refmeta> +<refentrytitle>glossary.collection</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossary.collection</refname> +<refpurpose>Name of the glossary collection file</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='glossary.collection.frag'> +<xsl:param name="glossary.collection" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Glossaries maintained independently across a set of documents +are likely to become inconsistent unless considerable effort is +expended to keep them in sync. It makes much more sense, usually, to +store all of the glossary entries in a single place and simply +<quote>extract</quote> the ones you need in each document.</para> + +<para>That's the purpose of the +<parameter>glossary.collection</parameter> parameter. To setup a global +glossary <quote>database</quote>, follow these steps:</para> + +<refsect2><title>Setting Up the Glossary Database</title> + +<para>First, create a stand-alone glossary document that contains all of +the entries that you wish to reference. Make sure that each glossary +entry has an ID.</para> + +<para>Here's an example glossary:</para> + +<informalexample> +<programlisting><![CDATA[ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE glossary + PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<glossary> +<glossaryinfo> +<editor><firstname>Eric</firstname><surname>Raymond</surname></editor> +<title>Jargon File 4.2.3 (abridged)</title> +<releaseinfo>Just some test data</releaseinfo> +</glossaryinfo> + +<glossdiv><title>0</title> + +<glossentry> +<glossterm>0</glossterm> +<glossdef> +<para>Numeric zero, as opposed to the letter `O' (the 15th letter of +the English alphabet). In their unmodified forms they look a lot +alike, and various kluges invented to make them visually distinct have +compounded the confusion. If your zero is center-dotted and letter-O +is not, or if letter-O looks almost rectangular but zero looks more +like an American football stood on end (or the reverse), you're +probably looking at a modern character display (though the dotted zero +seems to have originated as an option on IBM 3270 controllers). If +your zero is slashed but letter-O is not, you're probably looking at +an old-style ASCII graphic set descended from the default typewheel on +the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter, +curse this arrangement). (Interestingly, the slashed zero long +predates computers; Florian Cajori's monumental "A History of +Mathematical Notations" notes that it was used in the twelfth and +thirteenth centuries.) If letter-O has a slash across it and the zero +does not, your display is tuned for a very old convention used at IBM +and a few other early mainframe makers (Scandinavians curse <emphasis>this</emphasis> +arrangement even more, because it means two of their letters collide). +Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed</emphasis> +slash. Old CDC computers rendered letter O as an unbroken oval and 0 +as an oval broken at upper right and lower left. And yet another +convention common on early line printers left zero unornamented but +added a tail or hook to the letter-O so that it resembled an inverted +Q or cursive capital letter-O (this was endorsed by a draft ANSI +standard for how to draw ASCII characters, but the final standard +changed the distinguisher to a tick-mark in the upper-left corner). +Are we sufficiently confused yet?</para> +</glossdef> +</glossentry> + +<glossentry> +<glossterm>1TBS</glossterm> +<glossdef> +<para role="accidence"> +<phrase role="pronounce"></phrase> +<phrase role="partsofspeach">n</phrase> +</para> +<para>The "One True Brace Style"</para> +<glossseealso>indent style</glossseealso> +</glossdef> +</glossentry> + +<!-- ... --> + +</glossdiv> + +<!-- ... --> + +</glossary>]]></programlisting> +</informalexample> + +</refsect2> + +<refsect2><title>Marking Up Glossary Terms</title> + +<para>That takes care of the glossary database, now you have to get the entries +into your document. Unlike bibliography entries, which can be empty, creating +<quote>placeholder</quote> glossary entries would be very tedious. So instead, +support for <parameter>glossary.collection</parameter> relies on implicit linking.</para> + +<para>In your source document, simply use <sgmltag>firstterm</sgmltag> and +<sgmltag>glossterm</sgmltag> to identify the terms you wish to have included +in the glossary. The stylesheets assume that you will either set the +<sgmltag class="attribute">baseform</sgmltag> attribute correctly, or that the +content of the element exactly matches a term in your glossary.</para> + +<para>If you're using a <parameter>glossary.collection</parameter>, don't +make explicit links on the terms in your document.</para> + +<para>So, in your document, you might write things like this:</para> + +<informalexample> +<programlisting><![CDATA[<para>This is dummy text, without any real meaning. +The point is simply to reference glossary terms like <glossterm>0</glossterm> +and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstterm>. +The <glossterm>1TBS</glossterm>, as you can probably imagine, is a nearly +religious issue.</para>]]></programlisting> +</informalexample> + +<para>If you set the <parameter>firstterm.only.link</parameter> parameter, +only the terms marked with <sgmltag>firstterm</sgmltag> will be links. +Otherwise, all the terms will be linked.</para> + +</refsect2> + +<refsect2><title>Marking Up the Glossary</title> + +<para>The glossary itself has to be identified for the stylesheets. For lack +of a better choice, the <sgmltag class="attribute">role</sgmltag> is used. +To identify the glossary as the target for automatic processing, set +the role to <quote><literal>auto</literal></quote>. The title of this +glossary (and any other information from the <sgmltag>glossaryinfo</sgmltag> +that's rendered by your stylesheet) will be displayed, but the entries will +come from the database. +</para> + +<para>Unfortunately, the glossary can't be empty, so you must put in +at least one <sgmltag>glossentry</sgmltag>. The content of this entry +is irrelevant, it will not be rendered:</para> + +<informalexample> +<programlisting><![CDATA[<glossary role="auto"> +<glossentry> +<glossterm>Irrelevant</glossterm> +<glossdef> +<para>If you can see this, the document was processed incorrectly. Use +the <parameter>glossary.collection</parameter> parameter.</para> +</glossdef> +</glossentry> +</glossary>]]></programlisting> +</informalexample> + +<para>What about glossary divisions? If your glossary database has glossary +divisions <emphasis>and</emphasis> your automatic glossary contains at least +one <sgmltag>glossdiv</sgmltag>, the automic glossary will have divisions. +If the <sgmltag>glossdiv</sgmltag> is missing from either location, no divisions +will be rendered.</para> + +<para>Glossary entries (and divisions, if appropriate) in the glossary will +occur in precisely the order they occur in your database.</para> + +</refsect2> + +<refsect2><title>Formatting the Document</title> + +<para>Finally, when you are ready to format your document, simply set the +<parameter>glossary.collection</parameter> parameter (in either a +customization layer or directly through your processor's interface) to +point to your global glossary.</para> + +<para>The stylesheets will format the glossary in your document as if +all of the entries implicilty referenced appeared there literally.</para> +</refsect2> + +<refsect2><title>Limitations</title> + +<para>Glossary cross-references <emphasis>within the glossary</emphasis> are +not supported. For example, this <emphasis>will not</emphasis> work:</para> + +<informalexample> +<programlisting><![CDATA[<glossentry> +<glossterm>gloss-1</glossterm> +<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para> +<glossseealso>gloss-2</glossseealso> +</glossdef> +</glossentry>]]></programlisting> +</informalexample> + +<para>If you put glossary cross-references in your glossary that way, +you'll get the cryptic error: <computeroutput>Warning: +glossary.collection specified, but there are 0 automatic +glossaries</computeroutput>.</para> + +<para>Instead, you must do two things:</para> + +<orderedlist> +<listitem> +<para>Markup your glossary using <sgmltag>glossseealso</sgmltag>:</para> + +<informalexample> +<programlisting><![CDATA[<glossentry> +<glossterm>gloss-1</glossterm> +<glossdef><para>A description that references <glossterm>gloss-2</glossterm>.</para> +<glossseealso>gloss-2</glossseealso> +</glossdef> +</glossentry>]]></programlisting> +</informalexample> +</listitem> + +<listitem> +<para>Make sure there is at least one <sgmltag>glossterm</sgmltag> reference to +<glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The +easiest way to do that is probably within a <sgmltag>remark</sgmltag> in your +automatic glossary:</para> + +<informalexample> +<programlisting><![CDATA[<glossary role="auto"> +<remark>Make sure there's a reference to <glossterm>gloss-2</glossterm>.</remark> +<glossentry> +<glossterm>Irrelevant</glossterm> +<glossdef> +<para>If you can see this, the document was processed incorrectly. Use +the <parameter>glossary.collection</parameter> parameter.</para> +</glossdef> +</glossentry> +</glossary>]]></programlisting> +</informalexample> +</listitem> +</orderedlist> +</refsect2> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/glossentry.show.acronym.xml b/kdoctools/docbook/xsl/params/glossentry.show.acronym.xml new file mode 100644 index 000000000..feacb9f7c --- /dev/null +++ b/kdoctools/docbook/xsl/params/glossentry.show.acronym.xml @@ -0,0 +1,29 @@ +<refentry id="glossentry.show.acronym"> +<refmeta> +<refentrytitle>glossentry.show.acronym</refentrytitle> +<refmiscinfo role="type">list</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossentry.show.acronym</refname> +<refpurpose>Display <sgmltag>glossentry</sgmltag> acronyms?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='glossentry.show.acronym.frag'> +<xsl:param name="glossentry.show.acronym" select="'no'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>A setting of <quote>yes</quote> means they should be displayed; +<quote>no</quote> means they shouldn't. If <quote>primary</quote> is used, +then they are shown as the primary text for the entry.</para> + +<note> +<para>This setting controls both <sgmltag>acronym</sgmltag> and +<sgmltag>abbrev</sgmltag> elements in the <sgmltag>glossentry</sgmltag>.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/glosslist.as.blocks.xml b/kdoctools/docbook/xsl/params/glosslist.as.blocks.xml new file mode 100644 index 000000000..53af6ee2f --- /dev/null +++ b/kdoctools/docbook/xsl/params/glosslist.as.blocks.xml @@ -0,0 +1,22 @@ +<refentry id="glosslist.as.blocks"> +<refmeta> +<refentrytitle>glosslist.as.blocks</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glosslist.as.blocks</refname> +<refpurpose>Use blocks for glosslists?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='glosslist.as.blocks.frag'> +<xsl:param name="glosslist.as.blocks" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>See <parameter>glossary.as.blocks</parameter>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/glossterm.auto.link.xml b/kdoctools/docbook/xsl/params/glossterm.auto.link.xml new file mode 100644 index 000000000..0478977bc --- /dev/null +++ b/kdoctools/docbook/xsl/params/glossterm.auto.link.xml @@ -0,0 +1,28 @@ +<refentry id="glossterm.auto.link"> +<refmeta> +<refentrytitle>glossterm.auto.link</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossterm.auto.link</refname> +<refpurpose>Generate links from glossterm to glossentry automaticaly?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='glossterm.auto.link.frag'> +<xsl:param name="glossterm.auto.link" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, a link will be automatically created from glossterm +to glossentry for that glossary term. This is usefull when your +glossterm names are consistent and you don't want to add links +manually.</para> +<para>If there is <sgmltag class="attribute">linkend</sgmltag> on +<sgmltag>glossterm</sgmltag> then is used instead of autogeneration of +link.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/glossterm.separation.xml b/kdoctools/docbook/xsl/params/glossterm.separation.xml new file mode 100644 index 000000000..d69a2b928 --- /dev/null +++ b/kdoctools/docbook/xsl/params/glossterm.separation.xml @@ -0,0 +1,23 @@ +<refentry id="glossterm.separation"> +<refmeta> +<refentrytitle>glossterm.separation</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossterm.separation</refname> +<refpurpose>Separation between glossary terms and descriptions in list mode</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='glossterm.separation.frag'> +<xsl:param name="glossterm.separation" select="'0.25in'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the separation between glossary terms and descriptions when +glossarys are presented using lists.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/glossterm.width.xml b/kdoctools/docbook/xsl/params/glossterm.width.xml new file mode 100644 index 000000000..6f26d76f6 --- /dev/null +++ b/kdoctools/docbook/xsl/params/glossterm.width.xml @@ -0,0 +1,23 @@ +<refentry id="glossterm.width"> +<refmeta> +<refentrytitle>glossterm.width</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>glossterm.width</refname> +<refpurpose>Width of glossterm in list presentation mode</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='glossterm.width.frag'> +<xsl:param name="glossterm.width" select="'2in'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the width reserved for glossary terms when +a list presentation is used.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/graphic.default.extension.xml b/kdoctools/docbook/xsl/params/graphic.default.extension.xml new file mode 100644 index 000000000..58d763c65 --- /dev/null +++ b/kdoctools/docbook/xsl/params/graphic.default.extension.xml @@ -0,0 +1,24 @@ +<refentry id="graphic.default.extension"> +<refmeta> +<refentrytitle>graphic.default.extension</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>graphic.default.extension</refname> +<refpurpose>Default extension for graphic filenames</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='graphic.default.extension.frag'><xsl:param name="graphic.default.extension"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If a <sgmltag>graphic</sgmltag> or <sgmltag>mediaobject</sgmltag> +includes a reference to a filename that does not include an extension, +and the <sgmltag class="attribute">format</sgmltag> attribute is +<emphasis>unspecified</emphasis>, the default extension will be used. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/graphicsize.extension.xml b/kdoctools/docbook/xsl/params/graphicsize.extension.xml new file mode 100644 index 000000000..e8cacff03 --- /dev/null +++ b/kdoctools/docbook/xsl/params/graphicsize.extension.xml @@ -0,0 +1,25 @@ +<refentry id="graphicsize.extension"> +<refmeta> +<refentrytitle>graphicsize.extension</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>graphicsize.extension</refname> +<refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='graphicsize.extension.frag'> +<xsl:param name="graphicsize.extension" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero +and if you're using a processor that supports extension functions), the +<function>getWidth</function> and <function>getDepth</function> functions +will be used to extract image sizes from graphics.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/header.column.widths.xml b/kdoctools/docbook/xsl/params/header.column.widths.xml new file mode 100644 index 000000000..f88dc6fb1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/header.column.widths.xml @@ -0,0 +1,69 @@ +<refentry id="header.column.widths"> +<refmeta> +<refentrytitle>header.column.widths</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.column.widths</refname> +<refpurpose>Specify relative widths of header areas</refpurpose> +</refnamediv> + +<refsynopsisdiv><src:fragment id='header.column.widths.frag'> +<xsl:param name="header.column.widths" select="'1 1 1'"/> +</src:fragment></refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Page headers in print output use a three column table +to position text at the left, center, and right side of +the header on the page. +This parameter lets you specify the relative sizes of the +three columns. The default value is +"1 1 1".</para> + +<para>The parameter value must be three numbers, separated +by white space. The first number represents the relative +width of the left header for +single-sided output, or the inside header for +double-sided output. The second number is the relative +width of the center header. The third number is the +relative width of the right header for +single-sided output, or the outside header for +double-sided output. +</para> + +<para>The numbers are used to specify the column widths +for the table that makes up the header area. +In the FO output, this looks like: +</para> + +<programlisting> +<fo:table-column column-number="1" + column-width="proportional-column-width(1)"/> +</programlisting> + +<para> +The <literal>proportional-column-width()</literal> +function computes a column width by dividing its +argument by the total of the arguments for all the columns, and +then multiplying the result by the width of the whole table +(assuming all the column specs use the function). +Its argument can be any positive integer or floating point number. +Zero is an acceptable value, although some FO processors +may warn about it, in which case using a very small number might +be more satisfactory. +</para> + +<para>For example, the value "1 2 1" means the center +header should have twice the width of the other areas. +A value of "0 0 1" means the entire header area +is reserved for the right (or outside) header text. +Note that to keep the center area centered on +the page, the left and right values must be +the same. A specification like "1 2 3" means the +center area is no longer centered on the page +since the right area is three times the width of the left area. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/header.content.properties.xml b/kdoctools/docbook/xsl/params/header.content.properties.xml new file mode 100644 index 000000000..7ba0986fd --- /dev/null +++ b/kdoctools/docbook/xsl/params/header.content.properties.xml @@ -0,0 +1,29 @@ +<refentry id="header.content.properties"> +<refmeta> +<refentrytitle>header.content.properties</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.content.properties</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='header.content.properties.frag'> +<xsl:attribute-set name="header.content.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$body.fontset"/> + </xsl:attribute> + <xsl:attribute name="margin-left"> + <xsl:value-of select="$title.margin.left"/> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Properties of page header content.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/header.rule.xml b/kdoctools/docbook/xsl/params/header.rule.xml new file mode 100644 index 000000000..0455f1a0c --- /dev/null +++ b/kdoctools/docbook/xsl/params/header.rule.xml @@ -0,0 +1,22 @@ +<refentry id="header.rule"> +<refmeta> +<refentrytitle>header.rule</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.rule</refname> +<refpurpose>Rule under headers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='header.rule.frag'> +<xsl:param name="header.rule" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, a rule will be drawn below the page headers.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/headers.on.blank.pages.xml b/kdoctools/docbook/xsl/params/headers.on.blank.pages.xml new file mode 100644 index 000000000..ba8fb0f28 --- /dev/null +++ b/kdoctools/docbook/xsl/params/headers.on.blank.pages.xml @@ -0,0 +1,22 @@ +<refentry id="headers.on.blank.pages"> +<refmeta> +<refentrytitle>headers.on.blank.pages</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>headers.on.blank.pages</refname> +<refpurpose>Put headers on blank pages?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='headers.on.blank.pages.frag'> +<xsl:param name="headers.on.blank.pages" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, headers will be placed on blank pages.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/html.base.xml b/kdoctools/docbook/xsl/params/html.base.xml new file mode 100644 index 000000000..039889418 --- /dev/null +++ b/kdoctools/docbook/xsl/params/html.base.xml @@ -0,0 +1,23 @@ +<refentry id="html.base"> +<refmeta> +<refentrytitle>html.base</refentrytitle> +<refmiscinfo role="type">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.base</refname> +<refpurpose>An HTML base URI</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='html.base.frag'><xsl:param name="html.base"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If html.base is set, it is used for the <sgmltag>BASE</sgmltag> +element in the <sgmltag>HEAD</sgmltag> of the HTML documents. +This is useful for dynamically served HTML where the base URI needs +to be shifted.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/html.cellpadding.xml b/kdoctools/docbook/xsl/params/html.cellpadding.xml new file mode 100644 index 000000000..0180a139f --- /dev/null +++ b/kdoctools/docbook/xsl/params/html.cellpadding.xml @@ -0,0 +1,23 @@ +<refentry id="html.cellpadding"> +<refmeta> +<refentrytitle>html.cellpadding</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.cellpadding</refname> +<refpurpose>Default value for cellpadding in HTML tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='html.cellpadding.frag'> +<xsl:param name="html.cellpadding" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If specified, this value will be used as the default cellpadding value +in HTML tables.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/html.cellspacing.xml b/kdoctools/docbook/xsl/params/html.cellspacing.xml new file mode 100644 index 000000000..10fbe0182 --- /dev/null +++ b/kdoctools/docbook/xsl/params/html.cellspacing.xml @@ -0,0 +1,23 @@ +<refentry id="html.cellspacing"> +<refmeta> +<refentrytitle>html.cellspacing</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.cellspacing</refname> +<refpurpose>Default value for cellspacing in HTML tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='html.cellspacing.frag'> +<xsl:param name="html.cellspacing" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If specified, this value will be used as the default cellspacing value +in HTML tables.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/html.cleanup.xml b/kdoctools/docbook/xsl/params/html.cleanup.xml new file mode 100644 index 000000000..43fa6b4f1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/html.cleanup.xml @@ -0,0 +1,29 @@ +<refentry id="html.cleanup"> +<refmeta> +<refentrytitle>html.cleanup</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.cleanup</refname> +<refpurpose>Attempt to clean up the resulting HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='html.cleanup.frag'> +<xsl:param name="html.cleanup" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, and if the <ulink url="http://www.exslt.org/">EXSLT</ulink> +extensions are supported by your processor, the resulting HTML will be +<quote>cleaned up</quote>. This improves the chances that the +resulting HTML will be valid. It may also improve the formatting of +some elements.</para> + +<para>This parameter is different from <parameter>make.valid.html</parameter> +because it uses extension functions to manipulate result-tree-fragments.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/html.ext.xml b/kdoctools/docbook/xsl/params/html.ext.xml new file mode 100644 index 000000000..dd202057a --- /dev/null +++ b/kdoctools/docbook/xsl/params/html.ext.xml @@ -0,0 +1,24 @@ +<refentry id="html.ext"> +<refmeta> +<refentrytitle>html.ext</refentrytitle> + +</refmeta> +<refnamediv> +<refname>html.ext</refname> +<refpurpose>Identifies the extension of generated HTML files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='html.ext.frag'> +<xsl:param name="html.ext" select="'.html'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The extension identified by <parameter>html.ext</parameter> will +be used as the filename extension for chunks created by this stylesheet. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/html.extra.head.links.xml b/kdoctools/docbook/xsl/params/html.extra.head.links.xml new file mode 100644 index 000000000..5680e5975 --- /dev/null +++ b/kdoctools/docbook/xsl/params/html.extra.head.links.xml @@ -0,0 +1,26 @@ +<refentry id="html.extra.head.links"> +<refmeta> +<refentrytitle>html.extra.head.links</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.extra.head.links</refname> +<refpurpose>Toggle extra HTML head link information</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='html.extra.head.links.frag'> +<xsl:param name="html.extra.head.links" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, extra <sgmltag>link</sgmltag> elements will be +generated in the <sgmltag>head</sgmltag> of chunked HTML files. These +extra links point to chapters, appendixes, sections, etc. as supported +by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least). +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/html.longdesc.link.xml b/kdoctools/docbook/xsl/params/html.longdesc.link.xml new file mode 100644 index 000000000..a3406f29b --- /dev/null +++ b/kdoctools/docbook/xsl/params/html.longdesc.link.xml @@ -0,0 +1,29 @@ +<refentry id="html.longdesc.link"> +<refmeta> +<refentrytitle>html.longdesc.link</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.longdesc.link</refname> +<refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='html.longdesc.link.frag'> +<xsl:param name="html.longdesc.link" select="$html.longdesc"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, links will be created to the +HTML files created for the +<sgmltag class="attribute">longdesc</sgmltag> attribute. It makes no +sense to turn enable this option without also enabling the +<parameter>$html.longdesc</parameter> parameter.</para> + +<para>The <literal>longdesc.link</literal> named template is called +to construct the link.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/html.longdesc.xml b/kdoctools/docbook/xsl/params/html.longdesc.xml new file mode 100644 index 000000000..1098b69e4 --- /dev/null +++ b/kdoctools/docbook/xsl/params/html.longdesc.xml @@ -0,0 +1,27 @@ +<refentry id="html.longdesc"> +<refmeta> +<refentrytitle>html.longdesc</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.longdesc</refname> +<refpurpose>Should longdesc URIs be created?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='html.longdesc.frag'> +<xsl:param name="html.longdesc" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, HTML files will be created for the +<sgmltag class="attribute">longdesc</sgmltag> attribute. These files +are created from the <sgmltag>textobject</sgmltag>s in +<sgmltag>mediaobject</sgmltag>s and +<sgmltag>inlinemediaobject</sgmltag>. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/html.stylesheet.type.xml b/kdoctools/docbook/xsl/params/html.stylesheet.type.xml new file mode 100644 index 000000000..8cea763b8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/html.stylesheet.type.xml @@ -0,0 +1,21 @@ +<refentry id="html.stylesheet.type"> +<refmeta> +<refentrytitle>html.stylesheet.type</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.stylesheet.type</refname> +<refpurpose>The type of the stylesheet used in the generated HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='html.stylesheet.type.frag'><xsl:param name="html.stylesheet.type">text/css</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The type of the stylesheet to place in the HTML <sgmltag>link</sgmltag> tag. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/html.stylesheet.xml b/kdoctools/docbook/xsl/params/html.stylesheet.xml new file mode 100644 index 000000000..d78332fbc --- /dev/null +++ b/kdoctools/docbook/xsl/params/html.stylesheet.xml @@ -0,0 +1,30 @@ +<refentry id="html.stylesheet"> +<refmeta> +<refentrytitle>html.stylesheet</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>html.stylesheet</refname> +<refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='html.stylesheet.frag'> +<xsl:param name="html.stylesheet" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>html.stylesheet</parameter> parameter is either empty, +indicating that no stylesheet <sgmltag>LINK</sgmltag> tag should be generated +in the HTML output, or it is a list of one or more stylesheets.</para> + +<para>Multiple stylesheets are space-delimited. If you need to +reference a stylesheet URI that includes a space, encode it with +<literal>%20</literal>. A seprate HTML <sgmltag>LINK</sgmltag> element will +be generated for each stylesheet in the order they are listed in the +parameter.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.alias.file.xml b/kdoctools/docbook/xsl/params/htmlhelp.alias.file.xml new file mode 100644 index 000000000..ff67d1c14 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.alias.file.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.alias.file"> +<refmeta> +<refentrytitle>htmlhelp.alias.file</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.alias.file</refname> +<refpurpose>Filename of map file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.alias.file.frag'> +<xsl:param name="htmlhelp.alias.file" select="'alias.h'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Change this parameter if you want different name of map file +than <filename>alias.h</filename>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.autolabel.xml b/kdoctools/docbook/xsl/params/htmlhelp.autolabel.xml new file mode 100644 index 000000000..25c65cbda --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.autolabel.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.autolabel"> +<refmeta> +<refentrytitle>htmlhelp.autolabel</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.autolabel</refname> +<refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.autolabel.frag'> +<xsl:param name="htmlhelp.autolabel" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want to include chapter and section numbers into ToC in +the left panel, set this parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.back.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.back.xml new file mode 100644 index 000000000..99f2dc606 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.back.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.back"> +<refmeta> +<refentrytitle>htmlhelp.button.back</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.back</refname> +<refpurpose>Should be Back button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.back.frag'> +<xsl:param name="htmlhelp.button.back" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Back button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.forward.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.forward.xml new file mode 100644 index 000000000..c4e699a38 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.forward.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.forward"> +<refmeta> +<refentrytitle>htmlhelp.button.forward</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.forward</refname> +<refpurpose>Should be Forward button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.forward.frag'> +<xsl:param name="htmlhelp.button.forward" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Forward button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.hideshow.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.hideshow.xml new file mode 100644 index 000000000..118d3754c --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.hideshow.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.hideshow"> +<refmeta> +<refentrytitle>htmlhelp.button.hideshow</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.hideshow</refname> +<refpurpose>Should be Hide/Show button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.hideshow.frag'> +<xsl:param name="htmlhelp.button.hideshow" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Hide/Show button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.home.url.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.home.url.xml new file mode 100644 index 000000000..5d19ff747 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.home.url.xml @@ -0,0 +1,22 @@ +<refentry id="htmlhelp.button.home.url"> +<refmeta> +<refentrytitle>htmlhelp.button.home.url</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.home.url</refname> +<refpurpose>URL address of page accessible by Home button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.home.url.frag'> +<xsl:param name="htmlhelp.button.home.url"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>URL address of page accessible by Home button.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.home.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.home.xml new file mode 100644 index 000000000..ab7c6f292 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.home.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.home"> +<refmeta> +<refentrytitle>htmlhelp.button.home</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.home</refname> +<refpurpose>Should be Home button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.home.frag'> +<xsl:param name="htmlhelp.button.home" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Home button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.jump1.title.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.jump1.title.xml new file mode 100644 index 000000000..ddcc65cfd --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.jump1.title.xml @@ -0,0 +1,22 @@ +<refentry id="htmlhelp.button.jump1.title"> +<refmeta> +<refentrytitle>htmlhelp.button.jump1.title</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump1.title</refname> +<refpurpose>Title of Jump1 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.jump1.title.frag'> +<xsl:param name="htmlhelp.button.jump1.title" select="'User1'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Title of Jump1 button.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.jump1.url.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.jump1.url.xml new file mode 100644 index 000000000..f800538c8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.jump1.url.xml @@ -0,0 +1,22 @@ +<refentry id="htmlhelp.button.jump1.url"> +<refmeta> +<refentrytitle>htmlhelp.button.jump1.url</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump1.url</refname> +<refpurpose>URL address of page accessible by Jump1 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.jump1.url.frag'> +<xsl:param name="htmlhelp.button.jump1.url"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>URL address of page accessible by Jump1 button.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.jump1.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.jump1.xml new file mode 100644 index 000000000..a578dd675 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.jump1.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.jump1"> +<refmeta> +<refentrytitle>htmlhelp.button.jump1</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump1</refname> +<refpurpose>Should be Jump1 button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.jump1.frag'> +<xsl:param name="htmlhelp.button.jump1" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Jump1 button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.jump2.title.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.jump2.title.xml new file mode 100644 index 000000000..05a1c2992 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.jump2.title.xml @@ -0,0 +1,22 @@ +<refentry id="htmlhelp.button.jump2.title"> +<refmeta> +<refentrytitle>htmlhelp.button.jump2.title</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump2.title</refname> +<refpurpose>Title of Jump2 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.jump2.title.frag'> +<xsl:param name="htmlhelp.button.jump2.title" select="'User2'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Title of Jump2 button.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.jump2.url.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.jump2.url.xml new file mode 100644 index 000000000..492b52b2e --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.jump2.url.xml @@ -0,0 +1,22 @@ +<refentry id="htmlhelp.button.jump2.url"> +<refmeta> +<refentrytitle>htmlhelp.button.jump2.url</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump2.url</refname> +<refpurpose>URL address of page accessible by Jump2 button</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.jump2.url.frag'> +<xsl:param name="htmlhelp.button.jump2.url"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>URL address of page accessible by Jump2 button.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.jump2.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.jump2.xml new file mode 100644 index 000000000..3d89acf70 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.jump2.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.jump2"> +<refmeta> +<refentrytitle>htmlhelp.button.jump2</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.jump2</refname> +<refpurpose>Should be Jump2 button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.jump2.frag'> +<xsl:param name="htmlhelp.button.jump2" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Jump2 button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.locate.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.locate.xml new file mode 100644 index 000000000..ffa89cda8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.locate.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.locate"> +<refmeta> +<refentrytitle>htmlhelp.button.locate</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.locate</refname> +<refpurpose>Should be Locate button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.locate.frag'> +<xsl:param name="htmlhelp.button.locate" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Locate button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.next.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.next.xml new file mode 100644 index 000000000..aa7552d5f --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.next.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.next"> +<refmeta> +<refentrytitle>htmlhelp.button.next</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.next</refname> +<refpurpose>Should be Next button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.next.frag'> +<xsl:param name="htmlhelp.button.next" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Next button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.options.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.options.xml new file mode 100644 index 000000000..70ca16b2d --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.options.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.options"> +<refmeta> +<refentrytitle>htmlhelp.button.options</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.options</refname> +<refpurpose>Should be Options button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.options.frag'> +<xsl:param name="htmlhelp.button.options" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Options button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.prev.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.prev.xml new file mode 100644 index 000000000..f47a78a9a --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.prev.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.prev"> +<refmeta> +<refentrytitle>htmlhelp.button.prev</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.prev</refname> +<refpurpose>Should be Prev button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.prev.frag'> +<xsl:param name="htmlhelp.button.prev" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Prev button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.print.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.print.xml new file mode 100644 index 000000000..58eb7cf0b --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.print.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.print"> +<refmeta> +<refentrytitle>htmlhelp.button.print</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.print</refname> +<refpurpose>Should be Print button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.print.frag'> +<xsl:param name="htmlhelp.button.print" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Print button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.refresh.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.refresh.xml new file mode 100644 index 000000000..9a9e14037 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.refresh.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.refresh"> +<refmeta> +<refentrytitle>htmlhelp.button.refresh</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.refresh</refname> +<refpurpose>Should be Refresh button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.refresh.frag'> +<xsl:param name="htmlhelp.button.refresh" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Refresh button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.stop.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.stop.xml new file mode 100644 index 000000000..5b88acb91 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.stop.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.stop"> +<refmeta> +<refentrytitle>htmlhelp.button.stop</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.stop</refname> +<refpurpose>Should be Stop button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.stop.frag'> +<xsl:param name="htmlhelp.button.stop" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Stop button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.button.zoom.xml b/kdoctools/docbook/xsl/params/htmlhelp.button.zoom.xml new file mode 100644 index 000000000..f6e4a18d0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.button.zoom.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.button.zoom"> +<refmeta> +<refentrytitle>htmlhelp.button.zoom</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.button.zoom</refname> +<refpurpose>Should be Zoom button shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.button.zoom.frag'> +<xsl:param name="htmlhelp.button.zoom" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want Zoom button shown on toolbar, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.chm.xml b/kdoctools/docbook/xsl/params/htmlhelp.chm.xml new file mode 100644 index 000000000..7d571e320 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.chm.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.chm"> +<refmeta> +<refentrytitle>htmlhelp.chm</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.chm</refname> +<refpurpose>Filename of output HTML Help file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.chm.frag'> +<xsl:param name="htmlhelp.chm" select="'htmlhelp.chm'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Change this parameter if you want different name of result +CHM file than htmlhelp.chm.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml b/kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml new file mode 100644 index 000000000..9350d7b3a --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml @@ -0,0 +1,31 @@ +<refentry id="htmlhelp.default.topic"> +<refmeta> +<refentrytitle>htmlhelp.default.topic</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.default.topic</refname> +<refpurpose>Name of file with default topic</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.default.topic.frag'> +<xsl:param name="htmlhelp.default.topic" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Normally first chunk of document is displayed when you open HTML +Help file. If you want to display another topic, simply set its +filename by this parameter.</para> + +<para>This is useful especially if you don't generate ToC in front of +your document and you also hide root element in ToC. E.g.:</para> + +<programlisting><![CDATA[<xsl:param name="generate.book.toc" select="0"/> +<xsl:param name="htmlhelp.hhc.show.root" select="0"/> +<xsl:param name="htmlhelp.default.topic" select="'pr01.html'"/>]]></programlisting> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.display.progress.xml b/kdoctools/docbook/xsl/params/htmlhelp.display.progress.xml new file mode 100644 index 000000000..fee4164d8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.display.progress.xml @@ -0,0 +1,24 @@ +<refentry id="htmlhelp.display.progress"> +<refmeta> +<refentrytitle>htmlhelp.display.progress</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.display.progress</refname> +<refpurpose>Display compile progress?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.display.progress.frag'> +<xsl:param name="htmlhelp.display.progress" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>You can swith off display of compile progress by setting this +parameter to 0.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/htmlhelp.encoding.xml b/kdoctools/docbook/xsl/params/htmlhelp.encoding.xml new file mode 100644 index 000000000..f7c04b545 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.encoding.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.encoding"> +<refmeta> +<refentrytitle>htmlhelp.encoding</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.encoding</refname> +<refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.encoding.frag'> +<xsl:param name="htmlhelp.encoding" select="'iso-8859-1'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>HTML Help Compiler is not UTF-8 aware, so you should always use +apropriate single-byte encoding here.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.enhanced.decompilation.xml b/kdoctools/docbook/xsl/params/htmlhelp.enhanced.decompilation.xml new file mode 100644 index 000000000..881b00a88 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.enhanced.decompilation.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.enhanced.decompilation"> +<refmeta> +<refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.enhanced.decompilation</refname> +<refpurpose>Allow enhanced decompilation of CHM?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.enhanced.decompilation.frag'> +<xsl:param name="htmlhelp.enhanced.decompilation" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>When set to 1 this parameter enables enhanced decompilation of CHM.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/htmlhelp.enumerate.images.xml b/kdoctools/docbook/xsl/params/htmlhelp.enumerate.images.xml new file mode 100644 index 000000000..723dbdafa --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.enumerate.images.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.enumerate.images"> +<refmeta> +<refentrytitle>htmlhelp.enumerate.images</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.enumerate.images</refname> +<refpurpose>Should be paths to all used images added to project file?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.enumerate.images.frag'> +<xsl:param name="htmlhelp.enumerate.images" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>You should turn on this flag, if you insert images into your documents +as external binary entities or if you are using absolute path in image names.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.force.map.and.alias.xml b/kdoctools/docbook/xsl/params/htmlhelp.force.map.and.alias.xml new file mode 100644 index 000000000..92a9e6959 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.force.map.and.alias.xml @@ -0,0 +1,24 @@ +<refentry id="htmlhelp.force.map.and.alias"> +<refmeta> +<refentrytitle>htmlhelp.force.map.and.alias</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.force.map.and.alias</refname> +<refpurpose>Should be [MAP] and [ALIAS] section added to project file unconditionaly?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.force.map.and.alias.frag'> +<xsl:param name="htmlhelp.force.map.and.alias" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>You should turn on this flag, if you have your own +<filename>alias.h</filename> and <filename>contex.h</filename> files +and you want include reference to them in project file.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhc.binary.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhc.binary.xml new file mode 100644 index 000000000..b8cc986df --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhc.binary.xml @@ -0,0 +1,24 @@ +<refentry id="htmlhelp.hhc.binary"> +<refmeta> +<refentrytitle>htmlhelp.hhc.binary</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.binary</refname> +<refpurpose>Generate binary ToC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhc.binary.frag'> +<xsl:param name="htmlhelp.hhc.binary" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parametr controls whether binary TOC will be generated. You +must create binary TOC if you want to add Prev/Next buttons to toolbar +(which is default behaviour). Files with binary TOC can't be merged.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhc.folders.instead.books.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhc.folders.instead.books.xml new file mode 100644 index 000000000..f3a914e4e --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhc.folders.instead.books.xml @@ -0,0 +1,25 @@ +<refentry id="htmlhelp.hhc.folders.instead.books"> +<refmeta> +<refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.folders.instead.books</refname> +<refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhc.folders.instead.books.frag'> +<xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter controls whether there should be folder-like +icons (1) or book-like icons (0) in ToC. If you want to use +folder-like icons you must swith off binary ToC using +<parameter>htmlhelp.hhc.binary</parameter>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhc.section.depth.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhc.section.depth.xml new file mode 100644 index 000000000..b00f4d802 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhc.section.depth.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.hhc.section.depth"> +<refmeta> +<refentrytitle>htmlhelp.hhc.section.depth</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.section.depth</refname> +<refpurpose>Depth of TOC for sections in a left pane.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhc.section.depth.frag'> +<xsl:param name="htmlhelp.hhc.section.depth" select="5"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Change this parameter if you want shallower ToC in a left pane +of HTML Help viewer.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhc.show.root.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhc.show.root.xml new file mode 100644 index 000000000..3d4a5b424 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhc.show.root.xml @@ -0,0 +1,24 @@ +<refentry id="htmlhelp.hhc.show.root"> +<refmeta> +<refentrytitle>htmlhelp.hhc.show.root</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.show.root</refname> +<refpurpose>Should be entry for root element shown in ToC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhc.show.root.frag'> +<xsl:param name="htmlhelp.hhc.show.root" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If set to 0, there will be no entry for root element in +ToC. This is useful when you want provide user with expanded ToC as +a default.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhc.width.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhc.width.xml new file mode 100644 index 000000000..63236b700 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhc.width.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.hhc.width"> +<refmeta> +<refentrytitle>htmlhelp.hhc.width</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc.width</refname> +<refpurpose>Width of navigation (ToC) pane</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhc.width.frag'> +<xsl:param name="htmlhelp.hhc.width"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies width of ToC pane in pixels.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhc.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhc.xml new file mode 100644 index 000000000..dadb0a613 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhc.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.hhc"> +<refmeta> +<refentrytitle>htmlhelp.hhc</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhc</refname> +<refpurpose>Filename of TOC file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhc.frag'> +<xsl:param name="htmlhelp.hhc" select="'toc.hhc'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Change this parameter if you want different name of TOC file +than toc.hhc.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhk.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhk.xml new file mode 100644 index 000000000..49506a8ca --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhk.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.hhk"> +<refmeta> +<refentrytitle>htmlhelp.hhk</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhk</refname> +<refpurpose>Filename of index file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhk.frag'> +<xsl:param name="htmlhelp.hhk" select="'index.hhk'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Change this parameter if you want different name of index file +than index.hhk.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhp.tail.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhp.tail.xml new file mode 100644 index 000000000..0792bbb65 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhp.tail.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.hhp.tail"> +<refmeta> +<refentrytitle>htmlhelp.hhp.tail</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp.tail</refname> +<refpurpose>Additional content for project file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhp.tail.frag'> +<xsl:param name="htmlhelp.hhp.tail"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want to include some additional parameters into project file, +store appropriate part of project file into this parameter.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhp.window.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhp.window.xml new file mode 100644 index 000000000..7ba52966d --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhp.window.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.hhp.window"> +<refmeta> +<refentrytitle>htmlhelp.hhp.window</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp.window</refname> +<refpurpose>Name of default window.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhp.window.frag'> +<xsl:param name="htmlhelp.hhp.window" select="'Main'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Name of default window. If empty no [WINDOWS] section will be +added to project file.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhp.windows.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhp.windows.xml new file mode 100644 index 000000000..81d0b7304 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhp.windows.xml @@ -0,0 +1,25 @@ +<refentry id="htmlhelp.hhp.windows"> +<refmeta> +<refentrytitle>htmlhelp.hhp.windows</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp.windows</refname> +<refpurpose>Definition of additional windows</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhp.windows.frag'> +<xsl:param name="htmlhelp.hhp.windows"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Content of this parameter is placed at the end of [WINDOWS] +section of project file. You can use it for defining your own +addtional windows.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/htmlhelp.hhp.xml b/kdoctools/docbook/xsl/params/htmlhelp.hhp.xml new file mode 100644 index 000000000..4058f0a9c --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.hhp.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.hhp"> +<refmeta> +<refentrytitle>htmlhelp.hhp</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.hhp</refname> +<refpurpose>Filename of project file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.hhp.frag'> +<xsl:param name="htmlhelp.hhp" select="'htmlhelp.hhp'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Change this parameter if you want different name of project +file than htmlhelp.hhp.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.map.file.xml b/kdoctools/docbook/xsl/params/htmlhelp.map.file.xml new file mode 100644 index 000000000..49ee9cb0c --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.map.file.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.map.file"> +<refmeta> +<refentrytitle>htmlhelp.map.file</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.map.file</refname> +<refpurpose>Filename of map file.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.map.file.frag'> +<xsl:param name="htmlhelp.map.file" select="'context.h'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Change this parameter if you want different name of map file +than <filename>context.h</filename>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.only.xml b/kdoctools/docbook/xsl/params/htmlhelp.only.xml new file mode 100644 index 000000000..17755dfd9 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.only.xml @@ -0,0 +1,25 @@ +<refentry id="htmlhelp.only"> +<refmeta> +<refentrytitle>htmlhelp.only</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.only</refname> +<refpurpose>Should be only project files generated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.only.frag'> +<xsl:param name="htmlhelp.only" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want to play with various HTML Help parameters and you +don't need to regenerate all HTML files, you can set this parameter to +1. This setting will not process whole document, only project files +(hhp, hhc, hhk,...) will be generated.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.remember.window.position.xml b/kdoctools/docbook/xsl/params/htmlhelp.remember.window.position.xml new file mode 100644 index 000000000..4cf97fe40 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.remember.window.position.xml @@ -0,0 +1,24 @@ +<refentry id="htmlhelp.remember.window.position"> +<refmeta> +<refentrytitle>htmlhelp.remember.window.position</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.remember.window.position</refname> +<refpurpose>Remember help window position?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.remember.window.position.frag'> +<xsl:param name="htmlhelp.remember.window.position" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>To remember help window position between starts set this +parameter to 1.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/htmlhelp.show.advanced.search.xml b/kdoctools/docbook/xsl/params/htmlhelp.show.advanced.search.xml new file mode 100644 index 000000000..85e4c4da3 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.show.advanced.search.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.show.advanced.search"> +<refmeta> +<refentrytitle>htmlhelp.show.advanced.search</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.advanced.search</refname> +<refpurpose>Should be advanced search available?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.show.advanced.search.frag'> +<xsl:param name="htmlhelp.show.advanced.search" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want advanced search features in your help, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.show.favorities.xml b/kdoctools/docbook/xsl/params/htmlhelp.show.favorities.xml new file mode 100644 index 000000000..c1811d11d --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.show.favorities.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.show.favorities"> +<refmeta> +<refentrytitle>htmlhelp.show.favorities</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.favorities</refname> +<refpurpose>Should be favorities tab shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.show.favorities.frag'> +<xsl:param name="htmlhelp.show.favorities" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want favorities tab shown in your help, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.show.menu.xml b/kdoctools/docbook/xsl/params/htmlhelp.show.menu.xml new file mode 100644 index 000000000..0fad24e42 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.show.menu.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.show.menu"> +<refmeta> +<refentrytitle>htmlhelp.show.menu</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.menu</refname> +<refpurpose>Should be menu shown?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.show.menu.frag'> +<xsl:param name="htmlhelp.show.menu" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want application menu in your HTML Help file, turn this +parameter to 1.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.show.toolbar.text.xml b/kdoctools/docbook/xsl/params/htmlhelp.show.toolbar.text.xml new file mode 100644 index 000000000..44f8d2407 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.show.toolbar.text.xml @@ -0,0 +1,24 @@ +<refentry id="htmlhelp.show.toolbar.text"> +<refmeta> +<refentrytitle>htmlhelp.show.toolbar.text</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.show.toolbar.text</refname> +<refpurpose>Show text under toolbar buttons?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.show.toolbar.text.frag'> +<xsl:param name="htmlhelp.show.toolbar.text" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>You can switch off display of texts under toolbar buttons by +setting this parameter to 0.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/htmlhelp.title.xml b/kdoctools/docbook/xsl/params/htmlhelp.title.xml new file mode 100644 index 000000000..c5b1cb398 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.title.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.title"> +<refmeta> +<refentrytitle>htmlhelp.title</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.title</refname> +<refpurpose>Title of HTML Help</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.title.frag'> +<xsl:param name="htmlhelp.title" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Content of this parameter will be used as a title for generated +HTML Help. If empty, title will be automatically taken from document.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.use.hhk.xml b/kdoctools/docbook/xsl/params/htmlhelp.use.hhk.xml new file mode 100644 index 000000000..6c9da0774 --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.use.hhk.xml @@ -0,0 +1,23 @@ +<refentry id="htmlhelp.use.hhk"> +<refmeta> +<refentrytitle>htmlhelp.use.hhk</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.use.hhk</refname> +<refpurpose>Should be index built using HHK file?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.use.hhk.frag'> +<xsl:param name="htmlhelp.use.hhk" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, index is created using HHK file. This provides some +new features.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/htmlhelp.window.geometry.xml b/kdoctools/docbook/xsl/params/htmlhelp.window.geometry.xml new file mode 100644 index 000000000..e0742b10d --- /dev/null +++ b/kdoctools/docbook/xsl/params/htmlhelp.window.geometry.xml @@ -0,0 +1,26 @@ +<refentry id="htmlhelp.window.geometry"> +<refmeta> +<refentrytitle>htmlhelp.window.geometry</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>htmlhelp.window.geometry</refname> +<refpurpose>Set initial geometry of help window</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='htmlhelp.window.geometry.frag'> +<xsl:param name="htmlhelp.window.geometry"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies initial position of help +window. E.g.</para> + +<programlisting><![CDATA[<xsl:param name="htmlhelp.window.geometry">[160,64,992,704]</xsl:param>]]></programlisting> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/hyphenate.verbatim.xml b/kdoctools/docbook/xsl/params/hyphenate.verbatim.xml new file mode 100644 index 000000000..35b295ebc --- /dev/null +++ b/kdoctools/docbook/xsl/params/hyphenate.verbatim.xml @@ -0,0 +1,42 @@ +<refentry id="hyphenate.verbatim"> +<refmeta> +<refentrytitle>hyphenate.verbatim</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>hyphenate.verbatim</refname> +<refpurpose>Should verbatim environments be hyphenated on space characters?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='hyphenate.verbatim.frag'><xsl:param name="hyphenate.verbatim" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If the lines of program listing are too long to fit into one +line it is quite common to split them at space and indicite by hook +arrow that code continues on the next line. You can turn on this +behaviour for <sgmltag>programlisting</sgmltag>, +<sgmltag>screen</sgmltag> and <sgmltag>synopsis</sgmltag> elements by +using this parameter.</para> + +<para>Note that you must also enable line wrapping for verbatim environments and +select appropriate hyphenation character (e.g. hook arrow). This can +be done using <parameter>monospace.verbatim.properties</parameter> +attribute set:</para> + +<programlisting><![CDATA[<xsl:attribute-set name="monospace.verbatim.properties" + use-attribute-sets="verbatim.properties monospace.properties"> + <xsl:attribute name="wrap-option">wrap</xsl:attribute> + <xsl:attribute name="hyphenation-character">►</xsl:attribute> +</xsl:attribute-set>]]></programlisting> + +<para>For a list of arrows available in Unicode see <ulink +url="http://www.unicode.org/charts/PDF/U2190.pdf"/> and <ulink +url="http://www.unicode.org/charts/PDF/U2900.pdf"/> and make sure that +selected character is available in the font you are using for verbatim +environments.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/hyphenate.xml b/kdoctools/docbook/xsl/params/hyphenate.xml new file mode 100644 index 000000000..429bf7fc8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/hyphenate.xml @@ -0,0 +1,21 @@ +<refentry id="hyphenate"> +<refmeta> +<refentrytitle>hyphenate</refentrytitle> + +</refmeta> +<refnamediv> +<refname>hyphenate</refname> +<refpurpose>Specify hyphenation behavior</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='hyphenate.frag'><xsl:param name="hyphenate">true</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, words may be hyphenated. Otherwise, they may not. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/ignore.image.scaling.xml b/kdoctools/docbook/xsl/params/ignore.image.scaling.xml new file mode 100644 index 000000000..40aaa7733 --- /dev/null +++ b/kdoctools/docbook/xsl/params/ignore.image.scaling.xml @@ -0,0 +1,23 @@ +<refentry id="ignore.image.scaling"> +<refmeta> +<refentrytitle>ignore.image.scaling</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ignore.image.scaling</refname> +<refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='ignore.image.scaling.frag'> +<xsl:param name="ignore.image.scaling" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, the scaling attributes on graphics and media objects are +ignored.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/img.src.path.xml b/kdoctools/docbook/xsl/params/img.src.path.xml new file mode 100644 index 000000000..a99b0ff0e --- /dev/null +++ b/kdoctools/docbook/xsl/params/img.src.path.xml @@ -0,0 +1,30 @@ +<refentry id="img.src.path"> +<refmeta> +<refentrytitle>img.src.path</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>img.src.path</refname> +<refpurpose>Path to HTML image files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='img.src.path.frag'><xsl:param name="img.src.path"></xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Add a path prefix to each HTML +<sgmltag class="element">img</sgmltag> element's +<sgmltag class="attribute">src</sgmltag> attribute. +This path could relative to the directory where the HTML +files are created, or it could be an absolute URI. +The default value is empty. +Be sure to include a trailing slash if needed. +</para> +<para>This prefix is not applied to any filerefs that start +with "/" or contain "//:". +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/index.on.role.xml b/kdoctools/docbook/xsl/params/index.on.role.xml new file mode 100644 index 000000000..804c7de6a --- /dev/null +++ b/kdoctools/docbook/xsl/params/index.on.role.xml @@ -0,0 +1,43 @@ +<refentry id="index.on.role"> +<refmeta> +<refentrytitle>index.on.role</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.on.role</refname> +<refpurpose>Select indexterms based on role value</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='index.on.role.frag'> +<xsl:param name="index.on.role" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para> +If non-zero, +then an <sgmltag>index</sgmltag> element that has a +<sgmltag>role</sgmltag> attribute +value will contain only those <sgmltag>indexterm</sgmltag> +elements with a matching role value. +If an <sgmltag>index</sgmltag> has no <sgmltag>role</sgmltag> +attribute or it is blank, then the index will contain +all <sgmltag>indexterm</sgmltag>s in the current scope. +</para> +<para> +If <literal>index.on.role</literal> is zero, then the +<sgmltag>role</sgmltag> attribute has no effect +on selecting indexterms for an index. +</para> + +<para>If you are using DocBook version 4.3 or later, you should +use the <sgmltag>type</sgmltag> attribute instead of <sgmltag>role</sgmltag> +on <sgmltag>indexterm</sgmltag> and <sgmltag>index</sgmltag>, +and set the <parameter>index.on.type</parameter> to a nonzero +value. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/index.on.type.xml b/kdoctools/docbook/xsl/params/index.on.type.xml new file mode 100644 index 000000000..3c5df73fc --- /dev/null +++ b/kdoctools/docbook/xsl/params/index.on.type.xml @@ -0,0 +1,47 @@ +<refentry id="index.on.type"> +<refmeta> +<refentrytitle>index.on.type</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.on.type</refname> +<refpurpose>Select indexterms based on <sgmltag>type</sgmltag> +attribute value</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='index.on.type.frag'> +<xsl:param name="index.on.type" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para> +If non-zero, +then an <sgmltag>index</sgmltag> element that has a +<sgmltag>type</sgmltag> attribute +value will contain only those <sgmltag>indexterm</sgmltag> +elements with a matching <sgmltag>type</sgmltag> attribute value. +If an <sgmltag>index</sgmltag> has no <sgmltag>type</sgmltag> +attribute or it is blank, then the index will contain +all <sgmltag>indexterm</sgmltag>s in the current scope. +</para> + +<para> +If <literal>index.on.type</literal> is zero, then the +<sgmltag>type</sgmltag> attribute has no effect +on selecting indexterms for an index. +</para> + +<para>For those using DocBook version 4.2 or earlier, +the <sgmltag>type</sgmltag> attribute is not available +for index terms. However, you can achieve the same +effect by using the <sgmltag>role</sgmltag> attribute +in the same manner on <sgmltag>indexterm</sgmltag> +and <sgmltag>index</sgmltag>, and setting the stylesheet parameter +<parameter>index.on.role</parameter> to a nonzero value. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/index.prefer.titleabbrev.xml b/kdoctools/docbook/xsl/params/index.prefer.titleabbrev.xml new file mode 100644 index 000000000..a3d735974 --- /dev/null +++ b/kdoctools/docbook/xsl/params/index.prefer.titleabbrev.xml @@ -0,0 +1,23 @@ +<refentry id="index.prefer.titleabbrev"> +<refmeta> +<refentrytitle>index.prefer.titleabbrev</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.prefer.titleabbrev</refname> +<refpurpose>Should be abbreviated titles used as back references</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='index.prefer.titleabbrev.frag'> +<xsl:param name="index.prefer.titleabbrev" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME: +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/index.preferred.page.properties.xml b/kdoctools/docbook/xsl/params/index.preferred.page.properties.xml new file mode 100644 index 000000000..994e4aab7 --- /dev/null +++ b/kdoctools/docbook/xsl/params/index.preferred.page.properties.xml @@ -0,0 +1,26 @@ +<refentry id="index.preferred.page.properties"> +<refnamediv> +<refname>index.preferred.page.properties</refname> +<refpurpose>Properties used to emphasize page number references for +significant index terms</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='index.preferred.page.properties.frag'> +<xsl:attribute-set name="index.preferred.page.properties"> + <xsl:attribute name="font-weight">bold</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Properties used to emphasize page number references for +significant index terms (<sgmltag +class="attribute">significance</sgmltag>=<sgmltag +class="attvalue">preffered</sgmltag>). Currently works only with +XEP.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/informal.object.properties.xml b/kdoctools/docbook/xsl/params/informal.object.properties.xml new file mode 100644 index 000000000..6092cc083 --- /dev/null +++ b/kdoctools/docbook/xsl/params/informal.object.properties.xml @@ -0,0 +1,20 @@ +<refentry id="informal.object.properties"> +<refnamediv> +<refname>informal.object.properties</refname> +<refpurpose>Properties associated with a formal object such as a figure, or other component that has a title</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='informal.object.properties.frag'><xsl:attribute-set name="informal.object.properties"> + <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.maximum">2em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.maximum">2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsect1><title>Description</title> +<para>The styling for informal objects in docbook. Specify the spacing before and after the object.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/informalequation.properties.xml b/kdoctools/docbook/xsl/params/informalequation.properties.xml new file mode 100644 index 000000000..8843b9b3f --- /dev/null +++ b/kdoctools/docbook/xsl/params/informalequation.properties.xml @@ -0,0 +1,18 @@ +<refentry id="informalequation.properties"> +<refnamediv> +<refname>informalequation.properties</refname> +<refpurpose>Properties associated with a informalequation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='informalequation.properties.frag'> +<xsl:attribute-set name="informalequation.properties" use-attribute-sets="informal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for informalequations.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/informalexample.properties.xml b/kdoctools/docbook/xsl/params/informalexample.properties.xml new file mode 100644 index 000000000..e541ce35a --- /dev/null +++ b/kdoctools/docbook/xsl/params/informalexample.properties.xml @@ -0,0 +1,18 @@ +<refentry id="informalexample.properties"> +<refnamediv> +<refname>informalexample.properties</refname> +<refpurpose>Properties associated with an informalexample</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='informalexample.properties.frag'> +<xsl:attribute-set name="informalexample.properties" use-attribute-sets="informal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for informalexamples.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/informalfigure.properties.xml b/kdoctools/docbook/xsl/params/informalfigure.properties.xml new file mode 100644 index 000000000..28a1a0e7f --- /dev/null +++ b/kdoctools/docbook/xsl/params/informalfigure.properties.xml @@ -0,0 +1,18 @@ +<refentry id="informalfigure.properties"> +<refnamediv> +<refname>informalfigure.properties</refname> +<refpurpose>Properties associated with an informalfigure</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='informalfigure.properties.frag'> +<xsl:attribute-set name="informalfigure.properties" use-attribute-sets="informal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for informalfigures.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/informaltable.properties.xml b/kdoctools/docbook/xsl/params/informaltable.properties.xml new file mode 100644 index 000000000..ab9a19540 --- /dev/null +++ b/kdoctools/docbook/xsl/params/informaltable.properties.xml @@ -0,0 +1,24 @@ +<refentry id="informaltable.properties"> +<refnamediv> +<refname>informaltable.properties</refname> +<refpurpose>Properties associated with the block surrounding an informaltable</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='informaltable.properties.frag'> +<xsl:attribute-set name="informaltable.properties" + use-attribute-sets="informal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Block styling properties for informaltables. This parameter should really +have been called <literal>informaltable.block.properties</literal> or something +like that, but we’re leaving it to avoid backwards-compatibility +problems.</para> + +<para>See also <parameter>table.table.properties</parameter>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/inherit.keywords.xml b/kdoctools/docbook/xsl/params/inherit.keywords.xml new file mode 100644 index 000000000..fd4152947 --- /dev/null +++ b/kdoctools/docbook/xsl/params/inherit.keywords.xml @@ -0,0 +1,25 @@ +<refentry id="inherit.keywords"> +<refmeta> +<refentrytitle>inherit.keywords</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>inherit.keywords</refname> +<refpurpose>Inherit keywords from ancestor elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='inherit.keywords.frag'><xsl:param name="inherit.keywords" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>inherit.keywords</parameter> +is non-zero, the keyword <sgmltag>META</sgmltag> for each HTML +<sgmltag>HEAD</sgmltag> element will include all of the keywords from +ancestral elements. Otherwise, only the keywords from the current section +will be used. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/insert.olink.page.number.xml b/kdoctools/docbook/xsl/params/insert.olink.page.number.xml new file mode 100644 index 000000000..13f8b4636 --- /dev/null +++ b/kdoctools/docbook/xsl/params/insert.olink.page.number.xml @@ -0,0 +1,75 @@ +<refentry id="insert.olink.page.number"> +<refmeta> +<refentrytitle>insert.olink.page.number</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>insert.olink.page.number</refname> +<refpurpose>Turns page numbers in olinks on and off</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='insert.olink.page.number.frag'> +<xsl:param name="insert.olink.page.number">no</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The value of this parameter determines if +cross references made between documents with +<sgmltag>olink</sgmltag> will +include page number citations. +In most cases this is only applicable to references in printed output. +</para> +<para>The parameter has three possible values. +</para> +<variablelist> +<varlistentry> +<term>no</term> +<listitem><para>No page number references will be generated for olinks. +</para></listitem> +</varlistentry> +<varlistentry> +<term>yes</term> +<listitem><para>Page number references will be generated +for all <sgmltag>olink</sgmltag> references. +The style of page reference may be changed +if an <sgmltag class="attribute">xrefstyle</sgmltag> +attribute is used. +</para></listitem> +</varlistentry> +<varlistentry> +<term>maybe</term> +<listitem><para>Page number references will not be generated +for an <sgmltag>olink</sgmltag> element unless +it has an +<sgmltag class="attribute">xrefstyle</sgmltag> +attribute whose value specifies a page reference. +</para></listitem> +</varlistentry> +</variablelist> +<para>Olinks that point to targets within the same document +are treated as <sgmltag>xref</sgmltag>s, and controlled by +the <parameter>insert.xref.page.number</parameter> parameter. +</para> + +<para>Page number references for olinks to +external documents can only be inserted if the +information exists in the olink database. +This means each olink target element +(<sgmltag>div</sgmltag> or <sgmltag>obj</sgmltag>) +must have a <sgmltag class="attribute">page</sgmltag> attribute +whose value is its page number in the target document. +The XSL stylesheets are not able to extract that information +during processing because pages have not yet been created in +XSLT transformation. Only the XSL-FO processor knows what +page each element is placed on. +Therefore some postprocessing must take place to populate +page numbers in the olink database. +</para> + + + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/insert.olink.pdf.frag.xml b/kdoctools/docbook/xsl/params/insert.olink.pdf.frag.xml new file mode 100644 index 000000000..8939f2798 --- /dev/null +++ b/kdoctools/docbook/xsl/params/insert.olink.pdf.frag.xml @@ -0,0 +1,63 @@ +<refentry id="insert.olink.pdf.frag"> +<refmeta> +<refentrytitle>insert.olink.pdf.frag</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>insert.olink.pdf.frag</refname> +<refpurpose>Add fragment identifiers for links into PDF files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='insert.olink.pdf.frag.frag'> +<xsl:param name="insert.olink.pdf.frag" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The value of this parameter determines whether +the cross reference URIs to PDF documents made with +<sgmltag>olink</sgmltag> will +include fragment identifiers. +</para> + +<para>When forming a URI to link to a PDF document, +a fragment identifier (typically a '#' followed by an +id value) appended to the PDF filename can be used by +the PDF viewer to open +the PDF file to a location within the document instead of +the first page. +However, not all PDF files have id +values embedded in them, and not all PDF viewers can +handle fragment identifiers. +</para> + +<para>If <parameter>insert.olink.pdf.frag</parameter> is set +to a non-zero value, then any olink targeting a +PDF file will have the fragment identifier appended to the URI. +The URI is formed by concatenating the value of the +<parameter>olink.base.uri</parameter> parameter, the +value of the <sgmltag class="attribute">baseuri</sgmltag> +attribute from the <sgmltag class="element">document</sgmltag> +element in the olink database with the matching +<sgmltag class="attribute">targetdoc</sgmltag> value, +and the value of the <sgmltag class="attribute">href</sgmltag> +attribute for the targeted element in the olink database. +The <sgmltag class="attribute">href</sgmltag> attribute +contains the fragment identifier. +</para> + +<para>If <parameter>insert.olink.pdf.frag</parameter> is set +to zero (the default value), then +the <sgmltag class="attribute">href</sgmltag> attribute +from the olink database +is not appended to PDF olinks, so the fragment identifier is left off. +A PDF olink is any olink for which the +<sgmltag class="attribute">baseuri</sgmltag> attribute +from the matching <sgmltag class="element">document</sgmltag> +element in the olink database ends with '.pdf'. +Any other olinks will still have the fragment identifier added. +</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/insert.xref.page.number.xml b/kdoctools/docbook/xsl/params/insert.xref.page.number.xml new file mode 100644 index 000000000..c1b814778 --- /dev/null +++ b/kdoctools/docbook/xsl/params/insert.xref.page.number.xml @@ -0,0 +1,52 @@ +<refentry id="insert.xref.page.number"> +<refmeta> +<refentrytitle>insert.xref.page.number</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>insert.xref.page.number</refname> +<refpurpose>Turns page numbers in xrefs on and off</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='insert.xref.page.number.frag'> +<xsl:param name="insert.xref.page.number">no</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The value of this parameter determines if +cross references (<sgmltag>xref</sgmltag>s) in +printed output will +include page number citations. +It has three possible values. +</para> +<variablelist> +<varlistentry> +<term>no</term> +<listitem><para>No page number references will be generated. +</para></listitem> +</varlistentry> +<varlistentry> +<term>yes</term> +<listitem><para>Page number references will be generated +for all <sgmltag>xref</sgmltag> elements. +The style of page reference may be changed +if an <sgmltag class="attribute">xrefstyle</sgmltag> +attribute is used. +</para></listitem> +</varlistentry> +<varlistentry> +<term>maybe</term> +<listitem><para>Page number references will not be generated +for an <sgmltag>xref</sgmltag> element unless +it has an +<sgmltag class="attribute">xrefstyle</sgmltag> +attribute whose value specifies a page reference. +</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/l10n.gentext.default.language.xml b/kdoctools/docbook/xsl/params/l10n.gentext.default.language.xml new file mode 100644 index 000000000..9420c0b77 --- /dev/null +++ b/kdoctools/docbook/xsl/params/l10n.gentext.default.language.xml @@ -0,0 +1,24 @@ +<refentry id="l10n.gentext.default.language"> +<refmeta> +<refentrytitle>l10n.gentext.default.language</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>l10n.gentext.default.language</refname> +<refpurpose>Sets the default language for generated text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='l10n.gentext.default.language.frag'> +<xsl:param name="l10n.gentext.default.language" select="'en'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The value of the <parameter>l10n.gentext.default.language</parameter> +parameter is used as the language for generated text if no setting is provided +in the source document.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/l10n.gentext.language.xml b/kdoctools/docbook/xsl/params/l10n.gentext.language.xml new file mode 100644 index 000000000..cb5d90ea8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/l10n.gentext.language.xml @@ -0,0 +1,28 @@ +<refentry id="l10n.gentext.language"> +<refmeta> +<refentrytitle>l10n.gentext.language</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>l10n.gentext.language</refname> +<refpurpose>Sets the gentext language</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='l10n.gentext.language.frag'> +<xsl:param name="l10n.gentext.language" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If this parameter is set to any value other than the empty string, its +value will be used as the value for the language when generating text. Setting +<parameter>l10n.gentext.language</parameter> overrides any settings within the +document being formatted.</para> + +<para>It's much more likely that you might want to set the +<parameter>l10n.gentext.default.language</parameter> parameter.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/l10n.gentext.use.xref.language.xml b/kdoctools/docbook/xsl/params/l10n.gentext.use.xref.language.xml new file mode 100644 index 000000000..5554de082 --- /dev/null +++ b/kdoctools/docbook/xsl/params/l10n.gentext.use.xref.language.xml @@ -0,0 +1,48 @@ +<refentry id="l10n.gentext.use.xref.language"> +<refmeta> +<refentrytitle>l10n.gentext.use.xref.language</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>l10n.gentext.use.xref.language</refname> +<refpurpose>Use the language of target when generating cross-reference text?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='l10n.gentext.use.xref.language.frag'> +<xsl:param name="l10n.gentext.use.xref.language" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, the language of the target will be used when +generating cross reference text. Usually, the <quote>current</quote> +language is used when generating text (that is, the language of the +element that contains the cross-reference element). But setting this parameter +allows the language of the element <emphasis>pointed to</emphasis> to control +the generated text.</para> + +<para>Consider the following example:</para> + +<informalexample> +<programlisting><![CDATA[<para lang="en">See also <xref linkend="chap3"/>.</para>]]> +</programlisting> +</informalexample> + +<para>Suppose that Chapter 3 happens to be written in German. +If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the +resulting text will be something like this:</para> + +<blockquote> +<para>See also Kapital 3.</para> +</blockquote> + +<para>Where the more traditional rendering would be:</para> + +<blockquote> +<para>See also Chapter 3.</para> +</blockquote> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/label.from.part.xml b/kdoctools/docbook/xsl/params/label.from.part.xml new file mode 100644 index 000000000..b4866ca41 --- /dev/null +++ b/kdoctools/docbook/xsl/params/label.from.part.xml @@ -0,0 +1,25 @@ +<refentry id="label.from.part"> +<refmeta> +<refentrytitle>label.from.part</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>label.from.part</refname> +<refpurpose>Renumber chapters in each part?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='label.from.part.frag'><xsl:param name="label.from.part" select="'0'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>label.from.part</parameter> is non-zero, components +(<sgmltag>chapter</sgmltag>s, <sgmltag>appendixe</sgmltag>s, etc.) +will be numbered from 1 in each <sgmltag>part</sgmltag>. Otherwise, +they will be numbered monotonically throughout each +<sgmltag>book</sgmltag>. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/line-height.xml b/kdoctools/docbook/xsl/params/line-height.xml new file mode 100644 index 000000000..7bb6e639a --- /dev/null +++ b/kdoctools/docbook/xsl/params/line-height.xml @@ -0,0 +1,22 @@ +<refentry id="line-height"> +<refmeta> +<refentrytitle>line-height</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>line-height</refname> +<refpurpose>Specify the line-height property</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='line-height.frag'> +<xsl:param name="line-height" select="'normal'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Sets the line-height property.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/linenumbering.everyNth.xml b/kdoctools/docbook/xsl/params/linenumbering.everyNth.xml new file mode 100644 index 000000000..b28848007 --- /dev/null +++ b/kdoctools/docbook/xsl/params/linenumbering.everyNth.xml @@ -0,0 +1,21 @@ +<refentry id="linenumbering.everyNth"> +<refmeta> +<refentrytitle>linenumbering.everyNth</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.everyNth</refname> +<refpurpose>Indicate which lines should be numbered</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='linenumbering.everyNth.frag'><xsl:param name="linenumbering.everyNth" select="'5'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If line numbering is enabled, everyNth line will be numbered. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/linenumbering.extension.xml b/kdoctools/docbook/xsl/params/linenumbering.extension.xml new file mode 100644 index 000000000..b9322dd1e --- /dev/null +++ b/kdoctools/docbook/xsl/params/linenumbering.extension.xml @@ -0,0 +1,24 @@ +<refentry id="linenumbering.extension"> +<refmeta> +<refentrytitle>linenumbering.extension</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.extension</refname> +<refpurpose>Enable the line numbering extension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='linenumbering.extension.frag'><xsl:param name="linenumbering.extension" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, verbatim environments (elements that have the +format='linespecific' notation attribute: address, literallayout, +programlisting, screen, synopsis) that specify line numbering will +have, surprise, line numbers. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/linenumbering.separator.xml b/kdoctools/docbook/xsl/params/linenumbering.separator.xml new file mode 100644 index 000000000..1e81b5b94 --- /dev/null +++ b/kdoctools/docbook/xsl/params/linenumbering.separator.xml @@ -0,0 +1,22 @@ +<refentry id="linenumbering.separator"> +<refmeta> +<refentrytitle>linenumbering.separator</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.separator</refname> +<refpurpose>Specify a separator between line numbers and lines</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='linenumbering.separator.frag'><xsl:param name="linenumbering.separator" select="' '"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The separator is inserted between line numbers and lines in +the verbatim environment. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/linenumbering.width.xml b/kdoctools/docbook/xsl/params/linenumbering.width.xml new file mode 100644 index 000000000..3571487d6 --- /dev/null +++ b/kdoctools/docbook/xsl/params/linenumbering.width.xml @@ -0,0 +1,22 @@ +<refentry id="linenumbering.width"> +<refmeta> +<refentrytitle>linenumbering.width</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>linenumbering.width</refname> +<refpurpose>Indicates the width of line numbers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='linenumbering.width.frag'><xsl:param name="linenumbering.width" select="'3'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If line numbering is enabled, line numbers will appear right +justified in a field "width" characters wide. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/link.mailto.url.xml b/kdoctools/docbook/xsl/params/link.mailto.url.xml new file mode 100644 index 000000000..c7e7fecd8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/link.mailto.url.xml @@ -0,0 +1,22 @@ +<refentry id="link.mailto.url"> +<refmeta> +<refentrytitle>link.mailto.url</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>link.mailto.url</refname> +<refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='link.mailto.url.frag'><xsl:param name="link.mailto.url"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If not the empty string, this address will be used for the +REL=made <sgmltag>LINK</sgmltag> element in the HTML <sgmltag>HEAD</sgmltag>. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/list.block.spacing.xml b/kdoctools/docbook/xsl/params/list.block.spacing.xml new file mode 100644 index 000000000..14a212913 --- /dev/null +++ b/kdoctools/docbook/xsl/params/list.block.spacing.xml @@ -0,0 +1,20 @@ +<refentry id="list.block.spacing"> +<refnamediv> +<refname>list.block.spacing</refname> +<refpurpose>What spacing do you want before and after lists?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='list.block.spacing.frag'><xsl:attribute-set name="list.block.spacing"> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsect1><title>Description</title> +<para>Specify the spacing required before and after a list. It is necessary to specify the space after a list block because lists can come inside of paras. </para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/list.item.spacing.xml b/kdoctools/docbook/xsl/params/list.item.spacing.xml new file mode 100644 index 000000000..1ae484e9f --- /dev/null +++ b/kdoctools/docbook/xsl/params/list.item.spacing.xml @@ -0,0 +1,17 @@ +<refentry id="list.item.spacing"> +<refnamediv> +<refname>list.item.spacing</refname> +<refpurpose>What space do you want between list items?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='list.item.spacing.frag'><xsl:attribute-set name="list.item.spacing"> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsect1><title>Description</title> +<para>Specify what spacing you want between each list item.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/make.graphic.viewport.xml b/kdoctools/docbook/xsl/params/make.graphic.viewport.xml new file mode 100644 index 000000000..1d3a25b50 --- /dev/null +++ b/kdoctools/docbook/xsl/params/make.graphic.viewport.xml @@ -0,0 +1,30 @@ +<refentry id="make.graphic.viewport"> +<refmeta> +<refentrytitle>make.graphic.viewport</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.graphic.viewport</refname> +<refpurpose>Use tables in HTML to make viewports for graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='make.graphic.viewport.frag'> +<xsl:param name="make.graphic.viewport" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The HTML <sgmltag>img</sgmltag> element only supports the notion +of content-area scaling; it doesn't support the distinction between a +content-area and a viewport-area, so we have to make some compromises.</para> + +<para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table +will be used to frame the image. This creates an effective viewport-area. +</para> + +<para>Tables and alignment don't work together, so this parameter is ignored +if alignment is specified on an image.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/make.index.markup.xml b/kdoctools/docbook/xsl/params/make.index.markup.xml new file mode 100644 index 000000000..eec982b36 --- /dev/null +++ b/kdoctools/docbook/xsl/params/make.index.markup.xml @@ -0,0 +1,68 @@ +<refentry id="make.index.markup"> +<refmeta> +<refentrytitle>make.index.markup</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.index.markup</refname> +<refpurpose>Generate XML index markup in the index?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='make.index.markup.frag'> +<xsl:param name="make.index.markup" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter enables a very neat trick for getting properly +merged, collated back-of-the-book indexes. G. Ken Holman suggested +this trick at Extreme Markup Languages 2002 and I'm indebted to him +for it.</para> + +<para>Jeni Tennison's excellent code in +<filename>autoidx.xsl</filename> does a great job of merging and +sorting <sgmltag>indexterm</sgmltag>s in the document and building a +back-of-the-book index. However, there's one thing that it cannot +reasonably be expected to do: merge page numbers into ranges. (I would +not have thought that it could collate and suppress duplicate page +numbers, but in fact it appears to manage that task somehow.)</para> + +<para>Ken's trick is to produce a document in which the index at the +back of the book is <quote>displayed</quote> in XML. Because the index +is generated by the FO processor, all of the page numbers have been resolved. +It's a bit hard to explain, but what it boils down to is that instead of having +an index at the back of the book that looks like this:</para> + +<blockquote> +<formalpara><title>A</title> +<para>ap1, 1, 2, 3</para> +</formalpara> +</blockquote> + +<para>you get one that looks like this:</para> + +<blockquote> +<programlisting><![CDATA[<indexdiv>A</indexdiv> +<indexentry> +<primaryie>ap1</primaryie>, +<phrase role="pageno">1</phrase>, +<phrase role="pageno">2</phrase>, +<phrase role="pageno">3</phrase> +</indexentry>]]></programlisting> +</blockquote> + +<para>After building a PDF file with this sort of odd-looking index, you can +extract the text from the PDF file and the result is a proper index expressed in +XML.</para> + +<para>Now you have data that's amenable to processing and a simple Perl script +(such as <filename>fo/pdf2index</filename>) can +merge page ranges and generate a proper index.</para> + +<para>Finally, reformat your original document using this literal index instead of +an automatically generated one and <quote>bingo</quote>!</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/make.single.year.ranges.xml b/kdoctools/docbook/xsl/params/make.single.year.ranges.xml new file mode 100644 index 000000000..bf2af8e9e --- /dev/null +++ b/kdoctools/docbook/xsl/params/make.single.year.ranges.xml @@ -0,0 +1,22 @@ +<refentry id="make.single.year.ranges"> +<refmeta> +<refentrytitle>make.single.year.ranges</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.single.year.ranges</refname> +<refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='make.single.year.ranges.frag'><xsl:param name="make.single.year.ranges" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, year ranges that span a single year will be printed +in range notation (1998-1999) instead of discrete notation +(1998, 1999).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/make.valid.html.xml b/kdoctools/docbook/xsl/params/make.valid.html.xml new file mode 100644 index 000000000..d73a1881a --- /dev/null +++ b/kdoctools/docbook/xsl/params/make.valid.html.xml @@ -0,0 +1,30 @@ +<refentry id="make.valid.html"> +<refmeta> +<refentrytitle>make.valid.html</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.valid.html</refname> +<refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='make.valid.html.frag'> +<xsl:param name="make.valid.html" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>make.valid.html</parameter> is true, the stylesheets take +extra effort to ensure that the resulting HTML is valid. This may mean that some +<sgmltag>para</sgmltag> tags are translated into HTML <sgmltag>div</sgmltag>s or +that other substitutions occur.</para> + +<para>This parameter is different from <parameter>html.cleanup</parameter> +because it changes the resulting markup; it does not use extension functions +to manipulate result-tree-fragments and is therefore applicable to any +XSLT processor.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/make.year.ranges.xml b/kdoctools/docbook/xsl/params/make.year.ranges.xml new file mode 100644 index 000000000..17f80876e --- /dev/null +++ b/kdoctools/docbook/xsl/params/make.year.ranges.xml @@ -0,0 +1,20 @@ +<refentry id="make.year.ranges"> +<refmeta> +<refentrytitle>make.year.ranges</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>make.year.ranges</refname> +<refpurpose>Collate copyright years into ranges?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='make.year.ranges.frag'><xsl:param name="make.year.ranges" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, copyright years will be collated into ranges.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/manifest.in.base.dir.xml b/kdoctools/docbook/xsl/params/manifest.in.base.dir.xml new file mode 100644 index 000000000..a13a5c674 --- /dev/null +++ b/kdoctools/docbook/xsl/params/manifest.in.base.dir.xml @@ -0,0 +1,25 @@ +<refentry id="manifest.in.base.dir"> +<refmeta> +<refentrytitle>manifest.in.base.dir</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>manifest.in.base.dir</refname> +<refpurpose>Should be manifest file written in $base.dir?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='manifest.in.base.dir.frag'> +<xsl:param name="manifest.in.base.dir" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero manifest file and project files for HTML Help and +Eclipse Help are written into <parameter>base.dir</parameter> instead +of current directory.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/manifest.xml b/kdoctools/docbook/xsl/params/manifest.xml new file mode 100644 index 000000000..4022d9ce7 --- /dev/null +++ b/kdoctools/docbook/xsl/params/manifest.xml @@ -0,0 +1,23 @@ +<refentry id="manifest"> + <refmeta> + <refentrytitle>manifest</refentrytitle> + <refmiscinfo role="type">string</refmiscinfo> + </refmeta> + <refnamediv> + <refname>manifest</refname> + <refpurpose>Name of manifest file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <src:fragment id='manifest.frag' + ><xsl:param name="manifest" select="'HTML.manifest'"/></src:fragment> + </refsynopsisdiv> + + <refsect1><title>Description</title> + + <para>The name of the file to which a manifest is written (if the + value of the <parameter>generate.manifest</parameter> parameter + is non-zero).</para> + + </refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/manual.toc.xml b/kdoctools/docbook/xsl/params/manual.toc.xml new file mode 100644 index 000000000..760e612cb --- /dev/null +++ b/kdoctools/docbook/xsl/params/manual.toc.xml @@ -0,0 +1,24 @@ +<refentry id="manual.toc"> +<refmeta> +<refentrytitle>manual.toc</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>manual.toc</refname> +<refpurpose>An explicit TOC to be used for the TOC</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='manual.toc.frag'> +<xsl:param name="manual.toc" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>manual.toc</parameter> identifies an explicit TOC that +will be used for building the printed TOC. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/marker.section.level.xml b/kdoctools/docbook/xsl/params/marker.section.level.xml new file mode 100644 index 000000000..b944f9caf --- /dev/null +++ b/kdoctools/docbook/xsl/params/marker.section.level.xml @@ -0,0 +1,45 @@ +<refentry id="marker.section.level"> +<refmeta> +<refentrytitle>marker.section.level</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>marker.section.level</refname> +<refpurpose>Control depth of sections shown in running headers or footers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='marker.section.level.frag'> +<xsl:param name="marker.section.level" select="2"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>marker.section.level</parameter> parameter +controls the depth of section levels that may be displayed +in running headers and footers. For example, if the value +is 2 (the default), then titles from <sgmltag>sect1</sgmltag> and +<sgmltag>sect2</sgmltag> or equivalent <sgmltag>section</sgmltag> +elements are candidates for use in running headers and +footers. +</para> +<para>Each candidate title is marked in the FO output with a +<sgmltag><fo:marker marker-class-name="section.head.marker"></sgmltag> +element. +</para> +<para>In order for such titles to appear in headers +or footers, the <literal>header.content</literal> +or <literal>footer.content</literal> template +must be customized to retrieve the marker using +an output element such as: +</para> +<programlisting> +<fo:retrieve-marker retrieve-class-name="section.head.marker" + retrieve-position="first-including-carryover" + retrieve-boundary="page-sequence"/> +</programlisting> + + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/menuchoice.menu.separator.xml b/kdoctools/docbook/xsl/params/menuchoice.menu.separator.xml new file mode 100644 index 000000000..2ed337ce1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/menuchoice.menu.separator.xml @@ -0,0 +1,27 @@ +<refentry id="menuchoice.menu.separator"> +<refmeta> +<refentrytitle>menuchoice.menu.separator</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>menuchoice.menu.separator</refname> +<refpurpose>Separator between items of a <sgmltag>menuchoice</sgmltag> +with <sgmltag>guimenuitem</sgmltag> or +<sgmltag>guisubmenu</sgmltag></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='menuchoice.menu.separator.frag'> +<xsl:param name="menuchoice.menu.separator" select="'->'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Separator used to connect items of a <sgmltag>menuchoice</sgmltag> with +<sgmltag>guimenuitem</sgmltag> or <sgmltag>guisubmenu</sgmltag>. Other elements +are linked with <parameter>menuchoice.separator</parameter>. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/menuchoice.separator.xml b/kdoctools/docbook/xsl/params/menuchoice.separator.xml new file mode 100644 index 000000000..3d3fb1662 --- /dev/null +++ b/kdoctools/docbook/xsl/params/menuchoice.separator.xml @@ -0,0 +1,27 @@ +<refentry id="menuchoice.separator"> +<refmeta> +<refentrytitle>menuchoice.separator</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>menuchoice.separator</refname> +<refpurpose>Separator between items of a <sgmltag>menuchoice</sgmltag> +other than <sgmltag>guimenuitem</sgmltag> and +<sgmltag>guisubmenu</sgmltag></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='menuchoice.separator.frag'> +<xsl:param name="menuchoice.separator" select="'+'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Separator used to connect items of a <sgmltag>menuchoice</sgmltag> other +than <sgmltag>guimenuitem</sgmltag> and <sgmltag>guisubmenu</sgmltag>. The latter +elements are linked with <parameter>menuchoice.menu.separator</parameter>. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/monospace.font.family.xml b/kdoctools/docbook/xsl/params/monospace.font.family.xml new file mode 100644 index 000000000..d14bd1e3a --- /dev/null +++ b/kdoctools/docbook/xsl/params/monospace.font.family.xml @@ -0,0 +1,24 @@ +<refentry id="monospace.font.family"> +<refmeta> +<refentrytitle>monospace.font.family</refentrytitle> + +</refmeta> +<refnamediv> +<refname>monospace.font.family</refname> +<refpurpose>The default font family for monospace environments</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='monospace.font.family.frag'> +<xsl:param name="monospace.font.family" select="'monospace'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The monospace font family is used for verbatim environments +(program listings, screens, etc.). +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/monospace.properties.xml b/kdoctools/docbook/xsl/params/monospace.properties.xml new file mode 100644 index 000000000..c06687998 --- /dev/null +++ b/kdoctools/docbook/xsl/params/monospace.properties.xml @@ -0,0 +1,33 @@ +<refentry id="monospace.properties"> +<refmeta> +<refentrytitle>monospace.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>monospace.properties</refname> +<refpurpose>Properties of monospaced content</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='monospace.properties.frag'> +<xsl:attribute-set name="monospace.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$monospace.font.family"/> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the font name for monospaced output. This property set +used to set the font-size as well, but that doesn't work very well +when different fonts are used (as they are in titles and paragraphs, +for example).</para> + +<para>If you want to set the font-size in a customization layer, it's +probably going to be more appropriate to set font-size-adjust, if your +formatter supports it.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/monospace.verbatim.properties.xml b/kdoctools/docbook/xsl/params/monospace.verbatim.properties.xml new file mode 100644 index 000000000..228be1a4e --- /dev/null +++ b/kdoctools/docbook/xsl/params/monospace.verbatim.properties.xml @@ -0,0 +1,18 @@ +<refentry id="monospace.verbatim.properties"> +<refnamediv> +<refname>monospace.verbatim.properties</refname> +<refpurpose>What font and size do you want for monospaced content?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='monospace.verbatim.properties.frag'> +<xsl:attribute-set name="monospace.verbatim.properties" use-attribute-sets="verbatim.properties monospace.properties"> + <xsl:attribute name="text-align">start</xsl:attribute> + <xsl:attribute name="wrap-option">no-wrap</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> +<refsect1><title>Description</title> +<para>Specify the font name and size you want for monospaced output</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/navig.graphics.extension.xml b/kdoctools/docbook/xsl/params/navig.graphics.extension.xml new file mode 100644 index 000000000..833a1061b --- /dev/null +++ b/kdoctools/docbook/xsl/params/navig.graphics.extension.xml @@ -0,0 +1,21 @@ +<refentry id="navig.graphics.extension"> +<refmeta> +<refentrytitle>navig.graphics.extension</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.graphics.extension</refname> +<refpurpose>Extension for navigational graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='navig.graphics.extension.frag'><xsl:param name="navig.graphics.extension" select="'.gif'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Sets the filename extension to use on navigational graphics used +in the headers and footers of chunked HTML.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/navig.graphics.path.xml b/kdoctools/docbook/xsl/params/navig.graphics.path.xml new file mode 100644 index 000000000..3a36a41a5 --- /dev/null +++ b/kdoctools/docbook/xsl/params/navig.graphics.path.xml @@ -0,0 +1,23 @@ +<refentry id="navig.graphics.path"> +<refmeta> +<refentrytitle>navig.graphics.path</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.graphics.path</refname> +<refpurpose>Path to navigational graphics</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='navig.graphics.path.frag'><xsl:param name="navig.graphics.path">images/</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Sets the path, probably relative to the directory where the HTML +files are created, to the navigational graphics used in the +headers and footers of chunked HTML. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/navig.graphics.xml b/kdoctools/docbook/xsl/params/navig.graphics.xml new file mode 100644 index 000000000..fa83f3efc --- /dev/null +++ b/kdoctools/docbook/xsl/params/navig.graphics.xml @@ -0,0 +1,24 @@ +<refentry id="navig.graphics"> +<refmeta> +<refentrytitle>navig.graphics</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.graphics</refname> +<refpurpose>Use graphics in navigational headers and footers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='navig.graphics.frag'><xsl:param name="navig.graphics" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), the navigational headers and footers in chunked +HTML are presented in an alternate style that uses +graphical icons for Next, Previous, Up, and Home. +Default graphics are provided in the distribution. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/navig.showtitles.xml b/kdoctools/docbook/xsl/params/navig.showtitles.xml new file mode 100644 index 000000000..aa40588e0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/navig.showtitles.xml @@ -0,0 +1,27 @@ +<refentry id="navig.showtitles"> +<refmeta> +<refentrytitle>navig.showtitles</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>navig.showtitles</refname> +<refpurpose>Display titles in HTML headers and footers?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='navig.showtitles.frag'><xsl:param name="navig.showtitles">1</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), +the headers and footers of chunked HTML +display the titles of the next and previous chunks, +along with the words 'Next' and 'Previous' (or the +equivalent graphical icons if navig.graphics is true). +If false (zero), then only the words 'Next' and 'Previous' +(or the icons) are displayed. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/nominal.image.depth.xml b/kdoctools/docbook/xsl/params/nominal.image.depth.xml new file mode 100644 index 000000000..ac4935b00 --- /dev/null +++ b/kdoctools/docbook/xsl/params/nominal.image.depth.xml @@ -0,0 +1,22 @@ +<refentry id="nominal.image.depth"> +<refmeta> +<refentrytitle>nominal.image.depth</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nominal.image.depth</refname> +<refpurpose>Nominal image depth</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='nominal.image.depth.frag'> +<xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>See <parameter>nominal.image.width</parameter>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/nominal.image.width.xml b/kdoctools/docbook/xsl/params/nominal.image.width.xml new file mode 100644 index 000000000..f630af9c0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/nominal.image.width.xml @@ -0,0 +1,38 @@ +<refentry id="nominal.image.width"> +<refmeta> +<refentrytitle>nominal.image.width</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nominal.image.width</refname> +<refpurpose>The nominal image width</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='nominal.image.width.frag'> +<xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Graphic widths expressed as a percentage are problematic. In the +following discussion, we speak of width and contentwidth, but +the same issues apply to depth and contentdepth.</para> + +<para>A width of 50% means "half of the available space for the image." +That's fine. But note that in HTML, this is a dynamic property and +the image size will vary if the browser window is resized.</para> + +<para>A contentwidth of 50% means "half of the actual image width". +But what does that mean if the stylesheets cannot assess the image's +actual size? Treating this as a width of 50% is one possibility, but +it produces behavior (dynamic scaling) that seems entirely out of +character with the meaning.</para> + +<para>Instead, the stylesheets define a +<parameter>nominal.image.width</parameter> and convert percentages to +actual values based on that nominal size.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/nominal.table.width.xml b/kdoctools/docbook/xsl/params/nominal.table.width.xml new file mode 100644 index 000000000..6abbf0b20 --- /dev/null +++ b/kdoctools/docbook/xsl/params/nominal.table.width.xml @@ -0,0 +1,23 @@ +<refentry id="nominal.table.width"> +<refmeta> +<refentrytitle>nominal.table.width</refentrytitle> +<refmiscinfo role="type">length</refmiscinfo> +</refmeta> +<refnamediv> +<refname>nominal.table.width</refname> +<refpurpose>The (absolute) nominal width of tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='nominal.table.width.frag'><xsl:param name="nominal.table.width" select="'6in'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>In order to convert CALS column widths into HTML column widths, it +is sometimes necessary to have an absolute table width to use for conversion +of mixed absolute and relative widths. This value must be an absolute +length (not a percentag).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/normal.para.spacing.xml b/kdoctools/docbook/xsl/params/normal.para.spacing.xml new file mode 100644 index 000000000..4e68217a1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/normal.para.spacing.xml @@ -0,0 +1,17 @@ +<refentry id="normal.para.spacing"> +<refnamediv> +<refname>normal.para.spacing</refname> +<refpurpose>What space do you want between normal paragraphs</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='normal.para.spacing.frag'><xsl:attribute-set name="normal.para.spacing"> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> +<refsect1><title>Description</title> +<para>Specify the spacing required between normal paragraphs</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/olink.base.uri.xml b/kdoctools/docbook/xsl/params/olink.base.uri.xml new file mode 100644 index 000000000..266030ec0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/olink.base.uri.xml @@ -0,0 +1,17 @@ +<refentry id="olink.base.uri"> +<refmeta> +<refentrytitle>olink.base.uri</refentrytitle> +<refmiscinfo role="type">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.base.uri</refname> +<refpurpose>Base URI used in olink hrefs</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment id="olink.base.uri.frag"> +<xsl:param name="olink.base.uri" select="''"/> </src:fragment> +</refsynopsisdiv> +<refsect1> +<title>Description</title> +<para>When cross reference data is collected for resolving olinks, it may be necessary to prepend a base URI to each target's href. This parameter lets you set that base URI when cross reference data is collected. This feature is needed when you want to link to a document that is processed without chunking. The output filename for such a document is not known to the XSL stylesheet; the only target information consists of fragment identifiers such as <literal>#idref</literal>. To enable the resolution of olinks between documents, you should pass the name of the HTML output file as the value of this parameter. Then the hrefs recorded in the cross reference data collection look like <literal>outfile.html#idref</literal>, which can be reached as links from other documents.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/olink.debug.xml b/kdoctools/docbook/xsl/params/olink.debug.xml new file mode 100644 index 000000000..318920a58 --- /dev/null +++ b/kdoctools/docbook/xsl/params/olink.debug.xml @@ -0,0 +1,31 @@ +<refentry id="olink.debug"> +<refmeta> +<refentrytitle>olink.debug</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.debug</refname> +<refpurpose>Turn on debugging messages for olinks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='olink.debug.frag'> +<xsl:param name="olink.debug" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, then each olink will generate several +messages about how it is being resolved during processing. +This is useful when an olink does not resolve properly +and the standard error messages are not sufficient to +find the problem. +</para> + +<para>You may need to read through the olink XSL templates +to understand the context for some of the debug messages. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/olink.doctitle.xml b/kdoctools/docbook/xsl/params/olink.doctitle.xml new file mode 100644 index 000000000..9493fb671 --- /dev/null +++ b/kdoctools/docbook/xsl/params/olink.doctitle.xml @@ -0,0 +1,137 @@ +<refentry id="olink.doctitle"> +<refmeta> +<refentrytitle>olink.doctitle</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.doctitle</refname> +<refpurpose>show the document title for external olinks?</refpurpose> + +</refnamediv> +<refsynopsisdiv> <src:fragment id="olink.doctitle.frag"> +<xsl:param name="olink.doctitle" select="no"/> </src:fragment> +</refsynopsisdiv> +<refsect1> +<title>Description</title> +<para>When olinks between documents are resolved, the generated text +may not make it clear that the reference is to another document. +It is possible for the stylesheets to append the other document's +title to external olinks. For this to happen, two parameters must +be set.</para> +<itemizedlist> +<listitem> +<para>This <parameter>olink.doctitle</parameter> parameter +should be set to either <literal>yes</literal> or <literal>maybe</literal> +to enable this feature. +</para> +</listitem> +<listitem> +<para>And you should also set the <parameter>current.docid</parameter> +parameter to the document id for the document currently +being processed for output. +</para> +</listitem> +</itemizedlist> + +<para> +Then if an olink's <literal>targetdoc</literal> id differs from +the <literal>current.docid</literal> value, the stylesheet knows +that it is a reference to another document and can +append the target document's +title to the generated olink text. </para> + +<para>The text for the target document's title is copied from the +olink database from the <sgmltag>ttl</sgmltag> element +of the top-level <sgmltag>div</sgmltag> for that document. +If that <sgmltag>ttl</sgmltag> element is missing or empty, +no title is output. +</para> + +<para>The supported values for <parameter>olink.doctitle</parameter> are: +</para> +<variablelist> +<varlistentry> +<term><literal>yes</literal></term> +<listitem> +<para> +Always insert the title to the target document if it is not +the current document. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>no</literal></term> +<listitem> +<para> +Never insert the title to the target document, even if requested +in an <sgmltag class="attribute">xrefstyle</sgmltag> attribute. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>maybe</literal></term> +<listitem> +<para> +Only insert the title to the target document, if requested +in an <sgmltag class="attribute">xrefstyle</sgmltag> attribute. +</para> +</listitem> +</varlistentry> +</variablelist> +<para>An <sgmltag class="attribute">xrefstyle</sgmltag> attribute +may override the global setting for individual olinks. +The following values are supported in an +<sgmltag class="attribute">xrefstyle</sgmltag> +attribute using the <literal>select:</literal> syntax: +</para> + +<variablelist> +<varlistentry> +<term><literal>docname</literal></term> +<listitem> +<para> +Insert the target document name for this olink using the +<literal>docname</literal> gentext template, but only +if the value of <parameter>olink.doctitle</parameter> +is not <literal>no</literal>. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>docnamelong</literal></term> +<listitem> +<para> +Insert the target document name for this olink using the +<literal>docnamelong</literal> gentext template, but only +if the value of <parameter>olink.doctitle</parameter> +is not <literal>no</literal>. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal>nodocname</literal></term> +<listitem> +<para> +Omit the target document name even if +the value of <parameter>olink.doctitle</parameter> +is <literal>yes</literal>. +</para> +</listitem> +</varlistentry> +</variablelist> +<para>Another way of inserting the target document name +for a single olink is to employ an +<sgmltag class="attribute">xrefstyle</sgmltag> +attribute using the <literal>template:</literal> syntax. +The <literal>%o</literal> placeholder (the letter o, not zero) +in such a template +will be filled in with the target document's title when it is processed. +This will occur regardless of +the value of <parameter>olink.doctitle</parameter>. +</para> +<para>Note that prior to version 1.66 of the XSL stylesheets, +the allowed values for this parameter were 0 and 1. Those +values are still supported and mapped to 'no' and 'yes', respectively. +</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/olink.fragid.xml b/kdoctools/docbook/xsl/params/olink.fragid.xml new file mode 100644 index 000000000..0e6d33d99 --- /dev/null +++ b/kdoctools/docbook/xsl/params/olink.fragid.xml @@ -0,0 +1,20 @@ +<refentry id="olink.fragid"> +<refmeta> +<refentrytitle>olink.fragid</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.fragid</refname> +<refpurpose>Names the fragment identifier portion of an OLink resolver query</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='olink.fragid.frag'><xsl:param name="olink.fragid" select="'fragid='"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/olink.lang.fallback.sequence.xml b/kdoctools/docbook/xsl/params/olink.lang.fallback.sequence.xml new file mode 100644 index 000000000..b7aea9eef --- /dev/null +++ b/kdoctools/docbook/xsl/params/olink.lang.fallback.sequence.xml @@ -0,0 +1,77 @@ +<refentry id="olink.lang.fallback.sequence"> +<refmeta> +<refentrytitle>olink.lang.fallback.sequence</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.lang.fallback.sequence</refname> +<refpurpose>look up translated documents if olink not found?</refpurpose> + +</refnamediv> +<refsynopsisdiv> <src:fragment id="olink.lang.fallback.sequence.frag"> +<xsl:param name="olink.lang.fallback.sequence" select="''"/> </src:fragment> +</refsynopsisdiv> +<refsect1> +<title>Description</title> + +<para>This parameter defines a list of lang values +to search among to resolve olinks. +</para> + +<para>Normally an olink tries to resolve to a document in the same +language as the olink itself. The language of an olink +is determined by its nearest ancestor element with a +<sgmltag class="attribute">lang</sgmltag> attribute, otherwise the +value of the <parameter>l10n.gentext.default.lang</parameter> +parameter. +</para> + +<para>An olink database can contain target data for the same +document in multiple languages. Each set of data has the +same value for the <sgmltag>targetdoc</sgmltag> attribute in +the <sgmltag>document</sgmltag> element in the database, but with a +different <sgmltag>lang</sgmltag> attribute value. +</para> + +<para>When an olink is being resolved, the target is first +sought in the document with the same language as the olink. +If no match is found there, then this parameter is consulted +for additional languages to try.</para> + +<para>The <parameter>olink.lang.fallback.sequence</parameter> +must be a whitespace separated list of lang values to +try. The first one with a match in the olink database is used. +The default value is empty.</para> + +<para>For example, a document might be written in German +and contain an olink with +<literal>targetdoc="adminguide"</literal>. +When the document is processed, the processor +first looks for a target dataset in the +olink database starting with:</para> + +<literallayout><literal><document targetdoc="adminguide" lang="de"></literal>. +</literallayout> + +<para>If there is no such element, then the +<parameter>olink.lang.fallback.sequence</parameter> +parameter is consulted. +If its value is, for example, <quote>fr en</quote>, then the processor next +looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and +then for <literal>targetdoc="adminguide" lang="en"</literal>. +If there is still no match, it looks for +<literal>targetdoc="adminguide"</literal> with no +lang attribute. +</para> + +<para>This parameter is useful when a set of documents is only +partially translated, or is in the process of being translated. +If a target of an olink has not yet been translated, then this +parameter permits the processor to look for the document in +other languages. This assumes the reader would rather have +a link to a document in a different language than to have +a broken link. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/olink.outline.ext.xml b/kdoctools/docbook/xsl/params/olink.outline.ext.xml new file mode 100644 index 000000000..f0ac801bf --- /dev/null +++ b/kdoctools/docbook/xsl/params/olink.outline.ext.xml @@ -0,0 +1,20 @@ +<refentry id="olink.outline.ext"> +<refmeta> +<refentrytitle>olink.outline.ext</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.outline.ext</refname> +<refpurpose>The extension of OLink outline files</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='olink.outline.ext.frag'><xsl:param name="olink.outline.ext" select="'.olink'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/olink.properties.xml b/kdoctools/docbook/xsl/params/olink.properties.xml new file mode 100644 index 000000000..7797bd05d --- /dev/null +++ b/kdoctools/docbook/xsl/params/olink.properties.xml @@ -0,0 +1,23 @@ +<refentry id="olink.properties"> +<refnamediv> +<refname>olink.properties</refname> +<refpurpose>Properties associated with the cross-reference +text of an olink.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='olink.properties.frag'> +<xsl:attribute-set name="olink.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This attribute set is used on cross reference text +from an olink. It is not applied to the +optional page number or +optional title of the external document.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/olink.pubid.xml b/kdoctools/docbook/xsl/params/olink.pubid.xml new file mode 100644 index 000000000..1b2281816 --- /dev/null +++ b/kdoctools/docbook/xsl/params/olink.pubid.xml @@ -0,0 +1,20 @@ +<refentry id="olink.pubid"> +<refmeta> +<refentrytitle>olink.pubid</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.pubid</refname> +<refpurpose>Names the public identifier portion of an OLink resolver query</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='olink.pubid.frag'><xsl:param name="olink.pubid" select="'pubid='"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/olink.resolver.xml b/kdoctools/docbook/xsl/params/olink.resolver.xml new file mode 100644 index 000000000..5926a16dc --- /dev/null +++ b/kdoctools/docbook/xsl/params/olink.resolver.xml @@ -0,0 +1,20 @@ +<refentry id="olink.resolver"> +<refmeta> +<refentrytitle>olink.resolver</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.resolver</refname> +<refpurpose>The root name of the OLink resolver (usually a script)</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='olink.resolver.frag'><xsl:param name="olink.resolver" select="'/cgi-bin/olink'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/olink.sysid.xml b/kdoctools/docbook/xsl/params/olink.sysid.xml new file mode 100644 index 000000000..cc6f3bc4d --- /dev/null +++ b/kdoctools/docbook/xsl/params/olink.sysid.xml @@ -0,0 +1,20 @@ +<refentry id="olink.sysid"> +<refmeta> +<refentrytitle>olink.sysid</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>olink.sysid</refname> +<refpurpose>Names the system identifier portion of an OLink resolver query</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='olink.sysid.frag'><xsl:param name="olink.sysid" select="'sysid='"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/page.height.portrait.xml b/kdoctools/docbook/xsl/params/page.height.portrait.xml new file mode 100644 index 000000000..cffafd9c9 --- /dev/null +++ b/kdoctools/docbook/xsl/params/page.height.portrait.xml @@ -0,0 +1,64 @@ +<refentry id="page.height.portrait"> +<refmeta> +<refentrytitle>page.height.portrait</refentrytitle> + +</refmeta> +<refnamediv> +<refname>page.height.portrait</refname> +<refpurpose>Specify the physical size of the long edge of the page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='page.height.portrait.frag'><xsl:param name="page.height.portrait"> + <xsl:choose> + <xsl:when test="$paper.type = 'A4landscape'">210mm</xsl:when> + <xsl:when test="$paper.type = 'USletter'">11in</xsl:when> + <xsl:when test="$paper.type = 'USlandscape'">8.5in</xsl:when> + <xsl:when test="$paper.type = '4A0'">2378mm</xsl:when> + <xsl:when test="$paper.type = '2A0'">1682mm</xsl:when> + <xsl:when test="$paper.type = 'A0'">1189mm</xsl:when> + <xsl:when test="$paper.type = 'A1'">841mm</xsl:when> + <xsl:when test="$paper.type = 'A2'">594mm</xsl:when> + <xsl:when test="$paper.type = 'A3'">420mm</xsl:when> + <xsl:when test="$paper.type = 'A4'">297mm</xsl:when> + <xsl:when test="$paper.type = 'A5'">210mm</xsl:when> + <xsl:when test="$paper.type = 'A6'">148mm</xsl:when> + <xsl:when test="$paper.type = 'A7'">105mm</xsl:when> + <xsl:when test="$paper.type = 'A8'">74mm</xsl:when> + <xsl:when test="$paper.type = 'A9'">52mm</xsl:when> + <xsl:when test="$paper.type = 'A10'">37mm</xsl:when> + <xsl:when test="$paper.type = 'B0'">1414mm</xsl:when> + <xsl:when test="$paper.type = 'B1'">1000mm</xsl:when> + <xsl:when test="$paper.type = 'B2'">707mm</xsl:when> + <xsl:when test="$paper.type = 'B3'">500mm</xsl:when> + <xsl:when test="$paper.type = 'B4'">353mm</xsl:when> + <xsl:when test="$paper.type = 'B5'">250mm</xsl:when> + <xsl:when test="$paper.type = 'B6'">176mm</xsl:when> + <xsl:when test="$paper.type = 'B7'">125mm</xsl:when> + <xsl:when test="$paper.type = 'B8'">88mm</xsl:when> + <xsl:when test="$paper.type = 'B9'">62mm</xsl:when> + <xsl:when test="$paper.type = 'B10'">44mm</xsl:when> + <xsl:when test="$paper.type = 'C0'">1297mm</xsl:when> + <xsl:when test="$paper.type = 'C1'">917mm</xsl:when> + <xsl:when test="$paper.type = 'C2'">648mm</xsl:when> + <xsl:when test="$paper.type = 'C3'">458mm</xsl:when> + <xsl:when test="$paper.type = 'C4'">324mm</xsl:when> + <xsl:when test="$paper.type = 'C5'">229mm</xsl:when> + <xsl:when test="$paper.type = 'C6'">162mm</xsl:when> + <xsl:when test="$paper.type = 'C7'">114mm</xsl:when> + <xsl:when test="$paper.type = 'C8'">81mm</xsl:when> + <xsl:when test="$paper.type = 'C9'">57mm</xsl:when> + <xsl:when test="$paper.type = 'C10'">40mm</xsl:when> + <xsl:otherwise>11in</xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The portrait page height is the length of the long +edge of the physical page. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/page.height.xml b/kdoctools/docbook/xsl/params/page.height.xml new file mode 100644 index 000000000..02ce412ca --- /dev/null +++ b/kdoctools/docbook/xsl/params/page.height.xml @@ -0,0 +1,32 @@ +<refentry id="page.height"> +<refmeta> +<refentrytitle>page.height</refentrytitle> + +</refmeta> +<refnamediv> +<refname>page.height</refname> +<refpurpose>The height of the physical page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='page.height.frag'><xsl:param name="page.height"> + <xsl:choose> + <xsl:when test="$page.orientation = 'portrait'"> + <xsl:value-of select="$page.height.portrait"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$page.width.portrait"/> + </xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The page height is generally calculated from the +<literal>paper.type</literal> and +<literal>page.orientation</literal>. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/page.margin.bottom.xml b/kdoctools/docbook/xsl/params/page.margin.bottom.xml new file mode 100644 index 000000000..1a3b29fba --- /dev/null +++ b/kdoctools/docbook/xsl/params/page.margin.bottom.xml @@ -0,0 +1,24 @@ +<refentry id="page.margin.bottom"> +<refmeta> +<refentrytitle>page.margin.bottom</refentrytitle> + +</refmeta> +<refnamediv> +<refname>page.margin.bottom</refname> +<refpurpose>The bottom margin of the page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='page.margin.bottom.frag'> +<xsl:param name="page.margin.bottom" select="'0.5in'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The bottom page margin is the distance from the bottom of the region-after +to the physical bottom of the page. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/page.margin.inner.xml b/kdoctools/docbook/xsl/params/page.margin.inner.xml new file mode 100644 index 000000000..cb3b3b8d2 --- /dev/null +++ b/kdoctools/docbook/xsl/params/page.margin.inner.xml @@ -0,0 +1,30 @@ +<refentry id="page.margin.inner"> +<refmeta> +<refentrytitle>page.margin.inner</refentrytitle> + +</refmeta> +<refnamediv> +<refname>page.margin.inner</refname> +<refpurpose>The inner page margin</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='page.margin.inner.frag'><xsl:param name="page.margin.inner"> + <xsl:choose> + <xsl:when test="$double.sided != 0">1.25in</xsl:when> + <xsl:otherwise>1in</xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The inner page margin is the distance from binding edge of the +page to the first column of text. In the left-to-right, top-to-bottom writing +direction, this is the left margin of recto pages.</para> +<para>The inner and outer margins are usually the same unless the output +is double-sided. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/page.margin.outer.xml b/kdoctools/docbook/xsl/params/page.margin.outer.xml new file mode 100644 index 000000000..d66e11a6d --- /dev/null +++ b/kdoctools/docbook/xsl/params/page.margin.outer.xml @@ -0,0 +1,30 @@ +<refentry id="page.margin.outer"> +<refmeta> +<refentrytitle>page.margin.outer</refentrytitle> + +</refmeta> +<refnamediv> +<refname>page.margin.outer</refname> +<refpurpose>The outer page margin</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='page.margin.outer.frag'><xsl:param name="page.margin.outer"> + <xsl:choose> + <xsl:when test="$double.sided != 0">0.75in</xsl:when> + <xsl:otherwise>1in</xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The outer page margin is the distance from non-binding edge of the +page to the last column of text. In the left-to-right, top-to-bottom writing +direction, this is the right margin of recto pages.</para> +<para>The inner and outer margins are usually the same unless the output +is double-sided. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/page.margin.top.xml b/kdoctools/docbook/xsl/params/page.margin.top.xml new file mode 100644 index 000000000..5c98bb5b4 --- /dev/null +++ b/kdoctools/docbook/xsl/params/page.margin.top.xml @@ -0,0 +1,23 @@ +<refentry id="page.margin.top"> +<refmeta> +<refentrytitle>page.margin.top</refentrytitle> + +</refmeta> +<refnamediv> +<refname>page.margin.top</refname> +<refpurpose>The top margin of the page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='page.margin.top.frag'> +<xsl:param name="page.margin.top" select="'0.5in'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The top page margin is the distance from the physical top of the +page to the top of the region-before.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/page.orientation.xml b/kdoctools/docbook/xsl/params/page.orientation.xml new file mode 100644 index 000000000..22871ff03 --- /dev/null +++ b/kdoctools/docbook/xsl/params/page.orientation.xml @@ -0,0 +1,22 @@ +<refentry id="page.orientation"> +<refmeta> +<refentrytitle>page.orientation</refentrytitle> + +</refmeta> +<refnamediv> +<refname>page.orientation</refname> +<refpurpose>Select the page orientation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='page.orientation.frag'><xsl:param name="page.orientation" select="'portrait'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>In portrait orientation, the short edge is horizontal; in +landscape orientation, it is vertical. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/page.width.portrait.xml b/kdoctools/docbook/xsl/params/page.width.portrait.xml new file mode 100644 index 000000000..a00584e18 --- /dev/null +++ b/kdoctools/docbook/xsl/params/page.width.portrait.xml @@ -0,0 +1,62 @@ +<refentry id="page.width.portrait"> +<refmeta> +<refentrytitle>page.width.portrait</refentrytitle> + +</refmeta> +<refnamediv> +<refname>page.width.portrait</refname> +<refpurpose>Specify the physical size of the short edge of the page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='page.width.portrait.frag'><xsl:param name="page.width.portrait"> + <xsl:choose> + <xsl:when test="$paper.type = 'USletter'">8.5in</xsl:when> + <xsl:when test="$paper.type = '4A0'">1682mm</xsl:when> + <xsl:when test="$paper.type = '2A0'">1189mm</xsl:when> + <xsl:when test="$paper.type = 'A0'">841mm</xsl:when> + <xsl:when test="$paper.type = 'A1'">594mm</xsl:when> + <xsl:when test="$paper.type = 'A2'">420mm</xsl:when> + <xsl:when test="$paper.type = 'A3'">297mm</xsl:when> + <xsl:when test="$paper.type = 'A4'">210mm</xsl:when> + <xsl:when test="$paper.type = 'A5'">148mm</xsl:when> + <xsl:when test="$paper.type = 'A6'">105mm</xsl:when> + <xsl:when test="$paper.type = 'A7'">74mm</xsl:when> + <xsl:when test="$paper.type = 'A8'">52mm</xsl:when> + <xsl:when test="$paper.type = 'A9'">37mm</xsl:when> + <xsl:when test="$paper.type = 'A10'">26mm</xsl:when> + <xsl:when test="$paper.type = 'B0'">1000mm</xsl:when> + <xsl:when test="$paper.type = 'B1'">707mm</xsl:when> + <xsl:when test="$paper.type = 'B2'">500mm</xsl:when> + <xsl:when test="$paper.type = 'B3'">353mm</xsl:when> + <xsl:when test="$paper.type = 'B4'">250mm</xsl:when> + <xsl:when test="$paper.type = 'B5'">176mm</xsl:when> + <xsl:when test="$paper.type = 'B6'">125mm</xsl:when> + <xsl:when test="$paper.type = 'B7'">88mm</xsl:when> + <xsl:when test="$paper.type = 'B8'">62mm</xsl:when> + <xsl:when test="$paper.type = 'B9'">44mm</xsl:when> + <xsl:when test="$paper.type = 'B10'">31mm</xsl:when> + <xsl:when test="$paper.type = 'C0'">917mm</xsl:when> + <xsl:when test="$paper.type = 'C1'">648mm</xsl:when> + <xsl:when test="$paper.type = 'C2'">458mm</xsl:when> + <xsl:when test="$paper.type = 'C3'">324mm</xsl:when> + <xsl:when test="$paper.type = 'C4'">229mm</xsl:when> + <xsl:when test="$paper.type = 'C5'">162mm</xsl:when> + <xsl:when test="$paper.type = 'C6'">114mm</xsl:when> + <xsl:when test="$paper.type = 'C7'">81mm</xsl:when> + <xsl:when test="$paper.type = 'C8'">57mm</xsl:when> + <xsl:when test="$paper.type = 'C9'">40mm</xsl:when> + <xsl:when test="$paper.type = 'C10'">28mm</xsl:when> + <xsl:otherwise>8.5in</xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The portrait page width is the length of the short +edge of the physical page. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/page.width.xml b/kdoctools/docbook/xsl/params/page.width.xml new file mode 100644 index 000000000..8c3f7b856 --- /dev/null +++ b/kdoctools/docbook/xsl/params/page.width.xml @@ -0,0 +1,31 @@ +<refentry id="page.width"> +<refmeta> +<refentrytitle>page.width</refentrytitle> + +</refmeta> +<refnamediv> +<refname>page.width</refname> +<refpurpose>The width of the physical page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='page.width.frag'><xsl:param name="page.width"> + <xsl:choose> + <xsl:when test="$page.orientation = 'portrait'"> + <xsl:value-of select="$page.width.portrait"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$page.height.portrait"/> + </xsl:otherwise> + </xsl:choose> +</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The page width is generally calculated from the +<literal>paper.type</literal> and <literal>page.orientation</literal>. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/paper.type.xml b/kdoctools/docbook/xsl/params/paper.type.xml new file mode 100644 index 000000000..f9092516b --- /dev/null +++ b/kdoctools/docbook/xsl/params/paper.type.xml @@ -0,0 +1,23 @@ +<refentry id="paper.type"> +<refmeta> +<refentrytitle>paper.type</refentrytitle> + +</refmeta> +<refnamediv> +<refname>paper.type</refname> +<refpurpose>Select the paper type</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='paper.type.frag'><xsl:param name="paper.type" select="'USletter'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The paper type is a convenient way to specify the paper size. +The list of known paper sizes includes USletter and most of the A, +B, and C sizes. See <literal>page.width.portrait</literal>, for example. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/para.propagates.style.xml b/kdoctools/docbook/xsl/params/para.propagates.style.xml new file mode 100644 index 000000000..81dbd11cb --- /dev/null +++ b/kdoctools/docbook/xsl/params/para.propagates.style.xml @@ -0,0 +1,24 @@ +<refentry id="para.propagates.style"> +<refmeta> +<refentrytitle>para.propagates.style</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>para.propagates.style</refname> +<refpurpose>Pass para role attribute through to HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='para.propagates.style.frag'> +<xsl:param name="para.propagates.style" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, the role attribute of <sgmltag>para</sgmltag> elements +will be passed through to the HTML as a class attribute on the +<sgmltag>p</sgmltag> generated for the paragraph.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/part.autolabel.xml b/kdoctools/docbook/xsl/params/part.autolabel.xml new file mode 100644 index 000000000..a8e0e5cf5 --- /dev/null +++ b/kdoctools/docbook/xsl/params/part.autolabel.xml @@ -0,0 +1,21 @@ +<refentry id="part.autolabel"> +<refmeta> +<refentrytitle>part.autolabel</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>part.autolabel</refname> +<refpurpose>Are parts and references enumerated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='part.autolabel.frag'><xsl:param name="part.autolabel" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), unlabeled parts and references will be enumerated. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/passivetex.extensions.xml b/kdoctools/docbook/xsl/params/passivetex.extensions.xml new file mode 100644 index 000000000..e5430e557 --- /dev/null +++ b/kdoctools/docbook/xsl/params/passivetex.extensions.xml @@ -0,0 +1,26 @@ +<refentry id="passivetex.extensions"> +<refmeta> +<refentrytitle>passivetex.extensions</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>passivetex.extensions</refname> +<refpurpose>Enable PassiveTeX extensions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='passivetex.extensions.frag'><xsl:param name="passivetex.extensions" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, +<ulink url="http://users.ox.ac.uk/~rahtz/passivetex/">PassiveTeX</ulink> +extensions will be used. At present, this consists of PDF bookmarks +and sorted index terms. +</para> + +<para>This parameter can also affect which graphics file formats +are supported</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/phrase.propagates.style.xml b/kdoctools/docbook/xsl/params/phrase.propagates.style.xml new file mode 100644 index 000000000..ad17380ee --- /dev/null +++ b/kdoctools/docbook/xsl/params/phrase.propagates.style.xml @@ -0,0 +1,22 @@ +<refentry id="phrase.propagates.style"> +<refmeta> +<refentrytitle>phrase.propagates.style</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>phrase.propagates.style</refname> +<refpurpose>Pass phrase role attribute through to HTML?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='phrase.propagates.style.frag'><xsl:param name="phrase.propagates.style" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, the role attribute of <sgmltag>phrase</sgmltag> elements +will be passed through to the HTML as a class attribute on a +<sgmltag>span</sgmltag> that surrounds the phrase.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/pixels.per.inch.xml b/kdoctools/docbook/xsl/params/pixels.per.inch.xml new file mode 100644 index 000000000..dbce98a62 --- /dev/null +++ b/kdoctools/docbook/xsl/params/pixels.per.inch.xml @@ -0,0 +1,26 @@ +<refentry id="pixels.per.inch"> +<refmeta> +<refentrytitle>pixels.per.inch</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>pixels.per.inch</refname> +<refpurpose>How many pixels are there per inch?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='pixels.per.inch.frag'> +<xsl:param name="pixels.per.inch" select="90"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>When lengths are converted to pixels, this value is used to +determine the size of a pixel. The default value is taken from the +<ulink url="http://www.w3.org/TR/xsl/slice5.html#pixels">XSL +Recommendation</ulink>. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/points.per.em.xml b/kdoctools/docbook/xsl/params/points.per.em.xml new file mode 100644 index 000000000..17d1ac27f --- /dev/null +++ b/kdoctools/docbook/xsl/params/points.per.em.xml @@ -0,0 +1,22 @@ +<refentry id="points.per.em"> +<refmeta> +<refentrytitle>points.per.em</refentrytitle> +<refmiscinfo role="type">number</refmiscinfo> +</refmeta> +<refnamediv> +<refname>points.per.em</refname> +<refpurpose>Specify the nominal size of an em-space in points</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='points.per.em.frag'> +<xsl:param name="points.per.em" select="10"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/preface.autolabel.xml b/kdoctools/docbook/xsl/params/preface.autolabel.xml new file mode 100644 index 000000000..739dceab1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/preface.autolabel.xml @@ -0,0 +1,21 @@ +<refentry id="preface.autolabel"> +<refmeta> +<refentrytitle>preface.autolabel</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>preface.autolabel</refname> +<refpurpose>Are prefaces enumerated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='preface.autolabel.frag'><xsl:param name="preface.autolabel" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), unlabeled prefaces will be enumerated. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/prefer.internal.olink.xml b/kdoctools/docbook/xsl/params/prefer.internal.olink.xml new file mode 100644 index 000000000..86c2fe3f0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/prefer.internal.olink.xml @@ -0,0 +1,73 @@ +<refentry id="prefer.internal.olink"> +<refmeta> +<refentrytitle>prefer.internal.olink</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>prefer.internal.olink</refname> +<refpurpose>Prefer a local olink reference to an external reference</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='prefer.internal.olink.frag'> +<xsl:param name="prefer.internal.olink" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you are re-using XML content modules in multiple documents, +you may want to redirect some of your olinks. This parameter +permits you to redirect an olink to the current document. +</para> + +<para>For example: you are writing documentation for a product, +which includes 3 manuals: a little installation +booklet (booklet.xml), a user +guide (user.xml), and a reference manual (reference.xml). +All 3 documents begin with the same introduction section (intro.xml) that +contains a reference to the customization section (custom.xml) which is +included in both user.xml and reference.xml documents. +</para> + +<para>How do you write the link to custom.xml in intro.xml +so that it is interpreted correctly in all 3 documents?</para> +<itemizedlist> +<listitem><para>If you use xref, it will fail in user.xml.</para> +</listitem> +<listitem><para>If you use olink (pointing to reference.xml), +the reference in user.xml +will point to the customization section of the reference manual, while it is +actually available in user.xml.</para> +</listitem> +</itemizedlist> + +<para>If you set the <parameter>prefer.internal.olink</parameter> +parameter to a non-zero value, then the processor will +first look in the olink database +for the olink's <sgmltag>targetptr</sgmltag> attribute value +in document matching the <parameter>current.docid</parameter> +parameter value. If it isn't found there, then +it tries the document in the database +with the <sgmltag>targetdoc</sgmltag> +value that matches the olink's <sgmltag>targetdoc</sgmltag> +attribute. +</para> + +<para>This feature permits an olink reference to resolve to +the current document if there is an element +with an id matching the olink's <sgmltag>targetptr</sgmltag> +value. The current document's olink data must be +included in the target database for this to work.</para> + +<caution> +<para>There is a potential for incorrect links if +the same <sgmltag>id</sgmltag> attribute value is used for different +content in different documents. +Some of your olinks may be redirected to the current document +when they shouldn't be. It is not possible to control +individual olink instances.</para> +</caution> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/preferred.mediaobject.role.xml b/kdoctools/docbook/xsl/params/preferred.mediaobject.role.xml new file mode 100644 index 000000000..7c664c5c1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/preferred.mediaobject.role.xml @@ -0,0 +1,33 @@ +<refentry id="preferred.mediaobject.role"> +<refmeta> +<refentrytitle>preferred.mediaobject.role</refentrytitle> +</refmeta> +<refnamediv> +<refname>preferred.mediaobject.role</refname> +<refpurpose>Select which mediaobject to use based on +this value of an object's <sgmltag class="attribute">role</sgmltag> attribute. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='preferred.mediaobject.role.frag'> +<xsl:param name="preferred.mediaobject.role"></xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>A mediaobject may contain several objects such as imageobjects. +If the parameter <parameter>use.role.for.mediaobject</parameter> +is non-zero, then the <sgmltag class="attribute">role</sgmltag> attribute on +<sgmltag>imageobject</sgmltag>s and other objects within a <sgmltag>mediaobject</sgmltag> container will be used to select which object will be +used. If one of the objects has a role value that matches the +preferred.mediaobject.role parameter, then it has first +priority for selection. If more than one has such a +role value, the first one is used. +</para> +<para> +See the <parameter>use.role.for.mediaobject</parameter> parameter +for the sequence of selection.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/procedure.properties.xml b/kdoctools/docbook/xsl/params/procedure.properties.xml new file mode 100644 index 000000000..b8dcbfefe --- /dev/null +++ b/kdoctools/docbook/xsl/params/procedure.properties.xml @@ -0,0 +1,18 @@ +<refentry id="procedure.properties"> +<refnamediv> +<refname>procedure.properties</refname> +<refpurpose>Properties associated with a procedure</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='procedure.properties.frag'> +<xsl:attribute-set name="procedure.properties" use-attribute-sets="formal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for procedures.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/process.empty.source.toc.xml b/kdoctools/docbook/xsl/params/process.empty.source.toc.xml new file mode 100644 index 000000000..933d14560 --- /dev/null +++ b/kdoctools/docbook/xsl/params/process.empty.source.toc.xml @@ -0,0 +1,33 @@ +<refentry id="process.empty.source.toc"> +<refmeta> +<refentrytitle>process.empty.source.toc</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>process.empty.source.toc</refname> +<refpurpose>Generate automated TOC if <sgmltag>toc</sgmltag> element occurs in a source document?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='process.empty.source.toc.frag'><xsl:param name="process.empty.source.toc" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies that if an empty <sgmltag>toc</sgmltag> element is +found in a source document, an automated TOC is generated. +<note> + <para>Depending on what the value of the + <parameter>generate.toc</parameter> parameter is, setting this + parameter to <literal>1</literal> could result in generation of + duplicate automated TOCs. So the + <parameter>process.empty.source.toc</parameter> is primarily useful + as an "override": by placing an empty <sgmltag>toc</sgmltag> in your + document and setting this parameter to <literal>1</literal>, you can + force a TOC to be generated even if <sgmltag>generate.toc</sgmltag> + says not to.</para> +</note> +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/process.source.toc.xml b/kdoctools/docbook/xsl/params/process.source.toc.xml new file mode 100644 index 000000000..a1d254b4e --- /dev/null +++ b/kdoctools/docbook/xsl/params/process.source.toc.xml @@ -0,0 +1,34 @@ +<refentry id="process.source.toc"> +<refmeta> +<refentrytitle>process.source.toc</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>process.source.toc</refname> +<refpurpose>Process a non-empty <sgmltag>toc</sgmltag> element if it occurs in a source document?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='process.source.toc.frag'><xsl:param name="process.source.toc" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies that the contents of a non-empty "hard-coded" +<sgmltag>toc</sgmltag> element in a source document are processed to +generate a TOC in output. +<note> + <para>This parameter has no effect on automated generation of + TOCs. An automated TOC may still be generated along with the + "hard-coded" TOC. To suppress automated TOC generation, adjust the + value of the <parameter>generate.toc</parameter> paramameter.</para> + + <para>The <sgmltag>process.source.toc</sgmltag> parameter also has + no effect if the <sgmltag>toc</sgmltag> element is empty; handling + for empty <sgmltag>toc</sgmltag> is controlled by the + <parameter>process.empty.source.toc</parameter> parameter.</para> +</note> +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.arch.xml b/kdoctools/docbook/xsl/params/profile.arch.xml new file mode 100644 index 000000000..d29cb9c86 --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.arch.xml @@ -0,0 +1,33 @@ +<refentry id="profile.arch"> +<refmeta> +<refentrytitle>profile.arch</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.arch</refname> +<refpurpose>Target profile for <sgmltag class="attribute">arch</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.arch.frag'> +<xsl:param name="profile.arch" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.attribute.xml b/kdoctools/docbook/xsl/params/profile.attribute.xml new file mode 100644 index 000000000..565372323 --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.attribute.xml @@ -0,0 +1,29 @@ +<refentry id="profile.attribute"> +<refmeta> +<refentrytitle>profile.attribute</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.attribute</refname> +<refpurpose>Name of user-specified profiling attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.attribute.frag'> +<xsl:param name="profile.attribute" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter is used in conjuction with <link +linkend="profile.value"><parameter>profile.value</parameter></link>.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.condition.xml b/kdoctools/docbook/xsl/params/profile.condition.xml new file mode 100644 index 000000000..f8e7753b0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.condition.xml @@ -0,0 +1,33 @@ +<refentry id="profile.condition"> +<refmeta> +<refentrytitle>profile.condition</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.condition</refname> +<refpurpose>Target profile for <sgmltag class="attribute">condition</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.condition.frag'> +<xsl:param name="profile.condition" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.conformance.xml b/kdoctools/docbook/xsl/params/profile.conformance.xml new file mode 100644 index 000000000..1b4441e46 --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.conformance.xml @@ -0,0 +1,33 @@ +<refentry id="profile.conformance"> +<refmeta> +<refentrytitle>profile.conformance</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.conformance</refname> +<refpurpose>Target profile for <sgmltag class="attribute">conformance</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.conformance.frag'> +<xsl:param name="profile.conformance" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.lang.xml b/kdoctools/docbook/xsl/params/profile.lang.xml new file mode 100644 index 000000000..97961383a --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.lang.xml @@ -0,0 +1,33 @@ +<refentry id="profile.lang"> +<refmeta> +<refentrytitle>profile.lang</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.lang</refname> +<refpurpose>Target profile for <sgmltag class="attribute">lang</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.lang.frag'> +<xsl:param name="profile.lang" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.os.xml b/kdoctools/docbook/xsl/params/profile.os.xml new file mode 100644 index 000000000..45172a596 --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.os.xml @@ -0,0 +1,33 @@ +<refentry id="profile.os"> +<refmeta> +<refentrytitle>profile.os</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.os</refname> +<refpurpose>Target profile for <sgmltag class="attribute">os</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.os.frag'> +<xsl:param name="profile.os" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.revision.xml b/kdoctools/docbook/xsl/params/profile.revision.xml new file mode 100644 index 000000000..ea4769d62 --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.revision.xml @@ -0,0 +1,33 @@ +<refentry id="profile.revision"> +<refmeta> +<refentrytitle>profile.revision</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.revision</refname> +<refpurpose>Target profile for <sgmltag class="attribute">revision</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.revision.frag'> +<xsl:param name="profile.revision" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.revisionflag.xml b/kdoctools/docbook/xsl/params/profile.revisionflag.xml new file mode 100644 index 000000000..5a443731b --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.revisionflag.xml @@ -0,0 +1,33 @@ +<refentry id="profile.revisionflag"> +<refmeta> +<refentrytitle>profile.revisionflag</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.revisionflag</refname> +<refpurpose>Target profile for <sgmltag class="attribute">revisionflag</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.revisionflag.frag'> +<xsl:param name="profile.revisionflag" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.role.xml b/kdoctools/docbook/xsl/params/profile.role.xml new file mode 100644 index 000000000..6f223528b --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.role.xml @@ -0,0 +1,54 @@ +<refentry id="profile.role"> +<refmeta> +<refentrytitle>profile.role</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.role</refname> +<refpurpose>Target profile for <sgmltag class="attribute">role</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.role.frag'> +<xsl:param name="profile.role" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +<warning> +<para>Note that <sgmltag class="attribute">role</sgmltag> is often +used for other purposes than profiling. For example it is commonly +used to get emphasize in bold font:</para> + +<programlisting><![CDATA[<emphasis role="bold">very important</emphasis>]]></programlisting> + +<para>If you are using <sgmltag class="attribute">role</sgmltag> for +these purposes do not forget to add values like <literal>bold</literal> to +value of this parameter. If you forgot you will get document with +small pieces missing which are very hard to track.</para> + +<para>For this reason it is not recommended to use <sgmltag +class="attribute">role</sgmltag> attribute for profiling. You should +rather use profiling specific attributes like <sgmltag +class="attribute">userlevel</sgmltag>, <sgmltag +class="attribute">os</sgmltag>, <sgmltag +class="attribute">arch</sgmltag>, <sgmltag +class="attribute">condition</sgmltag>, etc.</para> +</warning> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.security.xml b/kdoctools/docbook/xsl/params/profile.security.xml new file mode 100644 index 000000000..935363238 --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.security.xml @@ -0,0 +1,33 @@ +<refentry id="profile.security"> +<refmeta> +<refentrytitle>profile.security</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.security</refname> +<refpurpose>Target profile for <sgmltag class="attribute">security</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.security.frag'> +<xsl:param name="profile.security" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.separator.xml b/kdoctools/docbook/xsl/params/profile.separator.xml new file mode 100644 index 000000000..f48fd02e8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.separator.xml @@ -0,0 +1,22 @@ +<refentry id="profile.separator"> +<refmeta> +<refentrytitle>profile.separator</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.separator</refname> +<refpurpose>Separator character for compound profile values</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.separator.frag'> +<xsl:param name="profile.separator" select="';'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Separator character for compound profile values.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.userlevel.xml b/kdoctools/docbook/xsl/params/profile.userlevel.xml new file mode 100644 index 000000000..d2aeae00f --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.userlevel.xml @@ -0,0 +1,33 @@ +<refentry id="profile.userlevel"> +<refmeta> +<refentrytitle>profile.userlevel</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.userlevel</refname> +<refpurpose>Target profile for <sgmltag class="attribute">userlevel</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.userlevel.frag'> +<xsl:param name="profile.userlevel" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.value.xml b/kdoctools/docbook/xsl/params/profile.value.xml new file mode 100644 index 000000000..c22c5c96e --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.value.xml @@ -0,0 +1,36 @@ +<refentry id="profile.value"> +<refmeta> +<refentrytitle>profile.value</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.value</refname> +<refpurpose>Target profile for user-specified attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.value.frag'> +<xsl:param name="profile.value" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>When you are using this parameter you must also specify name of +profiling attribute with parameter <link +linkend="profile.attribute"><parameter>profile.attribute</parameter></link>.</para> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/profile.vendor.xml b/kdoctools/docbook/xsl/params/profile.vendor.xml new file mode 100644 index 000000000..06800d8d1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/profile.vendor.xml @@ -0,0 +1,33 @@ +<refentry id="profile.vendor"> +<refmeta> +<refentrytitle>profile.vendor</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>profile.vendor</refname> +<refpurpose>Target profile for <sgmltag class="attribute">vendor</sgmltag> +attribute</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='profile.vendor.frag'> +<xsl:param name="profile.vendor" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Value of this parameter specifies profiles which should be +included in the output. You can specify multiple profiles by +separating them by semicolon. You can change separator character by +<link linkend="profile.separator"><parameter>profile.separator</parameter></link> +parameter.</para> + +<para>This parameter has effect only when you are using profiling +stylesheets (<filename>profile-docbook.xsl</filename>, +<filename>profile-chunk.xsl</filename>, …) instead of normal +ones (<filename>docbook.xsl</filename>, +<filename>chunk.xsl</filename>, …).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/punct.honorific.xml b/kdoctools/docbook/xsl/params/punct.honorific.xml new file mode 100644 index 000000000..c34143c76 --- /dev/null +++ b/kdoctools/docbook/xsl/params/punct.honorific.xml @@ -0,0 +1,23 @@ +<refentry id="punct.honorific"> +<refmeta> +<refentrytitle>punct.honorific</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>punct.honorific</refname> +<refpurpose>Punctuation after an honorific in a personal name.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='punct.honorific.frag'> +<xsl:param name="punct.honorific" select="'.'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter specifies the punctuation that should be added after an +honorific in a personal name.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/qanda.defaultlabel.xml b/kdoctools/docbook/xsl/params/qanda.defaultlabel.xml new file mode 100644 index 000000000..58b0f8ae5 --- /dev/null +++ b/kdoctools/docbook/xsl/params/qanda.defaultlabel.xml @@ -0,0 +1,23 @@ +<refentry id="qanda.defaultlabel"> +<refmeta> +<refentrytitle>qanda.defaultlabel</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.defaultlabel</refname> +<refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='qanda.defaultlabel.frag'><xsl:param name="qanda.defaultlabel">number</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If no defaultlabel attribute is specified on a QandASet, this +value is used. It must be one of the legal values for the defaultlabel +attribute. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/qanda.inherit.numeration.xml b/kdoctools/docbook/xsl/params/qanda.inherit.numeration.xml new file mode 100644 index 000000000..900535515 --- /dev/null +++ b/kdoctools/docbook/xsl/params/qanda.inherit.numeration.xml @@ -0,0 +1,22 @@ +<refentry id="qanda.inherit.numeration"> +<refmeta> +<refentrytitle>qanda.inherit.numeration</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.inherit.numeration</refname> +<refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='qanda.inherit.numeration.frag'><xsl:param name="qanda.inherit.numeration" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), numbered QandADiv elements and Questions and Answers inherit +the numeration of the ancestors of the QandASet. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/qanda.title.level1.properties.xml b/kdoctools/docbook/xsl/params/qanda.title.level1.properties.xml new file mode 100644 index 000000000..600687a94 --- /dev/null +++ b/kdoctools/docbook/xsl/params/qanda.title.level1.properties.xml @@ -0,0 +1,27 @@ +<refentry id="qanda.title.level1.properties"> +<refmeta> +<refentrytitle>qanda.title.level1.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level1.properties</refname> +<refpurpose>Properties for level-1 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='qanda.title.level1.properties.frag'> +<xsl:attribute-set name="qanda.title.level1.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 2.0736"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-1 qanda set titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/qanda.title.level2.properties.xml b/kdoctools/docbook/xsl/params/qanda.title.level2.properties.xml new file mode 100644 index 000000000..d6800bc10 --- /dev/null +++ b/kdoctools/docbook/xsl/params/qanda.title.level2.properties.xml @@ -0,0 +1,27 @@ +<refentry id="qanda.title.level2.properties"> +<refmeta> +<refentrytitle>qanda.title.level2.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level2.properties</refname> +<refpurpose>Properties for level-2 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='qanda.title.level2.properties.frag'> +<xsl:attribute-set name="qanda.title.level2.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.728"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-2 qanda set titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/qanda.title.level3.properties.xml b/kdoctools/docbook/xsl/params/qanda.title.level3.properties.xml new file mode 100644 index 000000000..ef793442d --- /dev/null +++ b/kdoctools/docbook/xsl/params/qanda.title.level3.properties.xml @@ -0,0 +1,27 @@ +<refentry id="qanda.title.level3.properties"> +<refmeta> +<refentrytitle>qanda.title.level3.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level3.properties</refname> +<refpurpose>Properties for level-3 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='qanda.title.level3.properties.frag'> +<xsl:attribute-set name="qanda.title.level3.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.44"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-3 qanda set titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/qanda.title.level4.properties.xml b/kdoctools/docbook/xsl/params/qanda.title.level4.properties.xml new file mode 100644 index 000000000..599edf7a4 --- /dev/null +++ b/kdoctools/docbook/xsl/params/qanda.title.level4.properties.xml @@ -0,0 +1,27 @@ +<refentry id="qanda.title.level4.properties"> +<refmeta> +<refentrytitle>qanda.title.level4.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level4.properties</refname> +<refpurpose>Properties for level-4 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='qanda.title.level4.properties.frag'> +<xsl:attribute-set name="qanda.title.level4.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.2"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-4 qanda set titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/qanda.title.level5.properties.xml b/kdoctools/docbook/xsl/params/qanda.title.level5.properties.xml new file mode 100644 index 000000000..560ef31ed --- /dev/null +++ b/kdoctools/docbook/xsl/params/qanda.title.level5.properties.xml @@ -0,0 +1,27 @@ +<refentry id="qanda.title.level5.properties"> +<refmeta> +<refentrytitle>qanda.title.level5.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level5.properties</refname> +<refpurpose>Properties for level-5 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='qanda.title.level5.properties.frag'> +<xsl:attribute-set name="qanda.title.level5.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-5 qanda set titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/qanda.title.level6.properties.xml b/kdoctools/docbook/xsl/params/qanda.title.level6.properties.xml new file mode 100644 index 000000000..6864172e4 --- /dev/null +++ b/kdoctools/docbook/xsl/params/qanda.title.level6.properties.xml @@ -0,0 +1,29 @@ +<refentry id="qanda.title.level6.properties"> +<refmeta> +<refentrytitle>qanda.title.level6.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.level6.properties</refname> +<refpurpose>Properties for level-6 qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='qanda.title.level6.properties.frag'> +<xsl:attribute-set name="qanda.title.level6.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-6 qanda set titles. +This property set is actually +used for all titles below level 5.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/qanda.title.properties.xml b/kdoctools/docbook/xsl/params/qanda.title.properties.xml new file mode 100644 index 000000000..0e580c7c0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/qanda.title.properties.xml @@ -0,0 +1,33 @@ +<refentry id="qanda.title.properties"> +<refmeta> +<refentrytitle>qanda.title.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qanda.title.properties</refname> +<refpurpose>Properties for qanda set titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='qanda.title.properties.frag'> +<xsl:attribute-set name="qanda.title.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$title.font.family"/> + </xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <!-- font size is calculated dynamically by qanda.heading template --> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties common to all qanda set titles.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/qandadiv.autolabel.xml b/kdoctools/docbook/xsl/params/qandadiv.autolabel.xml new file mode 100644 index 000000000..a3a62c458 --- /dev/null +++ b/kdoctools/docbook/xsl/params/qandadiv.autolabel.xml @@ -0,0 +1,21 @@ +<refentry id="qandadiv.autolabel"> +<refmeta> +<refentrytitle>qandadiv.autolabel</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>qandadiv.autolabel</refname> +<refpurpose>Are divisions in QAndASets enumerated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='qandadiv.autolabel.frag'><xsl:param name="qandadiv.autolabel" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), unlabeled qandadivs will be enumerated. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/refentry.generate.name.xml b/kdoctools/docbook/xsl/params/refentry.generate.name.xml new file mode 100644 index 000000000..f2b714f1f --- /dev/null +++ b/kdoctools/docbook/xsl/params/refentry.generate.name.xml @@ -0,0 +1,26 @@ +<refentry id="refentry.generate.name"> +<refmeta> +<refentrytitle>refentry.generate.name</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.generate.name</refname> +<refpurpose>Output NAME header before 'RefName'(s)?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='refentry.generate.name.frag'><xsl:param name="refentry.generate.name" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), a "NAME" section title is output before the list +of 'RefName's. This parameter and +<parameter>refentry.generate.title</parameter> are mutually +exclusive. This means that if you change this parameter to zero, you +should set <parameter>refentry.generate.title</parameter> to 1 unless +you want get quite strange output. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/refentry.generate.title.xml b/kdoctools/docbook/xsl/params/refentry.generate.title.xml new file mode 100644 index 000000000..6c3936235 --- /dev/null +++ b/kdoctools/docbook/xsl/params/refentry.generate.title.xml @@ -0,0 +1,28 @@ +<refentry id="refentry.generate.title"> +<refmeta> +<refentrytitle>refentry.generate.title</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.generate.title</refname> +<refpurpose>Output title before 'RefName'(s)?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='refentry.generate.title.frag'> +<xsl:param name="refentry.generate.title" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), the reference page title or first name is +output before the list of 'RefName's. This parameter and +<parameter>refentry.generate.name</parameter> are mutually exclusive. +This means that if you change this parameter to 1, you +should set <parameter>refentry.generate.name</parameter> to 0 unless +you want get quite strange output.</para> + + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/refentry.pagebreak.xml b/kdoctools/docbook/xsl/params/refentry.pagebreak.xml new file mode 100644 index 000000000..51d305234 --- /dev/null +++ b/kdoctools/docbook/xsl/params/refentry.pagebreak.xml @@ -0,0 +1,23 @@ +<refentry id="refentry.pagebreak"> +<refmeta> +<refentrytitle>refentry.pagebreak</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.pagebreak</refname> +<refpurpose>Start each refentry on a new page</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='refentry.pagebreak.frag'><xsl:param name="refentry.pagebreak" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero (the default), each <sgmltag>refentry</sgmltag> +element will start on a new page. If zero, a page +break will not be generated. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/refentry.separator.xml b/kdoctools/docbook/xsl/params/refentry.separator.xml new file mode 100644 index 000000000..26d0ef0ff --- /dev/null +++ b/kdoctools/docbook/xsl/params/refentry.separator.xml @@ -0,0 +1,22 @@ +<refentry id="refentry.separator"> +<refmeta> +<refentrytitle>refentry.separator</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.separator</refname> +<refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='refentry.separator.frag'><xsl:param name="refentry.separator" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, a separator will be generated between consecutive +reference pages. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/refentry.title.properties.xml b/kdoctools/docbook/xsl/params/refentry.title.properties.xml new file mode 100644 index 000000000..2ae97e035 --- /dev/null +++ b/kdoctools/docbook/xsl/params/refentry.title.properties.xml @@ -0,0 +1,43 @@ +<refentry id="refentry.title.properties"> +<refmeta> +<refentrytitle>refentry.title.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.title.properties</refname> +<refpurpose>Title properties for a refentry title</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='refentry.title.properties.frag'> +<xsl:attribute-set name="refentry.title.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$title.font.family"/> + </xsl:attribute> + <xsl:attribute name="font-size">18pt</xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <xsl:attribute name="space-after">1em</xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="space-after.optimum">0.5em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.4em</xsl:attribute> + <xsl:attribute name="space-after.maximum">0.6em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Formatting properties applied to refentry titles, +including refnamediv, refsect1 through 3, and refsection. +The font size is supplied by the appropriate +<parameter>section.level<replaceable>X</replaceable>.title.properties</parameter> +attribute-set, +computed from its location in the section hierarchy. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/refentry.xref.manvolnum.xml b/kdoctools/docbook/xsl/params/refentry.xref.manvolnum.xml new file mode 100644 index 000000000..d79079335 --- /dev/null +++ b/kdoctools/docbook/xsl/params/refentry.xref.manvolnum.xml @@ -0,0 +1,24 @@ +<refentry id="refentry.xref.manvolnum"> +<refmeta> +<refentrytitle>refentry.xref.manvolnum</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>refentry.xref.manvolnum</refname> +<refpurpose>Output <sgmltag>manvolnum</sgmltag> as part of +<sgmltag>refentry</sgmltag> cross-reference?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='refentry.xref.manvolnum.frag'><xsl:param name="refentry.xref.manvolnum" select="1"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>if true (non-zero), the <sgmltag>manvolnum</sgmltag> is used when cross-referencing +<sgmltag>refentry</sgmltag>s, either with <sgmltag>xref</sgmltag> +or <sgmltag>citerefentry</sgmltag>. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/region.after.extent.xml b/kdoctools/docbook/xsl/params/region.after.extent.xml new file mode 100644 index 000000000..3ddf3ec92 --- /dev/null +++ b/kdoctools/docbook/xsl/params/region.after.extent.xml @@ -0,0 +1,24 @@ +<refentry id="region.after.extent"> +<refmeta> +<refentrytitle>region.after.extent</refentrytitle> + +</refmeta> +<refnamediv> +<refname>region.after.extent</refname> +<refpurpose>Specifies the height of the footer.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='region.after.extent.frag'> +<xsl:param name="region.after.extent" select="'0.4in'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The region after extent is the height of the area where footers +are printed. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/region.before.extent.xml b/kdoctools/docbook/xsl/params/region.before.extent.xml new file mode 100644 index 000000000..2a1a27939 --- /dev/null +++ b/kdoctools/docbook/xsl/params/region.before.extent.xml @@ -0,0 +1,24 @@ +<refentry id="region.before.extent"> +<refmeta> +<refentrytitle>region.before.extent</refentrytitle> + +</refmeta> +<refnamediv> +<refname>region.before.extent</refname> +<refpurpose>Specifies the height of the header</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='region.before.extent.frag'> +<xsl:param name="region.before.extent" select="'0.4in'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The region before extent is the height of the area where headers +are printed. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/root.filename.xml b/kdoctools/docbook/xsl/params/root.filename.xml new file mode 100644 index 000000000..c62670fc3 --- /dev/null +++ b/kdoctools/docbook/xsl/params/root.filename.xml @@ -0,0 +1,22 @@ +<refentry id="root.filename"> +<refmeta> +<refentrytitle>root.filename</refentrytitle> + +</refmeta> +<refnamediv> +<refname>root.filename</refname> +<refpurpose>Identifies the name of the root HTML file when chunking</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='root.filename.frag'><xsl:param name="root.filename" select="'index'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>root.filename</parameter> is the base filename for +the chunk created for the root of each document processed. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/root.properties.xml b/kdoctools/docbook/xsl/params/root.properties.xml new file mode 100644 index 000000000..6424412c0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/root.properties.xml @@ -0,0 +1,38 @@ +<refentry id="root.properties"> +<refmeta> +<refentrytitle>root.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>root.properties</refname> +<refpurpose>The properties of the fo:root element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='root.properties.frag'> +<xsl:attribute-set name="root.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$body.fontset"/> + </xsl:attribute> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.size"/> + </xsl:attribute> + <xsl:attribute name="text-align"> + <xsl:value-of select="$alignment"/> + </xsl:attribute> + <xsl:attribute name="line-height"> + <xsl:value-of select="$line-height"/> + </xsl:attribute> + <xsl:attribute name="font-selection-strategy">character-by-character</xsl:attribute> + <xsl:attribute name="line-height-shift-adjustment">disregard-shifts</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This property set is used on the <sgmltag>fo:root</sgmltag> element of +an FO file. It defines a set of default, global parameters.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/rootid.xml b/kdoctools/docbook/xsl/params/rootid.xml new file mode 100644 index 000000000..49108ffa4 --- /dev/null +++ b/kdoctools/docbook/xsl/params/rootid.xml @@ -0,0 +1,27 @@ +<refentry id="rootid"> +<refmeta> +<refentrytitle>rootid</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>rootid</refname> +<refpurpose>Specify the root element to format</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='rootid.frag'><xsl:param name="rootid" select="''"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>rootid</parameter> is specified, it must be the +value of an ID that occurs in the document being formatted. The entire +document will be loaded and parsed, but formatting will begin at the +element identified, rather than at the root. For example, this allows +you to process only chapter 4 of a book.</para> +<para>Because the entire document is available to the processor, automatic +numbering, cross references, and other dependencies are correctly +resolved.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/runinhead.default.title.end.punct.xml b/kdoctools/docbook/xsl/params/runinhead.default.title.end.punct.xml new file mode 100644 index 000000000..0fe73431f --- /dev/null +++ b/kdoctools/docbook/xsl/params/runinhead.default.title.end.punct.xml @@ -0,0 +1,21 @@ +<refentry id="runinhead.default.title.end.punct"> +<refmeta> +<refentrytitle>runinhead.default.title.end.punct</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>runinhead.default.title.end.punct</refname> +<refpurpose>Default punctuation character on a run-in-head</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='runinhead.default.title.end.punct.frag'><xsl:param name="runinhead.default.title.end.punct" select="'.'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME: +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/runinhead.title.end.punct.xml b/kdoctools/docbook/xsl/params/runinhead.title.end.punct.xml new file mode 100644 index 000000000..a82487bfe --- /dev/null +++ b/kdoctools/docbook/xsl/params/runinhead.title.end.punct.xml @@ -0,0 +1,21 @@ +<refentry id="runinhead.title.end.punct"> +<refmeta> +<refentrytitle>runinhead.title.end.punct</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>runinhead.title.end.punct</refname> +<refpurpose>Characters that count as punctuation on a run-in-head</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='runinhead.title.end.punct.frag'><xsl:param name="runinhead.title.end.punct" select="'.!?:'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME: +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/sans.font.family.xml b/kdoctools/docbook/xsl/params/sans.font.family.xml new file mode 100644 index 000000000..c07ad4cc1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/sans.font.family.xml @@ -0,0 +1,24 @@ +<refentry id="sans.font.family"> +<refmeta> +<refentrytitle>sans.font.family</refentrytitle> + +</refmeta> +<refnamediv> +<refname>sans.font.family</refname> +<refpurpose>The default sans-serif font family</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='sans.font.family.frag'> +<xsl:param name="sans.font.family" select="'sans-serif'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The default sans-serif font family. At the present, this isn't +actually used by the stylesheets. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/saxon.callouts.xml b/kdoctools/docbook/xsl/params/saxon.callouts.xml new file mode 100644 index 000000000..362c3b737 --- /dev/null +++ b/kdoctools/docbook/xsl/params/saxon.callouts.xml @@ -0,0 +1,23 @@ +<refentry id="saxon.callouts"> +<refmeta> +<refentrytitle>saxon.callouts</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>saxon.callouts</refname> +<refpurpose>Enable the callout extension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='saxon.callouts.frag'><xsl:param name="saxon.callouts" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The callouts extension processes <sgmltag>areaset</sgmltag> +elements in <sgmltag>ProgramListingCO</sgmltag> and other text-based +callout elements. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/saxon.character.representation.xml b/kdoctools/docbook/xsl/params/saxon.character.representation.xml new file mode 100644 index 000000000..167f6c775 --- /dev/null +++ b/kdoctools/docbook/xsl/params/saxon.character.representation.xml @@ -0,0 +1,27 @@ +<refentry id="saxon.character.representation"> +<refmeta> +<refentrytitle>saxon.character.representation</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>saxon.character.representation</refname> +<refpurpose>Saxon character representation used in generated HTML pages</refpurpose> +</refnamediv> + +<refsynopsisdiv><xsl:param name="saxon.character.representation" select="'entity;decimal'"/> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This character representation is used in files generated by chunking stylesheet. If +you want to suppress entity references for characters with direct representation +in default.encoding, set this parameter to value <literal>native</literal>. +</para> + +<note> +<para>This parameter is documented here, but the declaration is actually +in the <filename>chunker.xsl</filename> stylesheet module.</para> +</note> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/saxon.linenumbering.xml b/kdoctools/docbook/xsl/params/saxon.linenumbering.xml new file mode 100644 index 000000000..8b3d5578c --- /dev/null +++ b/kdoctools/docbook/xsl/params/saxon.linenumbering.xml @@ -0,0 +1,24 @@ +<refentry id="saxon.linenumbering"> +<refmeta> +<refentrytitle>saxon.linenumbering</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>saxon.linenumbering</refname> +<refpurpose>Enable the line numbering extension</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='saxon.linenumbering.frag'><xsl:param name="saxon.linenumbering" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true, verbatim environments (elements that have the +format='linespecific' notation attribute: address, literallayout, +programlisting, screen, synopsis) that specify line numbering will +have, surprise, line numbers. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/saxon.tablecolumns.xml b/kdoctools/docbook/xsl/params/saxon.tablecolumns.xml new file mode 100644 index 000000000..8a7482ab2 --- /dev/null +++ b/kdoctools/docbook/xsl/params/saxon.tablecolumns.xml @@ -0,0 +1,23 @@ +<refentry id="saxon.tablecolumns"> +<refmeta> +<refentrytitle>saxon.tablecolumns</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>saxon.tablecolumns</refname> +<refpurpose>Enable the table columns extension function</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='saxon.tablecolumns.frag'><xsl:param name="saxon.tablecolumns" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The table columns extension function adjusts the widths of table +columns in the HTML result to more accurately reflect the specifications +in the CALS table. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.autolabel.max.depth.xml b/kdoctools/docbook/xsl/params/section.autolabel.max.depth.xml new file mode 100644 index 000000000..4e100a302 --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.autolabel.max.depth.xml @@ -0,0 +1,26 @@ +<refentry id="section.autolabel.max.depth"> +<refmeta> +<refentrytitle>section.autolabel.max.depth</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.autolabel.max.depth</refname> +<refpurpose>The deepest level of sections that are numbered.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.autolabel.max.depth.frag'><xsl:param name="section.autolabel.max.depth" select="8"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>When section numbering is turned on by the +<literal>section.autolabel</literal> parameter, +then this parameter controls the depth of section nesting +that is numbered. +Sections nested to a level deeper than this value will +not be numbered. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.autolabel.xml b/kdoctools/docbook/xsl/params/section.autolabel.xml new file mode 100644 index 000000000..d68966d0d --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.autolabel.xml @@ -0,0 +1,21 @@ +<refentry id="section.autolabel"> +<refmeta> +<refentrytitle>section.autolabel</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.autolabel</refname> +<refpurpose>Are sections enumerated?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.autolabel.frag'><xsl:param name="section.autolabel" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), unlabeled sections will be enumerated. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.label.includes.component.label.xml b/kdoctools/docbook/xsl/params/section.label.includes.component.label.xml new file mode 100644 index 000000000..124d233ea --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.label.includes.component.label.xml @@ -0,0 +1,22 @@ +<refentry id="section.label.includes.component.label"> +<refmeta> +<refentrytitle>section.label.includes.component.label</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.label.includes.component.label</refname> +<refpurpose>Do section labels include the component label?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.label.includes.component.label.frag'><xsl:param name="section.label.includes.component.label" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), section labels are prefixed with the label of the +component that contains them. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.level1.properties.xml b/kdoctools/docbook/xsl/params/section.level1.properties.xml new file mode 100644 index 000000000..c0a804d7b --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.level1.properties.xml @@ -0,0 +1,39 @@ +<refentry id="section.level1.properties"> +<refmeta> +<refentrytitle>section.level1.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level1.properties</refname> +<refpurpose>Properties for level-1 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.level1.properties.frag'> +<xsl:attribute-set name="section.level1.properties" + use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties that apply to the containing +block of a level-1 section, and therefore apply to +the whole section. This includes <sgmltag>sect1</sgmltag> +elements and <sgmltag>section</sgmltag> elements at level 1. +</para> + +<para>For example, you could start each level-1 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level1.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <sgmltag>section.properties</sgmltag> attribute set. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.level2.properties.xml b/kdoctools/docbook/xsl/params/section.level2.properties.xml new file mode 100644 index 000000000..15af8aaba --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.level2.properties.xml @@ -0,0 +1,39 @@ +<refentry id="section.level2.properties"> +<refmeta> +<refentrytitle>section.level2.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level2.properties</refname> +<refpurpose>Properties for level-2 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.level2.properties.frag'> +<xsl:attribute-set name="section.level2.properties" + use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties that apply to the containing +block of a level-2 section, and therefore apply to +the whole section. This includes <sgmltag>sect2</sgmltag> +elements and <sgmltag>section</sgmltag> elements at level 2. +</para> + +<para>For example, you could start each level-2 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level2.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <sgmltag>section.properties</sgmltag> attribute set. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.level3.properties.xml b/kdoctools/docbook/xsl/params/section.level3.properties.xml new file mode 100644 index 000000000..c6a29b032 --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.level3.properties.xml @@ -0,0 +1,39 @@ +<refentry id="section.level3.properties"> +<refmeta> +<refentrytitle>section.level3.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level3.properties</refname> +<refpurpose>Properties for level-3 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.level3.properties.frag'> +<xsl:attribute-set name="section.level3.properties" + use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties that apply to the containing +block of a level-3 section, and therefore apply to +the whole section. This includes <sgmltag>sect3</sgmltag> +elements and <sgmltag>section</sgmltag> elements at level 3. +</para> + +<para>For example, you could start each level-3 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level3.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <sgmltag>section.properties</sgmltag> attribute set. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.level4.properties.xml b/kdoctools/docbook/xsl/params/section.level4.properties.xml new file mode 100644 index 000000000..967ed94e5 --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.level4.properties.xml @@ -0,0 +1,39 @@ +<refentry id="section.level4.properties"> +<refmeta> +<refentrytitle>section.level4.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level4.properties</refname> +<refpurpose>Properties for level-4 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.level4.properties.frag'> +<xsl:attribute-set name="section.level4.properties" + use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties that apply to the containing +block of a level-4 section, and therefore apply to +the whole section. This includes <sgmltag>sect4</sgmltag> +elements and <sgmltag>section</sgmltag> elements at level 4. +</para> + +<para>For example, you could start each level-4 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level4.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <sgmltag>section.properties</sgmltag> attribute set. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.level5.properties.xml b/kdoctools/docbook/xsl/params/section.level5.properties.xml new file mode 100644 index 000000000..d1a30c93b --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.level5.properties.xml @@ -0,0 +1,39 @@ +<refentry id="section.level5.properties"> +<refmeta> +<refentrytitle>section.level5.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level5.properties</refname> +<refpurpose>Properties for level-5 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.level5.properties.frag'> +<xsl:attribute-set name="section.level5.properties" + use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties that apply to the containing +block of a level-5 section, and therefore apply to +the whole section. This includes <sgmltag>sect5</sgmltag> +elements and <sgmltag>section</sgmltag> elements at level 5. +</para> + +<para>For example, you could start each level-5 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level5.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <sgmltag>section.properties</sgmltag> attribute set. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.level6.properties.xml b/kdoctools/docbook/xsl/params/section.level6.properties.xml new file mode 100644 index 000000000..8bd590c5e --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.level6.properties.xml @@ -0,0 +1,39 @@ +<refentry id="section.level6.properties"> +<refmeta> +<refentrytitle>section.level6.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.level6.properties</refname> +<refpurpose>Properties for level-6 sections</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.level6.properties.frag'> +<xsl:attribute-set name="section.level6.properties" + use-attribute-sets="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties that apply to the containing +block of a level 6 or lower section, and therefore apply to +the whole section. This includes +<sgmltag>section</sgmltag> elements at level 6 and lower. +</para> + +<para>For example, you could start each level-6 section on +a new page by using:</para> +<programlisting><xsl:attribute-set name="section.level6.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> +</xsl:attribute-set> +</programlisting> + +<para>This attribute set inherits attributes from the +general <sgmltag>section.properties</sgmltag> attribute set. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.properties.xml b/kdoctools/docbook/xsl/params/section.properties.xml new file mode 100644 index 000000000..bd83a7403 --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.properties.xml @@ -0,0 +1,30 @@ +<refentry id="section.properties"> +<refmeta> +<refentrytitle>section.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.properties</refname> +<refpurpose>Properties for all section levels</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.properties.frag'> +<xsl:attribute-set name="section.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties that apply to the containing +block of all section levels, and therefore apply to +the whole section. +This attribute set is inherited by the +more specific attribute sets such as +<sgmltag>section.level1.properties</sgmltag>. +The default is empty. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.title.level1.properties.xml b/kdoctools/docbook/xsl/params/section.title.level1.properties.xml new file mode 100644 index 000000000..9b8584554 --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.title.level1.properties.xml @@ -0,0 +1,27 @@ +<refentry id="section.title.level1.properties"> +<refmeta> +<refentrytitle>section.title.level1.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level1.properties</refname> +<refpurpose>Properties for level-1 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.title.level1.properties.frag'> +<xsl:attribute-set name="section.title.level1.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 2.0736"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-1 section titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.title.level2.properties.xml b/kdoctools/docbook/xsl/params/section.title.level2.properties.xml new file mode 100644 index 000000000..f6f7d206a --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.title.level2.properties.xml @@ -0,0 +1,27 @@ +<refentry id="section.title.level2.properties"> +<refmeta> +<refentrytitle>section.title.level2.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level2.properties</refname> +<refpurpose>Properties for level-1 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.title.level2.properties.frag'> +<xsl:attribute-set name="section.title.level2.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.728"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-2 section titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.title.level3.properties.xml b/kdoctools/docbook/xsl/params/section.title.level3.properties.xml new file mode 100644 index 000000000..b895e232b --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.title.level3.properties.xml @@ -0,0 +1,27 @@ +<refentry id="section.title.level3.properties"> +<refmeta> +<refentrytitle>section.title.level3.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level3.properties</refname> +<refpurpose>Properties for level-1 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.title.level3.properties.frag'> +<xsl:attribute-set name="section.title.level3.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.44"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-3 section titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.title.level4.properties.xml b/kdoctools/docbook/xsl/params/section.title.level4.properties.xml new file mode 100644 index 000000000..36c7b72ff --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.title.level4.properties.xml @@ -0,0 +1,27 @@ +<refentry id="section.title.level4.properties"> +<refmeta> +<refentrytitle>section.title.level4.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level4.properties</refname> +<refpurpose>Properties for level-1 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.title.level4.properties.frag'> +<xsl:attribute-set name="section.title.level4.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master * 1.2"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-4 section titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.title.level5.properties.xml b/kdoctools/docbook/xsl/params/section.title.level5.properties.xml new file mode 100644 index 000000000..464afa7bf --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.title.level5.properties.xml @@ -0,0 +1,27 @@ +<refentry id="section.title.level5.properties"> +<refmeta> +<refentrytitle>section.title.level5.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level5.properties</refname> +<refpurpose>Properties for level-1 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.title.level5.properties.frag'> +<xsl:attribute-set name="section.title.level5.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-5 section titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.title.level6.properties.xml b/kdoctools/docbook/xsl/params/section.title.level6.properties.xml new file mode 100644 index 000000000..af3896764 --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.title.level6.properties.xml @@ -0,0 +1,28 @@ +<refentry id="section.title.level6.properties"> +<refmeta> +<refentrytitle>section.title.level6.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.level6.properties</refname> +<refpurpose>Properties for level-1 section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.title.level6.properties.frag'> +<xsl:attribute-set name="section.title.level6.properties"> + <xsl:attribute name="font-size"> + <xsl:value-of select="$body.font.master"/> + <xsl:text>pt</xsl:text> + </xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties of level-6 section titles. This property set is actually +used for all titles below level 5.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/section.title.properties.xml b/kdoctools/docbook/xsl/params/section.title.properties.xml new file mode 100644 index 000000000..b2b6c8e17 --- /dev/null +++ b/kdoctools/docbook/xsl/params/section.title.properties.xml @@ -0,0 +1,32 @@ +<refentry id="section.title.properties"> +<refmeta> +<refentrytitle>section.title.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>section.title.properties</refname> +<refpurpose>Properties for section titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='section.title.properties.frag'> +<xsl:attribute-set name="section.title.properties"> + <xsl:attribute name="font-family"> + <xsl:value-of select="$title.font.family"/> + </xsl:attribute> + <xsl:attribute name="font-weight">bold</xsl:attribute> + <!-- font size is calculated dynamically by section.heading template --> + <xsl:attribute name="keep-with-next.within-column">always</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1.0em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The properties common to all section titles.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/segmentedlist.as.table.xml b/kdoctools/docbook/xsl/params/segmentedlist.as.table.xml new file mode 100644 index 000000000..e7ce9c8b5 --- /dev/null +++ b/kdoctools/docbook/xsl/params/segmentedlist.as.table.xml @@ -0,0 +1,23 @@ +<refentry id="segmentedlist.as.table"> +<refmeta> +<refentrytitle>segmentedlist.as.table</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>segmentedlist.as.table</refname> +<refpurpose>Format segmented lists as tables?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='segmentedlist.as.table.frag'> +<xsl:param name="segmentedlist.as.table" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, <sgmltag>segmentedlist</sgmltag>s will be formatted as +tables.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/shade.verbatim.style.xml b/kdoctools/docbook/xsl/params/shade.verbatim.style.xml new file mode 100644 index 000000000..34805ceda --- /dev/null +++ b/kdoctools/docbook/xsl/params/shade.verbatim.style.xml @@ -0,0 +1,28 @@ +<refentry id="shade.verbatim.style"> +<refmeta> +<refentrytitle>shade.verbatim.style</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>shade.verbatim.style</refname> +<refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='shade.verbatim.style.frag'> +<xsl:attribute-set condition="html" name="shade.verbatim.style"> + <xsl:attribute name="border">0</xsl:attribute> + <xsl:attribute name="bgcolor">#E0E0E0</xsl:attribute> +</xsl:attribute-set> +<xsl:attribute-set condition="fo" name="shade.verbatim.style"> + <xsl:attribute name="background-color">#E0E0E0</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/shade.verbatim.xml b/kdoctools/docbook/xsl/params/shade.verbatim.xml new file mode 100644 index 000000000..8519f855f --- /dev/null +++ b/kdoctools/docbook/xsl/params/shade.verbatim.xml @@ -0,0 +1,25 @@ +<refentry id="shade.verbatim"> +<refmeta> +<refentrytitle>shade.verbatim</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>shade.verbatim</refname> +<refpurpose>Should verbatim environments be shaded?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='shade.verbatim.frag'><xsl:param name="shade.verbatim" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>In the FO stylesheet, if this parameter is non-zero then the +<property>shade.verbatim.style</property> properties will be applied +to verbatim environments.</para> + +<para>In the HTML stylesheet, this parameter is now deprecated. Use +CSS instead.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/show.comments.xml b/kdoctools/docbook/xsl/params/show.comments.xml new file mode 100644 index 000000000..1757fb4e8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/show.comments.xml @@ -0,0 +1,24 @@ +<refentry id="show.comments"> +<refmeta> +<refentrytitle>show.comments</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>show.comments</refname> +<refpurpose>Display <sgmltag>comment</sgmltag> elements?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='show.comments.frag'><xsl:param name="show.comments">1</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), comments will be displayed, otherwise they are suppressed. +Comments here refers to the <sgmltag>comment</sgmltag> element, +which will be renamed <sgmltag>remark</sgmltag> in DocBook V4.0, +not XML comments (<-- like this -->) which are unavailable. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/show.revisionflag.xml b/kdoctools/docbook/xsl/params/show.revisionflag.xml new file mode 100644 index 000000000..94360b5f3 --- /dev/null +++ b/kdoctools/docbook/xsl/params/show.revisionflag.xml @@ -0,0 +1,35 @@ +<refentry id="show.revisionflag"> +<refmeta> +<refentrytitle>show.revisionflag</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>show.revisionflag</refname> +<refpurpose>Enable decoration of elements that have a revisionflag</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='show.revisionflag.frag'><xsl:param name="show.revisionflag">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para> +If <literal>show.revisionflag</literal> is turned on, then the stylesheets +may produce additional markup designed to allow a CSS stylesheet to +highlight elements that have specific revisionflag settings.</para> + +<para>The markup inserted will be usually be either a <span> or <div> +with an appropriate <literal>class</literal> attribute. (The value of +the class attribute will be the same as the value of the revisionflag +attribute). In some contexts, for example tables, where extra markup +would be structurally illegal, the class attribute will be added to the +appropriate container element.</para> + +<para>In general, the stylesheets only test for revisionflag in contexts +where an importing stylesheet would have to redefine whole templates. +Most of the revisionflag processing is expected to be done by another +stylesheet, for example <filename>changebars.xsl</filename>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/sidebar.properties.xml b/kdoctools/docbook/xsl/params/sidebar.properties.xml new file mode 100644 index 000000000..8c54a36ea --- /dev/null +++ b/kdoctools/docbook/xsl/params/sidebar.properties.xml @@ -0,0 +1,38 @@ +<refentry id="sidebar.properties"> +<refmeta> +<refentrytitle>sidebar.properties</refentrytitle> +<refmiscinfo role="type">attribute set</refmiscinfo> +</refmeta> +<refnamediv> +<refname>sidebar.properties</refname> +<refpurpose>Attribute set for sidebar properties</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='sidebar.properties.frag'> +<xsl:attribute-set name="sidebar.properties" + use-attribute-sets="formal.object.properties"> + <xsl:attribute name="border-style">solid</xsl:attribute> + <xsl:attribute name="border-width">1pt</xsl:attribute> + <xsl:attribute name="border-color">black</xsl:attribute> + <xsl:attribute name="background-color">#DDDDDD</xsl:attribute> + <xsl:attribute name="padding-left">12pt</xsl:attribute> + <xsl:attribute name="padding-right">12pt</xsl:attribute> + <xsl:attribute name="padding-top">6pt</xsl:attribute> + <xsl:attribute name="padding-bottom">6pt</xsl:attribute> +<!-- + <xsl:attribute name="margin-left">12pt</xsl:attribute> + <xsl:attribute name="margin-right">12pt</xsl:attribute> + <xsl:attribute name="margin-top">6pt</xsl:attribute> + <xsl:attribute name="margin-bottom">6pt</xsl:attribute> +--> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for sidebars.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/simplesect.in.toc.xml b/kdoctools/docbook/xsl/params/simplesect.in.toc.xml new file mode 100644 index 000000000..8d19e0b43 --- /dev/null +++ b/kdoctools/docbook/xsl/params/simplesect.in.toc.xml @@ -0,0 +1,21 @@ +<refentry id="simplesect.in.toc"> +<refmeta> +<refentrytitle>simplesect.in.toc</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>simplesect.in.toc</refname> +<refpurpose>Should <sgmltag>simplesect</sgmltag> elements appear in the TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='simplesect.in.toc.frag'><xsl:param name="simplesect.in.toc" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, <sgmltag>simplesect</sgmltag>s appear in the TOC. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/spacing.paras.xml b/kdoctools/docbook/xsl/params/spacing.paras.xml new file mode 100644 index 000000000..f9fa22673 --- /dev/null +++ b/kdoctools/docbook/xsl/params/spacing.paras.xml @@ -0,0 +1,23 @@ +<refentry id="spacing.paras"> +<refmeta> +<refentrytitle>spacing.paras</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>spacing.paras</refname> +<refpurpose>Insert additional <p> elements for spacing?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='spacing.paras.frag'><xsl:param name="spacing.paras" select="'0'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>When non-zero, additional, empty paragraphs are inserted in +several contexts (for example, around informal figures), to create a +more pleasing visual appearance in many browsers. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/subscript.properties.xml b/kdoctools/docbook/xsl/params/subscript.properties.xml new file mode 100644 index 000000000..bd90a09d0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/subscript.properties.xml @@ -0,0 +1,24 @@ +<refentry id="subscript.properties"> +<refmeta> +<refentrytitle>subscript.properties</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>subscript.properties</refname> +<refpurpose>Properties associated with subscripts</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='subscript.properties.frag'> +<xsl:attribute-set name="subscript.properties"> + <xsl:attribute name="font-size">75%</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies styling properties for subscripts.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/superscript.properties.xml b/kdoctools/docbook/xsl/params/superscript.properties.xml new file mode 100644 index 000000000..8a5d5c070 --- /dev/null +++ b/kdoctools/docbook/xsl/params/superscript.properties.xml @@ -0,0 +1,24 @@ +<refentry id="superscript.properties"> +<refmeta> +<refentrytitle>superscript.properties</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>superscript.properties</refname> +<refpurpose>Properties associated with superscripts</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='superscript.properties.frag'> +<xsl:attribute-set name="superscript.properties"> + <xsl:attribute name="font-size">75%</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies styling properties for superscripts.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/suppress.footer.navigation.xml b/kdoctools/docbook/xsl/params/suppress.footer.navigation.xml new file mode 100644 index 000000000..90101d45a --- /dev/null +++ b/kdoctools/docbook/xsl/params/suppress.footer.navigation.xml @@ -0,0 +1,22 @@ +<refentry id="suppress.footer.navigation"> +<refmeta> +<refentrytitle>suppress.footer.navigation</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>suppress.footer.navigation</refname> +<refpurpose>Disable footer navigation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='suppress.footer.navigation.frag'><xsl:param name="suppress.footer.navigation">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para> +If <literal>suppress.footer.navigation</literal> is turned on, footer +navigation will be suppressed.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/suppress.header.navigation.xml b/kdoctools/docbook/xsl/params/suppress.header.navigation.xml new file mode 100644 index 000000000..276e28c6b --- /dev/null +++ b/kdoctools/docbook/xsl/params/suppress.header.navigation.xml @@ -0,0 +1,22 @@ +<refentry id="suppress.header.navigation"> +<refmeta> +<refentrytitle>suppress.header.navigation</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>suppress.header.navigation</refname> +<refpurpose>Disable header navigation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='suppress.header.navigation.frag'><xsl:param name="suppress.header.navigation">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para> +If <literal>suppress.header.navigation</literal> is turned on, header +navigation will be suppressed.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/suppress.navigation.xml b/kdoctools/docbook/xsl/params/suppress.navigation.xml new file mode 100644 index 000000000..a06568e2f --- /dev/null +++ b/kdoctools/docbook/xsl/params/suppress.navigation.xml @@ -0,0 +1,22 @@ +<refentry id="suppress.navigation"> +<refmeta> +<refentrytitle>suppress.navigation</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>suppress.navigation</refname> +<refpurpose>Disable header and footer navigation</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='suppress.navigation.frag'><xsl:param name="suppress.navigation">0</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para> +If <literal>suppress.navigation</literal> is turned on, header and +footer navigation will be suppressed.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/symbol.font.family.xml b/kdoctools/docbook/xsl/params/symbol.font.family.xml new file mode 100644 index 000000000..0f038e78c --- /dev/null +++ b/kdoctools/docbook/xsl/params/symbol.font.family.xml @@ -0,0 +1,36 @@ +<refentry id="symbol.font.family"> +<refmeta> +<refentrytitle>symbol.font.family</refentrytitle> + +</refmeta> +<refnamediv> +<refname>symbol.font.family</refname> +<refpurpose>The font families to be searched for symbols outside + of the body font</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='symbol.font.family.frag'> +<xsl:param name="symbol.font.family" select="'Symbol,ZapfDingbats'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>A typical body or title font does not contain all +the character glyphs that DocBook supports. This parameter +specifies additional fonts that should be searched for +special characters not in the normal font. +These symbol font names are automatically appended +to the body or title font family name when fonts +are specified in a +<sgmltag class="attribute">font-family</sgmltag> +property in the FO output. +</para> +<para>The symbol font names should be entered as a +comma-separated list. The default value is +<literal>Symbol,ZapfDingbats</literal>. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.borders.with.css.xml b/kdoctools/docbook/xsl/params/table.borders.with.css.xml new file mode 100644 index 000000000..2054b7393 --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.borders.with.css.xml @@ -0,0 +1,23 @@ +<refentry id="table.borders.with.css"> +<refmeta> +<refentrytitle>table.borders.with.css</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.borders.with.css</refname> +<refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.borders.with.css.frag'> +<xsl:param name="table.borders.with.css" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If true (non-zero), CSS will be used to draw table borders. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.cell.border.color.xml b/kdoctools/docbook/xsl/params/table.cell.border.color.xml new file mode 100644 index 000000000..1299a9e6e --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.cell.border.color.xml @@ -0,0 +1,23 @@ +<refentry id="table.cell.border.color"> +<refmeta> +<refentrytitle>table.cell.border.color</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.border.color</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.cell.border.color.frag'> +<xsl:param condition="html" name="table.cell.border.color" select="''"/> +<xsl:param condition="fo" name="table.cell.border.color" select="'black'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.cell.border.style.xml b/kdoctools/docbook/xsl/params/table.cell.border.style.xml new file mode 100644 index 000000000..26b416d8d --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.cell.border.style.xml @@ -0,0 +1,22 @@ +<refentry id="table.cell.border.style"> +<refmeta> +<refentrytitle>table.cell.border.style</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.border.style</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.cell.border.style.frag'> +<xsl:param name="table.cell.border.style" select="'solid'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.cell.border.thickness.xml b/kdoctools/docbook/xsl/params/table.cell.border.thickness.xml new file mode 100644 index 000000000..9c2c8ea9a --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.cell.border.thickness.xml @@ -0,0 +1,22 @@ +<refentry id="table.cell.border.thickness"> +<refmeta> +<refentrytitle>table.cell.border.thickness</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.border.thickness</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.cell.border.thickness.frag'> +<xsl:param name="table.cell.border.thickness" select="'0.5pt'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.cell.padding.xml b/kdoctools/docbook/xsl/params/table.cell.padding.xml new file mode 100644 index 000000000..5b3342fc9 --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.cell.padding.xml @@ -0,0 +1,27 @@ +<refentry id="table.cell.padding"> +<refmeta> +<refentrytitle>table.cell.padding</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.cell.padding</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.cell.padding.frag'> +<xsl:attribute-set name="table.cell.padding"> + <xsl:attribute name="padding-left">2pt</xsl:attribute> + <xsl:attribute name="padding-right">2pt</xsl:attribute> + <xsl:attribute name="padding-top">2pt</xsl:attribute> + <xsl:attribute name="padding-bottom">2pt</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.entry.padding.xml b/kdoctools/docbook/xsl/params/table.entry.padding.xml new file mode 100644 index 000000000..4775f6c4f --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.entry.padding.xml @@ -0,0 +1,22 @@ +<refentry id="table.entry.padding"> +<refmeta> +<refentrytitle>table.entry.padding</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.entry.padding</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.entry.padding.frag'> +<xsl:param name="table.entry.padding" select="'2pt'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.footnote.number.format.xml b/kdoctools/docbook/xsl/params/table.footnote.number.format.xml new file mode 100644 index 000000000..7ea911e72 --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.footnote.number.format.xml @@ -0,0 +1,23 @@ +<refentry id="table.footnote.number.format"> +<refmeta> +<refentrytitle>table.footnote.number.format</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.footnote.number.format</refname> +<refpurpose>Identifies the format used for footnote numbers in tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.footnote.number.format.frag'> +<xsl:param name="table.footnote.number.format" select="'a'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>table.footnote.number.format</parameter> specifies the format +to use for footnote numeration (1, i, I, a, or A) in tables.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.footnote.number.symbols.xml b/kdoctools/docbook/xsl/params/table.footnote.number.symbols.xml new file mode 100644 index 000000000..d8004cfd8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.footnote.number.symbols.xml @@ -0,0 +1,34 @@ +<refentry id="table.footnote.number.symbols"> +<refmeta> +<refentrytitle>table.footnote.number.symbols</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.footnote.number.symbols</refname> +<refpurpose>Special characters to use a footnote markers in tables</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.footnote.number.symbols.frag'> +<xsl:param name="table.footnote.number.symbols" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string, +table footnotes will use the characters it contains as footnote symbols. For example, +<quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify +footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>, +<quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes +than symbols, the stylesheets will fall back to numbered footnotes using +<parameter>table.footnote.number.format</parameter>.</para> + +<para>The use of symbols for footnotes depends on the ability of your +processor (or browser) to render the symbols you select. Not all systems are +capable of displaying the full range of Unicode characters. If the quoted characters +in the preceding paragraph are not displayed properly, that's a good indicator +that you may have trouble using those symbols for footnotes.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.frame.border.color.xml b/kdoctools/docbook/xsl/params/table.frame.border.color.xml new file mode 100644 index 000000000..b0e229fcf --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.frame.border.color.xml @@ -0,0 +1,23 @@ +<refentry id="table.frame.border.color"> +<refmeta> +<refentrytitle>table.frame.border.color</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.frame.border.color</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.frame.border.color.frag'> +<xsl:param condition="html" name="table.frame.border.color" select="''"/> +<xsl:param condition="fo" name="table.frame.border.color" select="'black'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.frame.border.style.xml b/kdoctools/docbook/xsl/params/table.frame.border.style.xml new file mode 100644 index 000000000..5a15e06fe --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.frame.border.style.xml @@ -0,0 +1,22 @@ +<refentry id="table.frame.border.style"> +<refmeta> +<refentrytitle>table.frame.border.style</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.frame.border.style</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.frame.border.style.frag'> +<xsl:param name="table.frame.border.style" select="'solid'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.frame.border.thickness.xml b/kdoctools/docbook/xsl/params/table.frame.border.thickness.xml new file mode 100644 index 000000000..0b5f2cbd1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.frame.border.thickness.xml @@ -0,0 +1,22 @@ +<refentry id="table.frame.border.thickness"> +<refmeta> +<refentrytitle>table.frame.border.thickness</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>table.frame.border.thickness</refname> +<refpurpose>Specifies the thickness of the frame border</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.frame.border.thickness.frag'> +<xsl:param name="table.frame.border.thickness" select="'0.5pt'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the thickness of the border on the table's frame.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.properties.xml b/kdoctools/docbook/xsl/params/table.properties.xml new file mode 100644 index 000000000..4abff03ad --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.properties.xml @@ -0,0 +1,24 @@ +<refentry id="table.properties"> +<refnamediv> +<refname>table.properties</refname> +<refpurpose>Properties associated with the block surrounding a table</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.properties.frag'> +<xsl:attribute-set name="table.properties" + use-attribute-sets="formal.object.properties"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Block styling properties for tables. This parameter should really +have been called <literal>table.block.properties</literal> or something +like that, but we’re leaving it to avoid backwards-compatibility +problems.</para> + +<para>See also <parameter>table.table.properties</parameter>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/table.table.properties.xml b/kdoctools/docbook/xsl/params/table.table.properties.xml new file mode 100644 index 000000000..581b9898b --- /dev/null +++ b/kdoctools/docbook/xsl/params/table.table.properties.xml @@ -0,0 +1,27 @@ +<refentry id="table.table.properties"> +<refnamediv> +<refname>table.table.properties</refname> +<refpurpose>Properties associated with a table</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='table.table.properties.frag'> +<xsl:attribute-set name="table.table.properties"> + <xsl:attribute name="border-before-width.conditionality">retain</xsl:attribute> + <xsl:attribute name="border-collapse">collapse</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The styling for tables. This parameter should really +have been called <literal>table.properties</literal>, but that parameter +name was inadvertantly established for the block-level properties +of the table as a whole. +</para> + +<para>See also <parameter>table.properties</parameter>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/tablecolumns.extension.xml b/kdoctools/docbook/xsl/params/tablecolumns.extension.xml new file mode 100644 index 000000000..772631258 --- /dev/null +++ b/kdoctools/docbook/xsl/params/tablecolumns.extension.xml @@ -0,0 +1,23 @@ +<refentry id="tablecolumns.extension"> +<refmeta> +<refentrytitle>tablecolumns.extension</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tablecolumns.extension</refname> +<refpurpose>Enable the table columns extension function</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='tablecolumns.extension.frag'><xsl:param name="tablecolumns.extension" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The table columns extension function adjusts the widths of table +columns in the HTML result to more accurately reflect the specifications +in the CALS table. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/target.database.document.xml b/kdoctools/docbook/xsl/params/target.database.document.xml new file mode 100644 index 000000000..01d95ab8c --- /dev/null +++ b/kdoctools/docbook/xsl/params/target.database.document.xml @@ -0,0 +1,27 @@ +<refentry id="target.database.document"> +<refmeta> +<refentrytitle>target.database.document</refentrytitle> +<refmiscinfo role="type">uri</refmiscinfo> +</refmeta> +<refnamediv> +<refname>target.database.document</refname> +<refpurpose>Name of master database file for resolving +olinks</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment id="target.database.document.frag"> +<xsl:param name="target.database.document" select="''"/> +</src:fragment> +</refsynopsisdiv> +<refsect1> +<title>Description</title> +<para> +To resolve olinks between documents, the stylesheets use +a master database document that identifies the target datafiles for all the documents within the scope +of the olinks. This parameter value is the URI of +the master document to be read during processing to resolve olinks. +The default value is <filename>olinkdb.xml</filename>.</para> +<para>The data structure of the file is defined in the <filename>targetdatabase.dtd</filename> DTD. The database file provides the high level elements to record the identifiers, locations, and relationships of documents. The cross reference data for individual documents is generally pulled into the database using system entity references or XIncludes. See also <parameter>targets.filename</parameter>. + +</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/targets.filename.xml b/kdoctools/docbook/xsl/params/targets.filename.xml new file mode 100644 index 000000000..d9b71a234 --- /dev/null +++ b/kdoctools/docbook/xsl/params/targets.filename.xml @@ -0,0 +1,27 @@ +<refentry id="targets.filename"> +<refmeta> +<refentrytitle>targets.filename</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>targets.filename</refname> +<refpurpose>Name of cross reference targets data file</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment id="targets.filename.frag"> +<xsl:param name="targets.filename" select="'target.db'"/> +</src:fragment> +</refsynopsisdiv> +<refsect1> +<title>Description</title> +<para> +In order to resolve olinks efficiently, the stylesheets can +generate an external data file containing information about +all potential cross reference endpoints in a document. +This parameter lets you change the name of the generated +file from the default name <filename>target.db</filename>. +The name must agree with that used in the target database +used to resolve olinks during processing. +See also <parameter>target.database.document</parameter>. +</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/template.xml b/kdoctools/docbook/xsl/params/template.xml new file mode 100644 index 000000000..0b97c3a74 --- /dev/null +++ b/kdoctools/docbook/xsl/params/template.xml @@ -0,0 +1,22 @@ +<refentry id="[[NAME]]"> +<refmeta> +<refentrytitle>[[NAME]]</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>[[NAME]]</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='[[NAME]].frag'> +<xsl:param name="[[NAME]]" select=""/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/tex.math.delims.xml b/kdoctools/docbook/xsl/params/tex.math.delims.xml new file mode 100644 index 000000000..d2e01f983 --- /dev/null +++ b/kdoctools/docbook/xsl/params/tex.math.delims.xml @@ -0,0 +1,24 @@ +<refentry id="tex.math.delims"> +<refmeta> +<refentrytitle>tex.math.delims</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tex.math.delims</refname> +<refpurpose>Should be equations outputed for processing by TeX +automatically surrounded by math mode delimiters</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='tex.math.delims.frag'> +<xsl:param name="tex.math.delims" select="'1'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell +you should set this parameter to 0.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/tex.math.file.xml b/kdoctools/docbook/xsl/params/tex.math.file.xml new file mode 100644 index 000000000..566177a3b --- /dev/null +++ b/kdoctools/docbook/xsl/params/tex.math.file.xml @@ -0,0 +1,24 @@ +<refentry id="tex.math.file"> +<refmeta> +<refentrytitle>tex.math.file</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tex.math.file</refname> +<refpurpose>Name of temporary file for generating images from equations</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='tex.math.file.frag'> +<xsl:param name="tex.math.file" select="'tex-math-equations.tex'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Name of auxiliary file for TeX equations. This file can be +processed by dvi2bitmap to get bitmap versions of equations for HTML +output.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/tex.math.in.alt.xml b/kdoctools/docbook/xsl/params/tex.math.in.alt.xml new file mode 100644 index 000000000..0b956c6c8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/tex.math.in.alt.xml @@ -0,0 +1,56 @@ +<refentry id="tex.math.in.alt"> +<refmeta> +<refentrytitle>tex.math.in.alt</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>tex.math.in.alt</refname> +<refpurpose>TeX notation used for equations</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='tex.math.in.alt.frag'> +<xsl:param name="tex.math.in.alt" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If you want type math directly in TeX notation in equations, +this parameter specifies notation used. Currently are supported two +values -- <literal>plain</literal> and <literal>latex</literal>. Empty +value means that you are not using TeX math at all.</para> + +<para>Preferred way for including TeX alternative of math is inside of +<sgmltag>textobject</sgmltag> element. Eg.:</para> + +<programlisting><![CDATA[<inlineequation> +<inlinemediaobject> +<imageobject> +<imagedata fileref="eq1.gif"/> +</imageobject> +<textobject><phrase>E=mc squared</phrase></textobject> +<textobject role="tex"><phrase>E=mc^2</phrase></textobject> +</inlinemediaobject> +</inlineequation>]]></programlisting> + +<para>If you are using <sgmltag>graphic</sgmltag> element, you can +store TeX inside <sgmltag>alt</sgmltag> element:</para> + +<programlisting><![CDATA[<inlineequation> +<alt role="tex">a^2+b^2=c^2</alt> +<graphic fileref="a2b2c2.gif"/> +</inlineequation>]]></programlisting> + +<para>If you want use this feature, you should process your FO with +PassiveTeX, which only supports TeX math notation. When calling +stylsheet, don't forget to specify also +passivetex.extensions=1.</para> + +<para>If you want equations in HTML, just process generated file +<filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run +dvi2bitmap program on result DVI file. You will get images for +equations in your document.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/textdata.default.encoding.xml b/kdoctools/docbook/xsl/params/textdata.default.encoding.xml new file mode 100644 index 000000000..bb68226a5 --- /dev/null +++ b/kdoctools/docbook/xsl/params/textdata.default.encoding.xml @@ -0,0 +1,28 @@ +<refentry id="textdata.default.encoding"> +<refmeta> +<refentrytitle>textdata.default.encoding</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>textdata.default.encoding</refname> +<refpurpose>Default encoding of external text files which are included +using textdata element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='textdata.default.encoding.frag'> +<xsl:param name="textdata.default.encoding" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Default encoding of external text files which are included using +textdata element. This value is used only when you do not specify +encoding by appropriate attribute directly on textdata. Default +encoding (empty string) is interpreted as system default +encoding.</para> + +</refsect1> +</refentry> + diff --git a/kdoctools/docbook/xsl/params/textinsert.extension.xml b/kdoctools/docbook/xsl/params/textinsert.extension.xml new file mode 100644 index 000000000..8a3a0f223 --- /dev/null +++ b/kdoctools/docbook/xsl/params/textinsert.extension.xml @@ -0,0 +1,22 @@ +<refentry id="textinsert.extension"> +<refmeta> +<refentrytitle>textinsert.extension</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>textinsert.extension</refname> +<refpurpose>Enable the textinsert extension element</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='textinsert.extension.frag'><xsl:param name="textinsert.extension" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The textinsert extension element inserts the contents of a +a file into the result tree (as text). +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/title.font.family.xml b/kdoctools/docbook/xsl/params/title.font.family.xml new file mode 100644 index 000000000..75996076f --- /dev/null +++ b/kdoctools/docbook/xsl/params/title.font.family.xml @@ -0,0 +1,24 @@ +<refentry id="title.font.family"> +<refmeta> +<refentrytitle>title.font.family</refentrytitle> + +</refmeta> +<refnamediv> +<refname>title.font.family</refname> +<refpurpose>The default font family for titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='title.font.family.frag'> +<xsl:param name="title.font.family" select="'sans-serif'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The title font family is used for titles (chapter, section, figure, +etc.) +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/title.margin.left.xml b/kdoctools/docbook/xsl/params/title.margin.left.xml new file mode 100644 index 000000000..140d7f53d --- /dev/null +++ b/kdoctools/docbook/xsl/params/title.margin.left.xml @@ -0,0 +1,45 @@ +<refentry id="title.margin.left"> +<refmeta> +<refentrytitle>title.margin.left</refentrytitle> +<refmiscinfo role="type"></refmiscinfo> +</refmeta> +<refnamediv> +<refname>title.margin.left</refname> +<refpurpose>Adjust the left margin for titles</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='title.margin.left.frag'> +<xsl:param name="title.margin.left"> + <xsl:choose> + <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when> + <xsl:otherwise>-4pc</xsl:otherwise> + </xsl:choose> +</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This parameter adjusts the left margin for titles, +effectively leaving the titles at the left +margin and indenting the body text. +The default value is -4pc, which means the +body text is indented 4 picas relative to +the titles. +</para> +<para> +If you set the value to zero, be sure to still include +a unit indicator such as <literal>0pt</literal>, or +the FO processor will report errors. +</para> +<para> +This parameter is set to 0pt if the +<parameter>passivetex.extensions</parameter> +parameter is nonzero because PassiveTeX cannot handle +the math expression with negative values +used to calculate the indents. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/toc.indent.width.xml b/kdoctools/docbook/xsl/params/toc.indent.width.xml new file mode 100644 index 000000000..5ca83a45e --- /dev/null +++ b/kdoctools/docbook/xsl/params/toc.indent.width.xml @@ -0,0 +1,28 @@ +<refentry id="toc.indent.width"> +<refmeta> +<refentrytitle>toc.indent.width</refentrytitle> +<refmiscinfo role="type">float</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.indent.width</refname> +<refpurpose>Amount of indentation for TOC entries</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='toc.indent.width.frag'> +<xsl:param name="toc.indent.width" select="24"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies, in points, the distance by which each level of the +TOC is indented from its parent.</para> + +<para>This value is expressed in points, without +a unit (in other words, it is a bare number). Using a bare number allows the stylesheet +to perform calculations that would otherwise have to be performed by the FO processor +because not all processors support expressions.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/toc.list.type.xml b/kdoctools/docbook/xsl/params/toc.list.type.xml new file mode 100644 index 000000000..a0475b8a0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/toc.list.type.xml @@ -0,0 +1,25 @@ +<refentry id="toc.list.type"> +<refmeta> +<refentrytitle>toc.list.type</refentrytitle> +<refmiscinfo role="type">list</refmiscinfo> +<refmiscinfo role="value">dl</refmiscinfo> +<refmiscinfo role="value">ul</refmiscinfo> +<refmiscinfo role="value">ol</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.list.type</refname> +<refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='toc.list.type.frag'><xsl:param name="toc.list.type">dl</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>When an automatically generated Table of Contents (or List of Titles) +is produced, this HTML element will be used to make the list. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/toc.margin.properties.xml b/kdoctools/docbook/xsl/params/toc.margin.properties.xml new file mode 100644 index 000000000..077396776 --- /dev/null +++ b/kdoctools/docbook/xsl/params/toc.margin.properties.xml @@ -0,0 +1,24 @@ +<refentry id="toc.margin.properties"> +<refnamediv> +<refname>toc.margin.properties</refname> +<refpurpose>Margin properties used on Tables of Contents</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='toc.margin.properties.frag'> +<xsl:attribute-set name="toc.margin.properties"> + <xsl:attribute name="space-before.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.maximum">2em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.5em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.maximum">2em</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para>This attribute set is used on Tables of Contents. These attributes are set +on the wrapper that surrounds the ToC block, not on each individual lines.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/toc.max.depth.xml b/kdoctools/docbook/xsl/params/toc.max.depth.xml new file mode 100644 index 000000000..d96d02658 --- /dev/null +++ b/kdoctools/docbook/xsl/params/toc.max.depth.xml @@ -0,0 +1,20 @@ +<refentry id="toc.max.depth"> +<refmeta> +<refentrytitle>toc.max.depth</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.max.depth</refname> +<refpurpose>How maximaly deep should be each TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='toc.max.depth.frag'><xsl:param name="toc.max.depth">8</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the maximal depth of TOC on all levels.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/toc.section.depth.xml b/kdoctools/docbook/xsl/params/toc.section.depth.xml new file mode 100644 index 000000000..3051219a9 --- /dev/null +++ b/kdoctools/docbook/xsl/params/toc.section.depth.xml @@ -0,0 +1,23 @@ +<refentry id="toc.section.depth"> +<refmeta> +<refentrytitle>toc.section.depth</refentrytitle> +<refmiscinfo role="type">integer</refmiscinfo> +</refmeta> +<refnamediv> +<refname>toc.section.depth</refname> +<refpurpose>How deep should recursive <sgmltag>section</sgmltag>s appear +in the TOC?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='toc.section.depth.frag'><xsl:param name="toc.section.depth">2</xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Specifies the depth to which recursive sections should appear in the +TOC. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/ulink.footnote.number.format.xml b/kdoctools/docbook/xsl/params/ulink.footnote.number.format.xml new file mode 100644 index 000000000..2196c2b47 --- /dev/null +++ b/kdoctools/docbook/xsl/params/ulink.footnote.number.format.xml @@ -0,0 +1,23 @@ +<refentry id="ulink.footnote.number.format"> +<refmeta> +<refentrytitle>ulink.footnote.number.format</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.footnote.number.format</refname> +<refpurpose>Identifies the format used for <sgmltag>ulink</sgmltag> footnote numbers</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='ulink.footnote.number.format.frag'> +<xsl:param name="ulink.footnote.number.format" select="'1'"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>ulink.footnote.number.format</parameter> specifies the format +to use for footnote numeration (1, i, I, a, or A).</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/ulink.footnotes.xml b/kdoctools/docbook/xsl/params/ulink.footnotes.xml new file mode 100644 index 000000000..9a1ee1ca9 --- /dev/null +++ b/kdoctools/docbook/xsl/params/ulink.footnotes.xml @@ -0,0 +1,24 @@ +<refentry id="ulink.footnotes"> +<refmeta> +<refentrytitle>ulink.footnotes</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.footnotes</refname> +<refpurpose>Generate footnotes for <sgmltag>ULink</sgmltag>s?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='ulink.footnotes.frag'> +<xsl:param name="ulink.footnotes" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, the URL of each <sgmltag>ULink</sgmltag> will +appear as a footnote. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/ulink.hyphenate.xml b/kdoctools/docbook/xsl/params/ulink.hyphenate.xml new file mode 100644 index 000000000..4c4fc84f3 --- /dev/null +++ b/kdoctools/docbook/xsl/params/ulink.hyphenate.xml @@ -0,0 +1,28 @@ +<refentry id="ulink.hyphenate"> +<refmeta> +<refentrytitle>ulink.hyphenate</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.hyphenate</refname> +<refpurpose>Allow URLs to be automatically hyphenated</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='ulink.hyphenate.frag'> +<xsl:param name="ulink.hyphenate" select="''"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If not empty, the specified character (or more generally, content) is +added to URLs after every <quote>/</quote>. If the character specified is a +Unicode soft hyphen (0x00AD) or Unicode zero-width space (0x200B), some FO +processors will be able to reasonably hyphenate long URLs.</para> + +<para>As of 28 Jan 2002, discretionary hyphens are more widely and correctly +supported than zero-width spaces for this purpose.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/ulink.show.xml b/kdoctools/docbook/xsl/params/ulink.show.xml new file mode 100644 index 000000000..be6bcc238 --- /dev/null +++ b/kdoctools/docbook/xsl/params/ulink.show.xml @@ -0,0 +1,24 @@ +<refentry id="ulink.show"> +<refmeta> +<refentrytitle>ulink.show</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.show</refname> +<refpurpose>Display URLs after <sgmltag>ulink</sgmltag>s?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='ulink.show.frag'> +<xsl:param name="ulink.show" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, the URL of each <sgmltag>ULink</sgmltag> will +appear after the text of the link. If the text of the link and the URL +are identical, the URL is suppressed.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/ulink.target.xml b/kdoctools/docbook/xsl/params/ulink.target.xml new file mode 100644 index 000000000..010effe21 --- /dev/null +++ b/kdoctools/docbook/xsl/params/ulink.target.xml @@ -0,0 +1,22 @@ +<refentry id="ulink.target"> +<refmeta> +<refentrytitle>ulink.target</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>ulink.target</refname> +<refpurpose>The HTML anchor target for ULinks</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='ulink.target.frag'><xsl:param name="ulink.target" select="'_top'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>ulink.target</parameter> is set, its value will +be used for the <sgmltag class="attribute">target</sgmltag> attribute +on anchors generated for <sgmltag>ulink</sgmltag>s.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/use.embed.for.svg.xml b/kdoctools/docbook/xsl/params/use.embed.for.svg.xml new file mode 100644 index 000000000..9b82c60af --- /dev/null +++ b/kdoctools/docbook/xsl/params/use.embed.for.svg.xml @@ -0,0 +1,28 @@ +<refentry id="use.embed.for.svg"> +<refmeta> +<refentrytitle>use.embed.for.svg</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.embed.for.svg</refname> +<refpurpose>Use HTML <sgmltag>embed</sgmltag> for SVG?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='use.embed.for.svg.frag'> +<xsl:param name="use.embed.for.svg" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, an <sgmltag>embed</sgmltag> element will be created for +SVG figures. An <sgmltag>object</sgmltag> is <emphasis>always</emphasis> created, +this parameter merely controls whether or not an additional <sgmltag>embed</sgmltag> +is generated inside the <sgmltag>object</sgmltag>.</para> + +<para>On the plus side, this may be more portable among browsers and plug-ins. +On the minus side, it isn't valid HTML.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/use.extensions.xml b/kdoctools/docbook/xsl/params/use.extensions.xml new file mode 100644 index 000000000..721bf59d5 --- /dev/null +++ b/kdoctools/docbook/xsl/params/use.extensions.xml @@ -0,0 +1,24 @@ +<refentry id="use.extensions"> +<refmeta> +<refentrytitle>use.extensions</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.extensions</refname> +<refpurpose>Enable extensions</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='use.extensions.frag'><xsl:param name="use.extensions" select="'0'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, extensions may be used. Each extension is +further controlled by its own parameter. But if +<parameter>use.extensions</parameter> is zero, no extensions will +be used. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/use.id.as.filename.xml b/kdoctools/docbook/xsl/params/use.id.as.filename.xml new file mode 100644 index 000000000..90beb8df0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/use.id.as.filename.xml @@ -0,0 +1,23 @@ +<refentry id="use.id.as.filename"> +<refmeta> +<refentrytitle>use.id.as.filename</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.id.as.filename</refname> +<refpurpose>Use ID value of chunk elements as the filename?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='use.id.as.filename.frag'><xsl:param name="use.id.as.filename" select="'0'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If <parameter>use.id.as.filename</parameter> +is non-zero, the filename of chunk elements that have IDs will be +derived from the ID value. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/use.id.function.xml b/kdoctools/docbook/xsl/params/use.id.function.xml new file mode 100644 index 000000000..b9ceb5890 --- /dev/null +++ b/kdoctools/docbook/xsl/params/use.id.function.xml @@ -0,0 +1,25 @@ +<refentry id="use.id.function"> +<refmeta> +<refentrytitle>use.id.function</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.id.function</refname> +<refpurpose>Use the XPath id() function to find link targets?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='use.id.function.frag'><xsl:param name="use.id.function" select="'1'"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If 1, the stylesheets use the <function>id()</function> function +to find the targets of cross reference elements. This is more +efficient, but only works if your XSLT processor implements the +<function>id()</function> function, naturally.</para> +<para>THIS PARAMETER IS NOT SUPPORTED. IT IS ALWAYS ASSUMED TO BE 1. +SEE xref.xsl IF YOU NEED TO TURN IT OFF.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/use.local.olink.style.xml b/kdoctools/docbook/xsl/params/use.local.olink.style.xml new file mode 100644 index 000000000..3b893792e --- /dev/null +++ b/kdoctools/docbook/xsl/params/use.local.olink.style.xml @@ -0,0 +1,23 @@ +<refentry id="use.local.olink.style"> +<refmeta> +<refentrytitle>use.local.olink.style</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.local.olink.style</refname> +<refpurpose>Process olinks using xref style of current +document</refpurpose> +</refnamediv> +<refsynopsisdiv> <src:fragment id="use.local.olink.style.frag"> +<xsl:param name="use.local.olink.style" select="0"/> </src:fragment> +</refsynopsisdiv> +<refsect1> +<title>Description</title> +<para>When cross reference data is collected for use by olinks, the data for each potential target includes one field containing a completely assembled cross reference string, as if it were an xref generated in that document. Other fields record the separate title, number, and element name of each target. When an olink is formed to a target from another document, the olink resolves to that preassembled string by default. If the <parameter>use.local.olink.style</parameter> parameter is set to non-zero, then instead the cross +reference string is formed again from the target title, number, and +element name, using the stylesheet processing the targeting document. +Then olinks will match the xref style in the targeting document +rather than in the target document. If both documents are processed +with the same stylesheet, then the results will be the same.</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/use.role.as.xrefstyle.xml b/kdoctools/docbook/xsl/params/use.role.as.xrefstyle.xml new file mode 100644 index 000000000..9f29e95c2 --- /dev/null +++ b/kdoctools/docbook/xsl/params/use.role.as.xrefstyle.xml @@ -0,0 +1,91 @@ +<refentry id="use.role.as.xrefstyle"> +<refmeta> +<refentrytitle>use.role.as.xrefstyle</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.role.as.xrefstyle</refname> +<refpurpose>Use <sgmltag class="attribute">role</sgmltag> attribute for +<sgmltag class="attribute">xrefstyle</sgmltag> on <sgmltag>xref</sgmltag>?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='use.role.as.xrefstyle.frag'> +<xsl:param name="use.role.as.xrefstyle" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, the <sgmltag class="attribute">role</sgmltag> attribute on +<sgmltag>xref</sgmltag> will be used to select the cross reference style. +The <ulink url="http://www.oasis-open.org/docbook/">DocBook +Technical Committee</ulink> recently added an +<sgmltag class="attribute">xrefstyle</sgmltag> attribute for this purpose. +If the <sgmltag class="attribute">xrefstyle</sgmltag> attribute +is present, <sgmltag class="attribute">role</sgmltag> will be ignored, regardless +of this setting.</para> + +<para>Until an official DocBook release that includes the new +attribute, this flag allows <sgmltag class="attribute">role</sgmltag> +to serve that purpose.</para> + +</refsect1> + +<refsect1><title>Example</title> + +<para>The following small stylesheet shows how to configure the stylesheets to make +use of the cross reference style:</para> + +<programlisting><![CDATA[<?xml version="1.0"?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="1.0"> + +<xsl:import href="../xsl/html/docbook.xsl"/> + +<xsl:output method="html"/> + +<xsl:param name="local.l10n.xml" select="document('')"/> +<l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"> + <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en"> + <l:context name="xref"> + <l:template name="chapter" style="title" text="Chapter %n, %t"/> + <l:template name="chapter" text="Chapter %n"/> + </l:context> + </l:l10n> +</l:i18n> + +</xsl:stylesheet>]]></programlisting> + +<para>With this stylesheet, the cross references in the following document:</para> + +<programlisting><![CDATA[<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<book id="book"><title>Book</title> + +<preface> +<title>Preface</title> + +<para>Normal: <xref linkend="ch1"/>.</para> +<para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para> + +</preface> + +<chapter id="ch1"> +<title>First Chapter</title> + +<para>Irrelevant.</para> + +</chapter> +</book>]]></programlisting> + +<para>will appear as:</para> + +<informalexample> +<para>Normal: Chapter 1.</para> +<para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para> +</informalexample> +</refsect1> + +</refentry> diff --git a/kdoctools/docbook/xsl/params/use.role.for.mediaobject.xml b/kdoctools/docbook/xsl/params/use.role.for.mediaobject.xml new file mode 100644 index 000000000..d78df1897 --- /dev/null +++ b/kdoctools/docbook/xsl/params/use.role.for.mediaobject.xml @@ -0,0 +1,51 @@ +<refentry id="use.role.for.mediaobject"> +<refmeta> +<refentrytitle>use.role.for.mediaobject</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.role.for.mediaobject</refname> +<refpurpose>Use <sgmltag class="attribute">role</sgmltag> attribute +value for selecting which of several objects within a mediaobject to use. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='use.role.for.mediaobject.frag'> +<xsl:param name="use.role.for.mediaobject" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, the <sgmltag class="attribute">role</sgmltag> attribute on +<sgmltag>imageobject</sgmltag>s or other objects within a <sgmltag>mediaobject</sgmltag> container will be used to select which object will be +used. +</para> +<para> +The order of selection when then parameter is non-zero is: +</para> +<orderedlist> +<listitem> + <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para> +</listitem> +<listitem> +<para>Else if an object's role attribute has a value of +<literal>html</literal> for HTML processing or +<literal>fo</literal> for FO output, then the first +of such objects is selected. +</para> +</listitem> +<listitem> +<para>Else the first suitable object is selected.</para> +</listitem> +</orderedlist> +<para> +If the value of +<parameter>use.role.for.mediaobject</parameter> +is zero, then role attributes are not considered +and the first suitable object +with or without a role value is used. +</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/use.svg.xml b/kdoctools/docbook/xsl/params/use.svg.xml new file mode 100644 index 000000000..041d1addc --- /dev/null +++ b/kdoctools/docbook/xsl/params/use.svg.xml @@ -0,0 +1,25 @@ +<refentry id="use.svg"> +<refmeta> +<refentrytitle>use.svg</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>use.svg</refname> +<refpurpose>Allow SVG in the result tree?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='use.svg.frag'> +<xsl:param name="use.svg" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, SVG will be considered an acceptable image format. SVG +is passed through to the result tree, so correct rendering of the resulting +diagram depends on the formatter (FO processor or web browser) that is used +to process the output from the stylesheet.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/variablelist.as.blocks.xml b/kdoctools/docbook/xsl/params/variablelist.as.blocks.xml new file mode 100644 index 000000000..017e16651 --- /dev/null +++ b/kdoctools/docbook/xsl/params/variablelist.as.blocks.xml @@ -0,0 +1,44 @@ +<refentry id="variablelist.as.blocks"> +<refmeta> +<refentrytitle>variablelist.as.blocks</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.as.blocks</refname> +<refpurpose>Format <sgmltag>variablelist</sgmltag>s lists as blocks?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='variablelist.as.blocks.frag'> +<xsl:param name="variablelist.as.blocks" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, <sgmltag>variablelist</sgmltag>s will be formatted as +blocks.</para> + +<para>If you have long terms, proper list markup in the FO case may produce +unattractive lists. By setting this parameter, you can force the stylesheets +to produce block markup instead of proper lists.</para> + +<para>You can override this setting with a processing instruction as the +child of <sgmltag>variablelist</sgmltag>: <sgmltag class="pi">dbfo +list-presentation="blocks"</sgmltag> or <sgmltag class="pi">dbfo +list-presentation="list"</sgmltag></para> + +<programlisting><![CDATA[ <variablelist> + <?dbfo list-presentation="list"?> + <varlistentry> + <term>list</term> + <listitem> + <para> + Formatted as a list even if variablelist.as.blocks is set to 1. + </para> + </listitem> + </varlistentry> + </variablelist>]]></programlisting> +</refsect1> + +</refentry> diff --git a/kdoctools/docbook/xsl/params/variablelist.as.table.xml b/kdoctools/docbook/xsl/params/variablelist.as.table.xml new file mode 100644 index 000000000..92eb57ffc --- /dev/null +++ b/kdoctools/docbook/xsl/params/variablelist.as.table.xml @@ -0,0 +1,27 @@ +<refentry id="variablelist.as.table"> +<refmeta> +<refentrytitle>variablelist.as.table</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>variablelist.as.table</refname> +<refpurpose>Format <sgmltag>variablelist</sgmltag>s as tables?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='variablelist.as.table.frag'> +<xsl:param name="variablelist.as.table" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, <sgmltag>variablelist</sgmltag>s will be formatted as +tables.</para> + +<para>This parameter only applys to the HTML transformations. In the +FO case, proper list markup is robust enough to handle the formatting. +But see also <parameter>variablelist.as.blocks</parameter>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/variablelist.max.termlength.xml b/kdoctools/docbook/xsl/params/variablelist.max.termlength.xml new file mode 100644 index 000000000..8cad72df7 --- /dev/null +++ b/kdoctools/docbook/xsl/params/variablelist.max.termlength.xml @@ -0,0 +1,41 @@ +<refentry id="variablelist.max.termlength"> +<refmeta> +<refentrytitle>variablelist.max.termlength</refentrytitle> + +</refmeta> +<refnamediv> +<refname>variablelist.max.termlength</refname> +<refpurpose>Specifies the longest term in variablelists</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='variablelist.max.termlength.frag'> +<xsl:param name="variablelist.max.termlength">24</xsl:param> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>In variablelists, the <sgmltag>listitem</sgmltag> +is indented to leave room for the +<sgmltag>term</sgmltag> elements. That indent may be computed +if it is not specified with a <sgmltag class="attribute">termlength</sgmltag> +attribute on the <sgmltag>variablelist</sgmltag> element. +</para> +<para> +The computation counts characters in the +<sgmltag>term</sgmltag> elements in the list +to find the longest term. However, some terms are very long +and would produce extreme indents. This parameter lets you +set a maximum character count. Any terms longer than the maximum +would line wrap. The default value is 24. +</para> +<para> +The character counts are converted to physical widths +by multiplying by 0.50em. There will be some variability +in how many actual characters fit in the space +since some characters are wider than others. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/verbatim.properties.xml b/kdoctools/docbook/xsl/params/verbatim.properties.xml new file mode 100644 index 000000000..be93b3515 --- /dev/null +++ b/kdoctools/docbook/xsl/params/verbatim.properties.xml @@ -0,0 +1,24 @@ +<refentry id="verbatim.properties"> +<refnamediv> +<refname>verbatim.properties</refname> +<refpurpose>Properties associated with verbatim text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='verbatim.properties.frag'> +<xsl:attribute-set name="verbatim.properties"> + <xsl:attribute name="space-before.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.optimum">1em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.2em</xsl:attribute> + <xsl:attribute name="space-after.minimum">0.8em</xsl:attribute> + <xsl:attribute name="space-after.optimum">1em</xsl:attribute> + <xsl:attribute name="space-after.maximum">1.2em</xsl:attribute> + <xsl:attribute name="hyphenate">false</xsl:attribute> +</xsl:attribute-set></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para>This attribute set is used on all verbatim environments.</para> +</refsect1> + +</refentry> diff --git a/kdoctools/docbook/xsl/params/wordml.template.xml b/kdoctools/docbook/xsl/params/wordml.template.xml new file mode 100644 index 000000000..1a37dced0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/wordml.template.xml @@ -0,0 +1,23 @@ +<refentry id="wordml.template"> +<refmeta> +<refentrytitle>wordml.template</refentrytitle> +</refmeta> +<refnamediv> +<refname>wordml.template</refname> +<refpurpose>Specify the template WordML document</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='wordml.template.frag'> +<xsl:param name="wordml.template" select=""/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>The <parameter>wordml.template</parameter> parameter specifies a WordML document to use as a template for the generated document. The template document is used to define the (extensive) headers for the generated document, in particular the paragraph and character styles that are used to format the various elements. Any content in the template document is ignored.</para> + +<para>A template document is used in order to allow maintenance of the paragraph and character styles to be done using Word itself, rather than these XSL stylesheets.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/xep.extensions.xml b/kdoctools/docbook/xsl/params/xep.extensions.xml new file mode 100644 index 000000000..f28029c9c --- /dev/null +++ b/kdoctools/docbook/xsl/params/xep.extensions.xml @@ -0,0 +1,26 @@ +<refentry id="xep.extensions"> +<refmeta> +<refentrytitle>xep.extensions</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xep.extensions</refname> +<refpurpose>Enable XEP extensions?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='xep.extensions.frag'><xsl:param name="xep.extensions" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>If non-zero, +<ulink url="http://www.renderx.com/">XEP</ulink> +extensions will be used. XEP extensions consists of PDF bookmarks, +document information and better index processing. +</para> + +<para>This parameter can also affect which graphics file formats +are supported</para> +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/xep.index.item.properties.xml b/kdoctools/docbook/xsl/params/xep.index.item.properties.xml new file mode 100644 index 000000000..460daf589 --- /dev/null +++ b/kdoctools/docbook/xsl/params/xep.index.item.properties.xml @@ -0,0 +1,24 @@ +<refentry id="xep.index.item.properties"> +<refnamediv> +<refname>xep.index.item.properties</refname> +<refpurpose>Properties associated with XEP index-items</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='xep.index.item.properties.frag'> +<xsl:attribute-set name="xep.index.item.properties"> + <xsl:attribute name="merge-subsequent-page-numbers">true</xsl:attribute> + <xsl:attribute name="link-back">true</xsl:attribute> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Properties associated with XEP index-items. For more info see +the section "Indexes" in +<ulink + url="http://xep.xattic.com/xep/doc/spec.html"/>.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/xref.label-page.separator.xml b/kdoctools/docbook/xsl/params/xref.label-page.separator.xml new file mode 100644 index 000000000..a54400294 --- /dev/null +++ b/kdoctools/docbook/xsl/params/xref.label-page.separator.xml @@ -0,0 +1,33 @@ +<refentry id="xref.label-page.separator"> +<refmeta> +<refentrytitle>xref.label-page.separator</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.label-page.separator</refname> +<refpurpose>Punctuation or space separating label from page number in xref</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='xref.label-page.separator.frag'><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para> +This parameter allows you to control the punctuation of certain +types of generated cross reference text. +When cross reference text is generated for an +<sgmltag class="element">xref</sgmltag> or +<sgmltag class="element">olink</sgmltag> element +using an <sgmltag class="attribute">xrefstyle</sgmltag> attribute +that makes use of the <literal>select:</literal> feature, +and the selected components include both label and page +but no title, +then the value of this parameter is inserted between +label and page number in the output. +If a title is included, then other separators are used. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/xref.label-title.separator.xml b/kdoctools/docbook/xsl/params/xref.label-title.separator.xml new file mode 100644 index 000000000..7e21c25c8 --- /dev/null +++ b/kdoctools/docbook/xsl/params/xref.label-title.separator.xml @@ -0,0 +1,31 @@ +<refentry id="xref.label-title.separator"> +<refmeta> +<refentrytitle>xref.label-title.separator</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.label-title.separator</refname> +<refpurpose>Punctuation or space separating label from title in xref</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='xref.label-title.separator.frag'><xsl:param name="xref.label-title.separator">: </xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para> +This parameter allows you to control the punctuation of certain +types of generated cross reference text. +When cross reference text is generated for an +<sgmltag class="element">xref</sgmltag> or +<sgmltag class="element">olink</sgmltag> element +using an <sgmltag class="attribute">xrefstyle</sgmltag> attribute +that makes use of the <literal>select:</literal> feature, +and the selected components include both label and title, +then the value of this parameter is inserted between +label and title in the output. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/xref.properties.xml b/kdoctools/docbook/xsl/params/xref.properties.xml new file mode 100644 index 000000000..9212c57f7 --- /dev/null +++ b/kdoctools/docbook/xsl/params/xref.properties.xml @@ -0,0 +1,19 @@ +<refentry id="xref.properties"> +<refnamediv> +<refname>xref.properties</refname> +<refpurpose>Properties associated with cross-reference text</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='xref.properties.frag'> +<xsl:attribute-set name="xref.properties"> +</xsl:attribute-set> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>This attribute set is used on cross reference text.</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/xref.title-page.separator.xml b/kdoctools/docbook/xsl/params/xref.title-page.separator.xml new file mode 100644 index 000000000..c38ebb400 --- /dev/null +++ b/kdoctools/docbook/xsl/params/xref.title-page.separator.xml @@ -0,0 +1,31 @@ +<refentry id="xref.title-page.separator"> +<refmeta> +<refentrytitle>xref.title-page.separator</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.title-page.separator</refname> +<refpurpose>Punctuation or space separating title from page number in xref</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='xref.title-page.separator.frag'><xsl:param name="xref.title-page.separator"><xsl:text> </xsl:text></xsl:param></src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para> +This parameter allows you to control the punctuation of certain +types of generated cross reference text. +When cross reference text is generated for an +<sgmltag class="element">xref</sgmltag> or +<sgmltag class="element">olink</sgmltag> element +using an <sgmltag class="attribute">xrefstyle</sgmltag> attribute +that makes use of the <literal>select:</literal> feature, +and the selected components include both title and page number, +then the value of this parameter is inserted between +title and page number in the output. +</para> + +</refsect1> +</refentry> diff --git a/kdoctools/docbook/xsl/params/xref.with.number.and.title.xml b/kdoctools/docbook/xsl/params/xref.with.number.and.title.xml new file mode 100644 index 000000000..0656835d0 --- /dev/null +++ b/kdoctools/docbook/xsl/params/xref.with.number.and.title.xml @@ -0,0 +1,22 @@ +<refentry id="xref.with.number.and.title"> +<refmeta> +<refentrytitle>xref.with.number.and.title</refentrytitle> +<refmiscinfo role="type">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>xref.with.number.and.title</refname> +<refpurpose>Use number and title in cross references</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment id='xref.with.number.and.title.frag'> +<xsl:param name="xref.with.number.and.title" select="1"/> +</src:fragment> +</refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>FIXME:</para> + +</refsect1> +</refentry> |
