Date: Sat, 18 Jul 2015 17:08:09 -0600 (MDT) From: Warren Block <wblock@wonkity.com> To: Hoyoung Kim <trig4800@gmail.com> Cc: freebsd-doc@freebsd.org Subject: Re: What is the proper indent style for FDP? Message-ID: <alpine.BSF.2.20.1507181704470.62620@wonkity.com> In-Reply-To: <alpine.BSF.2.20.1507181653320.62620@wonkity.com> References: <55AACF8D.3060000@gmail.com> <alpine.BSF.2.20.1507181653320.62620@wonkity.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, 18 Jul 2015, Warren Block wrote: > On Sun, 19 Jul 2015, Hoyoung Kim wrote: > >> Hello. I'm curious about indentation style. >> Which is the proper one when dealing with FDP xml files? >> >> The original FDP files follow the style like this: >> >> <para>We have tried to keep the number of forward references in >> the text to a minimum so that you can read this section of the >> Handbook from front to back with the minimum page flipping >> required.</para> >> >> This is another example: >> >> <listitem> >> <para>Introduce you to X, the &unix; windowing system, and >> detail how to configure a desktop environment that makes >> you more productive.</para> >> </listitem> > > These are correct. To add to this, if editing an existing section, see https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style-guide.html#writing-style-whitespace-changes In short, whitespace-only changes to existing documents (indenting, blank lines, adding spaces) should be kept separate from content changes. Save them in a separate patch, for example.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?alpine.BSF.2.20.1507181704470.62620>