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