Date: Sat, 18 Jul 2015 18:23:23 -0400 From: Allan Jude <allanjude@freebsd.org> To: freebsd-doc@freebsd.org Subject: Re: What is the proper indent style for FDP? Message-ID: <55AAD1DB.6000903@freebsd.org> In-Reply-To: <55AAD0CC.5030001@freebsd.org> References: <55AACF8D.3060000@gmail.com> <55AAD0CC.5030001@freebsd.org>
index | next in thread | previous in thread | raw e-mail
[-- Attachment #1 --] On 2015-07-18 18:18, Allan Jude wrote: > On 2015-07-18 18:13, 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> >> >> However, when I press P in Vim Visual mode to reformat selected text, >> the style changes 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> >> >> And this: >> >> <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> >> >> 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. Should I >> manually indent paragraphs after pressing P? >> >> Thanks. >> _______________________________________________ >> freebsd-doc@freebsd.org mailing list >> http://lists.freebsd.org/mailman/listinfo/freebsd-doc >> To unsubscribe, send any mail to "freebsd-doc-unsubscribe@freebsd.org" > > https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style-guide.html#writing-style-indentation > > two spaces per indent, one indent per tag. 8 spaces = a real tab. No > spaces before a real tab. No whitespace at the end of the line. > To answer your question better, the content of the <para> should be indented, so the vim auto-formatting is not doing it correctly. The first 2 examples are correct -- Allan Jude [-- Attachment #2 --] -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.22 (MingW32) iQIcBAEBAgAGBQJVqtHbAAoJEBmVNT4SmAt+DpEP/A8g7SM/RqowZCZN8l8mqtqI ey60wisjYpxrJQTWjmKOU3GaBE3p/gHSIT3p0ghEABiyGmKf3Ur6gPVaR99v2lri ZIDdkUkpjOafWjY4Bu9YWoB79Tas6PHlXS6Zpf3LaSUBlsWscfDRRDswHSVnRuuu N5SsgTbc4zfzJkoeeq9WPYhW7VS8XvgCItidKlIEryOWKK40S4jNTl/IEBm3k5pG S/hXU8kLu3B5ABUIchmTh46JsGHnLWVnoR3outxpcTUb4Am0xxUeQzPVbYj97kxU sr9lXJcSbHA88Vt+g8HOgmpKzpcTMiqQZQwZL6yUN+VIFy7OC1m/NA7ukVOcX0e/ iNDD9vwhcXpLKJfxhwcX+ryUP3oWXO4AJj1YQRDp/KlBz/FwzB4aDAfqUUG4vN1t KntjaslPeQv8bUMn74p1hF6KBBFSWv2b5M+ednCII2K6JuGpJ7gfbKiM9vf3lOU3 RuyX0W5IXHjml0WZZjz2vzF66gtjzg24ioHJRgzK134jYBAvt0WenzQnmTC6ljvi D2caJ6u/AjBqEgNBJt7FBQf406yDo53X2CiONIosms4BUZLXH664RQE+AoY4todT QmX3afGtYfatSuV8CHB9cdFapHkcXgR1P0+DbokX9SIgswFEdG3DAgfRUT1Lv47P /2PmIKvz+Eifs1kSjjuV =OPy9 -----END PGP SIGNATURE-----help
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?55AAD1DB.6000903>