[DOCUMENTATION] TOCs level and numbers

[Jacques Le Roux]

Hi,

I asked recently on this ML if we should have

    "only 3 toc levels w/o numbers. Else some TOCs will be several pages, before reaching the real content."

Note that using ":toclevels: 3" in standalone documents does not work. Because when generating, the OOTB definition "'toclevels': '5'" in build.gradle
is not superseded.

I did not get any attention so far. So, in build.gradle, I suggest to set :

'toclevels': '3'
:!sectnums:

Without negative answers, I will do so in a week

Jacques

[Mathieu Lirzin]

Hello Jacques,

Jacques Le Roux <[hidden email]> writes:

> I asked recently on this ML if we should have
>
>    "only 3 toc levels w/o numbers. Else some TOCs will be several pages, before reaching the real content."
>
> Note that using ":toclevels: 3" in standalone documents does not
> work. Because when generating, the OOTB definition "'toclevels': '5'"
> in build.gradle is not superseded.
>
> I did not get any attention so far. So, in build.gradle, I suggest to set :
>
> 'toclevels': '3'
> :!sectnums:

I agree with limiting the table of content level to 3, However I
strongly disagree with the removal of section numbers which IME helps
both in understanding the structure of the manual and in making
references to a specific section.

--
Mathieu Lirzin
GPG: F2A3 8D7E EB2B 6640 5761  070D 0ADE E100 9460 4D37

[Jacques Le Roux]

Le 02/12/2018 à 13:49, Mathieu Lirzin a écrit :

> Hello Jacques,
>
> Jacques Le Roux <[hidden email]> writes:
>
>> I did not get any attention so far. So, in build.gradle, I suggest to set :
>>
>> 'toclevels': '3'
>> :!sectnums:
> I agree with limiting the table of content level to 3, However I
> strongly disagree with the removal of section numbers which IME helps
> both in understanding the structure of the manual and in making
> references to a specific section.
>

Hi Mathieu,

I did abuse of section numbers myself, and I now don't see what they bring. Can't we refer to the section itself? So we need a cluttering number for
that, and why? What does it had? Is it not cargo cult?

Jacques

[Jacques Le Roux]

Le 03/12/2018 à 22:46, Jacques Le Roux a écrit :

> Le 02/12/2018 à 13:49, Mathieu Lirzin a écrit :
>> Hello Jacques,
>>
>> Jacques Le Roux <[hidden email]> writes:
>>
>>> I did not get any attention so far. So, in build.gradle, I suggest to set :
>>>
>>> 'toclevels': '3'
>>> :!sectnums:
>> I agree with limiting the table of content level to 3, However I
>> strongly disagree with the removal of section numbers which IME helps
>> both in understanding the structure of the manual and in making
>> references to a specific section.
>>
> Hi Mathieu,
>
> I did abuse of section numbers myself, and I now don't see what they bring. Can't we refer to the section itself? So we need a cluttering number for
> that, and why? What does it had? Is it not cargo cult?
>
> Jacques
>
>

No other opinions?

Jacques

[Michael Brohl-3]

I‘m also in favour of keeping the section numbers.

Thanks,
Michael

--
Michael Brohl
Geschäftsführer

Fon   [phone]
Fax   [phone]
Mobil [phone]

Company and Management Headquarters:
ecomify GmbH, Gustav-Winkler-Straße 22, 33699 Bielefeld, Deutschland
Fon: [phone], Fax: [phone], www.ecomify.de

Court Registration: Amtsgericht Bielefeld HRB 41683
Chief Executive Officer: Martin Becker, Michael Brohl

> Am 06.12.2018 um 18:30 schrieb Jacques Le Roux <[hidden email]>:
>
>> Le 03/12/2018 à 22:46, Jacques Le Roux a écrit :
>>> Le 02/12/2018 à 13:49, Mathieu Lirzin a écrit :
>>> Hello Jacques,
>>>
>>> Jacques Le Roux <[hidden email]> writes:
>>>
>>>> I did not get any attention so far. So, in build.gradle, I suggest to set :
>>>>
>>>> 'toclevels': '3'
>>>> :!sectnums:
>>> I agree with limiting the table of content level to 3, However I
>>> strongly disagree with the removal of section numbers which IME helps
>>> both in understanding the structure of the manual and in making
>>> references to a specific section.
>>>
>> Hi Mathieu,
>>
>> I did abuse of section numbers myself, and I now don't see what they bring. Can't we refer to the section itself? So we need a cluttering number for
>> that, and why? What does it had? Is it not cargo cult?
>>
>> Jacques
>>
>>
> No other opinions?
>
> Jacques
>

[taher]

Section numbers are nice and we use them in all our documents. They help
you keep track of where you are and in large documents this becomes very
helpful.

So I would prefer keeping them.

On Fri, Dec 7, 2018, 12:09 AM Michael Brohl <[hidden email] wrote:

> I‘m also in favour of keeping the section numbers.
>
> Thanks,
> Michael
>
> --
> Michael Brohl
> Geschäftsführer
>
> Fon   [phone]
> Fax   [phone]
> Mobil [phone]
>
> Company and Management Headquarters:
> ecomify GmbH, Gustav-Winkler-Straße 22, 33699 Bielefeld, Deutschland
> Fon: [phone], Fax: [phone], www.ecomify.de
>
> Court Registration: Amtsgericht Bielefeld HRB 41683
> Chief Executive Officer: Martin Becker, Michael Brohl
>
> > Am 06.12.2018 um 18:30 schrieb Jacques Le Roux <
> [hidden email]>:
> >
> >> Le 03/12/2018 à 22:46, Jacques Le Roux a écrit :
> >>> Le 02/12/2018 à 13:49, Mathieu Lirzin a écrit :
> >>> Hello Jacques,
> >>>
> >>> Jacques Le Roux <[hidden email]> writes:
> >>>
> >>>> I did not get any attention so far. So, in build.gradle, I suggest to
> set :
> >>>>
> >>>> 'toclevels': '3'
> >>>> :!sectnums:
> >>> I agree with limiting the table of content level to 3, However I
> >>> strongly disagree with the removal of section numbers which IME helps
> >>> both in understanding the structure of the manual and in making
> >>> references to a specific section.
> >>>
> >> Hi Mathieu,
> >>
> >> I did abuse of section numbers myself, and I now don't see what they
> bring. Can't we refer to the section itself? So we need a cluttering number
> for
> >> that, and why? What does it had? Is it not cargo cult?
> >>
> >> Jacques
> >>
> >>
> > No other opinions?
> >
> > Jacques
> >
>

[Jacques Le Roux]

Thanks guys,

I see a majority and a trend so I'll simply change the toclevels from 5 to 3 in 3 days, if nobody disagree

Jacques


Le 07/12/2018 à 07:08, Taher Alkhateeb a écrit :

> Section numbers are nice and we use them in all our documents. They help
> you keep track of where you are and in large documents this becomes very
> helpful.
>
> So I would prefer keeping them.
>
> On Fri, Dec 7, 2018, 12:09 AM Michael Brohl <[hidden email] wrote:
>
>> I‘m also in favour of keeping the section numbers.
>>
>> Thanks,
>> Michael
>>
>> --
>> Michael Brohl
>> Geschäftsführer
>>
>> Fon   [phone]
>> Fax   [phone]
>> Mobil [phone]
>>
>> Company and Management Headquarters:
>> ecomify GmbH, Gustav-Winkler-Straße 22, 33699 Bielefeld, Deutschland
>> Fon: [phone], Fax: [phone], www.ecomify.de
>>
>> Court Registration: Amtsgericht Bielefeld HRB 41683
>> Chief Executive Officer: Martin Becker, Michael Brohl
>>
>>> Am 06.12.2018 um 18:30 schrieb Jacques Le Roux <
>> [hidden email]>:
>>>> Le 03/12/2018 à 22:46, Jacques Le Roux a écrit :
>>>>> Le 02/12/2018 à 13:49, Mathieu Lirzin a écrit :
>>>>> Hello Jacques,
>>>>>
>>>>> Jacques Le Roux <[hidden email]> writes:
>>>>>
>>>>>> I did not get any attention so far. So, in build.gradle, I suggest to
>> set :
>>>>>> 'toclevels': '3'
>>>>>> :!sectnums:
>>>>> I agree with limiting the table of content level to 3, However I
>>>>> strongly disagree with the removal of section numbers which IME helps
>>>>> both in understanding the structure of the manual and in making
>>>>> references to a specific section.
>>>>>
>>>> Hi Mathieu,
>>>>
>>>> I did abuse of section numbers myself, and I now don't see what they
>> bring. Can't we refer to the section itself? So we need a cluttering number
>> for
>>>> that, and why? What does it had? Is it not cargo cult?
>>>>
>>>> Jacques
>>>>
>>>>
>>> No other opinions?
>>>
>>> Jacques
>>>

[Rishi Solanki]

+1.

--
Rishi Solanki
Sr Manager, Enterprise Software Development
HotWax Systems Pvt. Ltd.
Direct: [phone]
http://www.hotwaxsystems.com
www.hotwax.co


On Fri, Dec 7, 2018 at 8:59 PM Jacques Le Roux <[hidden email]>
wrote:

> Thanks guys,
>
> I see a majority and a trend so I'll simply change the toclevels from 5 to
> 3 in 3 days, if nobody disagree
>
> Jacques
>
>
> Le 07/12/2018 à 07:08, Taher Alkhateeb a écrit :
> > Section numbers are nice and we use them in all our documents. They help
> > you keep track of where you are and in large documents this becomes very
> > helpful.
> >
> > So I would prefer keeping them.
> >
> > On Fri, Dec 7, 2018, 12:09 AM Michael Brohl <[hidden email]
> wrote:
> >
> >> I‘m also in favour of keeping the section numbers.
> >>
> >> Thanks,
> >> Michael
> >>
> >> --
> >> Michael Brohl
> >> Geschäftsführer
> >>
> >> Fon   [phone]
> >> Fax   [phone]
> >> Mobil [phone]
> >>
> >> Company and Management Headquarters:
> >> ecomify GmbH, Gustav-Winkler-Straße 22, 33699 Bielefeld, Deutschland
> >> Fon: [phone], Fax: [phone], www.ecomify.de
> >>
> >> Court Registration: Amtsgericht Bielefeld HRB 41683
> >> Chief Executive Officer: Martin Becker, Michael Brohl
> >>
> >>> Am 06.12.2018 um 18:30 schrieb Jacques Le Roux <
> >> [hidden email]>:
> >>>> Le 03/12/2018 à 22:46, Jacques Le Roux a écrit :
> >>>>> Le 02/12/2018 à 13:49, Mathieu Lirzin a écrit :
> >>>>> Hello Jacques,
> >>>>>
> >>>>> Jacques Le Roux <[hidden email]> writes:
> >>>>>
> >>>>>> I did not get any attention so far. So, in build.gradle, I suggest
> to
> >> set :
> >>>>>> 'toclevels': '3'
> >>>>>> :!sectnums:
> >>>>> I agree with limiting the table of content level to 3, However I
> >>>>> strongly disagree with the removal of section numbers which IME helps
> >>>>> both in understanding the structure of the manual and in making
> >>>>> references to a specific section.
> >>>>>
> >>>> Hi Mathieu,
> >>>>
> >>>> I did abuse of section numbers myself, and I now don't see what they
> >> bring. Can't we refer to the section itself? So we need a cluttering
> number
> >> for
> >>>> that, and why? What does it had? Is it not cargo cult?
> >>>>
> >>>> Jacques
> >>>>
> >>>>
> >>> No other opinions?
> >>>
> >>> Jacques
> >>>
>

[Jacques Le Roux]

Done at revision 1848849.

Jacques

Le 08/12/2018 à 15:05, Rishi Solanki a écrit :

> +1.
>
> --
> Rishi Solanki
> Sr Manager, Enterprise Software Development
> HotWax Systems Pvt. Ltd.
> Direct: [phone]
> http://www.hotwaxsystems.com
> www.hotwax.co
>
>
> On Fri, Dec 7, 2018 at 8:59 PM Jacques Le Roux <[hidden email]>
> wrote:
>
>> Thanks guys,
>>
>> I see a majority and a trend so I'll simply change the toclevels from 5 to
>> 3 in 3 days, if nobody disagree
>>
>> Jacques
>>
>>
>> Le 07/12/2018 à 07:08, Taher Alkhateeb a écrit :
>>> Section numbers are nice and we use them in all our documents. They help
>>> you keep track of where you are and in large documents this becomes very
>>> helpful.
>>>
>>> So I would prefer keeping them.
>>>
>>> On Fri, Dec 7, 2018, 12:09 AM Michael Brohl <[hidden email]
>> wrote:
>>>> I‘m also in favour of keeping the section numbers.
>>>>
>>>> Thanks,
>>>> Michael
>>>>
>>>> --
>>>> Michael Brohl
>>>> Geschäftsführer
>>>>
>>>> Fon   [phone]
>>>> Fax   [phone]
>>>> Mobil [phone]
>>>>
>>>> Company and Management Headquarters:
>>>> ecomify GmbH, Gustav-Winkler-Straße 22, 33699 Bielefeld, Deutschland
>>>> Fon: [phone], Fax: [phone], www.ecomify.de
>>>>
>>>> Court Registration: Amtsgericht Bielefeld HRB 41683
>>>> Chief Executive Officer: Martin Becker, Michael Brohl
>>>>
>>>>> Am 06.12.2018 um 18:30 schrieb Jacques Le Roux <
>>>> [hidden email]>:
>>>>>> Le 03/12/2018 à 22:46, Jacques Le Roux a écrit :
>>>>>>> Le 02/12/2018 à 13:49, Mathieu Lirzin a écrit :
>>>>>>> Hello Jacques,
>>>>>>>
>>>>>>> Jacques Le Roux <[hidden email]> writes:
>>>>>>>
>>>>>>>> I did not get any attention so far. So, in build.gradle, I suggest
>> to
>>>> set :
>>>>>>>> 'toclevels': '3'
>>>>>>>> :!sectnums:
>>>>>>> I agree with limiting the table of content level to 3, However I
>>>>>>> strongly disagree with the removal of section numbers which IME helps
>>>>>>> both in understanding the structure of the manual and in making
>>>>>>> references to a specific section.
>>>>>>>
>>>>>> Hi Mathieu,
>>>>>>
>>>>>> I did abuse of section numbers myself, and I now don't see what they
>>>> bring. Can't we refer to the section itself? So we need a cluttering
>> number
>>>> for
>>>>>> that, and why? What does it had? Is it not cargo cult?
>>>>>>
>>>>>> Jacques
>>>>>>
>>>>>>
>>>>> No other opinions?
>>>>>
>>>>> Jacques
>>>>>