From owner-freebsd-doc@freebsd.org Sat Jul 18 22:57:58 2015 Return-Path: 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 9D5E19A499F for ; Sat, 18 Jul 2015 22:57:58 +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 4CB7A1C95 for ; Sat, 18 Jul 2015 22:57:57 +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 t6IMvuxr041754 (version=TLSv1.2 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO); Sat, 18 Jul 2015 16:57:56 -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 t6IMvuq1041751; Sat, 18 Jul 2015 16:57:56 -0600 (MDT) (envelope-from wblock@wonkity.com) Date: Sat, 18 Jul 2015 16:57:56 -0600 (MDT) From: Warren Block To: Hoyoung Kim cc: freebsd-doc@freebsd.org Subject: Re: What is the proper indent style for FDP? In-Reply-To: <55AACF8D.3060000@gmail.com> Message-ID: References: <55AACF8D.3060000@gmail.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 16:57:56 -0600 (MDT) X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 18 Jul 2015 22:57:58 -0000 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: > > 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. > > This is another example: > > > Introduce you to X, the &unix; windowing system, and > detail how to configure a desktop environment that makes > you more productive. > These are correct. > However, when I press P in Vim Visual mode to reformat selected text, the > style changes like this: > > 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. > > And this: > > Introduce you to X, the &unix; windowing > system, and detail how to configure a desktop environment that > makes you more productive. These are not correct. > All the original files follow the former style, but FDP Primer suggests the > latter style. > (https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/editor-config.html#editor-config-vim) > > I want to know whether the latter style is allowed or not. No, the first style is the correct way. > Should I manually indent paragraphs after pressing P? If the editor does not do it correctly, yes. Providing a default editor config does not suggest that editor does everything correctly. vim users might be able to help more. I have yet to find any editor that really does our indenting correctly. Maybe some programming can improve on what vim or emacs does by default.