- ntg-context - Mailing Lists

Re: [NTG-context] [***SPAM***] OT: Generating Command reference from source code
by Hans Hagen 04 Dec '13

04 Dec '13

On 12/3/2013 10:59 PM, Jan Tosovsky wrote: > Dear All, > > in another thread I was dreaming ... to have always the complete and up to > date command/macro reference with basic descriptions and list all of the > parameter/options... > > 'Spoiled' by goodies offered by various Java APIs (based on > http://en.wikipedia.org/wiki/Javadoc ) I am missing this a lot. > > Example of the result: > http://docs.oracle.com/javase/7/docs/api/index.html?overview-summary.html > > In Java there is the following structure (simplified): > 1) 'packages' defining the hierarchy > 2) 'classes' defining objects > 3) 'properties' and 'methods' for every particular 'class' > > I've roughly scanned the ConTeXt source structure and bringing the following > idea: > > 1) There is no 'packages' counterpart in ConTeXt, but it would be handy to > think of any logical structure to group commands to logical groups (even > nested). Maybe the filename title prefix could be taken as a starting point > for this. > 2) 'classes' = all individual .mkiv files > 3) 'methods' = all public \def, \define etc in mkiv files (+maybe other > contructs I am not aware) > > Supposing that ... > a) every .mkiv file is enhanced by 'package' annotation > b) every public command/macro contains a description with the list of all > available params > (sensible subset of JavaDoc annotations) > > .... I can imagine to extract this info and: > > A) build the static command reference website with all the hyperlinks > B) eventually generate PDF variant of the same > C) export it into the form which can be imported into the WIKI (with > read-only mode) > > If every change of behaviour was reflected immediately in the description, > if any newly added parameter was added into the parameter list, the main > goal would be achieved. keep in mind that quite some functionality is the result of user requests and for a while can be in flux and i consider it then the users responsibility to wrap up on the wiki (for completely new mechanisms i often write a dedicated manual or an article for a user group journal) > But I understand there is lot of to do in the beginning... with disputable > effect in the end. > > I can help with some coding, transforming ... > > Jan > > Btw, would it be sufficient to scan texmf-context\tex\context\base\*.mkiv > files or there are other parts somewhere else? There are approx 500 files > now. It is huge number, but finite :-) there is a (somewhat incomplete) reference definition in xml format so your (b) is in principle covered; these definitions used to be in the source (more than a decade ago) but i moved them out because some functionality is stepwise provided (not in one place) and also because many commands are generated (you will not find their names by interpreting the source) the problem with tex (and therefore context) is that we are dealing with quite some interaction between unpredictable user input, macro (expansions), tex-internals, resources like fonts, patterns and whatever, etc. and this is why you often need to play with mechanisms: small test files and see how it looks (tex is a visual tool) it's often not as simple as "you feed it this" end "get back that" for documentation several methods are used: - examples in the test suite - some explanation in the source - explanations on the wiki - dedicated manuals - articles by users (+examples) although i sometimes run into impressive auto-documented documentation for languages or os commands, in practice i find myself looking for examples and/or experimenting and/or going into sources Hans ----------------------------------------------------------------- Hans Hagen | PRAGMA ADE Ridderstraat 27 | 8061 GH Hasselt | The Netherlands tel: 038 477 53 69 | voip: 087 875 68 74 | www.pragma-ade.com | www.pragma-pod.nl -----------------------------------------------------------------

3 3

[***SPAM***] OT: Generating Command reference from source code
by Jan Tosovsky 03 Dec '13

03 Dec '13

Dear All, in another thread I was dreaming ... to have always the complete and up to date command/macro reference with basic descriptions and list all of the parameter/options... 'Spoiled' by goodies offered by various Java APIs (based on http://en.wikipedia.org/wiki/Javadoc ) I am missing this a lot. Example of the result: http://docs.oracle.com/javase/7/docs/api/index.html?overview-summary.html In Java there is the following structure (simplified): 1) 'packages' defining the hierarchy 2) 'classes' defining objects 3) 'properties' and 'methods' for every particular 'class' I've roughly scanned the ConTeXt source structure and bringing the following idea: 1) There is no 'packages' counterpart in ConTeXt, but it would be handy to think of any logical structure to group commands to logical groups (even nested). Maybe the filename title prefix could be taken as a starting point for this. 2) 'classes' = all individual .mkiv files 3) 'methods' = all public \def, \define etc in mkiv files (+maybe other contructs I am not aware) Supposing that ... a) every .mkiv file is enhanced by 'package' annotation b) every public command/macro contains a description with the list of all available params (sensible subset of JavaDoc annotations) ... I can imagine to extract this info and: A) build the static command reference website with all the hyperlinks B) eventually generate PDF variant of the same C) export it into the form which can be imported into the WIKI (with read-only mode) If every change of behaviour was reflected immediately in the description, if any newly added parameter was added into the parameter list, the main goal would be achieved. But I understand there is lot of to do in the beginning... with disputable effect in the end. I can help with some coding, transforming ... Jan Btw, would it be sufficient to scan texmf-context\tex\context\base\*.mkiv files or there are other parts somewhere else? There are approx 500 files now. It is huge number, but finite :-)

1 0

(critical edition) Examples of bib files
by luigi scarso 03 Dec '13

03 Dec '13

We are currently seeing the part of bibliography and we are looking for real examples in utf. You can post the examples on this ml, or send me privately. -- luigi

1 0

vertical square root upstroke (instead of having a slant)
by Sanjoy Mahajan 03 Dec '13

03 Dec '13

With the following minimal file on MkIV (2013.05.28 00:36 MKIV current), the upstroke of the square root is vertical instead of having the usual slant toward the right. With MkII it has the usual slant. I see this problem only with certain arrangements of variables (that recur often in my book chapter on springs and piano strings). For example, it goes away after changing the "\rho" to a "b". \starttext \startformula \sqrt{Tb^2\over \rho}. \stopformula \stoptext I know that the big math symbols are constructed differently in MkIV and MkII. Does the example above show an intended difference? -- -Sanjoy

2 2

Re: [NTG-context] Keeping titles together with the following text when grid is on
by Hans Hagen 03 Dec '13

03 Dec '13

On 12/2/2013 9:02 PM, Jan Tosovsky wrote: > On 2013-12-02 "H. Özoguz" wrote: >> On 2013-12-01 Jan Tosovsky wrote: >>> >>> when grid is on, orphan and widows have to be eliminated using > additional >>> penalty settings. Whereas it works fine for body text, section titles > are >>> still sometimes left at the bottom of the page. >> >> this is not the same question as handling orphan and widows - because >> you surely do not want some titles with only 2-3 lines of body text >> after them. >> >> I always use "\testpage[x]" to handle those issues, see your example >> with testpage: >> >> \setuphead[section][before={\testpage[8]\blank}] \blank[samepage,big] > Thanks, it works! Another magic command not documented anywhere in the > ConTeXt Guide or Wiki... > > I was looking for any alternative for XSL-FO's keep-with-next="always". This > is a different approach, but it doesn't matter. > > Btw, I still don't understand why keeping the title and text behaves > differently when grid is on... > > Jan > > ___________________________________________________________________________________ > If your question is of interest to others as well, please add an entry to the Wiki! > > maillist : ntg-context(a)ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context > webpage : http://www.pragma-ade.nl / http://tex.aanhet.net > archive : http://foundry.supelec.fr/projects/contextrev/ > wiki : http://contextgarden.net > ___________________________________________________________________________________ > -- ----------------------------------------------------------------- Hans Hagen | PRAGMA ADE Ridderstraat 27 | 8061 GH Hasselt | The Netherlands tel: 038 477 53 69 | voip: 087 875 68 74 | www.pragma-ade.com | www.pragma-pod.nl -----------------------------------------------------------------

2 1

Command for the caption location inside \startplacefigure
by Géry Ogam 03 Dec '13

03 Dec '13

Hello, What is the option to specify the CAPTION location in \startplacefigure (I already now that you can do it from \setupcaption)? I thought the first argument of 'location' was for the FIGURE location, and the second one for the CAPTION location, but the second one has no effect: \startplacefigure[location={left, top}, title=A cow] \externalfigure[cow] \stopplacefigure Best regards.

1 0

xml selection on attribute expressions
by H. van der Meer 03 Dec '13

03 Dec '13

Following an example in the chapter on Expressions and filters for xml-processing one can select on an attribute ‘name’ in the node <file name=“whatever”/> file[@name=="whatever”]/command(todo) However, I would like to select on a combination of alternatives, so that equivalent are <file name=“whatever”/> and <file src=“whatever”/> I tried several variations but none of them work. \xmlfilter{#1}{file([@name=="whatever”] or [@src=="whatever”])/command(todo) \xmlfilter{#1}{file[@name=="whatever”] or [@src=="whatever”]/command(todo) \xmlfilter{#1}{file[@name=="whatever”] or file[@src=="whatever”]/command(todo) \xmlfilter{#1}{(file[@name=="whatever”]|file[@src=="whatever”])/command(todo) How to? Or is this impossible? Hans van der Meer

1 1

line notes compress
by Hans Hagen 03 Dec '13

03 Dec '13

Hi, The linenote compression options (and control) has been upgraded: \definepapersize [mine] [width=8cm, height=6cm] \setuplayout [location=middle, width=middle, height=middle, headerdistance=5mm] \setuppapersize [mine] [oversized] \definelinenote [MyNote] \setupnote [MyNote] [paragraph=yes] \setupnotation [MyNote] [alternative=serried, distance=.5em, width=broad] \setupalign [verytolerant] \showframe \startbuffer \setupfootertexts[\ttxx compress=\namednoteparameter{MyNote}{compress}\quad compressmethod=\namednoteparameter{MyNote}{compressmethod}] \startlinenumbering This\MyNote{That} context\MyNote{document} is\MyNote{was} a sample\MyNote{an example} that I\MyNote{she} want\MyNote{didn’t want} to show\MyNote{publish} \stoplinenumbering \page \stopbuffer \starttext \setupnote[MyNote][compress=yes,compressmethod=stopper] \getbuffer \setupnote[MyNote][compress=yes,compressmethod=separator] \getbuffer \setupnote[MyNote][compress=yes,compressmethod=space] \getbuffer \setupnote[MyNote][compress=yes,compressmethod=] \getbuffer \setupnote[MyNote][compress=no,compressmethod=stopper] \getbuffer \setupnote[MyNote][compress=no,compressmethod=separator] \getbuffer \setupnote[MyNote][compress=no,compressmethod=space] \getbuffer \setupnote[MyNote][compress=no,compressmethod=] \getbuffer \stoptext Keep in mind that paragraph notes are somewhat special so some tolerance in alignment helps. Hans ----------------------------------------------------------------- Hans Hagen | PRAGMA ADE Ridderstraat 27 | 8061 GH Hasselt | The Netherlands tel: 038 477 53 69 | voip: 087 875 68 74 | www.pragma-ade.com | www.pragma-pod.nl -----------------------------------------------------------------

2 2

Re: [NTG-context] Keeping titles together with the following text when grid is on
by Alan Braslau 02 Dec '13

02 Dec '13

On Mon, 2 Dec 2013 21:40:55 +0100 Jan Tosovsky <j.tosovsky(a)email.cz> wrote: > Nowadays most of API/command references are generated automatically > directly from the source code comments. It ensures up to date data, > but it helps also to programmers. Descriptive comments in the source > helps to understand the given code when editing older parts. I do not > know to what extent it could be implemented here, but the respective > person could give it a try Sometimes/often the answers to many questions can be found in the source code, indeed. Also, most names are intended to be quite descriptive, and ConTeXt does not error in the use of terse, cryptic labels. In fact, descriptive comments in the source then become redundant when the code is written in such an explicit style. This does not mean that there is no need for good documentation and tutorials. Alan

1 0

Re: [NTG-context] Keeping titles together with the following text when grid is on
by Thomas A. Schmitz 02 Dec '13

02 Dec '13

On 12/02/2013 09:02 PM, Jan Tosovsky wrote: > Thanks, it works! Another magic command not documented anywhere in the > ConTeXt Guide or Wiki... So have you added it yet? Thomas

2 1