Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 18 Jul 2015 18:18:52 -0400
From:      Allan Jude <allanjude@freebsd.org>
To:        freebsd-doc@freebsd.org
Subject:   Re: What is the proper indent style for FDP?
Message-ID:  <55AAD0CC.5030001@freebsd.org>
In-Reply-To: <55AACF8D.3060000@gmail.com>
References:  <55AACF8D.3060000@gmail.com>

index | next in thread | previous in thread | raw e-mail

[-- Attachment #1 --]
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.

-- 
Allan Jude


[-- Attachment #2 --]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.22 (MingW32)

iQIcBAEBAgAGBQJVqtDoAAoJEBmVNT4SmAt+aKIQAJwJOB/GIaFD/1bgQ92GSTPu
YrnkQmluReQ9r/jTG+EUf0Nv1gGVa+/Nq/ganw0qTX8xFRVhhYStqAonnF1xlkKg
en1oXUTxpJaF4rbDlNwlN6MNV32GpWV7Jzc3UgML3FdC8enYMSDuwMHDVJILCSz0
D7hd6BJEy5xplFOZi4GsYhYwCj/25UgYC1GxrphwLqWB8LEYMHV1zimpCxRdRQmi
yhX4dr9fG+bqobLSEuM3IcVj6cpxA5mSjHOyPCLKb9W9T7/u6nwv+ga2L2khhsOC
tBL4umjGqeD+V+saG3KXUxkRDuwBm8jPvOo2cYXS2ShiR3gzzwJuXkYsJHFsYWZE
iEYr8iFJ9XF9jnzP7LRLG92jz0gurg/WfZemXj4z291ATL/Izam+Uzhoo2wfcbBt
mM4xQLZ5VFBbA867FcoKLM2lTv1kCJQFp/adThe65bJpoUOs2h3iBhRzA35qEa9J
RRgWvz/k73YoIMS/gRBlh9Op95/kVHHDpoiH83sEYwFJkyIaDG316OBDkx8lDlPb
js42/aKMgMn/Vn4f3esnb+soCHy4XPe3DikbJ1VDw8ONVlYPFRLztErnrnXV7CE1
hgSeyUiIHWHLaW17ELeDFpfMwt0Ujsn6k7tDw5BgwaBHOk0cNffDj5Dwq01Myola
MDIeRgX259RET3agDUhD
=23XU
-----END PGP SIGNATURE-----
help

Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?55AAD0CC.5030001>