Source Browser ?

1% language=uk
2
3\usemodule[art-01,abr-01]
4
5\starttext
6
7\startsubject[title=Introduction]
8
9The interface definitions have a long history. They started out in as \TEX\
10commands, something \type {\start} \unknown\ \type {\stop} with embedded
11specifications. When \CONTEXT\ became larger and \XML\ showed up the definitions
12were converted into \XML\ and instead of putting the definitions in the source
13files they moved to one file: \type {cont-en.xml}.
14
15When at some point the number of commands not covered grew and the covered ones
16lagged behind reality, Wolfgang started to systematically collect all the
17information needed to make a more complete set of definitions. In the process we
18enhanced the supported syntax variants and added more methods to share common
19definitions. The current set of files describes all commands (even those not
20really meant for users). Because the definitions are also used to generate files
21for editors like \SCITE, there are some tools that operate on the \XML\ file. If
22needed one can still generate the large files (one per interface with merged
23definitions).
24
25\stopsubject
26
27\startsubject[title=Overviews]
28
29The files describing the interface can be recognized by the prefix \type {i-} and
30suffix \type {xml}. We don't explain the syntax here as those files give enough
31examples of usage.
32
33\starttabulate[|T|p|]
34\NC i-context            \NC the main file (it loads other files) \NC \NR
35\NC i-common-definitions \NC common definitions that save time and space when
36                             defining others\NC \NR
37\NC i-common-*           \NC files loaded by the common definition file \NC \NR
38\NC i-*                  \NC the setups organized by functionality \NC \NR
39\stoptabulate
40
41There are a couple of styles that implement the rendering of the interface
42commands (traditionally called setups):
43
44\starttabulate[|T|p|]
45\NC x-setups-basics   \NC loading of definitions and rendering of compact of extensive
46                          interface commands \NC \NR
47\NC x-setups-overview \NC generate a document with all commands using the large combined
48                          definition file \NC \NR
49\NC x-setups-generate \NC generate a document with all commands using the individual
50                          files but generate the combined file in the process \NC \NR
51\NC x-setups-proofing \NC used for direct rendering of a file where commands
52                          are defined \NC \NR
53\stoptabulate
54
55The proofing only works when there is the following line in a definition file:
56
57\starttyping
58<?context-directive job ctxfile x-setups.ctx ?>
59\stoptyping
60
61In that case running the \type {context} command on the file will render the
62defined commands.
63
64\starttyping
65context i-backend.xml
66\stoptyping
67
68If you want the combined \XML\ file(s), you need to call:
69
70\starttyping
71context x-setups-generate.mkiv
72context x-setups-generate.mkiv --interface=nl --result=setup-nl
73\stoptyping
74
75For each relevant interface. If you don't want that, and save quite some disk space,
76you can use:
77
78\starttyping
79context x-setups-overview.mkiv
80context x-setups-overview.mkiv --interface=nl --result=setup-nl
81\stoptyping
82
83Instead of these commands you can also do this:
84
85\starttyping
86context --extra=setups --overview
87context --extra=setups --overview --save
88context --extra=setups --overview --interface=nl
89context --extra=setups framed
90\stoptyping
91
92\stopsubject
93
94\startsubject[title=Use in manuals]
95
96{\em todo}
97
98\stopsubject
99
100\startsubject[title=Keeping up]
101
102We try to keep up with additions in \CONTEXT\ but it might be that we forget some. If
103you run into issues when processing, can't find what should be there, or find a discrepancy in
104a manual (like the beginners manual) you can contact us.
105
106\startlines
107Wolfgang Schuster
108Ton Otten
109Hans Hagen
110\stoplines
111
112\stopsubject
113
114\stoptext
115