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