summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/cweb/src/TODO
blob: 82fddd2ee5cae2c9f79152cc735d6be199bb1d75 (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
% $Id: TODO,v 1.10 1995/11/30 15:44:51 schrod Exp $
%----------------------------------------------------------------------


----------------------------------------------------------------------

functionality [problem]

In plain CWEB chunks are not split over pages, LaTeX CWEB does so. Add
an option that re-establishs the behaviour of plain CWEB.

Problem reported by Denis B. R\"ogel <denis.roegel@loria.fr>

----------------------------------------------------------------------

functionality [problem]

User index would use with standard LaTeX markup (\index) would use
*.idx as raw index file. This file is used by CWEAVE as tagged index
file.

Shall I redefine \makeindex?

----------------------------------------------------------------------

functionality [proposal]

Add support to create the illusion of more than one refinement in a
chunk.

\cwebNoChunkIntro; see cwebx.sty.
Proposed by Christopher Higgins <C.Higgins@cit.gu.edu.au>.
Ack him for that.

----------------------------------------------------------------------

functionality [proposal]

Add support for CWEB code examples.

For that code from cwebparts.doc must be moved to cwebbase.doc; see
cwebx.sty. That code has also several improvements over cwebparts.doc!
cwebparts.doc is needed later for typesetting sections, etc. Well, if
that can really be realized in a document/project independent way.
Don't know if I really need it. (Except as a user front end. But I
can also use cwebbase for that.)

----------------------------------------------------------------------

functionality [proposal]

Add support for HyperTeX.

Proposed by Christopher Higgins <C.Higgins@cit.gu.edu.au>.

----------------------------------------------------------------------

list headers [error]

Use \chaptermark & \sectionmark, in \CwebListSection.

Maybe discard \@mkboth from \CwebIdIndex, \CwebRefList, etc. It's
supposed to be changed by a pagestyle, but this doesn't happen with
fancyheadings anyhow -- and face it, fancyheadings is the method of
choice for head-/footline creation.

The actual code was caused by stupid copying from LaTeX standard
classes; with the change it's possible to have other list heading
layout (add to toc, other marks, etc.)

But check if I can use that in \CwebIdIndex: There \CwebListSection is
used in an \twocolumn optional arg, that will eventually trigger the
output routine and will be set as a float. Does marks correctly
migrate out of floats?

----------------------------------------------------------------------

layout [error]

In chunks without documentation, a refinement is too near to the chunk
marker. In addition, the distance is not independent of
\CwebIndentUnit, making it impossible to change the latter.

NOTE: Might be a problem of \cwebNoChunk that should start a
paragraph. *When* will CWEAVE add `\4' after `\B'? Have to make tests
for that. How can I detect an empty documentation section?

\B kind of repaired in cwebx.sty.

----------------------------------------------------------------------

layout [error]

Chunk numbers are not exactly aligned in all circumstances, see fixme
remark in cwebbase.doc.

----------------------------------------------------------------------

interface [idea]

Name all \cwbb@... macros used in other modules \Cwbb... (or even
\cwbb...).

----------------------------------------------------------------------

markup [proposal]

Support delimiting section titles by braces.

Maybe one needs an option to turn that on.

Supported by Peter Wainwright <prw-b@ugrad.cs.york.ac.uk>.

----------------------------------------------------------------------

documentation [ack]

Who sent the mail concerning \hb@xt@? Add to acks. Change log message
for it, too (cweb.doc: 3.4; cwebbase.doc: 1.4).

----------------------------------------------------------------------

documentation [problem]

cweb-conf.tex:

Cseq name of chunk marker (paragraph symbol).
Ack Christopher Higgins \path|<c.higgins@cit.gu.edu.au>|.

\CwebRankNoEject. (Implies explication of rank numbers. Should be
explicated in cwebbase.doc as well, btw.)
Ack Nicholas Urbanik \path|<nicku@iohk.com>|

Support for another language must be stored in cwbl-*.sty. Check
cwbl-german.sty for the cseqs that must be redefined, list their
original English text for clarification.

----------------------------------------------------------------------

distribution [problem]

cweb.cls & cwebbase.tex is > 100KB now. Export it in uncommented form.

----------------------------------------------------------------------

distribution [problem]

It's better to collect stuff from contrib, and have each file that
shall be installed in top dir.

This means a Makefile in contrib/; and changes in README, INSTALL, and
maybe even MANIFEST.

----------------------------------------------------------------------

distribution [proposal]

Add hint to TODO in README. Maybe point out that src/ sometimes holds
prereleases of future styles.

----------------------------------------------------------------------

distribution [proposal]

Install TODO in doc dir. The end user should see open problems and
plans, too.

----------------------------------------------------------------------