[NTG-context] your opinion about list structures

[NTG-context] your opinion about list structures

[Henning Hraban Ramm]

Hi, this is about my ConTeXt book again…

[ToC]

At the moment, my table of contents has chapters and sections and is 8 
pages long. I would probably hardly use it.

Maybe it would be better to show only chapters (29 content + 12 appendix 
= 2 pages) and include a list of sections after the chapter title (or 
not at all).

[Registers]

I split between command and topic index (9 pages each), because I find 
it annoying to have the commands between the topics.
I also include the topics that are mentioned in titles in the index, 
because I hate it if I must look in two places.
(Otherwise I wouldn’t think about omitting the sections from the ToC.)

At the moment there‘s also an index of todo items, but that will 
disappear before print.

[Glossary]

There’s a short dictionary of technical terms in the appendix (8.5 p.). 
Each lemma is also included in the index.

Should I add a list of abbreviations? (TDS, TEI, OCG, RAL, PDF, SVG…?)
They’re in the index and explained where they matter – I don’t think the 
meaning of many abbreviations like file types is important.

[Other lists]

Should I include a list of colors, like the output of 
\showcolor[crayola]? (I think it would only bloat the book, and everyone 
can create the list themselves.)

I have lists of supported languages (should get checked), fonts in the 
distribution and all math fonts, because these are not easily 
reproducible (AFAIK).


So, what do you think, and how do you like to work with technical books?
What kind of information (about ConTeXt or documents/printing in 
general) do you find hard to find?

Hraban
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / https://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : https://www.pragma-ade.nl / http://context.aanhet.net
archive  : https://bitbucket.org/phg/context-mirror/commits/
wiki     : https://contextgarden.net
___________________________________________________________________________________

[NTG-context] Re: your opinion about list structures

[Keith McKay]

Hi Hraban

Here are my thoughts on your ConTeXt Book.

[TOC] Definitely only show Chapters and Appendices. A list of sections 
could go under the Chapter Title, it would more useful there. I don't 
think there is also a need include sub-sections, (if you have them) it 
could make the list inordinately long.

[Registers] My own preference would be a command and a topic index if 
only for convenience sake.

[Glossary] I don't think an index of abbreviations is necessary if they 
are already in the index.

[Other Lists] I don't think a list of colours is necessary, you could 
just point them to the wiki.

Just my thoughts, and I look forward to read the English version of your 
book. (smiling)

Best Wishes

Keith McKay

p.s. It's been so long since I worked with technical books that I would 
have to blow the dust off them.

On 10/08/2023 14:21, Henning Hraban Ramm wrote:
> Hi, this is about my ConTeXt book again…
>
> [ToC]
>
> At the moment, my table of contents has chapters and sections and is 8 
> pages long. I would probably hardly use it.
>
> Maybe it would be better to show only chapters (29 content + 12 
> appendix = 2 pages) and include a list of sections after the chapter 
> title (or not at all).
>
> [Registers]
>
> I split between command and topic index (9 pages each), because I find 
> it annoying to have the commands between the topics.
> I also include the topics that are mentioned in titles in the index, 
> because I hate it if I must look in two places.
> (Otherwise I wouldn’t think about omitting the sections from the ToC.)
>
> At the moment there‘s also an index of todo items, but that will 
> disappear before print.
>
> [Glossary]
>
> There’s a short dictionary of technical terms in the appendix (8.5 
> p.). Each lemma is also included in the index.
>
> Should I add a list of abbreviations? (TDS, TEI, OCG, RAL, PDF, SVG…?)
> They’re in the index and explained where they matter – I don’t think 
> the meaning of many abbreviations like file types is important.
>
> [Other lists]
>
> Should I include a list of colors, like the output of 
> \showcolor[crayola]? (I think it would only bloat the book, and 
> everyone can create the list themselves.)
>
> I have lists of supported languages (should get checked), fonts in the 
> distribution and all math fonts, because these are not easily 
> reproducible (AFAIK).
>
>
> So, what do you think, and how do you like to work with technical books?
> What kind of information (about ConTeXt or documents/printing in 
> general) do you find hard to find?
>
> Hraban
> ___________________________________________________________________________________ 
>
> If your question is of interest to others as well, please add an entry 
> to the Wiki!
>
> maillist : ntg-context@ntg.nl / 
> https://www.ntg.nl/mailman/listinfo/ntg-context
> webpage  : https://www.pragma-ade.nl / http://context.aanhet.net
> archive  : https://bitbucket.org/phg/context-mirror/commits/
> wiki     : https://contextgarden.net
> ___________________________________________________________________________________
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / https://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : https://www.pragma-ade.nl / http://context.aanhet.net
archive  : https://bitbucket.org/phg/context-mirror/commits/
wiki     : https://contextgarden.net
___________________________________________________________________________________

[NTG-context] Re: your opinion about list structures

[denis.maier]

Hi Hraban,

a late reply concerning the ToCs in your book: maybe you could an two-toc-approach like in the Memoir manual? One could show only the chapters, another would contain everything.

Best,
Denis

> -----Ursprüngliche Nachricht-----
> Von: Henning Hraban Ramm <texml@fiee.net>
> Gesendet: Donnerstag, 10. August 2023 15:22
> An: mailing list for ConTeXt users <ntg-context@ntg.nl>
> Betreff: [NTG-context] your opinion about list structures
> 
> Hi, this is about my ConTeXt book again.
> 
> [ToC]
> 
> At the moment, my table of contents has chapters and sections and is 8 pages
> long. I would probably hardly use it.
> 
> Maybe it would be better to show only chapters (29 content + 12 appendix = 2
> pages) and include a list of sections after the chapter title (or not at all).
> 
> [Registers]
> 
> I split between command and topic index (9 pages each), because I find it
> annoying to have the commands between the topics.
> I also include the topics that are mentioned in titles in the index, because I hate
> it if I must look in two places.
> (Otherwise I wouldn't think about omitting the sections from the ToC.)
> 
> At the moment there's also an index of todo items, but that will disappear
> before print.
> 
> [Glossary]
> 
> There's a short dictionary of technical terms in the appendix (8.5 p.).
> Each lemma is also included in the index.
> 
> Should I add a list of abbreviations? (TDS, TEI, OCG, RAL, PDF, SVG.?) They're
> in the index and explained where they matter - I don't think the meaning of
> many abbreviations like file types is important.
> 
> [Other lists]
> 
> Should I include a list of colors, like the output of \showcolor[crayola]? (I think
> it would only bloat the book, and everyone can create the list themselves.)
> 
> I have lists of supported languages (should get checked), fonts in the
> distribution and all math fonts, because these are not easily reproducible
> (AFAIK).
> 
> 
> So, what do you think, and how do you like to work with technical books?
> What kind of information (about ConTeXt or documents/printing in
> general) do you find hard to find?
> 
> Hraban
> ___________________________________________________________________
> ________________
> If your question is of interest to others as well, please add an entry to the
> Wiki!
> 
> maillist : ntg-context@ntg.nl /
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww
> .ntg.nl%2Fmailman%2Flistinfo%2Fntg-
> context&data=05%7C01%7Cdenis.maier%40unibe.ch%7C8c6e26b5f7a14d8
> 5386c08db99a4ef16%7Cd400387a212f43eaac7f77aa12d7977e%7C1%7C0
> %7C638272705889584734%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4
> wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%
> 7C%7C%7C&sdata=wp5lFDSJq9915y4de%2BNuNiULb09yT%2FpDr%2FWXrq
> OcdVI%3D&reserved=0
> webpage  :
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww
> .pragma-
> ade.nl%2F&data=05%7C01%7Cdenis.maier%40unibe.ch%7C8c6e26b5f7a14
> d85386c08db99a4ef16%7Cd400387a212f43eaac7f77aa12d7977e%7C1%7
> C0%7C638272705889584734%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC
> 4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000
> %7C%7C%7C&sdata=TLdBrqOp1GuhmQRLiaydxRox1aeaO%2BWASrA%2FBa
> OAs%2BI%3D&reserved=0 /
> https://eur03.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcontex
> t.aanhet.net%2F&data=05%7C01%7Cdenis.maier%40unibe.ch%7C8c6e26b5
> f7a14d85386c08db99a4ef16%7Cd400387a212f43eaac7f77aa12d7977e%7
> C1%7C0%7C638272705889584734%7CUnknown%7CTWFpbGZsb3d8eyJWI
> joiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C
> 3000%7C%7C%7C&sdata=T%2FP42p3V5RzC%2B%2BwX5vByYtXy3LFOHce5
> Eues%2F8PPsug%3D&reserved=0
> archive  :
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbitbu
> cket.org%2Fphg%2Fcontext-
> mirror%2Fcommits%2F&data=05%7C01%7Cdenis.maier%40unibe.ch%7C8c6
> e26b5f7a14d85386c08db99a4ef16%7Cd400387a212f43eaac7f77aa12d79
> 77e%7C1%7C0%7C638272705889584734%7CUnknown%7CTWFpbGZsb3d
> 8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%
> 3D%7C3000%7C%7C%7C&sdata=MR51GITNqb9ludzBJMwmu4AqE%2BaWw
> 0%2BIPpPm76Nwv%2BE%3D&reserved=0
> wiki     :
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fconte
> xtgarden.net%2F&data=05%7C01%7Cdenis.maier%40unibe.ch%7C8c6e26b
> 5f7a14d85386c08db99a4ef16%7Cd400387a212f43eaac7f77aa12d7977e%
> 7C1%7C0%7C638272705889584734%7CUnknown%7CTWFpbGZsb3d8eyJ
> WIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D
> %7C3000%7C%7C%7C&sdata=ubpCSLzX4vdgb7WNlaK7ASRwd94Ugv0TtuF8
> wzDnnts%3D&reserved=0
> ___________________________________________________________________
> ________________
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / https://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : https://www.pragma-ade.nl / http://context.aanhet.net
archive  : https://bitbucket.org/phg/context-mirror/commits/
wiki     : https://contextgarden.net
___________________________________________________________________________________

[NTG-context] Re: your opinion about list structures

[Henning Hraban Ramm]

Am 22.08.23 um 17:12 schrieb denis.maier@unibe.ch:
> Hi Hraban,
> 
> a late reply concerning the ToCs in your book: maybe you could an two-toc-approach like in the Memoir manual? One could show only the chapters, another would contain everything.

Hi,
since Keith as the only other responder also preferred the chapter-ToC 
approach, I changed my setup accordingly. It was easy and looks good ;)

Hraban

___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / https://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : https://www.pragma-ade.nl / http://context.aanhet.net
archive  : https://bitbucket.org/phg/context-mirror/commits/
wiki     : https://contextgarden.net
___________________________________________________________________________________