[Openstack-docs] programlisting language="bash" or language="INI" for config files?

Steve Gordon sgordon at redhat.com
Wed Aug 14 17:13:03 UTC 2013


----- Original Message -----
> From: "Andreas Jaeger" <aj at suse.com>
> To: openstack-docs at lists.openstack.org
> Sent: Wednesday, August 14, 2013 12:35:25 PM
> Subject: [Openstack-docs] programlisting language="bash" or language="INI"	for config files?
> 
> Stephen Gordon asked in reviewing https://review.openstack.org/41861:
> 
> "Line 146:                                 <programlisting
> language="bash">[DEFAULT]
> Is bash actually the correct directive for these, I'm not super familiar
> with clouddocs-maven's highlight functionality but other tools I have
> worked with have one specifically for the INI file format?"
> 
> Looking at the wiki, I do not see INI mentioned - and don't see it used
> anywhere. So, is there an INI option we should use or should we continue
> using "bash"?
> 
> Andreas

As I said in the review I am not intimate with the highlighting method used by clouddocs-maven but for reference Publican uses this Perl module:

    http://search.cpan.org/~szabgab/Syntax-Highlight-Engine-Kate-0.08/lib/Syntax/Highlight/Engine/Kate.pm

So I believe the language value for it would be INI_Files. The list of supported language values is implementation specific (not part of the DocBook standard) though so perhaps sticking with either no language value or a common one like Bash that provides at least some highlighting for the provided content is more appropriate here after all - I am more curious than anything :).

Thanks,

Steve



More information about the Openstack-docs mailing list