add FAQ update to list of PyX 0.6 TODO items
[PyX/mjg.git] / CHANGES
blob62212870ebe373caaef58a6edcab8d435fcd04af
1 PyX
3 TODO:
4   - graph module
5     - do not include unneeded line segments when the axis range is set manually
6     - allow for an iteration of a graph style, when it is used several times
7     - symbols should become decorators
8     - common bboxes for different graphs
9     - automatic datafile key title
10     - exceptions in drawsymbol & friends...
11     - 3d graphs, circular graphs
12     - symbols + lines -> symbollines (??). Symbols should not allow setting lineattrs, and
13       lines not symbolattrs
14     - allow for graph.changesymbol.square(size=0.15) etc.
15     - rect style (and errorbars?) should use clipping
16     - should the divisor argument be moved to the texters?
17     - is the divisor argument really necessary?
18     - _mergelabels should work differently (perhaps a single list or a special texter?!)
19     - the exponentialtexter should have a labelattrs argument and the mantissatexter
20       should be removed
21     - Docu: part -> parter, tickdist->tickpos argument of parter
22   - style module:
23     - default patterns
24     - make dash length available
25   - text module:
26     - SlantFont & Co support
27     - keep an eye on PEP 324 (popen 5): it could make the texrunner much easier
28     - messageparser for replaced fontsizes: Warning
29     - messageparser for size differences at the end: Warning not Exception
30     - messageparser for overfull/underfull vbox/hbox: Warning not Exception
31     - newline removal when not disturbing texmessages only
32   - mathtree module:
33      - consider rewrite using the python compiler module
34   - data module:
35     - data.data should add line number like data.datafile
36     - use csv module (new in 2.3)
37     - Check for "inf" and "nan" in datafiles.
38       (When plotted, the graph does not complain, but the postscript will be broken)
39   - canvas module:
40     - multi page PostScript output
41     - contructor should only take a texrunner keyword argument
42     - set method???
43     - PDF support
44     - SVG support
45   - deco module:
46     - the name wriggle has to replaced by something better (e.g. wriggled?)
47   - style and color module:
48     - support modification of existing styles via __call__
49   - bbox module:
50     - height -> getheight, ...
51   - attr module:
52     - TODO: general documentation about attributes, clearing, merging?
53     - TODO: general documentation about changeable attributes?
54   - path module:
55     - glue -> join?
56   - unit module:
57     - what about unit.cm() -> unit.cm, ...
59 TODO for 0.6:
60   - deco module:
61     - the name wriggle has to replaced by something better (e.g. wriggled?)
62   - Documentation:
63     - graph module:
64       - documentation of the new class layout
65       - painters are using the new attribute scheme including changeable
66         attributes
67       - axis zeropath feature removed
68       - graph styles rewrite
69     - deco module:
70       - wriggle decorator
71       - smoothed decorator
72     - FAQ
74 0.6 (XXXX/XX/XX):
75   - bbox module:
76      - added inplace add (__iadd__), enlarge and transform methods
77      - callers use inplace add where possible now (yielding a considerable
78        speedup)
79     - "undefined" corners of bounding boxes are no longer supported which makes
80       the bounding box operations much more efficient.
81   - graph module:
82     - painters are using the new attribute scheme including changeable
83       attributes
84     - axis zeropath feature has been removed
85     - graph styles rewrite
86     - graph splitted into several modules in pyx/graph and pyx/graph/axis
87     - mergelabels removed; linpart doesn't have a label argument anymore
88   - text module:
89     - default handling of texmessages as in the new attribute scheme
90     - multiple insert bug fixed
91     - made left, right, width, height, depth information available (x length
92       not taking into account box transformations)
93     - ignore tex message "Please type a command or say `\\end'"
94     - added textboxes that are sequentially filled (experimental)
95   - examples:
96     - mandel.py (contributed by Stephen Phillips)
97   - path:
98     - added new pathels multilineto_pt and multicurveto which allows to specify
99       a list of points and can thus be much more efficient
100     - internal methods return coordinates in pts
101     - arclentoparam returns only parameters not total length
102     - added path.arclength_pt, path.at_pt, path.begin_pt, path.end_pt (and
103       correspondingly for normpath)
104     - complete refactoring of the normpath class: normpaths now consist of
105       normsubpaths which themselves consist of normlines and normcurves This is
106       much more convenient for any routines working with normpaths.
107     - reversing of closed sub paths does not change the first point of the sub
108       path
109     - renamed: arclength -> arclen
110     - renamed: lentopar -> arclentoparam
111     - path and normpath method raise exception instead of returning None
112       when parameter is out of range
113     - the accuracy epsilon can now only be specified in normpath and normsubpath
114       constructor and no longer in arguments of path and normpath methods
115     - negative parameters are no longer supported in path and normpath methods
116     - path and normpath methods which accept parameter value param now
117       alternatively accept an arc length
118   - connnector module:
119     - renamed _xxx -> xxx_pt
120   - deco module:
121     - wriggle decorator
122     - smoothed decorator
123     - arrow heads are no longer stroked (as suggested by Magnus Lie Hetland)
124   - canvas:
125     - writeEPSfile deprecates writetofile
126     - internally, write methods are renamed in outputPS
127   - tex module:
128     - not imported by default anymore
129     - obsolete warning when importing this module
130   - unit module:
131     - length comparision (David Beach)
132     - x-scale for TeX
133     - more unit tests
135 0.5.1 (2004/01/22):
136   - distribution:
137     - include missing c-files for optional extension modules
138   - prolog module:
139     - fix unpaired BeginProcSet/EndProcSet in font enconding
141 0.5 (2004/01/20):
142   - setup.py and distribution:
143     - allow customization of the extension modules built (via setup.cfg)
144     - disable building pykpathsea module by default
145     - more detailed description of install process in INSTALL
146     - provide more information and pointers to other files in README
147     - include example data files in distribution (suggested by Andrea Riciputi)
148     - force dvips to write ps files instead of printing them (suggested by Otto Tronarp)
149     - includ pyxfaq.pdf in distribution
150   - text module:
151     - improved is-readable test for lfs files and pyx.def file
152     - explicitly quit (La)TeX in cleantmp (helps when quitting with <Ctrl>C)
153     - showwaitfortex implemented following a suggestion by Fernando Perez
154       (waitfortex is increased to 60 seconds now)
155     - support of TeX extension --ipc for reading dvi results while TeX keeps running
156     - configurable font mapping files (via pyxrc or parameter of the texrunner constructor)
157     - markers to get access to positions within TeX expressions
158     - fix: allow for e-tex in texmessage.start (reported by Andrea Riciputi)
159     - fix: print warning at syntax errors in font mapping file and continue (cf. bug #795271)
160     - remove limitation on number of fonts in dvi file
161     - added native virtual font support
162     - dvicopy support not needed anymore (it is still available, but obsolete and
163       removed from the documentation)
164     - do not include too many glyphs in the eps file
165     - _xxx -> xxx_pt renaming
166   - dvifile module (NEW):
167     - separated from the text module
168     - dvifile class returns standard pyx canvas instances on readpage
169   - graph module:
170     - removed manualpart and partitioners mix keyword
171     - results of the splitting at "=" in graph.function were not stripped
172     - skip title=None in key (cf. bug #821284), properly align a single key entry
173     - another (the last?!) axis redesign: axispos -> class of its own
174     - some axispos name have changed slightly (zeroline -> zeropath etc.)
175     - tick/data-vmin/vmax removed
176     - pathaxis
177     - linkaxis
178     - minor enhancements in exponentionaltexter
179     - axes alongs paths including a set of examples
180     - mixing a partitioner and manual ticks by two distinct keyword arguments now
181     - _xxx -> xxx_pt renaming
182     - part -> parter renaming
183   - canvas module:
184     - stroke, fill, draw, set and insert do no longer accept variable length argument lists but
185       an attribute list as last argument
186     - stroke and fill now support trafos (TODO: documentation)
187     - uppercase version of a4, a3, ... paperformats
188   - config module:
189     - new module for loading PyX configuration information
190   - pyx module:
191     - automatically import main modules into pyx namespace as suggested by Fernando 
192       Perez.
193   - path module:
194     - check for sorting of parameter list passed to path.split method
195     - _xxx -> xxx_pt renaming
196   - deco module (NEW): 
197     - contains decoratedpath and decorators from canvas module
198     - all predefined decorators are instances now (deco.stroked is thus ok) and 
199       attributes have to be passed explicitely, e.g., deco.earrow.small(attrs=color.rgb.red) 
200       and deco.stroked([color.rgb.blue])
201   - style module (NEW):
202     - contains all line- and fillstyles which formerly had been defined in the canvas module
203     - dash now supports relative dash lengths (as suggested by Otto Tronarp)
204   - mathtree module:
205     - fixed incorrect handling of - (for instance -x**2 was not negative)
206   - attrlist module:
207     - contents have been moved to the (obsolete) tex module, which was the only user anyhow, and
208       the module itself was removed
209   - t1strip module:
210     - new fallback solution in pure python
211     - bugfix: pyxadapt.h needs to open files binary under Windows (reported by Gary Pajer)
212   - box module:
213     - _xxx -> xxx_pt renaming
214   - trafo module:
215     - _xxx -> xxx_pt renaming
217 0.4.1 (2003/09/17):
218   - canvas module:
219     - "in" to "inch" in paperformats
220   - text module:
221     - fix pyx.def hack occuring whenever \ProcessOptions* was used by a package
222   - pykpathsea module:
223     - implement different file formats for Python version of module
224   - t1strip module:
225     - python fallback solution should behave the same way as c extension module (closes SF bug #799182 reported
226       by Marcus Mendenhall)
227   - __init__.py:
228     - added "connector" to __all__
230 0.4 (2003/08/22):
231   - graph module:
232     - separate texter out of the axispainter
233     - axis/partitioner/texter/painter/axispos redesign & interfaces
234     - tick.text is renamed to tick.label
235     - ticks and labels are renamed to tickpos/tickdist and labelpos/labeldist in partitioning
236     - ticks can be used in the part to mix a partitioner with some manual ticks
237       -> manualpart and the mix technique is not needed anymore
238          (both things are still available and working, but they will be removed in the future)
239     - _ensurefrac is implemented inside the frac constructor now; initialization is possible by:
240       - a (enum, denom) tuple now (previously there were two arguments)
241       - a string (as before via _ensurefrac)
242       - exponential strings are allowed as well (e.g. "1e10" etc.)
243       - a float (precision is determined by floatprecision -- the number of decimal places)
244     - dense -> density
245     - axis.maxworse
246     - axis interface
247   - text module:
248     - reset() method for the texrunner
249     - automatic restart of a TeX instance with the same preamble (preamble changes are not possible)
250     - texmessage.loadfd for accepting font description loading
251     - don't bail out on width_index == 0, but mark character invalid instead
252     - dvicopy flag
253     - support for specials; pyxgraphics flag
254     - support psfonts.map: font names, font encodings
255     - bugfix \def\ProcessPyXBox -> \long\def\ProcessPyXBox
256     - improved lfs handling
257   - data module:
258     - full documentation via doc strings
259   - connector module:
260     - some preliminary version
261   - box module:
262     - multiple radii (up to two per point) and softnesses
263     - ensurecenter added --- do we always force the creation of a center?
264   - path module:
265     - lentopar methods added including some tests
266   - epsfile module:
267     - new parameter bbox allows to override the bounding box of the eps file
269   bugfixes:
270   - text module:
271     - derive TFMError and DVIError correctly from exceptions.Exception
272     - close files and pipes, if they are no longer used (thanks to Marcus Mendenhall)
273     - remove DeprecationWarning in Python 2.3 (thanks to Marcus Mendenhall)
274   - box module:
275     - correct rounding algorithm (Michael Schindler)
276   - graph module:
277     - refer to the graphs texrunner instead of the defaulttexrunner (cf. #728209)
278     - rounding towards zero bugfix in autolinpart
279     - log axis range rating bugfix
280   - mathtree module:
281     - addarg bugs (#738724)
282   - epsfile module:
283     - fix mixing up of height and width in scale calculation
284   - and various other fixer here and there
286 0.3.1 (2003/04/04):
287   - text module:
288     - fix bug in dvi rule code where width was height
289     - fix preamble attribute checking bug
290     - fix texmessage.load pattern search instead of pattern match bug
291     - renamed vbox to parbox (was done in 0.3 partially only)
292   - data module:
293     - allow for tuples in arguments of the data class
294     - convenience: exchanged order of named parameters in data.data
295   - graph module:
296     - convenience: allow for part=None in _axis (base of linaxis and logaxis)
297   - examples:
298     - added a latex example (requested)
299     - added a attributechange example (requested)
300     - added back the integral example (requested; prior PyX 0.3 it was part of the user manual)
301     - small change in vector example (allow for the access to the texrunner)
302     - examples included in source distribution
303   - canvas module:
304     - correct arrow template calculation for very short paths
306 0.3 (2003/03/31):
307   - examples
308     - new easy to use example generation (will hopefully lead to nice examples)
309   - unit box:
310     - new module for handling of convex polygons (taken out of the graph module)
311   - unit helper:
312     - new module containing a collection of helper functions (taken out of the graph module)
313     - moved the attrlist into helper -- as plain functions; attrlist becomes obsolete
314   - text module:
315     - new module: a new and preferable integration of TeX/LaTeX
316   - t1strip module:
317     - strip glyphs from pfa/pfb-fonts
318     - there is a C implementation taken from pdftex
319     - fallback solution via an external program (pfb2pfa)
320   - pykpathsea module:
321     - (partial) C binding to libkpathsea
322     - fallback solution via an external program (kpsewhich)
323   - graph module:
324     - removed some code duplication (various axis painters)
325     - use text module instead of the obsolete tex module
326     - allow for tailing zeros of automatic generated labels
327     - allow for missing data in bar graphs -> skipmissing parameter
328     - remove the support for variables given as keyword arguments in data constructor
329     - use context instead of extern for extern variables and functions
330     - graph keys; titles in data/function/etc.
331   - unit module:
332     - new classes for visual and width lengths, aliases for user length (u_pt = pt)
333     - all length classes have now by default a quantifier 1 (instead of 0), such that,
334       for instance, 5*unit.t_cm() == unit.t_cm(5)
335     - default_unit now has to be set via unit.set. For instance: unit.set(defaultunit="m").
336     - convert_to is now an internal function, which moreover does not longer accept tuples or lists
337   - bbox module:
338     - new class _bbox (the former bbox) which accepts points in the constructor. This is used
339       for internal purposes.
340     - the bbox constructor now accepts user lengths in the constructor.
341     - new methods height, width, top, bottom, left, right
342     - ll & ur ???, what about ul and lr -> ugly!
343     - enlarge (was enhance) now allows selective enlargement to the left, bottom, right and top
344     - output HiResBoundingBox
345     - never reduce bbox upon output
346   - epsfile module:
347     - new constructor signature, more in line with rest of PyX:
348       epsfile(x, y, filename, **additional_args)
349   - data module:
350     - removed additional column support in addcolumn; removed _addcolumn
351     - line reduction for datafile like the every parameter in gnuplot
352   - canvas module:
353     - new way of PS prolog generation that writes only necessary parts
354     - added support for patterns
355     - canvas.insert() now supports arguments
356     - bbox of canvas can be specified in writetofile command explicitely
357     - writetofile does not return self anymore
358     - arrow template now uses intersection with circle to get size right
359       (as per a suggestion by Michael Schindler)
360   - mathtree module:
361     - added abs function
362     - changed the handling of extern functions and all variables
363   - color module:
364     - gradient renamed to palette
365   - numerous bugfixes:
366     - problem with sizefile on windows (tex module)
367     - allow for strings in graphxy's width and height; allow for width only (graph module)
368     - disable rating for labelattrs equals None (graph module)
369     - defaultstyle selection, when a list of data is provided to the plot function (graph module)
370     - traverse when adding functions as arguments of operators (mathtree module)
371     - allow for extern functions in addcolumn (data module)
372     - just one common place for the version number
373     - fix incorrect exception name MathError (path module)
374     - prevent double return of intersections for closed sub paths
375     - ...
377 0.2 (2003/01/17):
378   - unit module:
379     - allow division of length by numbers
380   - trafo module:
381     - new transformation: slant
382     - renamed all trafo methods to use the participle (i.e translate->translated)
383     - the name of all trafo subclasses are verbs (i.e. translation->translate)
384   - graph module:
385     - mark class renamed to symbol
386     - (text-)box distance measurement
387     - moved axis partitioning to axis and axis painter
388     - automatic axis partitioning (now officially: general cleanup, distance measurement, documentation)
389     - splitaxis
390     - baraxis, baraxispainter, and bar style
391   - data module:
392     - previously named datafile module
393     - class "_datafile" renamed to class "data"
394     - class sectionfile added
395     - testsuite
396   - mathtree module:
397     - extern variables and functions (support in graph.function, graph.paramfunction and data.data)
398     - testsuite
399   - text module:
400     - deferred to Version 0.3
401     - running TeX "on the fly" is basically implemented
402   - numerous bugfixes:
403     - transformation bug (#624068, trafo module)
404     - canvas transformations (canvas module???)
405     - textbox alignment (graph module)
406     - return linewidth upon calculation with linewidths (unit module)
407     - allow column number variables with several digits
408     - ...
409   - british and american spellings (color module, graph module)
410   - small logo modifications
412 0.1 (2002/10/07):
413   - initial release