I've been using this function reference for years, and was surprised to
find that if I read closely, above each table for the various values to
pass in, the type of the value is specified. I'd never read the page
closely enough to realize that the options are grouped by type; I think
it might be common for readers to skim like this.
I think it'll be more obvious to the reader if the types are specified
as a title of each table.
This is my first foray into docbook, so comments on how to achieve this
are appreciated!
Cheers,
Patrick
Index: reference/curl/functions/curl-setopt.xml
===================================================================
--- reference/curl/functions/curl-setopt.xml (revision 298223)
+++ reference/curl/functions/curl-setopt.xml (working copy)
@@ -36,12 +36,13 @@
<term><parameter>value</parameter></term>
<listitem>
<para>
- The value to be set on <parameter>option</parameter>.
+ The value to be set on <parameter>option</parameter>. The type of
+ <parameter>value</parameter> varies based on
+ <parameter>option</parameter> as specified in the table below.
</para>
<para>
- <parameter>value</parameter> should be a <type>bool</type> for the
- following values of the <parameter>option</parameter> parameter:
- <informaltable>
+ <table>
+ <title><type>Boolean</type> options</title>
<tgroup cols="3">
<thead>
<row>
@@ -378,12 +379,11 @@
</row>
</tbody>
</tgroup>
- </informaltable>
+ </table>
</para>
<para>
- <parameter>value</parameter> should be an <type>integer</type> for the
- following values of the <parameter>option</parameter> parameter:
- <informaltable>
+ <table>
+ <title><type>Integer</type> parameters</title>
<tgroup cols="3">
<thead>
<row>
@@ -706,12 +706,11 @@
</row>
</tbody>
</tgroup>
- </informaltable>
+ </table>
</para>
<para>
- <parameter>value</parameter> should be a <type>string</type> for the
- following values of the <parameter>option</parameter> parameter:
- <informaltable>
+ <table>
+ <title><type>String</type> parameters</title>
<tgroup cols="3">
<thead>
<row>
@@ -1034,12 +1033,11 @@
</row>
</tbody>
</tgroup>
- </informaltable>
+ </table>
</para>
<para>
- <parameter>value</parameter> should be an array for the
- following values of the <parameter>option</parameter> parameter:
- <informaltable>
+ <table>
+ <title><type>Array</type> parameters</title>
<tgroup cols="3">
<thead>
<row>
@@ -1087,13 +1085,12 @@
</row>
</tbody>
</tgroup>
- </informaltable>
+ </table>
</para>
<para>
- <parameter>value</parameter> should be a stream resource (using
- <function>fopen</function>, for example) for the following values of the
- <parameter>option</parameter> parameter:
- <informaltable>
+ <table>
+ <title>Stream resource options (using <function>fopen</function>, for
+ example)</title>
<tgroup cols="3">
<thead>
<row>
@@ -1130,13 +1127,12 @@
</row>
</tbody>
</tgroup>
- </informaltable>
+ </table>
</para>
<para>
- <parameter>value</parameter> should be a string that is the name of a valid
- callback function for the following values of the
- <parameter>option</parameter> parameter:
- <informaltable>
+ <table>
+ <title>Callback function options, which are strings that name a valid
+ callback function</title>
<tgroup cols="3">
<thead>
<row>
@@ -1195,7 +1191,7 @@
</row>
</tbody>
</tgroup>
- </informaltable>
+ </table>
</para>
</listitem>
</varlistentry>
