seems pretty solid.
Regarding the 
"2) right command / wrong command

There are a few instances where a "right command" and "wrong command"
are referenced.  It appears that the '#' character is used with a wrong
command.  It's not clear when this convention would be used.  Could you
give me an example?

I'm concerned that the use of '#' could be confusing since '#' is so
commonly used as either a way to indicate that a command should be run
as root or that any words after the '#' are a comment in a file."

I thought using a prefix would not be such a good idea since every shell has it's own markers, and accross the numerous doc, I've hit "#", ~", "::", "(#)"
I then thought removing that will help having a good convention on that.

   <screen>
   <prompt>(mysql) </prompt><userinput>command to type</userinput>
   </screen>

I totally agree, great :)

5) "Result of the command"

The current suggestion is to use <programlisting>.  I would use <screen>
or <screen><computeroutput>.  So, a command combined with its output:

   <screen>
   <prompt>(mysql)</prompt> <userinput>command to type</userinput>
   <computeroutput>result</computeroutput>
   </screen>

Will take a time to update everything, but why not...
Are we sure for these both html and PDF output will be consistent ?



Nuage & Co - Razique Mahroua 
Le 4 mars 2012 à 18:51, David Cramer a écrit :

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

1) "Information or configuration files that the user has to type
or read"

This uses <literallayout>.  I would propose using
<programlisting>.

That's fine by me, though it'll take a while to change them all.

We could make the change programmatically, either with an xslt or in
this case even with find-and-replace-in-files in Oxygen.

6) "File names"

Instead of <literallayout>, <filename>

Okay. When we do this the output may not yet do anything to
indicate it is marked up but we'll need to find out.

<filename> is currently formatted as monospace.

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

iQEcBAEBAgAGBQJPU6ugAAoJEMHeSXG7afUh7MYH/1IeEAtBEM4AoMdeolrTGoEK
Ta+K2uQOgOBqNqhzyWjCAlozzmz3Z6C7tGllMJPxHD1NOJjpVubinSXwLQZVOetC
cgsBBbZkMeLxic/zRWlVdFhiGED9FkAEhzHL6ek6AfVmKO+fI8/DT0BnILRRrQww
4Z0FnZv4rP2J5I8TeCixDnC9kqCOQRcJni/JD3jeJIBAgeZ6F9XzeKYk+0EkaKa+
nHUFW3LRAxRRLF88y81MsB/z+XoGu5ATn4asprHWoatLNRZFXbTVmpe4i988Lrp2
3TMjbayuK/rWUmfDSEPw37DKpCDRSYbP6bjW6OpDDs0ySYoYzymoWDVdi2B0nIc=
=jkTb
-----END PGP SIGNATURE-----

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

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