________________________

GNOMESWORD RELEASE NOTES
________________________

Release 2.2.3
24 Mar 2007

1. A module cache has been implemented as a significant performance
   improvement.  As Bible text is visited, everything seen goes into
   an in-memory cache, so that subsequent navigation of the same text
   does not need to re-visit Sword.  If display options change
   (footnotes xrefs headings Strong's morph), the cache is invalidated
   and Sword is queried again to re-populate the display-ready cache.

   Display performance acid test:
     KJV Ps 119 (176 verses), all mod.opts enabled; spin verse selector.
     End-to-end (v1 -> v176) navigation time on 1.8GHz computer:
     GS 2.2.2, 441sec; GS 2.2.3, 102sec => 78% reduction.

2. Personal commentary archival, renaming, and verse dump are implemented
   (feat.req #1633407).  Archival is available via the module manager
   (any module may be archived); rename + dump are on the pers.comm
   popup menu.  [For Cygwin, regrets, NTFS prevents rename of files
   currently open, so module rename is not available there; but archive
   + dump are fine.]

3. Main window image content can be clicked to invoke an external image
   viewer (feat.req #1631815).  Support for this feature requires an
   enhancement to Sword itself beyond its 1.5.9 release (i.e. built from
   SVN at change level >= -r2035), but of course it builds/runs fine
   without this feature's availability using today's Sword 1.5.9.  Some
   day (soon?), Troy will release a new 1.5.something, or perhaps 1.6,
   which will contain this.

4. Finnish translation now available.

5. Sidebar verse lists are always savable (bug #1674149).

6. Improving i18n support now supports more non-ASCII searches
   (bug #1673598).

7. Mouse-selected Bible/commentary/genbook text can be read aloud using
   a popup menu selection, regardless of whether scripture reading is
   enabled on View -> Read Aloud.

Bug reports addressed since 2.2.2:
1687602  Module Manager crashes on FC6
1681135  Module manager crashes Gnomesword on startup
1674149  unable to save verse lists
1673598  cannot search personal for non-ascii chars
1667954  Missing modules in advanced-search window

New feature requests pending:
<none>

Feature requests closed:
1633407  personal commentary needs
1631815  open single-image window on click
________________________

Release 2.2.2 (maintenance)
23 Feb 2007

Behavioral matters:

1. The module manager now provides both short module name plus long
   module description on the right, and there is also a refresh icon
   between mismatched old & new version stamps of installed modules
   (bug #1666761).  GnomeSword now works around a Sword lib install
   manager bug when updating installed modules by deleting the old
   version before attempting to retrieve the new version (bug #1666748).
2. Several MM glitches related to unfindable or unusable newly-defined
   install sources have been fixed (bug #1666763, #1666759).
3. Some of the planned Advanced Search work has been done (feat.req
   #1615402).  E.g. you can select the Attributes radio button, then
   use the Attribute tab to define which attribute is in question.
   The Strong's syntax needed is now just H### or G###.
4. Many changes for improving i18n handling have been done.  (We need
   translators.)
5. The 2x2 set of buttons at the bottom of the sidebar have been moved
   to the top, where they sit near the rest of the mouse controls
   (bug #1666764).
6. GnomeSword can now build under MS-Windows in the Cygwin environment
   (feat.req #1124274), and gives every appearance of being fully
   functional there.  Doing so requires a bash script and two library tar
   files.  See ftp://ftp.kleinpaste.org/pub/sword/util/cygwin/

Bug reports addressed since 2.2.1:
1666764  sidebar buttons belong at top
1666763  MM loses track of newly-defined sources
1666761  MM: descriptions + refresh indicator
1666759  rem.source w/o bible text -> can't load
1666758  null genbook key -> crash
1666756  lack of icons in splash -> crash
1666755  strcasestr() is nonstandard
1666754  wrong morph for OT
1666751  GS infloops det.parallel on Rev22
1666748  need workaround for installmgr bug
1651736  Updated german Translation
1651514  Crasher bugs related to directories(?)
1651375  changing tabbed-view preference requires restart
1651077  osis-based commentary's xrefs don't work
1648806  Cannot add local module source directory
1647579  switching from local to remote causes crash
1646579  sidebar search, no bounds => crash
1645989  newly-defined install source unavailable

New feature requests pending:
1646037  very simple api for scrolling

Feature requests closed:
1642837  fullscreen support
1615402  advanced search needs help
1124274  GnomeSword for Windows
________________________

Release 2.2.1 (maintenance)
27 Jan 2007

Behavioral matters:

1. Genbooks now use a navbar in both dialog and Book View pane.
2. High-contrast highlight of current verse is available.
   (Edit->Prefs->Fonts->Colors, plus either View->Highlight Current Verse
    or Edit->Prefs->General->Misc->Highlight current verse.)
3. Unused verse number color preference was removed, as planned
   (feat.req #1620641).
4. Footnote content search works again, but it's a hack, it still uses
   an atrocious syntax, and we still need to do the planned rework in
   Advanced Search (feat.req #1615402).
5. Disabling both right-side panes completely disables right-side display
   (bug #1624753, feat.req #1624757).
6. GnomeSword enables GConf-based URL handling (feat.req #1613239).
7. There is code in place to do double-space text as soon as GTKMOZEMBED
   returns (feat.req #1193235).  #ifdef DOUBLESPACE keeps the View item
   out of visibility for the moment.  Improved Strong's/morph markup
   (feat.req #1633426) will follow soon.  Both depend on CSS.
8. Some new keyboard shortcuts have appeared (feat.req #1633397).  Alt-G
   focuses on the Genbook navbar, and thereafter arrow keys do what you
   expect.  Alt-C brings up the commentary.  Ctrl-L focuses the main
   verse navbar text.

Important usage note:

A genbook key handling bug exists in the Sword libs, in SVN after
their 1.5.9 release.  If you build Sword from SVN and you find that
you are unable to navigate to certain portions of some genbooks
(Finney, Heretics, Institutes), a workaround is this, for each module:
    cd ~/.sword/modules/genbook/rawgenbook/finney
    mod2imp Finney > finney.imp
    imp2gbs finney.imp
    rm finney.imp
That is, simple re-importation will make the module consistent with
itself in this regard.

Bug reports addressed since 2.2:
1643716  non UTF-8 chars with libsword built without icu
1643623  pers.comm. editor loses <tokens> on re-edit
1642835  TTS unavailable: Connection refused
1642603  loading a tab set leaves GS confused
1640907  long verse history -> pulldown-select fails
1639131  genbook footnotes are inaccessible
1635205  commentary dict lookup crashes GS
1634794  adv.search hates booknames w/spaces
1633109  gtk warnings from personal commentary
1632443  comm. fails to track beneath genbook
1631814  right-click -> Edit -> Find crashes
1631629  bible dialog uses wrong verse style
1629380  comm.dialog xref selection refers to wrong book
1628714  dialog commentaries select revelation?
1626605  Daily Devotion Does Not Display
1624753  "Show/Hide Sidebar" has a Weird Effect on the Right Sidebar
1623020  gnomesword tts
1622892  dict/lex cannot change xref setting

New feature requests pending:
1633426  update strong's/morph markup readability
1633407  personal commentary needs
1631815  open single-image window on click

Feature requests closed:
1642837  fullscreen support
1633397  shortcut: focus text cursor to verse bar
1624757  Add View Option to Toggle the Right Sidebar
1620641  "Verse numbers" font color is ignored
1613239  improve command line use of "sword://"
1193235  Allow text to be displayed double space
         (but inactive, pending return of GTKMOZEMBED)
 901894  Drop book list for search limit
________________________

Release 2.2
25 Dec 2006

Known deficiencies:

1. Footnote body search was very recently broken by other needed work
   in Advanced Search.  Other "attribute" searches (esp. Strong's
   refs) work, but not footnote body search.  This will be addressed
   early in the next development cycle: Advanced Search is due for
   another round of revamping, largely to simplify and enhance the
   operation of attribute searches.  See feature request #1615402.

2. The alternate HTML renderer code under the "mozembed" #ifdef is
   not functional at this time, and we do not know if such capability
   will return in a future release.  This means that the configure
   options --with-firefox and --with-seamonkey do not function.

3. The verse number font color preference is ignored; this will go
   away entirely soon, as verse numbers are links to themselves, for
   re-aligning verse navigation to the verse in question, which in
   turn tracks the commentary to the same verse.  See feature request
   #1620641.

4. The module manager offers installation directory options of
   ~/.sword as well as the system Sword directory, typically
   /usr/share/sword, iff that directory is writable by the user.
   Future work will involve efforts at a superuser password query
   to obtain temporary access to the system directory, but in the
   current release, "chown -R you.yourgroup" is necessary, prior to
   running GnomeSword.  See feature request #1618837.

Bug reports addressed since 2.1.10:
1620542  Crashes on "View Context"
1618998  Displays frame then hangs
1618829  first use: no global modules found by gnomesword
1618324  "philipper" in german version points to philemon
1617225  gnomesword crashes, when clicking on combobox...
1613439  Sidebar setting does not survive program restart

Feature requests pending:
1620641  "Verse numbers" font color is ignored
1620313  Couple of bugs with module manager operation
1618837  global install of modules
1615402  advanced search needs help
1613239  improve command line use of "sword://"
1194044  prayer list
1193235  Allow text to be displayed double space
1124274  GnomeSword for Windows
 901894  Drop book list for search limit
Requests 1613239 and above are post-2.1.10 release.  Older requests
represent capabilities for which the needed underlying support does
not exist or which represent an extremely complicated re-working of
GnomeSword from its current state.
________________________

Release 2.1.10
09 Dec 2006

Recent bug reports addressed:
1605640  Change Font does nothing
1605638  Printing does not work
1602532  Uninstallable with Ubuntu Edgy Eft
1602059  Images in Personal Commentary don't show if path has spaces
1601897  search too broad on strongs
1601744  title of module in titlebar not displaying for GetLut1545
1596747  Crash on "search", no content displayed
1594151  previewer-anchored footnotes needed
1582986  Crashed
1576964  GnomeSword fails to build with libsword6-dev
1575275  meta chars in new bookmark folders
1551501  Fix build with -Wl,--as-needed
1536274  clickable links to external sources don't work
1535370  feature request: track verse change across all open tabs
1535122  2.1.7 has typos in commentary_dialog.c
1521926  2.1.7 seems unaware of large portions of commentaries
1507371  2.1.7 forgets which commentary is in use
1505753  2.1.7 mishandles crossrefs in headers

This list is incomplete, as these notes did not exist to track such
reports until recently, but represents the major reports fixed since
the middle of the 2.1 development cycle at a time when many very old
bug reports were finally addressed.
________________________
