]> git.decadent.org.uk Git - ion3.git/blob - RELNOTES
[svn-upgrade] Integrating new upstream version, ion3 (20071130)
[ion3.git] / RELNOTES
1
2 ion-3rc-20071130
3 ----------------
4
5 This RC features various minor fixes, and some clarifications and
6 simplifications to the license, which people seem to have had trouble
7 understanding.
8
9
10 ion-3rc-20071109
11 ----------------
12
13 It seems people are a bit slow, or only scaring them with a final
14 release makes them report issues. So, still no stable release but
15 a candidate, with many minor fixes and improvements wrt. important
16 omissions. The most important changes are better behaviour of the 
17 unsplit operation, better handling of main window being closed
18 before a transient, and use of the workspace's working directory
19 for run query file name completion.
20
21
22 ion-3rc-20070927
23 ----------------
24
25 Another attempt at last "rc" release.
26
27
28 ion-3rc-20070902
29 ----------------
30
31 This release features a few minor fixes. If no major problems are
32 discovered, this is likely to be the last "rc" release before the
33 first and hopefully final "stable" release.
34
35
36 ion-3rc-20070720
37 ----------------
38
39 This fourth "rc" release fixes some minor bugs and omissions in
40 the previous release.
41
42
43 ion-3rc-20070708
44 ----------------
45
46 This third "rc" release again simply fixes some minor problems in 
47 the previous release.
48
49
50 ion-3rc-20070608
51 ----------------
52
53 This is the second "rc" release, and contains primarily bug fixes
54 and other minor improvements.
55
56
57 ion-3rc-20070506
58 ----------------
59
60 This is the first "rc" or "(stable) release candidate" release of 
61 Ion3. This means that there will not be any further major changes 
62 to it. Bugs will be fixed, and as an exception to the general 
63 feature freeze, some hooks may still be added, if deemed useful.
64 Translations may also be included. After no new bugs (that can not
65 be deemed features) have been found in this or following "rc" 
66 releases, the stable Ion3 will be released.
67
68 Most of the changes in this release to the previous one already
69 are bug fixes, in addition to some general clean-up. Other notable
70 changes are:
71
72   * Winprop matching improvements: it is possible to match against
73     `is_dockapp` and `is_transient` (booleans), and there's a hack
74     to support `class` and `instance` for dockapps too.
75
76   * The default configuration puts dockapps in the statusbar's
77     tray area.
78
79   * The autoconf kludge has been removed, as I will have nothing
80     to do with it, and nobody else seems to support or maintain 
81     it either.
82
83   * Tab numbers are displayed when releasing modifiers in the
84     `Mod1+K` submap.
85
86 Distributors should pay heed to the name policy notice in the
87 LICENSE file.
88
89
90 ion-3ds-20070318
91 ----------------
92
93 This may be the last "ds" release if Ion3; if all goes well, the next
94 release is likely to be an "rc". Some minor improvements will still 
95 be done, and minor requests may be accepted, so be quick.
96
97 The most notable changes in this release from the previous one are:
98
99   * Transients and queries in too small frames are "unsqueezed" out
100     of them, unless disabled with `ioncore.set{ unsqueeze = false }`.
101
102   * Some changes in default `cfg_ion.lua`: instead of loading 
103     various other files, just `cfg_default.lua` is loaded instead.
104
105   * `mod_tiling.untile` (available in the context menu) may be used 
106     to decompose tilings into floating frames. (This is the approximate
107     opposite of `mod_tiling.mkbottom` and the "new tiling" context menu 
108     entry.)
109
110   * Improved context menus.
111
112   * Slightly improved defaults style, using the drawing engine's
113     added possibility of partial borders.
114
115   * Various fixes and other improvements, in particular in relation
116     to focus code.
117
118
119 ion-3ds-20070203
120 ----------------
121
122   * There's been changes in padding/spacing usage in styles. Frames
123     now surround stuff inside borders not with `spacing` pixels, but
124     with `padding_pixels`. Spacing is only used to space things within
125     the borders (all the tabs and the client window from each other).
126     Consequently, custom styles may need to be updated to reflect this,
127     by increasing the padding, possibly also altering/removing colour 
128     (to set it to background colour). 
129
130   * The use of drawing engine attributes has also changed, and strict
131     ordering of them in the styles is no longer necessary. Additionally,
132     much more attributes are supported, including the name of every
133     statusbar meter.
134
135   * Xinerama support is gone. In addition to being problematic as such,
136     it had bit-rotted, and I will not waste time fixing it.
137
138   * `ioncore.set` no longer supports the `default_ws_params` parameter
139     for configuring the default layout. It is replaced by
140     `ioncore.deflayout("default", { ... })`, which allows configuring
141     other layouts as well, known by `mod_query.query_workspace` (F9).
142     Some default layouts are configured in `cfg_layout.lua`.
143
144   * It is now possible to automatically create new workspaces for
145     windows with the `new_group` winprop.
146
147
148 ion-3ds-20061223
149 ----------------
150
151 There's nothing major in this release, primarily just some minor fixes 
152 and tuning to the previous release, that it was time to release.
153
154
155 ion-3ds-20061029
156 ----------------
157
158 Mostly this release still fixes issues in the big 3ds-20061015 release,
159 but in addition there are some improvements in the query department:
160
161  * Query activation key now cycles completions (So e.g. the
162    in the context menu activated with META+M, this same key
163    can be used to cycle through the alternatives.) This does
164    not work for queries activated by submap bindings.
165
166  * Likewise, it is no longer necessary to specify the key to
167    use for cycling for `mod_menu.grabmenu`.
168
169  * Control+R can now be used for history completion in queries.
170    (Currently matching is done for full string up to 'point', but 
171    this may be changed to substring match.)
172
173  * Note that the parametrisation of WEdln.complete has changed,
174    and the second cycle parameter must be 'next' now instead of
175    `true`.
176
177
178 ion-3ds-20061020
179 ----------------
180
181 Fixes some (expected, but minor) issues in the previous release.
182
183
184 ion-3ds-20061015
185 ----------------
186
187  * WIonWS and WFloatWS and the corresponding modules are gone, and
188    your custom configuration files will be broken with regard to these.
189    However, a partial backwards compatibility hack exists for layout 
190    savefiles.
191
192    The F9 and META-F9 bindings now by default create workspaces with
193    a tiled layout of two frames. To create an "empty" workspace,
194    corresponding to the old WFloatWS, use the context menu (META-M)
195    and choose "new-empty-workspace". It is also possible to change 
196    the default layout.
197
198  * Note that if you restart from an old version to this new version of Ion,
199    transients will stop working as expected for already existing windows.
200    They will work for newly-created windows, however.
201
202  * There are a few new sets of binding (including one for `WClientWin`!),
203    and some old bindings may not work exactly as expected anymore. In
204    particular, those for switching to full-screen mode. 
205
206    **It is probably best to start from scratch with your custom 
207      bindings.**
208
209  * `WFrame.set_tabbar` is gone. If you absolutely want to get rid off 
210    the tabs, you must change the frame's "mode" with `WFrame.set_mode`. 
211    The mode "tiled-alt" has been intended for this, and the corresponding
212    "framed-tiled-alt" style defaults to `bar = "none"`.
213
214  * The rather popular `detach.lua` script from the scripts repository
215    is obsoleted now, as Ion includes detach functionality in itself.
216    To detach a window, use META-K D in the default bindings. To tile
217    an existing frame from a workspace that doesn't have a tiling yet,
218    use META-K B.
219    
220
221 ion-3ds-20060519
222 ----------------
223
224 Some notable changes in this release include
225
226  * Lua 5.1 is now required.
227
228  * Framed transients on by default now. New binding contexts
229    "WFrame.toplevel" and "WMPlex.toplevel" were added to allow
230    for separate sets of bindings for nested transient frames and
231    top-level frames. Some of the bindings in the default binding
232    maps that are likely to be unwanted on transient frames were
233    moved to these contexts. Old custom bindings will continue to 
234    work unless they modify the defaults by unbinding some of the
235    moved bindings.
236
237  * Pressing Mod1+K K in the default bindings now switches to any
238    region with the "activity" flag set (indicated by the a box
239    at a corner of the screen), if there's one, before cycling to 
240    previously active region. The same effect can be achieved in
241    your custom bindings with
242
243         ioncore.activity_goto() or ioncore.goto_previous()
244
245
246 ion-3ds-20050607
247 ----------------
248
249 This release mostly features minor bugfixes and other improvements. The most
250 visible non-bugfix changes are:
251
252  * Faster "fontset" filling kludge: only `-misc-fixed-*` fonts are tried. Ion
253    should now load faster in UTF-8 environments, and usually with no less
254    fonts in the fontset than before. (UTF-8 string drawing still does not
255    fully utilise these fonts under XFree86, but it does under XOrg.)
256
257  * Experimental auto-show-completions support, which is also on by default
258    now. In this mode the Tab key can be used to cycle forward through the
259    completions, and Shift+Tab backwards. Modify the settings seen in the 
260    new `mod_query.lua` to get normal Tab-completion, or change the completion
261    delay.
262
263  * The release scripts do not run automatically autoconf anymore so maybe
264    a few more people would look into the README first.
265
266
267 ion-3ds-20050322
268 ----------------
269
270 The most visible changes in this release are:
271
272  * Mod1+space now toggles the scratchpad by default and Mod1+D the dock.
273
274  * The `ion-(ssh|man|view|edit)` wrapper scripts were removed and instead
275    the programs used can be configured in Ion's configuration files.
276
277  * `ioncore.exec(_on)` also support the `:cmd` notation for "run cmd in 
278    xterm" familiar from the run query. The `::cmd` notation can be used 
279    to ask for enter to be pressed even when the program quit succesfully.
280
281  * Those with custom configuration files should note that many exported toggle
282    functions were changed and renamed, and now accept a string parameter
283    incidating whether to toggle, set or unset the property.
284   
285     - `WClientwin.set_fullsreen` (replaces `WClientWin.toggle_fullscreen`)
286     - `WRegion.set_tagged` (replaces `WRegion.tag/untag/toggle_tag`)
287     - `WFrame.set_tabbar` (replaces `WFrame.toggle_tabbar`)
288     - `WFrame.set_shaded` (replaces `WFrame.toggle_shade`)
289     - `WFloatFrame.set_sticky` (replaces `WFloatFrame.toggle_sticky`)
290     - `WMPlex.l2_set_hidden` (replaces `WMPlex.l2_hide/show`)
291     - `mod_sp.set_shown(_on)` (replaces `mod_sp.toggle(_on)`)
292     - `mod_dock.set_floating_shown_on` (replaces `mod_dock.toggle_floating_on`)
293     - `WRegion.set_activity` (replaces `WRegion.clear_activity` and 
294       `WRegion.notify_activity`)
295       
296    For example, `WRegion.set_tagged(_, 'toggle')` should be used in place of
297    `WRegion.toggle_tagged(_)` now.
298
299 Obviously there are some other changes and fixes too. See the changelog
300 for details as usual.
301
302
303 ion-3ds-20050304
304 ----------------
305
306 This is mostly a bug fix release, but also features improved
307 `mod_query.query_exec` (F3 key) completion support. Script writers should be
308 aware that As a side effect of one of these bug fixes, many hooks are now 
309 called in "protected mode" and can not call any functions that modify the 
310 internal state of Ion, except ioncore.defer.
311
312
313 ion-3ds-20050227
314 ----------------
315
316 The most important changes in this release are:
317
318  * So-called "placeholders". With the help of these the positions of
319    full-screen windows are remembered in their original frames, and don't
320    just get inserted after currently active window when returning from 
321    full-screen mode. Under a session manager placeholders are also used
322    to remember the original order of windows.
323
324  * Improved `mod_statusbar` and `ion-statusd` communication, and colouring
325    of important/critical meters.
326
327  * A number of small fixes.
328
329
330 ion-3ds-20041104
331 ----------------
332
333 This monthly snapshot adds a few new and improved features.
334
335  * 'Grabbed menus' that have a single cycling key and activate selected
336    entry when all modifiers have been released. See
337
338    <http://iki.fi/tuomov/repos/ion-scripts-3/scripts/wcirculate.lua>
339    
340    for an application.
341
342  * Potentially blocking status meters are now in a separate ion-statusd
343    program. Please write your additional status meters that do not monitor
344    the state of Ion itself for ion-statusd (and contribute them in the
345    Ion3 scripts repository at <http://iki.fi/tuomov/repos/ion-scripts-3/>).
346    For help on writing such status meters, see e.g. source for
347    `statusd_load` in `ext_statusbar/ion-statusd`.
348
349  * Floating splits are now supported on plain tiled workspaces as well as
350    on pane workspaces. To create such a split, use the workspace context
351    menu (Mod1+M by default) or write your own bindings.
352
353  * Line editor now supports history search; Control+Up/Down only scrolls
354    through history entries with matching initial part.
355
356  * Arbitrary winprop matching criteria is supported. Lua scripts have
357    access to X properties.
358  
359 Of course there are some other minor fixes and improvements as well.
360
361
362 ion-3ds-20040906
363 ----------------
364
365 This release finally includes a usable (yet still incomplete) version
366 of the `mod_panews` workspace module (that has also bored the name 'autows'
367 and 'rubberws' previously). The final outcome is not exactly what I
368 initially planned, as those plans turned out not to be that workable.
369 Instead, what `mod_panews` does is add to the basic tiled ionws approach
370 overlappable splits and automatically filled panes that are initially
371 empty. Each window is classified and assigned to the pane matching that
372 classification. (The default classifications are T(erminal), V(iewer)
373 and M(iscellaneous).)
374
375 For a better feel for it, try it out yourself and please give feedback.
376 The overlapping panes may be a bit confusing (this is one place where
377 true translucency might actually be useful and not just eyecandy) at
378 first, but you'll get used to them if you use the feature, and e.g.
379 the Gimp works quite splendidly with the toolboxes in the 'M' pane and
380 image windows in the 'V' pane --  although the simple initial size-based
381 classification heuristics don't always get it right and overriding
382 winprops (setting: `panews_classification`) should eventually added. 
383
384 In addition to the new module, this release adds support for translations
385 of program messages and the manual page, regardless of whether such is
386 of any use in a program like Ion or not. (Currently Finnish and Czech
387 translations are available.) Of course there are some bug fixes and
388 other minor additions as well, and the `./configure` script is also back,
389 the abandonment of libtool being final now. 
390
391
392 ion-3ds-20040730
393 ----------------
394
395 The first thing you'll notice when you start up this release of Ion is
396 that isn't reading your old configuration that. The next thing you 
397 should notice is a neat layout-adapting statusbar at the bottom of the
398 screen. That's right, Ion now includes an `ext_statusbar` Lua script that
399 is enabled by default and displays date/time/load/mail count in a
400 configurable format.
401
402 So why is it not reading your configuration and save files? Firstly,
403 all of the `.lua` files were renamed to be indicative of their purpose.
404 Secondly, there have been so many changes that your old files would be
405 incompatible anyway.
406
407 The `.lua` files are now named as follows:
408
409     cfg_*.lua    Configuration file that the user may wish to edit
410     look_*.lua   Drawing engine style file
411     saved_*.lua  Save file
412     mod_*.lua    Module stub loader
413     ext_*.lua    A bigger Lua extension without a C counterpart
414                  so that it is not a module
415                  
416 The configuration file for `mod_foobar` or `ext_foobar`, if it has one, is,
417 of course, `cfg_foobar.lua`. In the topic of file names, also note that 
418 the default installation paths and binary names have changed to include
419 the component '3' to reflect the situation with many binary packages
420 of Ion.
421
422 You perhaps noticed above that modules have stub loaders now, so the 
423 user has no need to use the `ioncore.load_module` routine. All extensions
424 and additional configuration files can now be loaded  with 'dopath'
425 (used to be 'include'). Also, the `menulib`, `querylib`, and `ioncorelib`
426 Lua libraries are gone and instead their contents can be found in the same 
427 `mod_whatever` namespace with the corresponding module (the "stub" loader
428 for these modules is a bit more than just a stub...). Some may also
429 want to know that for `mod_*` and `ext_*` only the compiled .lc files are
430 now installed, and not the source `.lua` files, thus removing redundant
431 files and making the installation slightly smaller.
432
433 There are few other changes to the contents of the configuration files
434 as well, so you're probably best off simply rewriting your modified
435 configuration files based on the new defaults. There quite likely won't
436 be any more _big_ changes to the configuration files before the release
437 of final Ion3, wherever that will be. (Most likely we won't see 3rc:s
438 yet this year.) However, some functions and variables are still likely
439 to be renamed or changed.
440
441 In addition to being renamed, the layout savefile of this Ion release
442 is incompatible with older releases. This is due to the changes made
443 to the `WIonWS` (and `WAutoWS`) split tree code to make it more modularly
444 extensible with the new kinds of nodes that `WAutoWS` requires.
445
446 The `mod_autows` module has infact been through many changes since the 
447 last release, and I think I have the final form of it finally figured
448 out. However, it is still far from finished and unlikely to be ready 
449 for use yet.
450
451
452 ion-3ds-20040703
453 ----------------
454
455 The major new features of this snapshot release are:
456
457  * `WMPlex` support for a sticky status display area to which `WIonWS`s
458    adjust properly. Modified to the dock module to support this method. 
459    See the new `dock.lua` to set up the dock in the new embedded or old 
460    floating manner (the API for the latter has also changed).
461  * Primitive session management support.
462
463 There are also some bug fixes and many minor improvements; see the ChangeLog
464 for details. Work on `mod_autows` has also started, but it isn't ready for 
465 use yet.
466  
467
468 ### Note on ./configure:
469
470 ./configure does not exist for the moment as the source autoconf script
471 is not up-to-date. Ion no longer uses libtool/libltdl due to problems
472 with inter-module dependencies, and I have not asked Tom Payne to fix
473 the script yet, as this change may not be final (although that is most
474 likely the case; those without Linux-compatible libdl and a flexible
475 binary format such as ELF will just have to link statically against the
476 modules).
477
478
479 ### Notes on session management:
480
481 Ion loads `mod_sm` automatically when the SESSION_MANAGER environment 
482 variable that should be set by the session manager is set, so there's 
483 no need load it in `ion.lua`. 
484
485 When session management is in use, all entries in the 'Session' menu
486 (previously 'Exit' menu) actually invoke the session manager to do the
487 task. 'Save' asks the SM save the whole session and 'Exit' (ioncore.shutdown)
488 asks it to shut down the session instead of just causing the WM to quite.
489 To do the latter, use ioncore.resign.
490
491 Unfortunately, all session managers I have tried (from Debian/unstable), 
492 are broken/incomplete in one way or another:
493
494
495 xsm: doesn't support any requests from applications. This makes Ion's
496 session menu complete unfunctional. The only way to restart/exit/save
497 state is through xsm's window.
498
499
500 gnome-session: This seems the most complete of the all the session managers
501 and works fine until it is requested to shut down the session, when it dumps
502 core and session state is lost if was not explicitly saved previously.
503
504 A `~/.gnome2/session` file to use with Ion follows:
505
506     [Default]
507     num_clients=2
508     0,id=default0
509     0,Priority=0
510     0,RestartCommand=gnome-smproxy --sm-client-id default0
511     1,id=default1
512     1,Priority=10
513     1,RestartCommand=/usr/local/ion-3/bin/ion -smclientid default1
514
515
516 ksmserver: Only supports a global shutdown request, so that Ion can not be
517 restarted or session state saved in the middle of a session.
518
519
520 ion-3ds-20040316
521 ----------------
522
523 This is the first development snapshot release of what is to be Ion3. 
524 The most visible changes to Ion2 so far are:
525
526   * Default installation directory is `/usr/local/ion-3` while user
527     configuration files go in `~/.ion3`
528
529   * The `mod_sp` module was added. It creates an extra toggleable 
530     "scratchpad" frame on each screen. Toggle is for now bound by default 
531     to Mod1+section, which should be very conveniently located on most 
532     Nordic keyboards (left of "1"), but you may have to change it. The 
533     scratchpad should be nice for xconsole or similar monitors, xmessage 
534     and other popups and just as temporary holding space for windows.
535
536   * All modules except the drawing engine are now called `mod_something`.
537
538   * Man-page complection supports a cache of known man-pages for faster
539     completion. See the README for instructions on setting up a cronjob
540     or manually generating the index if you want to use the feature.
541     Also `query_man_path` is no longer used. Instead we try the 
542     `ION_MC_MANPATH` and `MANPATH` environment variables and the 
543     'manpath' program.
544
545   * Exported functions are now separated into tables (namespaces)
546     instead of cluttering the globals table. Some frequently used
547     configuration functions are imported into the globals table, though.
548     Some functions have also been removed or renamed for simpler and
549     more consistent function set.
550
551   * New binding configuration mechanism. Dozens of `*_bindings` functions
552     were replaced with a single `[ioncorelib.]defbindings` function that
553     accepts a context parameter. Callbacks are specified as strings
554     (although passing functions still works) to make it easier for
555     external configuration programs to understand the configuration 
556     files and perhaps remove some confusion among users who do not
557     care to read a tiny bit of Lua documentation and understand the
558     concept of anonymous functions.
559
560   * It is now also possible to retrieve a list of bindings with
561     `ioncorelib.getbindings`, for example, for self-documentation.
562
563   * Single move/resize mode bindings instead of separate for both
564     ionframe and floatframe.
565
566 There are also quite a few internal changes; see the ChangeLog for
567 details. No documentation tarball is available at the moment as the
568 documentation is out-of-date except for the function reference. If 
569 you need the reference, just checkout the documentation from the 
570 Subversion repository with
571
572     svn co http://tao.uab.es/ion/svn/ion-doc/trunk ion-doc-3ds
573
574 and build the documentation.
575
576
577 ion-2rc-20040114
578 ----------------
579
580 This release is finally what can be called "Ion 2 release candidate #1". 
581 No more new features will be added to "Ion 2" after this release, and the
582 configuration interface has already been frozen for a while. I will wait a
583 couple of weeks for bug reports, and if nothing serious is found, the new
584 stable Ion should finally be released then.
585
586 The most notable changes since the previous release are:
587
588   * The dock module is included
589   * An optional autoconf script was added
590   * A few minor bugs were fixed
591   * Some incomplete features were polished, especially focus control on
592     floatws, and:
593   * Changes in X keyboard map are supported now (so e.g. switching to 
594     dvorak after Ion has started should update the bindings to match the
595     locations of symbols in the dvorak layout).
596
597
598 About the version numbering scheme:
599
600 Due to a demand of a version numbering scheme more indicative of the status
601 of the project, I was thinking of various different new version numbering 
602 schemes for this release: ion-2rc1 (then 2r1, 3d1, etc.), ion-2-20040114-rc1, 
603 ion-2.20040114rc1, ion-20040114-2rc1, etc.). It would've been nice if 
604 simple  lexicographical sorting could be used to order the packages, but 
605 in the end I decided to stick with a scheme that is consistent with the
606 'ion-devel' package names:
607
608     project-branch_and_status-release_date
609
610 Therefore this release is 'ion-2rc-20040114', and the "stable" one will be
611 'ion-2-20040???'.
612
613
614 ion-devel-20031211
615 ------------------
616
617 This is a big clean-up release. The most noticeable changes are that 
618 '-devel' has been removed from path names, user configuration files go
619 in `~/.ion2/` and the main configuration file is 'ion.lua'. (The other 
620 `ioncore-*.lua` files have also been renamed.) There have been no notable
621 changes in the configuration files themselves, so your old files will 
622 work if you move them to the correct directory and rename the changed
623 files. (`mv ~/.ion-devel ~/.ion2; cd ~/.ion2; mv ioncore.lua ion.lua;`
624 etc.)
625
626 This release also finally contains a working PWM binary. (The ioncore+
627 scripts scheme was replaced with separate binaries statically linked
628 to ioncore.a.) Floating workspaces now support edge snapping and 
629 sticky windows, but some PWM features are probably still missing.
630
631 Some bugs were also fixed and users are now force-fed the manual page 
632 the first time Ion is started. Transients can be toggled between
633 top/bottom of the main window with Mod1+K T. The SSH query uses
634 `~/.ssh/known_hosts` for completion instead of a manually defined list.
635
636 There may be a few additions (e.g. the dock) and bug fixes, of course,
637 before the stable release, but this release should pretty much be what
638 the new "stable" Ion should look like. Please upgrade to it to help
639 weed out the bugs. Note that you need to upgrade Lua to the 5.0.1 
640 pre-release.
641
642
643 ion-devel-20031119
644 ------------------
645
646
647 It's finally time for a new release on Ion's development branch. Most
648 likely this will also be the last "big" release before finally, after
649 almost two years, releasing a new "stable" version of Ion. A few bug 
650 fix and code clean-up releases should appear in between, though.
651
652 The most important additions, changes and non-changes in this release
653 are:
654
655   * Menu module
656   * A little less broken extended character set and string encoding 
657     support
658   * Extended WM hints fullscreen request support
659   * Hopefully a little clarified configuration file layout
660   * Quite a few fixes
661   * And most important of all:
662
663 >    Configuration files written for the previous release should
664 >    still work this time!
665
666 (However, Ion will complain of old drawing engine styles.)
667
668 The menu module provides both drop-down menus (in the stock configuration
669 pressing Button3 on a tab should show a context menu) and query-like 
670 "in-mplex" menus (F12: main menu at screen level; Mod1+M: the same context 
671 menu as above at frame level).
672
673 What was done enhance support for strings (mostly window titles) in 
674 languages that need more than 8-bit character sets is:
675
676   * Remove UTF8 restriction and support almost arbitrary multibyte 
677     encodings instead. (Statefull encodings will not work and combining 
678     characters can cause clutter. Both are a sign of bad encoding, IMHO.)
679
680   * The XCreateFontSet routine that is used to load fonts in the kind
681     of structure the X utf8 and multibyte routines want apparently wants
682     to be able to load glyphs for all character sets specified in the 
683     locale and therefore often fails if only single font is specified. 
684     Therefore a kludge was added that tries loading more fonts while 
685     keeping the fonts' size the same. (The ",*" kludge could load huge
686     fonts). Unfortunately this has a noticeable effect in startup time :(.
687
688   * There is no longer a system.mk option to enable utf8 (now multibyte)
689     support, but must still specifically be enabled with the -i18n
690     command line switch, mostly thanks to troublesome utf-8 locales.
691
692 Because Xlib's UTF-8 string drawing code is broken and very unlikely to 
693 be fixed, decent text output in an UTF-8 locale is still unlikely and 
694 dependent on the fonts loaded in the system. The Xmb routines that are now
695 used always use an iso10646-1 font even if other fonts are loaded and the 
696 unicode font does not contain a particular glyph to be drawn. The use of 
697 the Xutf8 routines  in an utf8 locale can be enabled with the
698 `CF_DE_USE_XUTF8` compile-time  option. The advantage of this is that 
699 these routines seem to choose the font to draw particular character in 
700 most cases more sanely. The downside is that there are other more serious
701 problems with unknown characters.
702
703 All in all, even if I'd like to support a universal move to UTF-8, thanks 
704 to Xlib brokenness I can't really recommend using UTF-8 locales with Ion 
705 and the default drawing engine if there's a decent alternative encoding.
706 Most if not all other stateless encodings shouldn't have the problems 
707 UTF-8 has. An alternative drawing engine that didn't use the Xlib i18n
708 string drawing routines might solve the troubles with utf-8 support.
709
710 One more note:
711
712 If you have saved a custom system.mk, you'll need to set LUAC
713 point to the Lua compiler there as some of the share/ files
714 are compiled now.
715
716
717 ion-devel-20030810
718 ------------------
719
720 It's been a while since the previous release as I wanted to freeze the
721 Lua configuration/scripting interface for this release and therefore 
722 finish work on a few things. Well, on my part the interface is frozen,
723 but I will still accept constructive complaints for a short time and
724 after that the implemented parts of the scripting interface will be 
725 frozen. But in all likelihood, if no one has anything else to say, but
726 "it's ok", "it sucks", the interface will no longer change, only possibly
727 grow.
728
729 What's new for this release then?
730
731   * Drawing engine module support.
732   * OO-style exported functions. The old `class_fn` functions are now
733     `WClass.fn` (an ugly wrapper is provided in `compat.lua`).
734   * No more screen-specific configuration or savefiles.
735   * Session name (can be specified on command line) instead of display
736     name based savefiles. Also affects query history and not just workspace
737     saves.
738   * Bug fixes, most small and one bigger (almost complete rewrite of 
739     the split resizing algorithm).
740   * Some documentation improvements.
741
742 Converting configuration files.
743
744 Old `.lua` colour schemes and workspace save files can be automatically
745 converted to a format suitable to be loaded by this latest release.
746 Other files will have to be ported manually. To convert colour schemes,
747 use the script `utils/lookconv.lua`. The usage is
748
749     lookconv.lua look-old.lua > look-new.lua
750
751 To convert workspaces savefiles, use the script `utils/saveconv.sh`. 
752 The usage is
753
754     saveconf.sh ~/.ion-devel/saves/workspaces-DISPLAY.*.lua \
755         > ~/.ion-devel/SESSIONNAME/workspaces.lua
756
757 `DISPLAY` here is the actual display part of `$DISPLAY`, probably just `:0`.
758 '*' stands for all screens (if you have only one screen you could do with
759 perhaps just `workspaces-:0.0.lua`). SESSIONNAME is the name of the session
760 where you want to use the converted savefiles. Default session name for
761 `DISPLAY` is `default-session-DISPLAY` with the colon in `DISPLAY` converted
762 to a dash. For most people this is `default-session--0`. In the simplest
763 case the whole command line is therefore
764
765     saveconv.sh ~/.ion-devel/saves/workspaces-:0.0.lua \
766         > ~/.ion-devel/default-session--0/workspaces.lua
767
768 The scripts may or may not work and are only provided as a potential
769 convenience that will not be maintained and will be removed eventually.
770
771
772 ion-devel-20030623
773 ------------------
774
775 Quite a few bug fixes and one most likely unnoticeable improvement:
776
777 2003-06-23:
778
779   * Fixed pointer warping on screen change.
780   * A bug in grab handler calling code could crash Ion when leaving
781     keyboard resize mode manually.
782   * Resize display was showing incorrect values for keyboard resize.
783
784 2003-06-21:
785
786   * Client window last height request bookkeeping code had been lost
787     when configure request policy was changed. This caused transient
788     sizes to be calculated incorrectly.
789   * Return from full screen mode to floatws had been broken.
790   * As the number of dynamic functions has been getting bigger, the
791     functions are now sorted on first use and then binary-searched
792     instead of naive linear searching.
793   * Screen lookup had been broken for windows that are not properly
794     on any screen.
795
796
797 ion-devel-20030620
798 ------------------
799
800 Just some bug fixes and minor behavioural changes and improvements in
801 this release:
802
803
804 ion-devel-20030617
805 ------------------
806
807 This release fixes some small problems with the previous release and
808 adds a workaround kludge for the XFree86 textprop bug (it's been fixed
809 but no release with the fix is available) that could cause Opera to 
810 crash Ion when UTF8 support was enabled. I also added the winprop
811 needed for galeon's find dialog to default `kludges.lua` and there's
812 some extra documentation and defaults for some systems in system.mk.
813
814
815 ion-devel-20030614
816 ------------------
817
818 Most changes in this release centre around making Ion more tolerant
819 to broken configuration files; for details see the ChangeLog. There
820 are also changes in binding configuration as I already mentioned in
821 an earlier poting. Namely `common-frame-bindings.lua` is gone and the
822 bindings previously set there (into variables that the `*ws.lua`
823 files later referenced) were moved to `ioncore-bindings.lua` and are
824 set using the new functions `mplex_bindings` and `genframe_bindings`
825 are were  added. Old modified configuration files should still work,
826 however, but if you use `make_active_leaf_fn`, you will need to 
827 include `compat.lua` as the `global_bindings` that used this were
828 replaced by bindings in `mplex_bindings` and the function
829 `make_current_clientwin_fn`.
830
831 There are also some (minor) bug fixes and a few other improvements 
832 worth a mention. In particular all regions are now given names of 
833 the form  `WFoobar<n>` by default and `DEFAULT_MOD.."F9"` was bound to 
834 create a new workspace without asking for a name. This binding and 
835 `QueryLib.query_workspace` use the workspace type defined in the 
836 variable `default_ws_type` instead of being hardcoded to `WIonWS`.
837
838 All objects passed to Lua now have a unique userdata (a `WWatch` 
839 cached in a weak table) so they can be used e.g. as indices to tables. 
840
841
842 ion-devel-20030606
843 ------------------
844
845 This release unifies some parts of `WScreen` and `WGenFrame`, which makes
846 screen-level queries possible. (Later the queries for small frames might
847 be changed to be shown at screen level.) The statusbar restriction from
848 ion-devel-20030531 was also removed by this some change and a few
849 non-fatal bugs have been fixed.
850
851
852 ion-devel-20030601
853 ------------------
854
855 A bug was discovered:
856
857 2003-06-01:
858
859   * An off-by-one error in `extl_l1_finalize` caused references to some
860     Lua tables (including large completions) never to be released.
861
862 It could be that this bug was causing some other errors in Lua as well.
863 Sometimes QueryLib bindings failed because some function generators
864 returned nil although they shouldn't. Adding dummy lines (!) in those
865 functions fixed the problem and for some reason this patch also seemed
866 to remove those problems.
867
868
869 One more note: as `ioncorelib.lua` and `querylib.lua` are now installed
870 in `$SHAREDIR`, you must remove the old files in `$ETCDIR` if installing
871 over a previous release or else there will be errors. You should also
872 not use any possible old copies you have in `~/.ion-devel/`. (One of the
873 reasons for moving these to `$SHAREDIR` is to stop users from making
874 copies of them as they are not configuration files.)
875
876
877 ion-devel-20030531
878 ------------------
879
880 As the subject line says, Ion-devel-20030531 was just released. The short
881 list of changes is:
882
883  * The license was changed from the Clarified Artistic License to the
884    GNU Library/Lesser General Public License (LGPL).
885  * Screen, viewport and root window renames and other changes (see below).
886  * Some installation directory changes; the ion-* helper programs are now
887    installed either in `$SHAREDIR` or `$EXTRABINDIR` and QueryLib searches 
888    for them on the script path (`~/.ion-devel/`, `$ETCDIR`, `$SHAREDIR`, 
889    `$EXTRABINDIR`) instead of assuming them being on `$PATH`.
890  * Client windows are now in a separate namespace.
891  * Resize/maximize/shade changes: Shading should work on `WIonFrame`s too
892    and shade mode is automatic when the client area gets too small when
893    resizing. Maximize toggle restores frame to previous size if shaded
894    instead of maximizing. The move/resize mode bindings were changed again
895    to be more consistent and predictable: Left/Right/Up/Down and F/B/P/N
896    grow the frame in the specific direction, Shift+keys shrink and in
897    case of floating frames, `DEFAULT_MOD+keys` move
898  * Returning from full screen mode should work on `WFloatWS`s too.
899  * Lots of minor fixes, export additions and clean-up.
900
901 As usual, see the (long!) list of new ChangeLog entries at the end of
902 this message for details.
903
904
905 I've finally personally switched from the old "stable" 20020207 to using
906 the latest development release at home too and I must say that it is
907 finally starting to look good. There are still things to be written, but
908 unless you need "proven" stability, I see no reason to sticking to that
909 old release anymore. Unless, of course, if you find a problem that I have
910 not encountered or simply have no need for the new features and don't want
911 to port your configuration files.
912
913
914 On screens, viewports, root windows and problems with the new
915 implementation
916
917 The objects previously called "screens" are now called "root windows"
918 and what were called "viewports" are called "screens" to better reflect
919 what the user sees. (When Xinerama is not used there's no difference
920 between a root window and a screen, but when Xinerama is used a root
921 window may be split over multiple screens.)
922
923 This release also creates so-called virtual root windows for each
924 Xinerama screen when there are more than one. This is to better separate
925 the windows on different screens and thus emulate normal multihead, the
926 main difference being that windows can be moved between screens.
927 Especially the virtual roots are there to keep the windows that are on
928 a floatws on the right screen.
929
930 Virtual root windows will, however, break a few apps:
931
932  * Mozilla -remote won't work because of its crappy method for looking
933    up existing windows that can't handle multiple levels of WM windows.
934    Nested workspaces have the same problem. There is, however, a simple
935    solution to this problem: gnome-moz-remote. It seems to use a saner
936    method for looking up an existing Gecko browser and also works with
937    at least Phoenix/MozillaFirebird and Galeon.
938
939 These two are problems only if you use floatws:s (other problems with
940 which virtual root windows are intended to solve):
941
942  * The background-setting apps I am aware of will require a following
943    'xrefresh' for the changes to be updated to the (transparent) virtual
944    roots. Background setting apps that support the `_NET_VIRTUAL_ROOTS`
945    property (which, I think, was meant for root window-sized WS 
946    backgrounds) could be used to set a separate background for each
947    Xinerama screen, though. I am not aware of any such app.
948  * Some apps' resize and move features will behave erratically on those
949    Xinerama screens not at (0, 0) on the root window. This is again
950    because the apps are assuming there's at most one WM window between
951    them and the root and are requesting windows' positions incorrectly.
952    The ICCCM is quite vague on this and I think _all_ apps that I have
953    tried are doing it wrong but the way e.g. XMMS does it certainly is
954    not an interpretation of the ICCCM. The apps that now behave correctly
955    request position for the outermost WM window. Nested workspaces have
956    the same problem.
957
958 There is one more temporary problem:
959
960  * Status bar modules (and the dock module's statusbar mode) will be
961    *temporarily* broken when virtual roots are _not_ used. This will be
962    fixed later when parts of screen and frame code are unified (it should
963    then be possible to run Ion without any workspace modules and have
964    queries attached to screens). In the meanwhile, if you don't care about
965    the above-mentioned problems and want a statusbar (which probably needs
966    to be ported to this release), you can defined `CF_ALWAYS_VIRTUAL_ROOT`
967    when compiling Ion.
968
969
970 ion-devel-20030510
971 ------------------
972
973 There are quite a few small fixes and minor enhancements invisible to
974 the user in this release. The splitting functions were renamed to be
975 more consistent and there are a couple of enhancements in the Lua code
976 query that should make it much more usable. First, tab-completion can
977 now descend into tables and complete subexpressions. Secondly, the local
978 variable `_` in addition to 'arg[1]' is set to point to the the frame in
979 which the query is executing. 
980
981 I have also written some new documentation that is now available from
982 the Ion web page.
983
984
985 ion-devel-20030506
986 ------------------
987
988 The most notable change in this release is that the `target_id` system
989 was removed and instead client window status is also saved over
990 restarts in the saves/workspaces-* files. (It shouldn't be too hard
991 to hook a session management module over this.) Thanks to this
992 modification, floatframes can also save their status now. Note
993 that if you restart from older version of Ion to this one, client
994 window layout will be messed up.
995
996 There are also a few bug fixes and code to save and load line editor
997 history was added.
998
999
1000 ion-devel-20030503
1001 ------------------
1002
1003 There are lots of minor improvements in this release, see the
1004 new ChangeLog entries for details.
1005
1006
1007 ion-devel-20030427
1008 ------------------
1009
1010 Some minor feature enhancements and a few fixes in this new release:
1011
1012 The file system scanning completions are now put in the background
1013 by receiving the data from external programs through pipes and select()
1014 for data in the main event loop. This way long taking completions don't
1015 block Ion from processing other events and NFS problems shouldn't hang
1016 it.
1017
1018 Basic window stacking management support code was added. Transients
1019 on floatws:s should now be stacked above their parents. If you don't
1020 want to change your modified binding configurations at this point and
1021 need the functions `floatframe_raise/lower`, include `compat.lua`.
1022
1023
1024 ion-devel-20030412
1025 ------------------
1026
1027 This release again fixes some minor problems and enhances a few
1028 features. Most of the enhancements are related to UTF8 support and
1029 the floatws module. If UTF8 support is enabled, Ion now tries to
1030 load the "fixed" font at startup after setting up locales. If locales
1031 aren't properly set up, this probably fails and Ion will reset locale
1032 back to "POSIX" as this might make fonts loadable although support for
1033 non-ASCII characters will be crippled. It might now be safe for
1034 package maintainers to enable UTF8 support by default
1035
1036 As apps seem to have switched to using `_NET_WM_NAME` for UTF8 titles
1037 and filling `WM_NAME` with crap, this property is also preferred over
1038 `WM_NAME` if set. Support for some other "extended" WM hints might be
1039 added in the future but I have no intentions of moking Ion NetWM-
1040 compliant. I might have thought of attempting to do so a few years
1041 ago when I last read the specification but it seems that since then
1042 they've filled it with lots of pointless bloat that may even be in
1043 opposition to Ion's goals. Take multi-parent transients, for example. 
1044
1045 Full error log is also displayed with xmessage on startup whether
1046 it is possible to continue or not.
1047
1048
1049 ion-devel-20030410
1050 ------------------
1051
1052 There was a bug in QueryLib written yesterday, therefore this release.
1053
1054
1055 ion-devel-20030409
1056 ------------------
1057
1058 I started converting the query code to Lua and discovered some rather
1059 silly bugs in the Lua interface so here's a new release with the new
1060 and improved query code included. The names of queries have changed
1061 (they're all in the table QueryLib defined in `querylib.lua` -- only
1062 `query_query` and a few temporary handlers are implemented in query.so)
1063 so your modified configuration files will be broken again :(.
1064
1065
1066 ion-devel-20030408
1067 ------------------
1068
1069 Be prepared to completely rewrite your configuration files once
1070 again: a new version of Ion-devel has been released that uses Lua
1071 <http://www.lua.org/> for all configuration. Version 5.0 of the
1072 language/library is required. Although scripting possibilities
1073 are now much better than before, there is one rather big drawback:
1074 Lua is not nearly as error-tolerant as Ion's old configuration
1075 parser so a syntax error in a file will cause the file not to be
1076 executed and may even cause Ion not to be able to start. More
1077 comments and documentation on scripting will follow at a later time.
1078
1079 Libtool and libltdl are also now used to implement module support.
1080 Hopefully this will make compiling Ion easier on a wider range of
1081 platforms. (On the other hand, this could also induce new problems.)
1082
1083 Finally, the preferred linking address for Ion's home page is now
1084 <http://www.iki.fi/tuomov/ion/>. The pages are still located at the
1085 old address, but this redirected address should be more permanent.
1086
1087
1088 ion-devel-20030327
1089 ------------------
1090
1091 Just some minor fixes, binary rename and better embedded workspace
1092 support in this release. I'm still contemplating whether to convert
1093 Ion to C++ and haven't written many things that I intended to as
1094 that decision will affect how those are implemented.
1095
1096 To create an embedded workspaces in a frame, at the moment you have
1097 to modify the appropriate workspace save file (when Ion is not running!)
1098 by  adding lines such as
1099
1100     region "WFloatWS", "testiupotus" {
1101     }
1102
1103 inside the frame definition after the other options (flags, `target_id`;
1104 those options will be ignored if after any region definitions).
1105
1106 One more thing to note: debugging infos are no longer automatically
1107 stripped from the ioncore binary or modules by 'make install' so that
1108 I don't have to explain how to get proper backtraces every time a bug
1109 is found. If you you are confident that you can send me proper backtraces
1110 when you find a bug (or maybe can fix it yourself), you can make the
1111 binary and the modules a _lot_ smaller by running 'strip' on them.
1112
1113
1114 ion-devel-20030311
1115 ------------------
1116
1117 The list of new ChangeLog entries is long this time, but I'm finally
1118 starting to get to what I started working on almost two years ago. Yes,
1119 there is *experimental* support for PWM-like "floating frame" workspaces.
1120 A lot of the functionality is still missing -- no need to complain of
1121 such at the time -- but the floatws.so module and basic functionality
1122 is there. Most notably perhaps a menu module is not yet implemented.
1123 (Porting the PWM menu code should a nice little task for whomever
1124 interested... *wink*.) To create some PWM workspaces, load the floatws.so
1125 module (should be loaded by default) and in `query_workspace` (F9)
1126 prefix workspace name with 'WFloatWS:' (or load the module before
1127 ionws.so). 
1128
1129 This release is also finally fully modularised: In addition to the
1130 ion core binary that can not function alone, there are the modules
1131 ionws.so, floatws.so and query.so. It is also possible statically
1132 compile the modules in the core binary if the system doesn't support
1133 libdl.
1134
1135 There's also *experimental* UTF8 support that must be specifically
1136 enabled from system.mk. You must have XFree86 (4.x?) and C99 wide
1137 char support available (either libc directly or maybe libutf8+libiconv).
1138 Thanks to bugs (?) in some of the XFree86 Xutf8 functions, your locales
1139 must be properly set up or else X will stop drawing strings at non-ascii
1140 characters instead of ignoring them. See my earlier rants on the mailing
1141 list for reasons on not using the more standard Xmb functions.
1142 To actually see any special characters, you must load the necessary fonts
1143 by specifying a comma-separated list of fonts to the font and `tab_font`
1144 draw.conf options. Multiple font loading does not work when Xft support
1145 is enabled at the time being.
1146
1147 There has been a lot of changes in the config files, again, and I can
1148 promise there's still more to come. See the ChangeLog for details.
1149 If you want to use your old workspaces configurations, move them to
1150 `~/.ion-devel/saves` and replace the strings "WFrame" and "WWorkspace"
1151 with "WIonFrame" and "WIonWS", respectively.
1152
1153
1154 ion-devel-20030225
1155 ------------------
1156
1157 I've made the bugfix release as promised. Get it from the usual place.
1158
1159
1160 ion-devel-20030223
1161 ------------------
1162
1163 There's a new major development release available from Ion web page.
1164 Not many changes are visible to the end user, though, but a lot was
1165 rewritten to be more flexible and simpler; see the ChangeLog for a
1166 full account. The older development release is also still available
1167 because this release can not be considered as stable after major
1168 changes to the code. The most visible changes are
1169
1170   * Changes in binding configuration
1171   * A (mostly) working full screen mode toggle (see below)
1172   * The ability to switch workspaces while dragging tabs (experimental)
1173   * The ability to re-read draw.conf without restarting Ion
1174   * Some bug fixes.
1175
1176
1177 Some notes on full screen mode toggle:
1178
1179  * Ion doesn't detect programs trying to leave full screen mode--it
1180    should be possible to devise some method using window properties,
1181    however.
1182  * At least Opera unmaps the window also before changing the size to
1183    enter full screen mode, so Ion doesn't remember the last frame.
1184  * Mozilla sometimes has trouble entering full screen mode but when it
1185    succeeds, Ion remembers the last frame. However, if
1186    `clientwin_toggle_fullscreen` is used to leave the full screen mode
1187    started from Mozilla, Mozilla doesn't know that the mode has been
1188    left.
1189
1190 Clearly there should be some method of communication between Ion and the
1191 programs for full screen toggles to fully work. At the moment I suggest
1192 using `clientwin_toggle_fullscreen` instead of the programs' native toggles
1193 unless the program has some special full screen mode and you really want
1194 it.