summaryrefslogtreecommitdiff
path: root/tex/context/base/strc-doc.mkiv
blob: 4e9dec32e570eb028f39685d79e832ed5a972fdd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
%D \module
%D   [       file=strc-doc,
%D        version=2008.10.20,
%D          title=\CONTEXT\ Structure Macros,
%D       subtitle=Document Structure,
%D         author=Hans Hagen,
%D           date=\currentdate,
%D      copyright={PRAGMA ADE \& \CONTEXT\ Development Team}]
%C
%C This module is part of the \CONTEXT\ macro||package and is
%C therefore copyrighted by \PRAGMA. See mreadme.pdf for
%C details.

\writestatus{loading}{ConTeXt Structure Macros / Document Structure}

\registerctxluafile{strc-doc}{1.001}

\unprotect

\def\c!xmlsetup{xmlsetup}

% We operate in a \type {@@ns} namespace. All data is passed through
% variables. Of course we can built another interface on top of this
% that accepts multiple arguments. We might change this approach and
% remove this layer but it was needed for the transition.

\installcorenamespace{structure}

\installdirectcommandhandler \??structure {structure} % unchecked, so we need to initialize used parameters

% \definesystemvariable{ns}
% \def\structureparameter#1{\csname\??ns#1\endcsname}
% \def\detokenizedstructureparameter#1{\detokenize\expandafter\expandafter\expandafter{\csname\??ns#1\endcsname}}

\setupstructure % not a user command so we might need to change the name
  [\c!number=,
   \c!level=,
   \c!name=,
   \c!title=,
   \c!bookmark=,
   \c!marking=,
   \c!list=,
   \c!label=,
   \c!coupling=,
   \c!ownnumber=,
   \c!sectionseparatorset=\s!default,
   \c!sectionconversionset=\s!default,
   \c!sectionstopper=,
   \c!sectionstarter=,
   \c!sectionsegments=,
   \c!sectionresetset=,
   \c!reference=,
   \c!backreference=,
   \c!expansion=\v!no,
   \c!xmlsetup=,
   \s!catcodes=,
   \c!saveinlist=\v!yes,
   \c!command=\showstructuredata]

% maybe flags for list, bm, mark

\def\structurereferenceprefixon {+}
\def\structurereferenceprefixoff{-}

\def\setstructurereferenceprefix
  {\ifx\currentstructurereferenceprefix\empty
     % nothing
   \else\ifx\currentstructurereferenceprefix\structurereferenceprefixon
     \setupglobalreferenceprefix[\currentstructurereference]%
   \else\ifx\currentstructurereferenceprefix\structurereferenceprefixoff
     \setupglobalreferenceprefix[]%
   \else
     \setupglobalreferenceprefix[\currentstructurereferenceprefix]%
   \fi\fi\fi
   \let\currentstructurereferenceprefix\referenceprefix}

% why xdef ?

\unexpanded\def\structurecomponent
  {\dodoubleempty\dostructurecomponent}

\def\dostructurecomponent[#1][#2]% #1=interfaced-settings, #2=optional user data (not yet supported)
  {\begingroup
   \setupstructure[#1]%
   \xdef\currentstructurename           {\structureparameter\c!name}%
   \xdef\currentstructurecoupling       {\structureparameter\c!coupling}%
   \xdef\currentstructureownnumber      {\structureparameter\c!ownnumber}% optional own number
   \xdef\currentstructurelevel          {\structureparameter\c!level}%
   \edef\currentstructureexpansion      {\structureparameter\c!expansion}%
   \xdef\currentstructurexmlsetup       {\structureparameter\c!xmlsetup}%
   \xdef\currentstructurecatcodes       {\structureparameter\s!catcodes}%
   \xdef\currentstructurelabel          {\structureparameter\c!label}%
   \xdef\currentstructurereference      {\structureparameter\c!reference}%
   \xdef\currentstructurereferenceprefix{\structureparameter\c!referenceprefix}%
   \xdef\currentstructurebackreference  {\structureparameter\c!backreference}%
   \xdef\currentstructureshownumber     {\structureparameter\c!number}%
   \xdef\currentstructuresaveinlist     {\structureparameter\c!saveinlist}%
   \xdef\currentstructureincrementnumber{\structureparameter\c!incrementnumber}%
   \ifx\currentstructureexpansion\s!xml
     \xmlstartraw
       \xdef\currentstructuretitle   {\structureparameter\c!title}%
       \xdef\currentstructurebookmark{\structureparameter\c!bookmark}%
       \xdef\currentstructuremarking {\structureparameter\c!marking}%
       \xdef\currentstructurelist    {\structureparameter\c!list}%
     \xmlstopraw
     \ifx\currentstructurelist\empty
       \globallet\currentstructurelist\currentstructuretitle
     \fi
     \globallet\currentstructurecoding\s!xml
   \else
     \ifx\currentstructureexpansion\v!yes
       \xdef\currentstructuretitle   {\structureparameter\c!title}%
       \xdef\currentstructurebookmark{\structureparameter\c!bookmark}%
       \xdef\currentstructuremarking {\structureparameter\c!marking}%
       \xdef\currentstructurelist    {\structureparameter\c!list}%
     \else
       \xdef\currentstructuretitle   {\detokenizedstructureparameter\c!title}%
       \xdef\currentstructurebookmark{\detokenizedstructureparameter\c!bookmark}%
       \xdef\currentstructuremarking {\detokenizedstructureparameter\c!marking}%
       \xdef\currentstructurelist    {\detokenizedstructureparameter\c!list}%
       \iflocation \ifx\currentstructurebookmark\empty
         \begingroup
         \simplifycommands
         \xdef\currentstructurebookmark{\detokenize\expandafter{\normalexpanded{\structureparameter\c!title}}}%
        \endgroup
       \fi \fi
     \fi
     \ifx\currentstructurelist\empty
       \globallet\currentstructurelist\currentstructuretitle
     \fi
     \globallet\currentstructurecoding\s!tex
   \fi
   \setnextinternalreference
   \setstructurereferenceprefix
   \xdef\currentstructurenumber{\ctxlua{ % todo: combine with next call, adapt marks accordingly
        structures.sections.somelevel {
            references = {
                internal        = \nextinternalreference,
                block           = "\currentsectionblock",
                reference       = "\currentstructurereference",
                referenceprefix = "\currentstructurereferenceprefix",
                backreference   = "\currentstructurebackreference",
            },
            directives = {
                resetset   = "\structureparameter\c!sectionresetset",
            },
            metadata = {
                kind      = "section",
                name      = "\currentstructurename",
                catcodes  = \the\ifx\currentstructurecatcodes\empty\catcodetable\else\csname\currentstructurecatcodes\endcsname\fi,
                coding    = "\currentstructurecoding",
            \ifx\currentstructurecoding\s!xml
                xmlroot   =  "\xmldocument",
            \fi
            \ifx\currentstructurexmlsetup\empty \else
                xmlsetup  = "\currentstructurexmlsetup",
            \fi
            \ifx\currentstructuresaveinlist\v!no
                nolist    = true,
            \fi
            \ifx\currentstructureincrementnumber\v!yes
                increment = "\currentstructureincrementnumber",
            \fi
            },
            titledata = { % we can add mark and reference
                label    = \!!bs\detokenize\expandafter{\currentstructurelabel    }\!!es,
                title    = \!!bs\detokenize\expandafter{\currentstructuretitle    }\!!es,
            \ifx\currentstructurebookmark\currentstructuretitle \else
                bookmark = \!!bs\detokenize\expandafter{\currentstructurebookmark }\!!es,
            \fi
            \ifx\currentstructuremarking\currentstructuretitle \else
                marking  = \!!bs\detokenize\expandafter{\currentstructuremarking  }\!!es,
            \fi
            \ifx\currentstructuresaveinlist\v!no \else
              \ifx\currentstructurelist\currentstructuretitle \else
                list     = \!!bs\detokenize\expandafter{\currentstructurelist}\!!es,
              \fi
            \fi
            },
            numberdata = {
                % needed ?
                block         = "\currentsectionblock",
                hidenumber    = \ifx\currentstructureshownumber\v!no true\else nil\fi, % titles
                % so far
                separatorset  = "\structureparameter\c!sectionseparatorset",
                conversion    = "\structureparameter\c!sectionconversion", % for good old times sake
                conversionset = "\structureparameter\c!sectionconversionset",
                starter       = \!!bs\structureparameter\c!sectionstarter\!!es,
                stopper       = \!!bs\structureparameter\c!sectionstopper\!!es,
                set           = "\structureparameter\c!sectionset",
                segments      = "\structureparameter\c!sectionsegments",
                ownnumber     = "\currentstructureownnumber",
            },
            userdata = \!!bs\detokenize{#2}\!!es % will be converted to table at the lua end
        }
    }}%
   \xdef\currentstructurelistnumber{\ctxcommand{addtolist(structures.sections.current())}}%
   % \currentstructuresynchronize has to be called someplace, since it introduces a node
   \setstructuresynchronization\currentstructurelistnumber
   \structureparameter\c!command
   \endgroup}

\let\currentstructurenumber     \!!zerocount
\let\currentsectioncountervalue \!!zerocount % redefined later
\let\previoussectioncountervalue\!!zerocount % redefined later

% todo: a direct flusher (needed when hidden)

\def\setstructuresynchronization#1% todo: use ctxcontext
  {\xdef\currentstructureattribute  {\ctxlua        {tex.write(structures.references.setinternalreference("\currentstructurereferenceprefix","\currentstructurereference",\nextinternalreference,"\interactionparameter\c!focus"))}}%
   \xdef\currentstructuresynchronize{\ctxlatecommand{enhancelist(#1)}}}

\def\reportcurrentstructure{\ctxlua{structures.sections.reportstructure()}}

% Beware: we need to flush the data to the list explicitly. This is because
% node in inserted and we may want control over when that happens.

\def\showstructuredata
  {\par
   \dontleavehmode\begingroup
   \currentstructuresynchronize
   \currentstructureattribute
   [\currentstructurename: \showstructurelevel: \currentstructuretitle]
   \endgroup\par}

% We can access the (stored) data with the following macros.
%
% \def\MyHeadCommand  #1#2{\framed{#1}\framed{#2 / \structureuservariable{subtitle}}}
% \def\MyListCommand#1#2#3{\externalfigure[\structurelistuservariable{figure}][height=5mm]#2}
%
% \setuphead[chapter][command=\MyHeadCommand]
% \setuplist[chapter][alternative=command,command=\MyListCommand]
%
% \starttext
%     \setupheadertexts[chapter]
%     \setupinteraction[state=start]
%     \placebookmarks[chapter]
%     \placelist[chapter]
%     \startchapter[ownnumber=10,title=Ton,list=Hans,marking=Kees,bookmark=Bram][figure=cow.pdf,subtitle=oeps]
%     \stopchapter
% \stoptext

% todo: #1 => "#1" ... adapt lua code for name and number

\def\structurenumber               {\ctxcommand{structurenumber()}}
\def\structuretitle                {\ctxcommand{structuretitle()}}
\def\structurevariable           #1{\ctxcommand{structurevariable("#1")}}
\def\structureuservariable       #1{\ctxcommand{structureuservariable("#1")}}
\def\structurecatcodedget        #1{\ctxcommand{structurecatcodedget("#1")}} % bad name
\def\structuregivencatcodedget #1#2{\ctxcommand{structuregivencatcodedget("#1",\number#2)}} % bad name
\def\structureautocatcodedget  #1#2{\ctxcommand{structureautocatcodedget ("#1","#2")}}

\def\namedstructurevariable    #1#2{\ctxcommand{namedstructurevariable    ("#1","#2")}}
\def\namedstructureuservariable#1#2{\ctxcommand{namedstructureuservariable("#1","#2")}}

\protect \endinput