Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 19 Jul 2015 08:08:01 +0900
From:      Hoyoung Kim <trig4800@gmail.com>
To:        freebsd-doc@freebsd.org
Subject:   Re: What is the proper indent style for FDP?
Message-ID:  <55AADC51.8070208@gmail.com>
In-Reply-To: <55AAD1DB.6000903@freebsd.org>
References:  <55AACF8D.3060000@gmail.com> <55AAD0CC.5030001@freebsd.org> <55AAD1DB.6000903@freebsd.org>

next in thread | previous in thread | raw e-mail | index | archive | help
Oh, I see. Thank you for reply :)

On 07/19/2015 07:23, Allan Jude wrote:
> 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
>




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