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