Re: [Firebird-docs] Re: Your protocol doc

[Paul V. <pa...@vi...>]

Hi Carlos,

> P.S: I'm sedning this email to the docs list too, hope we can
> continue the dicussion in the list :)

Good idea, since we're discussing doc techniques here.

>>  <simplelist columns="2" type="horiz">
>>  (...)
>>  </simplelist>

> What about a <segmentedlist> ??

That's also possible. In fact I had an example prepared to send to
you along with the <simplelist>, but I removed it because it didn't
build well. I used <segmentedlist presentation='table'> but it built
like a list. Just now I saw in the examples at docbook.org that they
do it with a <?dbhtml...> instruction. So here it is:

  <segmentedlist>
    <?dbhtml list-presentation="table"?>
    <seglistitem>
      <seg><type>Int32</type></seg>
      <seg>Operation code (<constant>op_create</constant>)</seg>
    </seglistitem>
    <seglistitem>
      <seg><type>Int32</type></seg>
      <seg>Attachment handle ??? (0)</seg>
    </seglistitem>
    <seglistitem>
      <seg><type>String</type></seg>
      <seg>Database path</seg>
    </seglistitem>
    <seglistitem>
      <seg><type>Buffer</type></seg>
      <seg>Database parameter buffer</seg>
    </seglistitem>
  </segmentedlist>

This builds exactly the same as the simplelist (well, not exactly, but
it looks the same in a browser). Note: Officially, you may not omit
the <segtitle> elements, but in practice it works.

The only problem is that in the PDF rendering, the segmentedlist looks
idiotic - worse than the simplelist:

  : Int32
  : Operation code (op_create)
  : Int32
  : Attachment handle ??? (0)
  : String
  : Database path
  : Buffer
  : Database parameter buffer


> P.S.2: I have a new draft of the document with some new sections :)

Feel free to send it - but you can also wait a while, if you expect
more revisions to come.


Greetings,
Paul Vinkenoog