openstack-doc-core team mailing list archive

[David Cramer <david.cramer@xxxxxxxxxxxxx>]

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

It's possible for the xslts to add quotes around words marked up with
an element. When it does this, the quotes are locale-specific (i.e. if
the xml:lang="fr" you get French-style quotes).

So <systemitem class="service">nova-volume</systemitem> would become
"nova-volume" in English and «nova-volume» in French.

If that's a convention you'd like to use, let me know and I can
configure the xslts to do that.

David

On 05/17/2012 05:32 AM, Razique Mahroua wrote:
> Actually it uses "" eg "nova-volume" is... I think 90% of the doc
> uses that convention. But it could be great to have a convention
> for it yes :)
> 
> On Thu, 17 May 2012 05:21:40 +0200, David Cramer 
> <david.cramer@xxxxxxxxxxxxx> wrote:
> 
> You probably want:
> 
> <systemitem class="service">
> 
> http://www.docbook.org/tdg5/en/html/systemitem.html
> 
> The things to think about in deciding whether to mark something
> like this up are:
> 
> 1) Do I want to be able to have this thing formatted in a
> particular way? E.g. monospace, bold. 2) Do I want to be able to do
> something else later (index, cross reference, etc) with this term?
> 
> If either are true, then you should have a policy of marking it up
> and agree on a tag to use.
> 
> Typing <systemitem class="service"> probably seems cumbersome, but
> I can add to oxygen a shortcut so that it feels like there's really
> a <service> tag. I.e. you press enter to pull up the context
> completion window, start typing "systemitem"...it autocompletes and
> you pick "systemitem-service" from thei list. Or we could even add
> a service tag to the schema.
> 
> David
> 
> 
> On 05/16/2012 09:37 PM, Lorin Hochstein wrote:
>>>> Hey Razique:
>>>> 
>>>> 
>>>> No, I was thinking specifically when the user *doesn't* have
>>>> to type it. For example, this sentence involving nova-volume:
>>>> "The nova-volume service is responsible for managing
>>>> attachable block storage devices".
>>>> 
>>>> 
>>>> Take care,
>>>> 
>>>> Lorin -- Lorin Hochstein Lead Architect - Cloud Services
>>>> Nimbis Services, Inc. www.nimbisservices.com 
>>>> <https://www.nimbisservices.com/>
>>>> 
>>>> 
>>>> 
>>>> 
>>>> 
>>>> On May 16, 2012, at 3:28 AM, Razique Mahroua wrote:
>>>> 
>>>>> Hey Lorin :) You mean when the user has to type it ?
>>>>> 
>>>>>> Lorin Hochstein <mailto:lorin@xxxxxxxxxxxxxxxxxx> 16 mai
>>>>>> 2012 05:04 Hi folks:
>>>>>> 
>>>>>> What tag should we use for marking up Linux service names
>>>>>> like nova-api and nova-network? Should we use <command>,
>>>>>> or <literal>, or something else?
>>>>>> 
>>>>>> Take care,
>>>>>> 
>>>>>> Lorin -- Lorin Hochstein Lead Architect - Cloud Services
>>>>>> Nimbis Services, Inc. www.nimbisservices.com 
>>>>>> <https://www.nimbisservices.com/>
>>>>>> 
>>>>>> 
>>>>>> 
>>>>>> 
>>>>>> 
>>>>> 
>>>>> -- Nuage & Co - Razique Mahroua razique.mahroua@xxxxxxxxx
>>>>> 
>>>>> <image.jpg>
>>>>> 
>>>>> 
>>>> 
>>>> 
>>>> 
> 
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJPtPD5AAoJEMHeSXG7afUhLfkH/i0UF7CJQ7AOAYzZaC1lod/l
ZpKPTGlndaIeFYsx5HBr2G4w+ePXea9aRZU+DUcnuRVHPAtbaKQHAhqjDwvz1iTk
2mJdP6Z9CfzzZtiYzNO/M2TovDs2SRB6q8a7DNxgCGFIiIJChnCPE96ba5gHtLVQ
FYeMWgTdCmONzWF1YVaCL6NDa6OWmop/HoPbaqZzL1w+CK1pZGW4/h+FlUZh/hIp
s1RmYmfMyhFbWjByVmlUuZDNPcBFVPvljvRCv9v7D0pBGCS7nILbqYNe0/B5wPda
mKlpB3UePF04lOqkOtdBW2MyUtHYMyZHURJpTNzhaVH3ukvUAvE9LqWkI80xdyk=
=rv4k
-----END PGP SIGNATURE-----