|
Lines 123-128
Link Here
|
| 123 |
</informalexample> |
123 |
</informalexample> |
| 124 |
</listitem> |
124 |
</listitem> |
| 125 |
</varlistentry> |
125 |
</varlistentry> |
|
|
126 |
<varlistentry> |
| 127 |
<term>Two spaces at the end of sentences</term> |
| 128 |
|
| 129 |
<listitem> |
| 130 |
<para>Always use two spaces at the end of sentences, as this |
| 131 |
improves readability, and eases use of tools such as |
| 132 |
<application>emacs</application>.</para> |
| 133 |
|
| 134 |
<para>While it may be argued that a capital letter following |
| 135 |
the end of sentence period, this is not the case, especially |
| 136 |
in name usage. <quote>Jordan K. Hubbard</quote> is a good |
| 137 |
example; it has a capital <literal>H</literal> following a |
| 138 |
period and a space, and there certainly isn't a new sentence |
| 139 |
there.</para> |
| 140 |
</listitem> |
| 141 |
</varlistentry> |
| 126 |
</variablelist> |
142 |
</variablelist> |
| 127 |
|
143 |
|
| 128 |
<para>For more information about writing style, see <ulink |
144 |
<para>For more information about writing style, see <ulink |
|
Lines 161-167
Link Here
|
| 161 |
over more than one line.</para> |
177 |
over more than one line.</para> |
| 162 |
|
178 |
|
| 163 |
<para>For example, the source for this section looks something |
179 |
<para>For example, the source for this section looks something |
| 164 |
like;</para> |
180 |
like:</para> |
| 165 |
|
181 |
|
| 166 |
<programlisting> |
182 |
<programlisting> |
| 167 |
<![ CDATA [+--- This is column 0 |
183 |
<![ CDATA [+--- This is column 0 |
|
Lines 194-199
Link Here
|
| 194 |
<literal>sgml-mode</literal> should be loaded automatically, and the |
210 |
<literal>sgml-mode</literal> should be loaded automatically, and the |
| 195 |
Emacs local variables at the bottom of each file should enforce these |
211 |
Emacs local variables at the bottom of each file should enforce these |
| 196 |
styles.</para> |
212 |
styles.</para> |
|
|
213 |
</sect2> |
| 214 |
|
| 215 |
<sect2> |
| 216 |
<title>Tag style</title> |
| 217 |
|
| 218 |
<sect3> |
| 219 |
<title>Tag spacing</title> |
| 220 |
|
| 221 |
<para>Tags that start at the same indent as a previous tag |
| 222 |
should be separated by a blank line, and those that are not |
| 223 |
at the same indent as a previous tag should not:</para> |
| 224 |
|
| 225 |
<informalexample> |
| 226 |
<programlisting> |
| 227 |
<![ CDATA [ |
| 228 |
<article> |
| 229 |
<artheader> |
| 230 |
<title>NIS</title> |
| 231 |
|
| 232 |
<pubdate>October 1999</pubdata> |
| 233 |
|
| 234 |
<abstract> |
| 235 |
<para>... |
| 236 |
... |
| 237 |
...</para> |
| 238 |
</abstract> |
| 239 |
</artheader> |
| 240 |
|
| 241 |
<sect1> |
| 242 |
<title>...</title> |
| 243 |
|
| 244 |
<para>...</para> |
| 245 |
</sect1> |
| 246 |
|
| 247 |
<sect1> |
| 248 |
<title>...</title> |
| 249 |
|
| 250 |
<para>...</para> |
| 251 |
</sect1> |
| 252 |
</article> |
| 253 |
]]> |
| 254 |
</programlisting> |
| 255 |
</informalexample> |
| 256 |
</sect3> |
| 257 |
|
| 258 |
<sect3> |
| 259 |
<title>Special tags</title> |
| 260 |
|
| 261 |
<para>Some tags just don't follow the indenting rules of the |
| 262 |
previous section; <sgmltag>screen</sgmltag> and |
| 263 |
<sgmltag>programlisting</sgmltag> should always be |
| 264 |
left-aligned.</para> |
| 265 |
|
| 266 |
<informalexample> |
| 267 |
<programlisting> |
| 268 |
<![ CDATA [ |
| 269 |
<informalexample> |
| 270 |
<programlisting> |
| 271 |
… |
| 272 |
</programlisting> |
| 273 |
</informalexample> |
| 274 |
]]> |
| 275 |
</programlisting> |
| 276 |
</informalexample> |
| 277 |
|
| 278 |
<para><sgmltag>informalexample</sgmltag> also should be |
| 279 |
left-aligned when it wraps a <sgmltag>screen</sgmltag> or |
| 280 |
<sgmltag>programlisting</sgmltag>.</para> |
| 281 |
|
| 282 |
<para>These examples should be separated from the rest of the |
| 283 |
content by a blank line before and after.</para> |
| 284 |
</sect3> |
| 285 |
|
| 286 |
<sect3> |
| 287 |
<title>Separating tags</title> |
| 288 |
|
| 289 |
<para>Tags like <sgmltag>itemizedlist</sgmltag> which will |
| 290 |
always have further tags inside them, and in fact don't take |
| 291 |
character data themselves, are always on a line by |
| 292 |
themselves.</para> |
| 293 |
|
| 294 |
<para>Tags like <sgmltag>para</sgmltag> and |
| 295 |
<sgmltag>term</sgmltag> don't need other tags to contain |
| 296 |
normal character data, and their contents begin immediately |
| 297 |
after the tag, <emphasis>on the same line</emphasis>.</para> |
| 298 |
|
| 299 |
<para>The same applies to when these two types of tags |
| 300 |
close.</para> |
| 301 |
|
| 302 |
<para>This leads to an obvious problem when mixing these |
| 303 |
tags.</para> |
| 304 |
|
| 305 |
<para>When a starting tag which cannot contain character data |
| 306 |
directly follows a tag of the type that requires other tags |
| 307 |
within it to use character data, they are on separate lines. |
| 308 |
The second tag should be properly indented.</para> |
| 309 |
|
| 310 |
<para>When a tag which can contain character data closes |
| 311 |
directly after a tag which cannot contain character data |
| 312 |
closes, they co-exist on the same line.</para> |
| 313 |
</sect3> |
| 197 |
</sect2> |
314 |
</sect2> |
| 198 |
|
315 |
|
| 199 |
<sect2> |
316 |
<sect2> |