doc: updated NEWS.xml
[adg.git] / docs / gnu / NEWS.xml
blobe6e141ddd497f0f2b9e25f5715c0e14f3907fe7d
1 <?xml version="1.0"?>
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3                          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5 <chapter id="NEWS">
6 <title>News archive</title>
7 <subtitle>Summary of changes between releases</subtitle>
9 <simplesect id="NEWS.0.7.1">
10 <title>ADG 0.7.1</title>
12 <para>Out of the box support for <ulink url="http://github.com/pavouk/lgi/">LGI</ulink>
13 (dynamic Lua bindings based on GObject introspection) is now
14 provided upstream and effectively used for testing APIs. The
15 introspection support has been improved, some APIs (AdgPoint
16 related methods above all) have been protected against NULL and
17 some bugs raised by the bindings work have been corrected.</para>
19 <para>The GBoxed wrappers for cairo structs such as cairo_matrix_t have
20 been dropped in favor of the native support provided by the
21 cairo-gobject library.</para>
23 <para>GObject wrappers for CPML structs such as pairs, primitives and
24 segments has been moved to CPML itself. This makes redundant the
25 presence of wrappers on the ADG side, simplyfing the work for the
26 language bindings.</para>
27 </simplesect>
29 <simplesect id="NEWS.0.7.0">
30 <title>ADG 0.7.0</title>
32 <para>The autoscaling feature is now available: a series of predefined
33 scale factors are applied until the proper one is found. The demo
34 program autoscales the drawing on a right click on the drawing
35 area and restores the paper zoom and position on a left click.</para>
37 <para>The introspection support has been improved, making it possible
38 to have LGI (Lua) bindings working out of the box. The typedef
39 hack has been dropped in favor of a private forwarder header.</para>
41 <para>The dash pattern of AdgLineStyle can now be customized by binding
42 to it an AdgDash instance.</para>
43 </simplesect>
45 <simplesect id="NEWS.0.6.6">
46 <title>ADG 0.6.6</title>
48 <para>The project has been ported to GTK+3 also on Windows platforms.
49 The helper scripts now build only GTK+3 installers.</para>
51 <para>The recent porting of Fedora mingw packages to archlinux made
52 possible to generate for the first time a win64 installer.</para>
54 <para>adg-demo now embeds icons of different sizes, ranging from 16x16
55 to 128x128 pixels. The look-up falls back to srcdir so the icons
56 can be used also without installing the program. A bunch of new
57 APIs has been added to help this relocation.</para>
59 <para>The Windows installers received a lot of cosmetic improvements.
60 The NSIS code has been cleaned up.</para>
61 </simplesect>
63 <simplesect id="NEWS.0.6.5">
64 <title>ADG 0.6.5</title>
66 <para>Some missing documentation files that prevented the proper build
67 adg-0.6.4 have been included in the distribution package.</para>
68 </simplesect>
70 <simplesect id="NEWS.0.6.4">
71 <title>ADG 0.6.4</title>
73 <para>The Lua bindings, based on lgob, are now available as a separate
74 project (adg-lua). The glue code is automatically generated
75 using GObject introspection.</para>
77 <para>The build system can detect and use GTK+3 and gladeui-2.0 when
78 found. GTK+2 and gladeui-1.0 are still availables and can be forced
79 at configure time.</para>
81 <para>The rendering of AdgRDim has been enhanced: when the "outside"
82 property is enabled, the leader line will extend beyoud the arc to
83 quote for a styleable distance, and the marker will be reveresed.</para>
85 <para>The best text frontend is selected at configure time. When pango
86 is available, it will be preferred over the cairo toy text APIs.</para>
87 </simplesect>
89 <simplesect id="NEWS.0.6.3">
90 <title>ADG 0.6.3</title>
92 <para>The text manipulation logic has been moved inside the AdgTextual
93 interface and a new entity based on pango (AdgText) has been added.
94 Also AdgToyText implements AdgTextual so all the text entities are
95 now interchangeable.</para>
97 <para>The demo program has a new dialog page that allows to customize
98 the title block of the drawing. The zoom hints have been moved
99 outside the paper so the drawing can be considered finalized.</para>
101 <para>The CPML library has its own test framework. Anyway tests have
102 been improved generally so it is now possible to generate a
103 report by using "make test-report".</para>
105 <para>The missing extents computation on AdgRDim, AdgADim and AdgArrow
106 are now in place. By calling adg-demo with the -E option it
107 is possible to visually verify the extents status.</para>
109 <para>A bunch of bugs, most notably the wrong glade catalogdir detection
110 and some extents computation, have been resolved.</para>
111 </simplesect>
113 <simplesect id="NEWS.0.6.2">
114 <title>ADG 0.6.2</title>
116 <para>The localization infrastructure has been added and tested by adding
117 the italian translation.</para>
119 <para>The AdgGtkArea widget is now capable of interactively change zoom
120 and pan in global space by dragging and/or rotating the wheel while
121 keeping the shift pressed.</para>
123 <para>A new class has been implemented: AdgGtkLayout is an AdgGtkArea
124 based widget that implements the scrolling natively, hence it can
125 be added directly to a GtkScrolledWindow container.</para>
126 </simplesect>
128 <simplesect id="NEWS.0.6.1">
129 <title>ADG 0.6.1</title>
131 <para>The canvas now has printing support when compiled with GTK+ enabled.
132 The media setup can be associated to the canvas so this data can be
133 accessed to provide a consistent behavior between different backends.</para>
135 <para>The demo program can now render the drawing to an SVG file.
136 Generated files are stored in the user document directory.</para>
138 <para>Uncomplete entities now fail gracefully instead of complaining for
139 insufficient data. This provides an easy way to implement optional
140 machinings: the optional groove in the adg-demo program is working
141 by leveraging this feature.</para>
142 </simplesect>
144 <simplesect id="NEWS.0.6.0">
145 <title>ADG 0.6.0</title>
147 <para>The portability of the build system has been improved: the ADG project
148 now builds out of the box on FreeBSD, OpenSolaris, MinGW32 and GNU/Linux.</para>
150 <para>The adg-demo program has been rewritten almost from scratch to provide
151 a nice example of what the ADG should be used for. The rendering has
152 been cleaned up and the model-view interaction now works: changing the
153 data on the edit dialog changes the drawing (this is what the ADG has
154 been developed for). The GTK+ widget, although not shining, is fairly
155 usable and light years ahead of the previous version.</para>
157 <para>The canvas now has custom paddings and margins, a background dress and
158 the ability to accept an AdgTitleBlock entity.</para>
160 <para>The project tree has been rearranged in three different subprojects:
161 CPML (mathematical stuff above cairo), ADG (the canvas above CPML) and
162 ADG-GTK (user interface helpers above ADG and GTK+).</para>
164 <para>Support for glade-3 has been added: if enabled, ADG-GTK will try to
165 install its catalog in the proper glade directory.</para>
166 </simplesect>
168 <simplesect id="NEWS.0.5.6">
169 <title>ADG 0.5.6</title>
171 <para>The build system has done a huge step toward portability: the
172 requirements are less restrictive and the overall implementation
173 is cleaner and well defined.</para>
175 <para>The API has been exercised by API-Sanity-Autotest that helped to
176 discover some problems: check out issue #23 for details.</para>
178 <para>A test framework based on glib-2.16 has been added. It is still
179 under development but yet fully working.</para>
181 <para>The CPML API has been cleaned up by using an internal struct of
182 function pointers to delegate the job to the different primitives.
183 The public symbols of the CPML library have been reduced from 105
184 to 70.</para>
185 </simplesect>
187 <simplesect id="NEWS.0.5.5">
188 <title>ADG 0.5.5</title>
190 <para>The quote of linear dimensions can be freely positioned using the
191 AdgDim:pos property. By default, ADG keeps the quote inside the
192 extension lines if there is enough room, otherwise displaces it
193 to the "pos" coordinates.</para>
195 <para>A document describing how to contribute to the project has been
196 added. A general description of the API conventions used by is
197 also provided.</para>
199 <para>A lot of bug fixing and code clean up. A bug in the installation
200 has been solved and support for pkg-config has been added. This
201 will probably be the last release of the 0.5 branch.</para>
202 </simplesect>
204 <simplesect id="NEWS.0.5.4">
205 <title>ADG 0.5.4</title>
207 <para>AdgTable now provides a generic tabular entity customizable with
208 AdgTableStyle. It supports unlimited rows with independent cells.</para>
210 <para>Some new special entities, such as AdgLogo (the official ADG logo)
211 and AdgProjection (showing the drawing projection scheme) have
212 been implemented.</para>
214 <para>A bare title block entity, AdgTitleBlock, is now available: it is
215 allowed to set its cells content either by using string values or
216 custom entities.</para>
218 <para>AdgAlignment is a new container entity that allows to traslate its
219 children of a custom factor of the children boundary box: any
220 entity can now be right aligned or centered.</para>
221 </simplesect>
223 <simplesect id="NEWS.0.5.3">
224 <title>ADG 0.5.3</title>
226 <para>AdgRDim, a new entity to quote radial dimensions, is now available.</para>
228 <para>A bunch of new classes to manage hatches have been implemented.
229 Specifically, AdgHatch is the entity to be added to the canvas,
230 AdgFillStyle a generic abstract class that wraps cairo_pattern_t
231 and AdgRuledFill the AdgFillStyle implementation to fill an hatch
232 with a serie of parallel lines with custom spacing and angle.</para>
234 <para>The AdgModel now supports named pairs, that is any coordinates
235 can be set explicitely (as before) or as a reference to a pair
236 set by the model. The AdgPoint helper class is the object used
237 to manage this relationship. The API of dimension entities has
238 been updated to accept AdgPoint instead of plain AdgPair.</para>
239 </simplesect>
241 <simplesect id="NEWS.0.5.2">
242 <title>ADG 0.5.2</title>
244 <para>AdgADim, a new entity to quote angular dimensions, is implemented.</para>
246 <para>The linear dimensions now accept the "outside" property to reflect
247 the arrows around the extension lines. The default value of this
248 property is ADG_THREE_STATE_UNKNOWN, meaning it will be computed at
249 runtime, depending on quote size and available space.</para>
251 <para>The new AdgEdges model can now be used to programmatically build a
252 serie of vertical lines expressing the edges of another model. This
253 can be used on symmetrical shapes, often met in turned parts.</para>
255 <para>The entities now actively respond to extents requests: it is possible
256 to know the necessary space before rendering them. Any matrix change
257 now emits specific signals to fulfill this requirement.</para>
258 </simplesect>
260 <simplesect id="NEWS.0.5.1">
261 <title>ADG 0.5.1</title>
263 <para>The new AdgMarker abstract class has been added to provide a common
264 ancestor to marker entities. AdgArrow (a filled arrow) is its first
265 renderable implementation.</para>
267 <para>The rendering customization is now provided by AdgDress, an index that
268 virtualizes the underlying AdgStyle and derived instances. This allows
269 some advanced operation, such as overriding a style in a specific branch
270 of the entity hierarchy. The deprecated AdgContext class has been removed.</para>
272 <para>The AdgPath class has been splitted in AdgTrail and AdgPath. The former
273 provides low level access to CpmlPath, allowing the implementation of
274 paths that do not fit in the global/local model. AdgLDim internally
275 uses a private AdgTrail to implement base and extension lines rendering.</para>
276 </simplesect>
278 <simplesect id="NEWS.0.5.0">
279 <title>ADG 0.5.0</title>
281 <para>The old paper-model matrix approach has been superseded by a cleaner and
282 smarter approach based on global/local maps. This resulted in a great
283 code complexity reduction: check out the home page for further details.</para>
285 <para>Parent-child relationship is no more tied to AdgContainer: dependencies
286 between AdgEntities can now be expressed without a full-fledged container.</para>
288 <para>AdgDim now uses internally four AdgToyText entities to render the quote.
289 This has been made possible by the new parent-child APIs, simplyfing the
290 rendering code a lot.</para>
292 <para>A bunch of classes, most notably AdgRotable, AdgTranslatable and AdgPoint,
293 have been superseded by the new global/local map approach and have been
294 removed from the project.</para>
295 </simplesect>
297 <simplesect id="NEWS.0.4.3">
298 <title>ADG 0.4.3</title>
300 <para>Higher level operators, such as chamfer and fillet, can now be used
301 in the path definition. They do not work yet for Bézier curves but
302 the infrastructure is in place.</para>
304 <para>A Gtk+ widget for easily showing the canvas has been implemented. It
305 is based on GtkDrawingArea and provides some interaction throught the
306 mouse, such as zooming and panning. It is not viable for serious work
307 but it is funny to use and opened to improvements.</para>
309 <para>The CPML library has been enriched with the missing functions
310 needed by the above new features. Now it has a ..._length() and
311 ..._near_pos() families of functions. The mathematic behind this
312 library is far from complete: the overall design is quite stable
313 but there are a lot of placeholders, especially when curves were
314 involved.</para>
315 </simplesect>
317 <simplesect id="NEWS.0.4.2">
318 <title>ADG 0.4.2</title>
320 <para>The work on model-view separation has been started: the AdgModel
321 abstract class is now in place. Above this class, the new AdgPath
322 model is derived, providing a full set of APIs to construct paths
323 from scratch. Also, AdgPath gives full access the model throught
324 CPML, allowing to modify and manipulate the path data.</para> 
326 <para>The CPML library now natively supports arcs. Although cairo does
327 not recognize arcs, a lot of work has been done to hide the
328 complexity needed to provide an API that does the necessary
329 trasformations transparently.</para>
331 <para>The old AdgPath entity has been rewrote to AdgStroke. This is a
332 stroked view of an AdgPath model. Its implementation is trivial
333 as all the path complexity has moved to AdgPath.</para>
334 </simplesect>
336 <simplesect id="NEWS.0.4.1">
337 <title>ADG 0.4.1</title>
339 <para>The CPML library has been boosted with additional APIs to browse
340 segments/primitives and to compute intersections between different
341 constructs. Now it has its own demo program (cpml-demo), showing
342 some of the implemented feature. Although some function is still
343 a stub, the overall infrastructure is likely to be definitive.</para>
345 <para>All the CPML APIs are now properly documented.</para>
347 <para>The ldim demo has been merged into the more complex adg-demo.
348 Now the demo programs use the GtkBuilder feature, so the Gtk+
349 dependency has been raised to 2.12.</para>
350 </simplesect>
352 <simplesect id="NEWS.0.4.0">
353 <title>ADG 0.4.0</title>
355 <para>The useless wrappers in AdgPath have been removed: now the standard
356 cairo path API could be used in the path constructor callback.</para>
358 <para>AdgPoint has been added. This new core struct can be used to represent
359 a coordinate system with different model and space component.</para>
361 <para>The new AdgToyText entity can be used to show arbitrary text using the
362 cairo "toy" text API.</para>
364 <para>Two interfaces, AdgTranslatable and AdgRotable, have been implemented
365 to allow arbitrary positioning (using the new AdgPoint struct) and
366 rotation of entities where this is applicable (e.g. AdgToyText).</para>
368 <para>The CPML API has been almost rewrote from scratch: removed a lot of
369 duplicated stuff, dropped CpmlPath (by using the original cairo_path_t)
370 and implemented new functions, such as segment browsing (always in
371 forward direction), reversing and transformation.</para>
373 <para>README, NEWS, TODO and ChangeLog are now automatically generated, so
374 redundancy is removed and the maintainability improved. The originals
375 are kept in docbook format, allowing to use them also in html version.</para>
377 <para>The adg-demo program now allows to save the sample drawing in png, pdf
378 and postscript. Two useless toy text entities has been added.</para>
379 </simplesect>
381 <simplesect id="NEWS.0.3.2">
382 <title>ADG 0.3.2</title>
384 <para>The dependency on libgcontainer has been dropped: now the adg canvas
385 requires only cairo and Gtk+2 (will be optional). This allows to try
386 the demo program (demo/adg-demo) on any decent GNU/Linux distribution
387 without installing anything.</para>
389 <para>The container logic has been included in AdgEntity (the GChildable
390 portion) and AdgContainer (the GContainerable part).</para>
391 </simplesect>
393 <simplesect id="NEWS.0.3.1">
394 <title>ADG 0.3.1</title>
396 <para>Implemented the "invalidate" signal to force the cache recomputation
397 on a new rendering operation.</para>
399 <para>The new cairo "toy" API has been used to do text management in AdgDim.
400 This allows caching of the intermediate glyphs for improved
401 performances (no profiling yet done). The cairo dependency has been
402 raised to version 0.7.4 or more.</para>
404 <para>The AdgLDim entity has been rewritten to full implement the new cache
405 design. Other entities have been improved to allow a paper matrix
406 other than the default identity matrix.</para>
407 </simplesect>
409 <simplesect id="NEWS.0.3.0">
410 <title>ADG 0.3.0</title>
412 <para>Reworked styles and implemented AdgContext, a clean and well defined
413 approach to manage rendering customization.</para>
415 <para>Moved all the geometrical stuff in Cairo Path Manipulation Library
416 (CPML), an internal library depending only on cairo.</para>
417   
418 <para>Greatly improved documentation.</para>
419 </simplesect>
421 <simplesect id="NEWS.0.2.2">
422 <title>ADG 0.2.2</title>
424 <para>Strongly separated model and paper matrix concepts and updated their
425 management using nested transformations.</para>
427 <para>Reworked the rendering process in a cleaner way by propagating the
428 "render" signal and using internal entity states to let the application
429 know what changed from the previous rendering.</para>
430 </simplesect>
432 <simplesect id="NEWS.0.2.1">
433 <title>ADG 0.2.1</title>
435 <para>Reworked the sources tree in a cleaner way (to help future development)
436 and used private structs instead of populating the instance structure.</para>
437 </simplesect>
439 <simplesect id="NEWS.0.2.0">
440 <title>ADG 0.2.0</title>
442 <para>This is the first public release of the ADG library. It is in a early
443 stage of developement, but the goal is quite ambitious!</para>
444 </simplesect>
446 </chapter>