openstack-doc-core team mailing list archive

[David Cramer <david.cramer@xxxxxxxxxxxxx>]

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

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/

iQEcBAEBAgAGBQJPtG7BAAoJEMHeSXG7afUhNeAH/jmNOn4Iw7MKKQr9enFhUdq1
qL3xP6ixeqR+UZP0HrdTKchM2TLeljDY5gXLYKf1m9ZofIk5nnFKFBQGlACWC8Z3
TjmEQM8XtAJeflmmWWEqnwWZ3kcjz3ivFB79liHpnkqhaqECcDEAISDLcLn+2xSW
SqckiyCusDMffdhSZIZAx9pfY5B6utBJlSdDJYNauM+ARlPOtVq9UREy/UwK5oAe
QzAzg6u1WkxFOqp+TdlLhqOcGOqMucL4qGvMQ+xb6nDMYo0lMJeIrNWzJXDYRBhi
UaEtg2N+lJeu2cPbrEj+R95DNQ9ovPhXjtv3n6Pi1HRN746f01thDR+6HGMNCA4=
=s5qz
-----END PGP SIGNATURE-----