GNOME.org

DocBook to HTML - Block Elements

This module handles most simple block-level elements, turning them into the appropriate HTML tags. It does not handle tables, lists, and various other complex block-level elements.

Templates
db2html.block

Renders a block-level element to an HTML div tag

db2html.block.title

Renders a formal title for a block-level element

db2html.blockquote

Renders a blockquote element to HTML

db2html.para

Renders a block-level element as an HTML p element

db2html.pre

Renders a block-level element as an HTML pre element

db2html.block

db2html.block — Renders a block-level element to an HTML div tag

Parameters

node

The block-level element to render

class

An extra string to insert in the class attribute

first

Whether this is the first child block in the parent

indent

Whether this block should be indented

verbatim

Whether to maintain whitespace as written

formal

Whether this is a formal block element

title

When formal is true, an element to use for the title

caption

When formal is true, an element to use for the caption

lang

The locale of the text in node

dir

The text direction, either ltr or rtl

ltr

Whether to default to ltr if neither lang nor dir is specified

Description

This template creates an HTML div element for the given DocBook element. This template uses the parameters to construct the class attribute, which is then used by the CSS for styling.

db2html.block.title

db2html.block.title — Renders a formal title for a block-level element

Parameters

node

The block-level element being processed

title

The element containing the title

lang

The locale of the text in title

dir

The text direction, either ltr or rtl

ltr

Whether to default to ltr if neither lang nor dir is specified

Description

This template formats the contents of title as a title for a block-level element. It is called by db2html.block for formal block elements.

db2html.blockquote

db2html.blockquote — Renders a blockquote element to HTML

Parameters

node

The blockquote element to render

first

Whether this is the first child block in the parent

lang

The locale of the text in node

dir

The text direction, either ltr or rtl

ltr

Whether to default to ltr if neither lang nor dir is specified

Description

This template creates an HTML blockquote element for the given DocBook element.

db2html.para

db2html.para — Renders a block-level element as an HTML p element

Parameters

node

The block-level element to render

first

Whether this is the first child block in the parent

lang

The locale of the text in node

dir

The text direction, either ltr or rtl

ltr

Whether to default to ltr if neither lang nor dir is specified

Description

This template creates an HTML p element for the given DocBook element.

db2html.pre

db2html.pre — Renders a block-level element as an HTML pre element

Parameters

node

The block-level element to render

class

An extra string to insert in the class attribute

first

Whether this is the first child block in the parent

indent

Whether this block should be indented

children

The child elements to process

lang

The locale of the text in node

dir

The text direction, either ltr or rtl

ltr

Whether to default to ltr if neither lang nor dir is specified

Description

This template creates an HTML pre element for the given DocBook element. This template uses the parameters to construct the class attribute, which is then used by the CSS for styling.

If node has the linenumbering attribute set to "numbered", then this template will create line numbers for each line, using the db.linenumbering template.

DocBook to HTML - Bibliographies DocBook to HTML - Callouts

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.