[Openstack-docs] <table> conventions and PDF results

Summer Long slong at redhat.com
Sun Aug 18 23:03:43 UTC 2013


Thanks, David.
Well, from now on, I'll use HTML tables, obviously less futzy. But if 
using CALS, will switch to * instead of % (and ensure row breaks 
with<?sbr?>).

And I've looked at using Oxygen, would just need to come up with that 
$500.  Soon. :> In the meantime, I work with a standard text editor.

Thanks for the tips!

Summer

Summer Long
OpenStack Documentation
Engineering Content Services

Red Hat Asia Pacific
Brisbane, Australia
slong at redhat.com <mailto:slong at redhat.com>

On 08/16/2013 11:00 PM, David Cramer wrote:
> Hi Summer,
> I'm adding the list back since this answer will be of interest to everyone.
>
> So the problem is that if you're use CALS tables, you have to set column
> widths either proportionally (or with absolute values, i.e. 100pts).
> Notice the colwidth values in this example using proportional widths:
>
>        <table frame='all'>
>          <title>nova.conf API and Credential Settings</title>
>          <tgroup cols='2' align='left' colsep='1' rowsep='1'>
>            <colspec colname="c1" colwidth="1*"/>
>            <colspec colname="c2" colwidth="2.45*"/>
>
> Tables are an area where oXygen really helps. You can drag the column
> borders and it will set the colwidths for the table appropriately for
> the type of table you're using.
>
> Another trick (applies to both CALS and HTML tables) that will help you
> get good results in the pdf with this particular table is to use <?sbr?>
> PIs to indicate where long strings should break inside of table cells.
> This is like a soft-hyphen but without the hyphen. I noticed in this
> table that neutron_admin_tenant_name was too long to fit in the table
> cell and wouldn't normally break since it's a code-like string. I fixed
> this by adding the <?sbr?> PI at points where a break would be good if
> one is necessary. When the clouddocs-maven-plugin encounters one of
> these it inserts a zero-width space. So if the string fits in the table
> cell, then there's no noticeable difference. If the string doesn't fit,
> then it will wrap at one of these zero-width spaces:
>
> <row>
> <entry>
> <para><literal>neutron_admin_<?sbr?>tenant_<?sbr?>name</literal></para></entry>
> <entry><para>Update to the name of the service tenant created
> in the above section on OpenStack Identity configuration.
> </para></entry>
> </row>
>
> Regards,
> David
>
>
> On 08/15/2013 06:49 PM, Summer Long wrote:
>> Hi David,
>> I just regenerated with the updated plugin version, and it didn't work.
>> The file I'm looking at:
>> openstack-network-connectivity-admin/ch_config.xml
>>
>> Table: nova.conf API and Credential Settings
>>
>> Am attaching both file copy and resulting pdf.
>> Thanks!
>> Summer
>>
>>
>> Summer Long
>> OpenStack Documentation
>> Engineering Content Services

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20130819/2e650555/attachment.html>


More information about the Openstack-docs mailing list