home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / share / gnome / help / gnome-doc-xslt / C / db-chunk.xml next >
Encoding:
Text File  |  2006-08-07  |  14.6 KB  |  574 lines
  1. <section id="section-db-chunk">
  2.   <title>Chunking</title>
  3.   <variablelist>
  4.     <title>Parameters</title>
  5.     <varlistentry>
  6.       <term>
  7.         <link linkend="param_db.chunk.chunks">
  8.           <parameter>db.chunk.chunks</parameter>
  9.         </link>
  10.       </term>
  11.       <listitem>
  12.         <para>
  13.     A space-seperated list of the names of elements that should be chunked
  14.   </para>
  15.       </listitem>
  16.     </varlistentry>
  17.     <varlistentry>
  18.       <term>
  19.         <link linkend="param_db.chunk.chunk_top">
  20.           <parameter>db.chunk.chunk_top</parameter>
  21.         </link>
  22.       </term>
  23.       <listitem>
  24.         <para>
  25.     Whether the top-level chunk should be output with the chunking mechanism
  26.   </para>
  27.       </listitem>
  28.     </varlistentry>
  29.     <varlistentry>
  30.       <term>
  31.         <link linkend="param_db.chunk.max_depth">
  32.           <parameter>db.chunk.max_depth</parameter>
  33.         </link>
  34.       </term>
  35.       <listitem>
  36.         <para>
  37.     The maximum depth for chunking sections
  38.   </para>
  39.       </listitem>
  40.     </varlistentry>
  41.     <varlistentry>
  42.       <term>
  43.         <link linkend="param_db.chunk.basename">
  44.           <parameter>db.chunk.basename</parameter>
  45.         </link>
  46.       </term>
  47.       <listitem>
  48.         <para>
  49.     The base filename of the output file, without an extension
  50.   </para>
  51.       </listitem>
  52.     </varlistentry>
  53.     <varlistentry>
  54.       <term>
  55.         <link linkend="param_db.chunk.extension">
  56.           <parameter>db.chunk.extension</parameter>
  57.         </link>
  58.       </term>
  59.       <listitem>
  60.         <para>
  61.     The default file extension for new output documents
  62.   </para>
  63.       </listitem>
  64.     </varlistentry>
  65.     <varlistentry>
  66.       <term>
  67.         <link linkend="param_db.chunk.info_chunk">
  68.           <parameter>db.chunk.info_chunk</parameter>
  69.         </link>
  70.       </term>
  71.       <listitem>
  72.         <para>
  73.     Whether to create a chunk for the titlepage
  74.   </para>
  75.       </listitem>
  76.     </varlistentry>
  77.     <varlistentry>
  78.       <term>
  79.         <link linkend="param_db.chunk.info_basename">
  80.           <parameter>db.chunk.info_basename</parameter>
  81.         </link>
  82.       </term>
  83.       <listitem>
  84.         <para>
  85.     The base filename for the titlepage
  86.   </para>
  87.       </listitem>
  88.     </varlistentry>
  89.   </variablelist>
  90.   <variablelist>
  91.     <title>Templates</title>
  92.     <varlistentry>
  93.       <term>
  94.         <link linkend="template_db.chunk">
  95.           <function role="template">db.chunk</function>
  96.         </link>
  97.       </term>
  98.       <listitem>
  99.         <para>
  100.     Create a new output document
  101.   </para>
  102.       </listitem>
  103.     </varlistentry>
  104.     <varlistentry>
  105.       <term>
  106.         <link linkend="template_db.chunk.content">
  107.           <function role="template">db.chunk.content</function>
  108.         </link>
  109.       </term>
  110.       <listitem>
  111.         <para>
  112.     Create the content of a new output document
  113.   </para>
  114.       </listitem>
  115.     </varlistentry>
  116.     <varlistentry>
  117.       <term>
  118.         <link linkend="template_db.chunk.children">
  119.           <function role="template">db.chunk.children</function>
  120.         </link>
  121.       </term>
  122.       <listitem>
  123.         <para>
  124.     Create new documents for the children of an element
  125.   </para>
  126.       </listitem>
  127.     </varlistentry>
  128.     <varlistentry>
  129.       <term>
  130.         <link linkend="template_db.chunk.depth-in-chunk">
  131.           <function role="template">db.chunk.depth-in-chunk</function>
  132.         </link>
  133.       </term>
  134.       <listitem>
  135.         <para>
  136.     Determine the depth of an element in the containing chunk
  137.   </para>
  138.       </listitem>
  139.     </varlistentry>
  140.     <varlistentry>
  141.       <term>
  142.         <link linkend="template_db.chunk.depth-of-chunk">
  143.           <function role="template">db.chunk.depth-of-chunk</function>
  144.         </link>
  145.       </term>
  146.       <listitem>
  147.         <para>
  148.     Determine the depth of the containing chunk in the document
  149.   </para>
  150.       </listitem>
  151.     </varlistentry>
  152.     <varlistentry>
  153.       <term>
  154.         <link linkend="template_db.chunk.chunk-id">
  155.           <function role="template">db.chunk.chunk-id</function>
  156.         </link>
  157.       </term>
  158.       <listitem>
  159.         <para>
  160.     Determine the id of the containing chunk of an element
  161.   </para>
  162.       </listitem>
  163.     </varlistentry>
  164.     <varlistentry>
  165.       <term>
  166.         <link linkend="template_db.chunk.chunk-id.axis">
  167.           <function role="template">db.chunk.chunk-id.axis</function>
  168.         </link>
  169.       </term>
  170.       <listitem>
  171.         <para>
  172.     Determine the id of the first chunk along a specified axis
  173.   </para>
  174.       </listitem>
  175.     </varlistentry>
  176.   </variablelist>
  177.   <refentry id="param_db.chunk.chunks">
  178.     <indexterm>
  179.       <primary>db.chunk.chunks</primary>
  180.     </indexterm>
  181.     <refnamediv>
  182.       <refname>db.chunk.chunks</refname>
  183.       <refpurpose>
  184.     A space-seperated list of the names of elements that should be chunked
  185.   </refpurpose>
  186.     </refnamediv>
  187.     <refsection>
  188.       <title>Description</title>
  189.       <para>This parameter has no description</para>
  190.     </refsection>
  191.   </refentry>
  192.   <refentry id="param_db.chunk.chunk_top">
  193.     <indexterm>
  194.       <primary>db.chunk.chunk_top</primary>
  195.     </indexterm>
  196.     <refnamediv>
  197.       <refname>db.chunk.chunk_top</refname>
  198.       <refpurpose>
  199.     Whether the top-level chunk should be output with the chunking mechanism
  200.   </refpurpose>
  201.     </refnamediv>
  202.     <refsection>
  203.       <title>Description</title>
  204.       <para>This parameter has no description</para>
  205.     </refsection>
  206.   </refentry>
  207.   <refentry id="param_db.chunk.max_depth">
  208.     <indexterm>
  209.       <primary>db.chunk.max_depth</primary>
  210.     </indexterm>
  211.     <refnamediv>
  212.       <refname>db.chunk.max_depth</refname>
  213.       <refpurpose>
  214.     The maximum depth for chunking sections
  215.   </refpurpose>
  216.     </refnamediv>
  217.     <refsection>
  218.       <title>Description</title>
  219.       <para>This parameter has no description</para>
  220.     </refsection>
  221.   </refentry>
  222.   <refentry id="param_db.chunk.basename">
  223.     <indexterm>
  224.       <primary>db.chunk.basename</primary>
  225.     </indexterm>
  226.     <refnamediv>
  227.       <refname>db.chunk.basename</refname>
  228.       <refpurpose>
  229.     The base filename of the output file, without an extension
  230.   </refpurpose>
  231.     </refnamediv>
  232.     <refsection>
  233.       <title>Description</title>
  234.       <para>This parameter has no description</para>
  235.     </refsection>
  236.   </refentry>
  237.   <refentry id="param_db.chunk.extension">
  238.     <indexterm>
  239.       <primary>db.chunk.extension</primary>
  240.     </indexterm>
  241.     <refnamediv>
  242.       <refname>db.chunk.extension</refname>
  243.       <refpurpose>
  244.     The default file extension for new output documents
  245.   </refpurpose>
  246.     </refnamediv>
  247.     <refsection>
  248.       <title>Description</title>
  249.       <para>This parameter has no description</para>
  250.     </refsection>
  251.   </refentry>
  252.   <refentry id="param_db.chunk.info_chunk">
  253.     <indexterm>
  254.       <primary>db.chunk.info_chunk</primary>
  255.     </indexterm>
  256.     <refnamediv>
  257.       <refname>db.chunk.info_chunk</refname>
  258.       <refpurpose>
  259.     Whether to create a chunk for the titlepage
  260.   </refpurpose>
  261.     </refnamediv>
  262.     <refsection>
  263.       <title>Description</title>
  264.       <para>This parameter has no description</para>
  265.     </refsection>
  266.   </refentry>
  267.   <refentry id="param_db.chunk.info_basename">
  268.     <indexterm>
  269.       <primary>db.chunk.info_basename</primary>
  270.     </indexterm>
  271.     <refnamediv>
  272.       <refname>db.chunk.info_basename</refname>
  273.       <refpurpose>
  274.     The base filename for the titlepage
  275.   </refpurpose>
  276.     </refnamediv>
  277.     <refsection>
  278.       <title>Description</title>
  279.       <para>This parameter has no description</para>
  280.     </refsection>
  281.   </refentry>
  282.   <refentry id="template_db.chunk">
  283.     <indexterm>
  284.       <primary>db.chunk</primary>
  285.     </indexterm>
  286.     <refnamediv>
  287.       <refname>db.chunk</refname>
  288.       <refpurpose>
  289.     Create a new output document
  290.   </refpurpose>
  291.     </refnamediv>
  292.     <refsection>
  293.       <title>Parameters</title>
  294.       <variablelist>
  295.         <varlistentry>
  296.           <term>
  297.             <parameter>node</parameter>
  298.           </term>
  299.           <listitem>
  300.             <para>
  301.       The source element for the output document
  302.     </para>
  303.           </listitem>
  304.         </varlistentry>
  305.         <varlistentry>
  306.           <term>
  307.             <parameter>template</parameter>
  308.           </term>
  309.           <listitem>
  310.             <para>
  311.       The named template to call to create the document
  312.     </para>
  313.           </listitem>
  314.         </varlistentry>
  315.         <varlistentry>
  316.           <term>
  317.             <parameter>href</parameter>
  318.           </term>
  319.           <listitem>
  320.             <para>
  321.       The name of the file for the new document
  322.     </para>
  323.           </listitem>
  324.         </varlistentry>
  325.         <varlistentry>
  326.           <term>
  327.             <parameter>depth_of_chunk</parameter>
  328.           </term>
  329.           <listitem>
  330.             <para>
  331.       The depth of new output document
  332.     </para>
  333.           </listitem>
  334.         </varlistentry>
  335.       </variablelist>
  336.     </refsection>
  337.   </refentry>
  338.   <refentry id="template_db.chunk.content">
  339.     <indexterm>
  340.       <primary>db.chunk.content</primary>
  341.     </indexterm>
  342.     <refnamediv>
  343.       <refname>db.chunk.content</refname>
  344.       <refpurpose>
  345.     Create the content of a new output document
  346.   </refpurpose>
  347.     </refnamediv>
  348.     <refsection>
  349.       <title>Parameters</title>
  350.       <variablelist>
  351.         <varlistentry>
  352.           <term>
  353.             <parameter>node</parameter>
  354.           </term>
  355.           <listitem>
  356.             <para>
  357.       The source element for the content
  358.     </para>
  359.           </listitem>
  360.         </varlistentry>
  361.         <varlistentry>
  362.           <term>
  363.             <parameter>template</parameter>
  364.           </term>
  365.           <listitem>
  366.             <para>
  367.       The named template to call to create the content
  368.     </para>
  369.           </listitem>
  370.         </varlistentry>
  371.         <varlistentry>
  372.           <term>
  373.             <parameter>depth_of_chunk</parameter>
  374.           </term>
  375.           <listitem>
  376.             <para>
  377.       The depth of new output document
  378.     </para>
  379.           </listitem>
  380.         </varlistentry>
  381.       </variablelist>
  382.     </refsection>
  383.   </refentry>
  384.   <refentry id="template_db.chunk.children">
  385.     <indexterm>
  386.       <primary>db.chunk.children</primary>
  387.     </indexterm>
  388.     <refnamediv>
  389.       <refname>db.chunk.children</refname>
  390.       <refpurpose>
  391.     Create new documents for the children of an element
  392.   </refpurpose>
  393.     </refnamediv>
  394.     <refsection>
  395.       <title>Parameters</title>
  396.       <variablelist>
  397.         <varlistentry>
  398.           <term>
  399.             <parameter>node</parameter>
  400.           </term>
  401.           <listitem>
  402.             <para>
  403.       The parent element
  404.     </para>
  405.           </listitem>
  406.         </varlistentry>
  407.         <varlistentry>
  408.           <term>
  409.             <parameter>depth_of_chunk</parameter>
  410.           </term>
  411.           <listitem>
  412.             <para>
  413.       The depth of the parent element
  414.     </para>
  415.           </listitem>
  416.         </varlistentry>
  417.       </variablelist>
  418.     </refsection>
  419.   </refentry>
  420.   <refentry id="template_db.chunk.depth-in-chunk">
  421.     <indexterm>
  422.       <primary>db.chunk.depth-in-chunk</primary>
  423.     </indexterm>
  424.     <refnamediv>
  425.       <refname>db.chunk.depth-in-chunk</refname>
  426.       <refpurpose>
  427.     Determine the depth of an element in the containing chunk
  428.   </refpurpose>
  429.     </refnamediv>
  430.     <refsection>
  431.       <title>Parameters</title>
  432.       <variablelist>
  433.         <varlistentry>
  434.           <term>
  435.             <parameter>node</parameter>
  436.           </term>
  437.           <listitem>
  438.             <para>
  439.       The element for which to determine the depth
  440.     </para>
  441.           </listitem>
  442.         </varlistentry>
  443.       </variablelist>
  444.     </refsection>
  445.   </refentry>
  446.   <refentry id="template_db.chunk.depth-of-chunk">
  447.     <indexterm>
  448.       <primary>db.chunk.depth-of-chunk</primary>
  449.     </indexterm>
  450.     <refnamediv>
  451.       <refname>db.chunk.depth-of-chunk</refname>
  452.       <refpurpose>
  453.     Determine the depth of the containing chunk in the document
  454.   </refpurpose>
  455.     </refnamediv>
  456.     <refsection>
  457.       <title>Parameters</title>
  458.       <variablelist>
  459.         <varlistentry>
  460.           <term>
  461.             <parameter>node</parameter>
  462.           </term>
  463.           <listitem>
  464.             <para>
  465.       The element for which to determine the depth
  466.     </para>
  467.           </listitem>
  468.         </varlistentry>
  469.       </variablelist>
  470.     </refsection>
  471.   </refentry>
  472.   <refentry id="template_db.chunk.chunk-id">
  473.     <indexterm>
  474.       <primary>db.chunk.chunk-id</primary>
  475.     </indexterm>
  476.     <refnamediv>
  477.       <refname>db.chunk.chunk-id</refname>
  478.       <refpurpose>
  479.     Determine the id of the containing chunk of an element
  480.   </refpurpose>
  481.     </refnamediv>
  482.     <refsection>
  483.       <title>Parameters</title>
  484.       <variablelist>
  485.         <varlistentry>
  486.           <term>
  487.             <parameter>id</parameter>
  488.           </term>
  489.           <listitem>
  490.             <para>
  491.       The id of the element for which to find the containing chunk id
  492.     </para>
  493.           </listitem>
  494.         </varlistentry>
  495.         <varlistentry>
  496.           <term>
  497.             <parameter>node</parameter>
  498.           </term>
  499.           <listitem>
  500.             <para>
  501.       The element for which to find the containing chunk id
  502.     </para>
  503.           </listitem>
  504.         </varlistentry>
  505.         <varlistentry>
  506.           <term>
  507.             <parameter>depth_in_chunk</parameter>
  508.           </term>
  509.           <listitem>
  510.             <para>
  511.       The depth of <parameter>node</parameter> in the containing chunk
  512.     </para>
  513.           </listitem>
  514.         </varlistentry>
  515.       </variablelist>
  516.     </refsection>
  517.   </refentry>
  518.   <refentry id="template_db.chunk.chunk-id.axis">
  519.     <indexterm>
  520.       <primary>db.chunk.chunk-id.axis</primary>
  521.     </indexterm>
  522.     <refnamediv>
  523.       <refname>db.chunk.chunk-id.axis</refname>
  524.       <refpurpose>
  525.     Determine the id of the first chunk along a specified axis
  526.   </refpurpose>
  527.     </refnamediv>
  528.     <refsection>
  529.       <title>Parameters</title>
  530.       <variablelist>
  531.         <varlistentry>
  532.           <term>
  533.             <parameter>node</parameter>
  534.           </term>
  535.           <listitem>
  536.             <para>
  537.       The base element
  538.     </para>
  539.           </listitem>
  540.         </varlistentry>
  541.         <varlistentry>
  542.           <term>
  543.             <parameter>axis</parameter>
  544.           </term>
  545.           <listitem>
  546.             <para>
  547.       The axis along which to find the first chunk
  548.     </para>
  549.           </listitem>
  550.         </varlistentry>
  551.         <varlistentry>
  552.           <term>
  553.             <parameter>depth_in_chunk</parameter>
  554.           </term>
  555.           <listitem>
  556.             <para>
  557.       The depth of <parameter>node</parameter> in the containing chunk
  558.     </para>
  559.           </listitem>
  560.         </varlistentry>
  561.         <varlistentry>
  562.           <term>
  563.             <parameter>depth_of_chunk</parameter>
  564.           </term>
  565.           <listitem>
  566.             <para>
  567.       The depth of the containing chunk in the document
  568.     </para>
  569.           </listitem>
  570.         </varlistentry>
  571.       </variablelist>
  572.     </refsection>
  573.   </refentry>
  574. </section>