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