GNOME.org

DocBook to HTML - Command Synopses

This module contains templates to process DocBook command synopsis elements.

Parameters
db2html.arg.choice

The default value of the choice parameter for arg elements

db2html.arg.rep

The default value of the rep parameter for arg elements

db2html.group.choice

The default value of the choice parameter for group elements

db2html.group.rep

The default value of the rep parameter for group elements

Modes
db2html.cmdsynopsis.sbr.padding.mode

Outputs padding for elements leading up to an sbr element

db2html.arg.choice

db2html.arg.choice — The default value of the choice parameter for arg elements

Description

db2html.arg.rep

db2html.arg.rep — The default value of the rep parameter for arg elements

Description

db2html.group.choice

db2html.group.choice — The default value of the choice parameter for group elements

Description

db2html.group.rep

db2html.group.rep — The default value of the rep parameter for group elements

Description

db2html.cmdsynopsis.sbr.padding.mode

db2html.cmdsynopsis.sbr.padding.mode — Outputs padding for elements leading up to an sbr element

Parameters

sbr

The sbr element to pad up to

sepchar

The value of the sepchar attribute on the enclosing cmdsynopsis

Description

When processed in this mode, elements output whitespace to the length of the textual output they would normally produce. This allows options to be aligned when explicit line breaks are inserted with sbr elements.

To create the padding for a given sbr element, this mode is called on the enclosing cmdsynopsis element, passing the sbr element. When processed in this mode, elements should only output padding for content the leads up to the sbr element passed in the sbr parameter. When processing children that don't contain the given sbr element, the sbr parameter should be set to false() for those children. This avoids additional ancestor selectors, which are generally expensive to perform.

DocBook to HTML - Class Synopses DocBook to HTML - CSS

About

Copyright

Copyright © 2004  Shaun McCance

Legal Notice

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this link or in the file COPYING-DOCS distributed with this manual.

This manual is part of a collection of GNOME manuals distributed under the GFDL. If you want to distribute this manual separately from the collection, you can do so by adding a copy of the license to the manual, as described in section 6 of the license.

Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and the members of the GNOME Documentation Project are made aware of those trademarks, then the names are in capital letters or initial capital letters.

DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE WITH THE FURTHER UNDERSTANDING THAT:

  1. DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER; AND
  2. UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, INITIAL WRITER, ANY CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR LOSSES ARISING OUT OF OR RELATING TO USE OF THE DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES.