From owner-freebsd-doc@freebsd.org  Sat Jul 18 23:08:11 2015
Return-Path: <owner-freebsd-doc@freebsd.org>
Delivered-To: freebsd-doc@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id CA8B09A4B14
 for <freebsd-doc@mailman.ysv.freebsd.org>;
 Sat, 18 Jul 2015 23:08:11 +0000 (UTC)
 (envelope-from wblock@wonkity.com)
Received: from wonkity.com (wonkity.com [67.158.26.137])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client CN "wonkity.com", Issuer "wonkity.com" (not verified))
 by mx1.freebsd.org (Postfix) with ESMTPS id 75F4B1F27
 for <freebsd-doc@freebsd.org>; Sat, 18 Jul 2015 23:08:11 +0000 (UTC)
 (envelope-from wblock@wonkity.com)
Received: from wonkity.com (localhost [127.0.0.1])
 by wonkity.com (8.15.2/8.14.9) with ESMTPS id t6IN890n044417
 (version=TLSv1.2 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO);
 Sat, 18 Jul 2015 17:08:09 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Received: from localhost (wblock@localhost)
 by wonkity.com (8.15.2/8.14.9/Submit) with ESMTP id t6IN896u044414;
 Sat, 18 Jul 2015 17:08:09 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
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?
In-Reply-To: <alpine.BSF.2.20.1507181653320.62620@wonkity.com>
Message-ID: <alpine.BSF.2.20.1507181704470.62620@wonkity.com>
References: <55AACF8D.3060000@gmail.com>
 <alpine.BSF.2.20.1507181653320.62620@wonkity.com>
User-Agent: Alpine 2.20 (BSF 67 2015-01-07)
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII; format=flowed
X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3
 (wonkity.com [127.0.0.1]); Sat, 18 Jul 2015 17:08:09 -0600 (MDT)
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.20
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc/>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sat, 18 Jul 2015 23:08:11 -0000

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.