← Back to team overview

openstack-doc-core team mailing list archive

Re: Documenting policy.json stuff

 

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 06/08/2012 12:23 PM, Lorin Hochstein wrote:
> All:
> 
> I'm working on documenting the actions in the variously
> policy.json files. I just posted a WIP branch here:
> https://review.openstack.org/8347
> 
> Can I get some feedback on whether this is a reasonable structure
> for documenting all of these options? It renders OK in HTML, but
> currently it looks terrible in PDF because the action names are so
> long, I don't know how to fix that.

Hi Lorin,
Try doing a search and replace to change

=

to

=<?sbr?>

(but be careful only to do this in text, not in XML attributes. Oxygen
has some xml-aware search features for this.

You might also add a few more <?sbr?>s. In this content, maybe after _
and :

The <?sbr?> processing instruction adds a zero-width space in pdf
output. It's sort of the opposite of a non-breaking space. Instead
it's a non-space that can break if it needs to. So in your table cells
when the size is constrained by the 8.5" page width, the content will
wrap if needed where the sbrs are.

In html, the <?sbr?>s are ignored and dropped.

In some contexts, the xsls add zero-width spaces automatically. For
example, in urls when using <link> IIRC.

David
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJP0joAAAoJEMHeSXG7afUhyWQIAJxeFqfuFY95Pe7Y0jCyi2d1
COWXRjPCO/nOeP90H3pC8roRMG/GnX5Borf35cqvr3niQyFDd/AkUSxIjaB+LlUr
69WzqdO+UWhiKMaSUU/AwMstHuDadEIwSGIDTcwkwyhI+m5/9/zt6YLLUuD0gynv
duYp4mPbRAq2ZojsjkGn/99raE7hzF7UiUF9nt/8z3NvxhDKGL2TQXL9rRhHOJP6
efrvWvzSOcv7HzhC0BDhlEHmL6nhm2w7AUbSNfbdLkdq30bA+9xPdivvU+cod7jI
0EKzzopNvCvRmPWh3q/3JRTH5p9XXD0gowSJp/Xgvy1an3ZpDUB5t3PpXZEIkzA=
=6/mI
-----END PGP SIGNATURE-----


References