[Openstack-docs] Suggestion: Improved styling for "Replaceable" in install guide

David Cramer david.cramer at rackspace.com
Thu Oct 17 17:43:06 UTC 2013


On 10/17/2013 12:15 PM, Steve Gordon wrote:
> In Publican styles we typically apply both bold and italic to replaceable values, I think at some point Summer already got David to add this to the clouddocs-maven styles though so I am unsure how to further proceed to make these "pop" as is. I'd personally be hesitant to use anything that only appears on mouseover because it hinders discoverability somewhat and may not be accessible at all in some output formats.

In clouddocs-maven-plugin, replaceable is styled as italic. The change
Summer requested was to fix a bug where replaceable's weren't formatted
in programlisting.

The tooltip would be easy enough to implement if it's decided to be
worth doing. We already style <glossterm> with a tooltip and a link to a
back-of-the-book glossary. The pdf output lacks the tooltip. In fact,
this should work right now:
<glossterm><replaceable>EXTERNAL_INTERFACE</replaceable></glossterm>

Where there's a corresponding
<glossdef><glossterm>EXTERNAL_INTERFACE</glossterm>... in the glossary
if you configure <glossaryCollection> to point to the glossary file.

See http://www.sagehill.net/docbookxsl/GlossDatabase.html for more
information.

Regards,
David



More information about the Openstack-docs mailing list