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