From 5557ff0213e46137e64f4fed247cae32e65256dd Mon Sep 17 00:00:00 2001 From: Alan Hicks Date: Sat, 18 Aug 2012 01:03:51 -0400 Subject: Added a rant about inside of 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. --- TODO | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'TODO') diff --git a/TODO b/TODO index 816d9d3..f92d0ec 100644 --- a/TODO +++ b/TODO @@ -1,5 +1,21 @@ General +* Make damn certain our Docbook markup is both _CORRECT_ and + _CONSISTANT_. There's many places where the sections + are very different. They should all be of this form. + + + darkstar:~$ _EVERYTHING_ the user types + Anything the screen prints that the user doesn't type. + + + I've found several cases where the tag was used inside of a + section. This is wrong and must be avoided. When the book + goes to the publisher, all of those tags will be formatted + one way for printing and the tags could be formatted + another. Also, wrapping only applications in 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. -- cgit v1.2.3