diff options
author | Alan Hicks <alan@lizella.net> | 2012-08-18 01:03:51 -0400 |
---|---|---|
committer | Alan Hicks <alan@lizella.net> | 2012-08-18 01:03:51 -0400 |
commit | 5557ff0213e46137e64f4fed247cae32e65256dd (patch) | |
tree | 12c37c031439a958159734b0c1d6206c76186fed | |
parent | c176e8f7036670c6949313c6076eb8431e9d72ab (diff) | |
download | slackbook-5557ff0213e46137e64f4fed247cae32e65256dd.tar.xz |
Added a rant about <command> inside of <screen> sections including a
thorough desciption of how they should be used. Some one's been doing
this incorrectly and we need to find all traces of that and fix them.
-rw-r--r-- | TODO | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -1,5 +1,21 @@ General +* Make damn certain our Docbook markup is both _CORRECT_ and + _CONSISTANT_. There's many places where the <screen> sections + are very different. They should all be of this form. + +<screen> + <prompt>darkstar:~$ <prompt><userinput>_EVERYTHING_ the user types</userinput> + Anything the screen prints that the user doesn't type. +</screen> + + I've found several cases where the <command> tag was used inside of a + <screen> section. This is wrong and must be avoided. When the book + goes to the publisher, all of those <command> tags will be formatted + one way for printing and the <userinput> tags could be formatted + another. Also, wrapping only applications in <command> tags could + make the reader wonder just how much they are supposed to type. + * Aim to update references to kernel versions and Slackware versions to those used in the most recent release of Slackware. I've seen kernel 2.6.29.4 and Slackware 12.0.0 for instance. |