Debian Codegraph @

texmf-dist/doc/metapost/base/source-manual/TODO

raw
1 This file contains an unsorted list of tasks to be done on the
2 MetaPost manual. Feel free to add new, move or remove finished
3 items.
4
5 Where to put new items?
6 -----------------------
7 Section 'Wanted For Release' contains items that we want to be
8 finished before the next release. Even minor issues can and
9 should be added here.
10
11 Items in section 'Mid Term Issues' have no dead-line, but should
12 be self-contained enough to be done independent from other stuff.
13
14 Items in section 'Long Term Issues' are less actively worked on.
15 The reason they are less actively worked on is not lack of
16 importance, but lack of developer resources. Nevertheless, they
17 are on the agenda. Contributions are welcome!
18
19 How to pick items?
20 ------------------
21 You can indicate interest or active work on an item by putting your
22 initials in parenthese in front of that item and checking the
23 modified TODO file into the repository. That way, anybody who is
24 subscribed to the metapost-commits list is notified of your
25 interest. Additionally, it is wise to communicate that you're
26 working on an issue (you didn't remember adding yourself) on the
27 mp-implementors list or alternatively the metapost list.
28
29
30 *****************************
31 *** Wanted For Release ***
32 *****************************
33 * Describe boundingpath
34
35 * Describe prescriptpart/postscriptpart.
36
37 * Describe penrazor, penspeck.
38
39 * Describe drawdot withpen counter-intuitivity. Describe recent change
40 in drawdot definition.
41
42
43
44 *****************************
45 *** Short term issues ***
46 *****************************
47
48 Integrating Text and Graphics:
49 * Fix bad description of prologues in table ivartab.
50 * Move discussion of prologues to sec. workflow2.
51 * Discuss difference between
52 label(btex ... etex, ...)
53 draw btex ... etex
54
55 Advanced Graphics:
56 * Describe turningnumber (mention differences in sec. 'MetaPost
57 Versus METAFONT').
58 * Make fig56 black and white.
59
60 Notes on the MetaPost Workflow:
61 * Describe variables jobname, charcode.
62
63 Reference Manual:
64 * Describe environment variables and configuration files.
65
66 Legacy Information:
67 * Cite original Hobby papers.
68
69 Debugging:
70 * turningnumber and tracingchoices > 2
71
72
73
74 *****************************
75 *** Mid Term Issues ***
76 *****************************
77
78 Introduction:
79 * Revise introduction.
80
81 Integrating Text and Graphics:
82 * Completely revise this section and consolidate information
83 scattered around mpman.
84 * More information and examples on alternatives for calling TeX
85 or LaTeX from within MetaPost.
86 * Revise (and add more) flow charts for MetaPost workflow.
87 * Describe whitespace handling of verbatimtex/btex/etex.
88 * Why is verbatimtex\end{document}etex "safer", cf. sec. 13.1?
89 * Discuss difference between "draw <pic> withpen" and
90 "label(<pic>, ...) withpen" (when label bug is fixed).
91
92 Advanced Graphics:
93 * Add a sub-section discussing colours.
94 * Colour cars and change code example in section piccomp.
95
96 Reference Manual:
97 * Describe missing variables, constants, and operators.
98 * Add description of interaction mode.
99
100 Legacy Information:
101 * Describe mpware (currently scattered around in mpman).
102
103
104
105
106 *****************************
107 *** Long Term Issues ***
108 *****************************
109
110 Title page:
111 * Add decent title graphics.
112
113 Reference Manual:
114 * Review presentation of primitives and plain macros in appendix A.
115 * Build reference manual automatically from mp.web (as a separate manual?).
116
117 General:
118 * Make mpman self-contained (no need to look-up sth. in 'The MetaFontbook').
119 * Make manual sources compatible with preview mode (Emacs).
120 * Make manual sources LaTeX2e conform.
121 * Make manual sources look nice in Emacs (AUCTeX font-locking).
122 * Review overall layout of the manuals (type area, float placement,
123 listing presentation etc.)
124