<?xml version="1.0" encoding="utf-8"?>
<section id="S__db2html-division"><title>DocBook to HTML - Division Elements</title>
  <remark>Describe this module</remark>
  <variablelist><title>Parameters</title><varlistentry><term><link linkend="P__db2html_linktrail"><parameter>db2html.linktrail</parameter></link></term><listitem><para>Whether to place a link trail under the header</para></listitem></varlistentry><varlistentry><term><link linkend="P__db2html_navbar_top"><parameter>db2html.navbar.top</parameter></link></term><listitem><para>Whether to place a navigation bar at the top of the page</para></listitem></varlistentry><varlistentry><term><link linkend="P__db2html_navbar_bottom"><parameter>db2html.navbar.bottom</parameter></link></term><listitem><para>Whether to place a navigation bar at the bottom of the page</para></listitem></varlistentry><varlistentry><term><link linkend="P__db2html_sidenav"><parameter>db2html.sidenav</parameter></link></term><listitem><para>Whether to create a navigation sidebar</para></listitem></varlistentry></variablelist><variablelist><title>Modes</title><varlistentry><term><link linkend="M__db2html_division_div_content_mode"><function>db2html.division.div.content.mode</function></link></term><listitem><para>Renders the block-level content of a division element</para></listitem></varlistentry></variablelist><variablelist><title>Templates</title><varlistentry><term><link linkend="T__db2html_division_html"><function>db2html.division.html</function></link></term><listitem><para>Renders a complete HTML page for a division element</para></listitem></varlistentry><varlistentry><term><link linkend="T__db2html_division_div"><function>db2html.division.div</function></link></term><listitem><para>Renders the content of a division element, chunking children if necessary</para></listitem></varlistentry><varlistentry><term><link linkend="T__db2html_header"><function>db2html.header</function></link></term><listitem><para>Generates a header with a title and optional subtitle</para></listitem></varlistentry><varlistentry><term><link linkend="T__db2html_linktrail"><function>db2html.linktrail</function></link></term><listitem><para>Generates links to pages from ancestor elements</para></listitem></varlistentry><varlistentry><term><link linkend="T__db2html_navbar"><function>db2html.navbar</function></link></term><listitem><para>Generates navigation links for a page</para></listitem></varlistentry><varlistentry><term><link linkend="T__db2html_sidenav"><function>db2html.sidenav</function></link></term><listitem><para>Generates a navigation sidebar</para></listitem></varlistentry><varlistentry><term><link linkend="T__db2html_division_head_extra"><function>db2html.division.head.extra</function></link></term><listitem><para>FIXME</para></listitem></varlistentry><varlistentry><term><link linkend="T__db2html_division_top"><function>db2html.division.top</function></link></term><listitem><para>FIXME</para></listitem></varlistentry><varlistentry><term><link linkend="T__db2html_division_sidebar"><function>db2html.division.sidebar</function></link></term><listitem><para>FIXME</para></listitem></varlistentry><varlistentry><term><link linkend="T__db2html_division_bottom"><function>db2html.division.bottom</function></link></term><listitem><para>FIXME</para></listitem></varlistentry></variablelist><refentry id="P__db2html_linktrail"><indexterm><primary>db2html.linktrail</primary></indexterm><refnamediv><refname><parameter>db2html.linktrail</parameter></refname><refpurpose>Whether to place a link trail under the header</refpurpose></refnamediv><refsection><title>Description</title>
  <para>This boolean parameter specifies whether a block containing links to
  ancestor elements should be included under the header.</para>
  </refsection></refentry><refentry id="P__db2html_navbar_top"><indexterm><primary>db2html.navbar.top</primary></indexterm><refnamediv><refname><parameter>db2html.navbar.top</parameter></refname><refpurpose>Whether to place a navigation bar at the top of the page</refpurpose></refnamediv><refsection><title>Description</title>
  <para>This boolean parameter specifies whether a block containing navigation
  links should be placed at the top of the page.  The top navigation bar
  is inserted by <function><link linkend="T__db2html_division_top">db2html.division.top</link></function>, so this parameter may have no
  effect if that template has been overridden.</para>
  </refsection></refentry><refentry id="P__db2html_navbar_bottom"><indexterm><primary>db2html.navbar.bottom</primary></indexterm><refnamediv><refname><parameter>db2html.navbar.bottom</parameter></refname><refpurpose>Whether to place a navigation bar at the bottom of the page</refpurpose></refnamediv><refsection><title>Description</title>
  <para>This boolean parameter specifies whether a block containing navigation
  links should be placed at the bottom of the page.  The bottom navigation
  bar is inserted by <function><link linkend="T__db2html_division_bottom">db2html.division.bottom</link></function>, so this parameter may have
  no effect if that template has been overridden.</para>
  </refsection></refentry><refentry id="P__db2html_sidenav"><indexterm><primary>db2html.sidenav</primary></indexterm><refnamediv><refname><parameter>db2html.sidenav</parameter></refname><refpurpose>Whether to create a navigation sidebar</refpurpose></refnamediv><refsection><title>Description</title>
  <para>This boolean parameter specifies whether a full navigation tree in a sidebar.
  The navigation sidebar is inserted by <function><link linkend="T__db2html_division_sidebar">db2html.division.sidebar</link></function>, so this
  parameter may have no effect if that template has been overridden.</para>
  </refsection></refentry><refentry id="M__db2html_division_div_content_mode"><indexterm><primary>db2html.division.div.content.mode</primary></indexterm><refnamediv><refname><function>db2html.division.div.content.mode</function></refname><refpurpose>Renders the block-level content of a division element</refpurpose></refnamediv><refsection><title>Parameters</title><variablelist><varlistentry><term><parameter>depth_in_chunk</parameter></term><listitem><para>The depth of the context element in the containing chunk</para></listitem></varlistentry><varlistentry><term><parameter>depth_of_chunk</parameter></term><listitem><para>The depth of the containing chunk in the document</para></listitem></varlistentry></variablelist></refsection><refsection><title>Description</title>
  <remark>Talk about how this works with <literal>callback</literal></remark>
  </refsection></refentry><refentry id="T__db2html_division_html"><indexterm><primary>db2html.division.html</primary></indexterm><refnamediv><refname><function>db2html.division.html</function></refname><refpurpose>Renders a complete HTML page for a division element</refpurpose></refnamediv><refsection><title>Parameters</title><variablelist><varlistentry><term><parameter>node</parameter></term><listitem><para>The element to create an HTML page for</para></listitem></varlistentry><varlistentry><term><parameter>info</parameter></term><listitem><para>The info child element of <parameter>node</parameter></para></listitem></varlistentry><varlistentry><term><parameter>template</parameter></term><listitem><para>The named template to call to create the page</para></listitem></varlistentry><varlistentry><term><parameter>depth_of_chunk</parameter></term><listitem><para>The depth of the containing chunk in the document</para></listitem></varlistentry><varlistentry><term><parameter>prev_id</parameter></term><listitem><para>The id of the previous page</para></listitem></varlistentry><varlistentry><term><parameter>next_id</parameter></term><listitem><para>The id of the next page</para></listitem></varlistentry></variablelist></refsection><refsection><title>Description</title>
  <remark>Put in a word about the chunk flow; talk about what templates get called</remark>
  </refsection></refentry><refentry id="T__db2html_division_div"><indexterm><primary>db2html.division.div</primary></indexterm><refnamediv><refname><function>db2html.division.div</function></refname><refpurpose>Renders the content of a division element, chunking children if necessary</refpurpose></refnamediv><refsection><title>Parameters</title><variablelist><varlistentry><term><parameter>node</parameter></term><listitem><para>The element to render the content of</para></listitem></varlistentry><varlistentry><term><parameter>info</parameter></term><listitem><para>The info child element of <parameter>node</parameter></para></listitem></varlistentry><varlistentry><term><parameter>title_node</parameter></term><listitem><para>The element containing the title of <parameter>node</parameter></para></listitem></varlistentry><varlistentry><term><parameter>subtitle_node</parameter></term><listitem><para>The element containing the subtitle of <parameter>node</parameter></para></listitem></varlistentry><varlistentry><term><parameter>title_content</parameter></term><listitem><para>The title for divisions lacking a <literal>title</literal> tag</para></listitem></varlistentry><varlistentry><term><parameter>subtitle_content</parameter></term><listitem><para>The subtitle for divisions lacking a <literal>subtitle</literal> tag</para></listitem></varlistentry><varlistentry><term><parameter>entries</parameter></term><listitem><para>The entry-style child elements</para></listitem></varlistentry><varlistentry><term><parameter>divisions</parameter></term><listitem><para>The division-level child elements</para></listitem></varlistentry><varlistentry><term><parameter>callback</parameter></term><listitem><para>Whether to process <parameter>node</parameter> in <function><link linkend="M__db2html_division_div_content_mode">db2html.division.div.content.mode</link></function></para></listitem></varlistentry><varlistentry><term><parameter>depth_in_chunk</parameter></term><listitem><para>The depth of <parameter>node</parameter> in the containing chunk</para></listitem></varlistentry><varlistentry><term><parameter>depth_of_chunk</parameter></term><listitem><para>The depth of the containing chunk in the document</para></listitem></varlistentry><varlistentry><term><parameter>chunk_divisions</parameter></term><listitem><para>Whether to create new documents for <parameter>divisions</parameter></para></listitem></varlistentry><varlistentry><term><parameter>chunk_info</parameter></term><listitem><para>Whether to create a new document for a title page</para></listitem></varlistentry><varlistentry><term><parameter>autotoc_depth</parameter></term><listitem><para>How deep to create contents listings of <parameter>divisions</parameter></para></listitem></varlistentry><varlistentry><term><parameter>lang</parameter></term><listitem><para>The locale of the text in <parameter>node</parameter></para></listitem></varlistentry><varlistentry><term><parameter>dir</parameter></term><listitem><para>The text direction, either <literal>ltr</literal> or <literal>rtl</literal></para></listitem></varlistentry></variablelist></refsection><refsection><title>Description</title>
  <remark>Talk about some of the parameters</remark>
  </refsection></refentry><refentry id="T__db2html_header"><indexterm><primary>db2html.header</primary></indexterm><refnamediv><refname><function>db2html.header</function></refname><refpurpose>Generates a header with a title and optional subtitle</refpurpose></refnamediv><refsection><title>Parameters</title><variablelist><varlistentry><term><parameter>node</parameter></term><listitem><para>The element containing the title</para></listitem></varlistentry><varlistentry><term><parameter>title_node</parameter></term><listitem><para>The <literal>title</literal> element to render</para></listitem></varlistentry><varlistentry><term><parameter>subtitle_node</parameter></term><listitem><para>The <literal>subtitle</literal> element to render</para></listitem></varlistentry><varlistentry><term><parameter>depth_in_chunk</parameter></term><listitem><para>The depth of <parameter>node</parameter> in the containing chunk</para></listitem></varlistentry><varlistentry><term><parameter>depth_of_chunk</parameter></term><listitem><para>The depth of the containing chunk in the document</para></listitem></varlistentry><varlistentry><term><parameter>generate_label</parameter></term><listitem><para>Whether to generate a label in the title</para></listitem></varlistentry><varlistentry><term><parameter>title_content</parameter></term><listitem><para>An optional string containing the title</para></listitem></varlistentry><varlistentry><term><parameter>subtitle_content</parameter></term><listitem><para>An optional string containing the subtitle</para></listitem></varlistentry></variablelist></refsection><refsection><title>Description</title>
  <remark>Talk about the different kinds of title blocks</remark>
  </refsection></refentry><refentry id="T__db2html_linktrail"><indexterm><primary>db2html.linktrail</primary></indexterm><refnamediv><refname><function>db2html.linktrail</function></refname><refpurpose>Generates links to pages from ancestor elements</refpurpose></refnamediv><refsection><title>Parameters</title><variablelist><varlistentry><term><parameter>node</parameter></term><listitem><para>The element to generate links for</para></listitem></varlistentry></variablelist></refsection><refsection><title>Description</title>
  <remark>Describe this</remark>
  </refsection></refentry><refentry id="T__db2html_navbar"><indexterm><primary>db2html.navbar</primary></indexterm><refnamediv><refname><function>db2html.navbar</function></refname><refpurpose>Generates navigation links for a page</refpurpose></refnamediv><refsection><title>Parameters</title><variablelist><varlistentry><term><parameter>node</parameter></term><listitem><para>The element to generate links for</para></listitem></varlistentry><varlistentry><term><parameter>prev_id</parameter></term><listitem><para>The id of the previous page</para></listitem></varlistentry><varlistentry><term><parameter>next_id</parameter></term><listitem><para>The id of the next page</para></listitem></varlistentry><varlistentry><term><parameter>prev_node</parameter></term><listitem><para>The element of the previous page</para></listitem></varlistentry><varlistentry><term><parameter>next_node</parameter></term><listitem><para>The element of the next page</para></listitem></varlistentry><varlistentry><term><parameter>position</parameter></term><listitem><para>Where the block is positioned on the pages, either 'top' or 'bottom'</para></listitem></varlistentry></variablelist></refsection><refsection><title>Description</title>
  <remark>Document this template</remark>
  </refsection></refentry><refentry id="T__db2html_sidenav"><indexterm><primary>db2html.sidenav</primary></indexterm><refnamediv><refname><function>db2html.sidenav</function></refname><refpurpose>Generates a navigation sidebar</refpurpose></refnamediv><refsection><title>Parameters</title><variablelist><varlistentry><term><parameter>node</parameter></term><listitem><para>The currently-selected division element</para></listitem></varlistentry><varlistentry><term><parameter>template</parameter></term><listitem><para>The named template to call to create the page</para></listitem></varlistentry></variablelist></refsection><refsection><title>Description</title>
  <remark>Document this template</remark>
  </refsection></refentry><refentry id="T__db2html_division_head_extra"><indexterm><primary>db2html.division.head.extra</primary></indexterm><refnamediv><refname><function>db2html.division.head.extra</function></refname><refpurpose>FIXME</refpurpose></refnamediv><refsection><title>Description</title>
  <remark>Describe this stub template.</remark>
  </refsection></refentry><refentry id="T__db2html_division_top"><indexterm><primary>db2html.division.top</primary></indexterm><refnamediv><refname><function>db2html.division.top</function></refname><refpurpose>FIXME</refpurpose></refnamediv><refsection><title>Parameters</title><variablelist><varlistentry><term><parameter>node</parameter></term><listitem><para>The division element being rendered</para></listitem></varlistentry><varlistentry><term><parameter>info</parameter></term><listitem><para>The info child element of <parameter>node</parameter></para></listitem></varlistentry><varlistentry><term><parameter>template</parameter></term><listitem><para>The named template to call to create the page</para></listitem></varlistentry><varlistentry><term><parameter>depth_of_chunk</parameter></term><listitem><para>The depth of the containing chunk in the document</para></listitem></varlistentry><varlistentry><term><parameter>prev_id</parameter></term><listitem><para>The id of the previous page</para></listitem></varlistentry><varlistentry><term><parameter>next_id</parameter></term><listitem><para>The id of the next page</para></listitem></varlistentry><varlistentry><term><parameter>prev_node</parameter></term><listitem><para>The element of the previous page</para></listitem></varlistentry><varlistentry><term><parameter>next_node</parameter></term><listitem><para>The element of the next page</para></listitem></varlistentry></variablelist></refsection><refsection><title>Description</title>
  <remark>Describe this template</remark>
  </refsection></refentry><refentry id="T__db2html_division_sidebar"><indexterm><primary>db2html.division.sidebar</primary></indexterm><refnamediv><refname><function>db2html.division.sidebar</function></refname><refpurpose>FIXME</refpurpose></refnamediv><refsection><title>Parameters</title><variablelist><varlistentry><term><parameter>node</parameter></term><listitem><para>The division element being rendered</para></listitem></varlistentry><varlistentry><term><parameter>info</parameter></term><listitem><para>The info child element of <parameter>node</parameter></para></listitem></varlistentry><varlistentry><term><parameter>template</parameter></term><listitem><para>The named template to call to create the page</para></listitem></varlistentry><varlistentry><term><parameter>depth_of_chunk</parameter></term><listitem><para>The depth of the containing chunk in the document</para></listitem></varlistentry><varlistentry><term><parameter>prev_id</parameter></term><listitem><para>The id of the previous page</para></listitem></varlistentry><varlistentry><term><parameter>next_id</parameter></term><listitem><para>The id of the next page</para></listitem></varlistentry><varlistentry><term><parameter>prev_node</parameter></term><listitem><para>The element of the previous page</para></listitem></varlistentry><varlistentry><term><parameter>next_node</parameter></term><listitem><para>The element of the next page</para></listitem></varlistentry></variablelist></refsection><refsection><title>Description</title>
  <remark>Describe this template</remark>
  </refsection></refentry><refentry id="T__db2html_division_bottom"><indexterm><primary>db2html.division.bottom</primary></indexterm><refnamediv><refname><function>db2html.division.bottom</function></refname><refpurpose>FIXME</refpurpose></refnamediv><refsection><title>Parameters</title><variablelist><varlistentry><term><parameter>node</parameter></term><listitem><para>The division element being rendered</para></listitem></varlistentry><varlistentry><term><parameter>info</parameter></term><listitem><para>The info child element of <parameter>node</parameter></para></listitem></varlistentry><varlistentry><term><parameter>template</parameter></term><listitem><para>The named template to call to create the page</para></listitem></varlistentry><varlistentry><term><parameter>depth_of_chunk</parameter></term><listitem><para>The depth of the containing chunk in the document</para></listitem></varlistentry><varlistentry><term><parameter>prev_id</parameter></term><listitem><para>The id of the previous page</para></listitem></varlistentry><varlistentry><term><parameter>next_id</parameter></term><listitem><para>The id of the next page</para></listitem></varlistentry><varlistentry><term><parameter>prev_node</parameter></term><listitem><para>The element of the previous page</para></listitem></varlistentry><varlistentry><term><parameter>next_node</parameter></term><listitem><para>The element of the next page</para></listitem></varlistentry></variablelist></refsection><refsection><title>Description</title>
  <remark>Describe this template</remark>
  </refsection></refentry></section>
