[svnbook] r3901 committed - * src/en/HACKING...
svnbook at googlecode.com
svnbook at googlecode.com
Fri Jul 8 14:26:15 CDT 2011
Revision: 3901
Author: cmpilato at gmail.com
Date: Fri Jul 8 12:25:31 2011
Log: * src/en/HACKING
Attempt to explain the differences in our use of the <screen> and
<programlisting> tags.
http://code.google.com/p/svnbook/source/detail?r=3901
Modified:
/trunk/src/en/HACKING
=======================================
--- /trunk/src/en/HACKING Tue Jul 5 09:25:22 2011
+++ /trunk/src/en/HACKING Fri Jul 8 12:25:31 2011
@@ -100,8 +100,14 @@
Of course, use the ASCII sequence where it appears literally, such
as in source code listings and computer output.
-- Screen output and program listings should be limited to 78 characters
- in width. Use backslash ('\') as a line continuation character.
+- Screen output (<screen>...</screen>) and program listings
+ (<programlisting>...</programlisting>) should be limited to 78
+ characters in width. Use backslash ('\') as a line continuation
+ character. For our purposes, "screen output" involves literal
+ transcripts of command-line interaction and "program listings" are
+ any sort of literal dump of a file's contents. (If you merely want
+ some sort of relatively structured text, consider using
+ <literallayout>...</literallayout>.)
- When referring to the name of binary programs (svn, svnadmin,
httpd), making a non-specific reference to one of their subcommands,
More information about the svnbook-dev
mailing list