Re: [Openstack-doc-core] How should we mark up nova-* services?

Fri, 18 May 2012 14:39:30 -0700

Thanks, so I can, basically run a formatting test, send you the xml  file and you could show us how it'll render ?
I've deployed the maven env. on my comp ^^

Razique

18 mai 2012 21:18
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Btw., I can make the html and pdf output (and the Oxygen wysioo view)
do whatever you want for that markup (or for any other markup).

David

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

iQEcBAEBAgAGBQJPtqBuAAoJEMHeSXG7afUhkakH/jM47f1l5w2+jS1XKEt1OxVH
q47LzBPy28igNJi0gcQRBO/goRBynqbZ0vjcdrhLO3jiiMpudSJ4MNDNG5/PwU0F
e7HnNPIGbbwV9hPfunvlH3puQ6/4fZiLh4xjy8ABoBngwg6DmMTFKpbF2ifyXwwv
swipWXEGZ8RV56mJsdp1sv7ORXN7dQndtf5ad51JCDszDC2n9/GSPqEjKZsiGkGY
AzLrcLc7pQmgynfWefCE4IgRzmPoH+lFEbFCRuzHykbzFa0M414ik9SXI1LPIkjE
Kd+EKyAyjSuOqlm0iaD8ynuO5eSH5/QWmcvE1HdcVQismUuUgt+L62Fh8HnsWpc=
=5jwQ
-----END PGP SIGNATURE-----
18 mai 2012 10:37
Hi all,
it would be interesting to see if the markup <systemitem class="service"> get interpreted for the html output, if so, we could give it a try. It would make the service designation in itself definitely clearer
Best regards,
Razique


17 mai 2012 16:35
Thanks David for the guidance and Razique for knowing what our docs mostly do. :) I'm fine with adding the <systemitem class="service"> markup and see what it gains us later.

Does anyone prefer quotation marks around the service names or is there another output style you'd like?

Thanks,
Anne




17 mai 2012 12:32
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 <[email protected]> wrote:

17 mai 2012 05:21
-----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


-----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-----

--
Nuage & Co - Razique Mahroua
[email protected]

  

-- 
Mailing list: https://launchpad.net/~openstack-doc-core
Post to     : [email protected]
Unsubscribe : https://launchpad.net/~openstack-doc-core
More help   : https://help.launchpad.net/ListHelp

Reply via email to