Discussion:
[DOCUMENTATION] TOCs level and numbers
Jacques Le Roux
2018-12-02 12:13:01 UTC
Permalink
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
2018-12-02 12:49:12 UTC
Permalink
Hello Jacques,
Post by Jacques Le Roux
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.
'toclevels': '3'
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
2018-12-03 21:46:49 UTC
Permalink
Post by Mathieu Lirzin
Hello Jacques,
Post by Jacques Le Roux
'toclevels': '3'
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
2018-12-06 17:30:13 UTC
Permalink
Post by Jacques Le Roux
Post by Mathieu Lirzin
Hello Jacques,
Post by Jacques Le Roux
'toclevels': '3'
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
2018-12-06 21:09:42 UTC
Permalink
I‘m also in favour of keeping the section numbers.

Thanks,
Michael

--
Michael Brohl
GeschÀftsfÌhrer

Fon +49 521 448 157-91
Fax +49 521 448 157-99
Mobil +49 160 3664918

Company and Management Headquarters:
ecomify GmbH, Gustav-Winkler-Straße 22, 33699 Bielefeld, Deutschland
Fon: +49 521 448157-90, Fax: +49 521 448157-99, www.ecomify.de

Court Registration: Amtsgericht Bielefeld HRB 41683
Chief Executive Officer: Martin Becker, Michael Brohl
Post by Jacques Le Roux
Post by Jacques Le Roux
Post by Mathieu Lirzin
Hello Jacques,
Post by Jacques Le Roux
'toclevels': '3'
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 Alkhateeb
2018-12-07 06:08:25 UTC
Permalink
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.
Post by Michael Brohl
I‘m also in favour of keeping the section numbers.
Thanks,
Michael
--
Michael Brohl
GeschÀftsfÌhrer
Fon +49 521 448 157-91
Fax +49 521 448 157-99
Mobil +49 160 3664918
ecomify GmbH, Gustav-Winkler-Straße 22, 33699 Bielefeld, Deutschland
Fon: +49 521 448157-90, Fax: +49 521 448157-99, 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 <
Post by Jacques Le Roux
Post by Mathieu Lirzin
Hello Jacques,
Post by Jacques Le Roux
I did not get any attention so far. So, in build.gradle, I suggest to
'toclevels': '3'
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
Post by Jacques Le Roux
that, and why? What does it had? Is it not cargo cult?
Jacques
No other opinions?
Jacques
Jacques Le Roux
2018-12-07 15:20:40 UTC
Permalink
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
Post by Taher Alkhateeb
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.
I‘m also in favour of keeping the section numbers.
Thanks,
Michael
--
Michael Brohl
Geschäftsführer
Fon +49 521 448 157-91
Fax +49 521 448 157-99
Mobil +49 160 3664918
ecomify GmbH, Gustav-Winkler-Straße 22, 33699 Bielefeld, Deutschland
Fon: +49 521 448157-90, Fax: +49 521 448157-99, 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 <
Post by Jacques Le Roux
Post by Mathieu Lirzin
Hello Jacques,
Post by Jacques Le Roux
I did not get any attention so far. So, in build.gradle, I suggest to
'toclevels': '3'
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
Post by Jacques Le Roux
that, and why? What does it had? Is it not cargo cult?
Jacques
No other opinions?
Jacques
Rishi Solanki
2018-12-08 14:05:52 UTC
Permalink
+1.

--
Rishi Solanki
Sr Manager, Enterprise Software Development
HotWax Systems Pvt. Ltd.
Direct: +91-9893287847
http://www.hotwaxsystems.com
www.hotwax.co
Post by 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
Post by Taher Alkhateeb
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.
Post by Michael Brohl
I‘m also in favour of keeping the section numbers.
Thanks,
Michael
--
Michael Brohl
GeschÀftsfÌhrer
Fon +49 521 448 157-91
Fax +49 521 448 157-99
Mobil +49 160 3664918
ecomify GmbH, Gustav-Winkler-Straße 22, 33699 Bielefeld, Deutschland
Fon: +49 521 448157-90, Fax: +49 521 448157-99, 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 <
Post by Jacques Le Roux
Post by Mathieu Lirzin
Hello Jacques,
Post by Jacques Le Roux
I did not get any attention so far. So, in build.gradle, I suggest
to
Post by Taher Alkhateeb
Post by Michael Brohl
Post by Jacques Le Roux
Post by Mathieu Lirzin
Post by Jacques Le Roux
'toclevels': '3'
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
Post by Taher Alkhateeb
Post by Michael Brohl
for
Post by Jacques Le Roux
that, and why? What does it had? Is it not cargo cult?
Jacques
No other opinions?
Jacques
Loading...