Date: Wed, 6 Oct 1999 15:25:49 +0200 From: Neil Blakey-Milner <nbm@mithrandr.moria.org> To: FreeBSD Documentation Project <doc@FreeBSD.org> Subject: Style Challenge! Message-ID: <19991006152549.A33181@mithrandr.moria.org>
next in thread | raw e-mail | index | archive | help
Hi, (First of all, excuses to those who understand what the topic refers to.) I've just re-indented and re-marked-up all the articles, and here's the rules of thumb I used, and would like discussion on: (I used vim with 'set ai sts=2 ts=8 sw=2 tw=70') . 70 column wrap? (Emacs' sgml-mode seemed to give me that, when sgml-fill worked properly) . Two spaces after '.' . No spaces at the end of a line (including no "empty" lines with spaces in them - is it Emacs that does this?) . Ignoring the above for <screen>/<programlisting> . Try not to use <para> around <screen>, <variablelist>, <itemizedlist>, <qandaset> if at all possible. . Treat <note>, <warning>, <listitem>, <abstract>, <question>, <answer>, <footnote> as block tags. . Always separate tags with tags on same indent level by an empty line, and no empty line on reducing/increasing indent - <para>foo foo</para> <para> and: <sect2> <title>foo</title> <para>foo</para> </sect2> . Always close inline tags on the same line as its contents - ie, never: <para>foo foo blah blah blah </para> Any comments? (oh, and does it matter about combining whitespace/markup/content changes in the articles at this point, without any translations?) Neil -- Neil Blakey-Milner nbm@rucus.ru.ac.za To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19991006152549.A33181>