Re: [NTG-context] general suggestion for ConTeXt documentation (was: footnote and endnote markers...)

2018-08-08 Thread Robert Zydenbos
On 8. Aug 2018, at 00:54, Alan Braslau  wrote:
> 
> tex/context/interface/mkiv/i-context.pdf

Thank you! I didn’t know I already had this updated version of a document I’ve 
already been using. But however useful this document already is, it does 
illustrate some of my problems. For instance, in the entry ‘\setupnote’ I see:

…
indicator: yes no
distance: dimension
…

Surely this is fine for those who have been working on ConTeXt for years at a 
very low coding level. But I see this and ask myself: “indicator of what? 
distance to what?” etc. (Sometimes, when confronted with such information, I 
just play around a bit with changing parameters and see what happens: sometimes 
I discover the meanings, sometimes I don’t.)

‘\setupnote’ inherits from ‘\setupframed’. There one finds

…
profile = NAME
empty = yes no
…

and similar questions arise: “what kind of profile?”, “what is empty or not?” 
etc.

Unfortunately the source browser on the Wiki is out of order, otherwise that 
might have helped.

Suggestion / request: all the ConTeXt source files are, of course, read and 
processed in a particular order. It would surely be useful if someone could 
indicate where this chain begins. Anybody who would be interested in sorting 
out the workings of ConTeXt and writing a manual (no, I am not making any 
promises yet :-) ) could then trace how one command leads to another, another, 
another… and how the entire system is built up.

Robert

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

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

Re: [NTG-context] general suggestion for ConTeXt documentation (was: footnote and endnote markers...)

2018-08-07 Thread Alan Braslau
tex/context/interface/mkiv/i-context.pdf


On Wed, 8 Aug 2018 00:40:37 +0200
Robert Zydenbos  wrote:

> > On 7. Aug 2018, at 17:54, Pablo Rodriguez  wrote:
> > 
> > On 08/06/2018 11:59 PM, Robert Zydenbos wrote:  
> >> Sorry for all these footnote questions, […]  
> > 
> > Hi Robert,
> > 
> > […]
> > 
> > I hope it helps,
> > 
> > Pablo  
> 
> That is it. I have no idea why – but that is the solution.
> 
> (For all readers:)
> 
> ConTeXt is great. Let me make that clear right way. I think it's the future 
> of TeX. I'm already doing things in ConTeXt that I dread trying to do in 
> LaTeX or any other system. But (yes, of course there was a 'but' coming) the 
> one thing that is missing, the one obstacle which I think exists for ConTeXt 
> gaining wider currency, is really good documentation.
> 
> Take this last question of mine which Pablo solved: I had to put a certain 
> parameter in  \setupnotedefinition  [footnote]. First I did it wrongly, 
> putting it in \setupnote [footnote] (why? because the names of the values, 
> like 'location', look so much alike). So what goes into \setupnotedefinition 
> and what goes into \setupnote? How do I know? (How does Pablo know this? 
> Maybe he can tell me off-list. :-) ) Many of the commands are not, or badly, 
> documented in the otherwise useful Wiki. What are all the parameters that are 
> recognized by the various commands, and just what do they mean? What are the 
> default settings? ConTeXt looks like an object oriented programming language 
> with inheritances, but it is unclear just what is inherited from where, and 
> why.
> 
> I appreciate all the effort made by various people to provide documentation 
> and demos. But I think the cause of ConTeXt would be greatly served if 
> someone would bring out a hierarchic list of the ConTeXt commands with a 
> brief description of what the commands and the parameters do and why they 
> exist at all, so that the reader gets an idea of the structure of the whole 
> system and the philosophy behind it (i.e., explaining why it is thus 
> structured and why it works).
> 
> Once again: I think ConTeXt is great, and so is this forum, which is a huge 
> help. I also realize ConTeXt is complex and that the great people behind it 
> also have other things to do in life. But still: maybe the kind of 
> documentation I propose would help to make things still a bit greater?
> 
> Robert
> 
> 
> ___
> If your question is of interest to others as well, please add an entry to the 
> Wiki!
> 
> maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
> webpage  : http://www.pragma-ade.nl / http://context.aanhet.net
> archive  : https://bitbucket.org/phg/context-mirror/commits/
> wiki : http://contextgarden.net
> ___
___
If your question is of interest to others as well, please add an entry to the 
Wiki!

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

Re: [NTG-context] general suggestion for ConTeXt documentation (was: footnote and endnote markers...)

2018-08-07 Thread Robert Zydenbos
> On 7. Aug 2018, at 17:54, Pablo Rodriguez  wrote:
> 
> On 08/06/2018 11:59 PM, Robert Zydenbos wrote:
>> Sorry for all these footnote questions, […]
> 
> Hi Robert,
> 
> […]
> 
> I hope it helps,
> 
> Pablo

That is it. I have no idea why – but that is the solution.

(For all readers:)

ConTeXt is great. Let me make that clear right way. I think it's the future of 
TeX. I'm already doing things in ConTeXt that I dread trying to do in LaTeX or 
any other system. But (yes, of course there was a 'but' coming) the one thing 
that is missing, the one obstacle which I think exists for ConTeXt gaining 
wider currency, is really good documentation.

Take this last question of mine which Pablo solved: I had to put a certain 
parameter in  \setupnotedefinition  [footnote]. First I did it wrongly, putting 
it in \setupnote [footnote] (why? because the names of the values, like 
'location', look so much alike). So what goes into \setupnotedefinition and 
what goes into \setupnote? How do I know? (How does Pablo know this? Maybe he 
can tell me off-list. :-) ) Many of the commands are not, or badly, documented 
in the otherwise useful Wiki. What are all the parameters that are recognized 
by the various commands, and just what do they mean? What are the default 
settings? ConTeXt looks like an object oriented programming language with 
inheritances, but it is unclear just what is inherited from where, and why.

I appreciate all the effort made by various people to provide documentation and 
demos. But I think the cause of ConTeXt would be greatly served if someone 
would bring out a hierarchic list of the ConTeXt commands with a brief 
description of what the commands and the parameters do and why they exist at 
all, so that the reader gets an idea of the structure of the whole system and 
the philosophy behind it (i.e., explaining why it is thus structured and why it 
works).

Once again: I think ConTeXt is great, and so is this forum, which is a huge 
help. I also realize ConTeXt is complex and that the great people behind it 
also have other things to do in life. But still: maybe the kind of 
documentation I propose would help to make things still a bit greater?

Robert


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

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