]> git.lyx.org Git - lyx.git/blobdiff - RELEASE-NOTES
adjust build systems
[lyx.git] / RELEASE-NOTES
index 34f5e9d2db7d7bb09bc8571fa60c9f9d5e6be51a..7d90ef2657da7f5136c6dda9d6ef3f5fb2d4fa6d 100644 (file)
@@ -1,47 +1,92 @@
-Known issues with version 1.4.0
---------------------------------
+This file lists interface changes that might affect users in 1.5.0 and
+also some known problems in LyX 1.5.0 that did not occur in
+1.4.5. Note that fixes are available for many of these, but they have
+not yet been applied because of incomplete testing.
 
-This file describes some known problems in LyX 1.4.0 that did not
-occur in 1.3.7. Note that fixes are available for many of these, but
-they have not yet been applied because of incomplete testing. 
 
-** Noticeable delays when editing a large document
+Interface changes
+-----------------
 
-- exiting a math formula with the keyboard.
-  http://bugzilla.lyx.org/show_bug.cgi?id=2217
+Some of the LyX functions have changed names :
 
-- creating/deleting paragraphs.
-  http://bugzilla.lyx.org/show_bug.cgi?id=2287    
 
-** Change tracking
+Known issues with version 1.5.0
+------------------------------------
 
-- Breaking a paragraph is not supported.
-  http://bugzilla.lyx.org/show_bug.cgi?id=880
+- User layout files must be converted to UTF-8
 
-- Delete key does not move the cursor to the next character.
-  http://bugzilla.lyx.org/show_bug.cgi?id=2185
-  
-- Pasted text inserted wrong after switch of change tracking state.
-  http://bugzilla.lyx.org/show_bug.cgi?id=2207
+In previous versions, layout styles were allowed to use non-ASCII names
+using the local encodings. LyX-1.5 now assumes that all layout files are
+UTF-8 encoded. This means that non-ASCII style names are still allowed
+but they must be valid UTF-8 strings. One way of doing the conversion
+is to use iconv. Using bash, the script below should work:
 
-- First change is skipped is "Merges changes..." dialog.
-  http://bugzilla.lyx.org/show_bug.cgi?id=2212
+#! /bin/sh
 
-** User Interface
+cd /path/to/layouts
+for l in *
+do
+  cp "$l" tmp.txt
+  iconv -f latin1 -t utf8 tmp.txt -o "$l"
+done
+rm -f tmp.txt
 
-- Shift-PageDown and Shift-PageUp key combinations work only if there
-  is an already active selection.
-  http://bugzilla.lyx.org/show_bug.cgi?id=2119
+- Cursor restoration problems with Multiple-View
 
-- First incorrect word is skipped when spell checking.
-  http://bugzilla.lyx.org/show_bug.cgi?id=2218
+When using multiple Windows to edit different parts of the
+same document, the cursor position is sometimes not correctly restored
+when you switch from one view to the other.
 
-- Font changes do not apply to tables inside the selection when
-  making latex.
-  http://bugzilla.lyx.org/show_bug.cgi?id=1973
+- Languages/encodings and insets
 
-- Bookmarks and links to LaTeX errors are broken after paragraph
-  deletion/insertion.
-  http://bugzilla.lyx.org/show_bug.cgi?id=2284
-  http://bugzilla.lyx.org/show_bug.cgi?id=2242
+One of the bugs fixed in LyX 1.5.0 is that previously, there were certain 
+specific cases in which the LaTeX generated did not correctly reflect 
+language/encoding transitions in and around insets (footnotes, LyX notes).
+After much deliberation, it was decided not to change older files such that
+they will still reflect the old LaTeX output; rather, they will now correctly
+reflect the situation as it appears in the GUI. This means, however, that if 
+you mangled the text in the GUI in the older versions, in order that it
+generate the correct LaTeX output, the LaTeX will now generate the mangled 
+text. If this is problematic for you, please get in touch with us on the
+developers mailing list, we do have some possible solutions for this.
+
+The effects of this will be more pronounced for RTL (Hebrew, Arabic, Farsi) 
+users --- though they affect users of other languages as well.
+
+- Inset encodings and Conversion from earlier LyX versions
+
+One of the main new features in version 1.5.0 is Unicode. As part of the
+transition, lyx2lyx (the scripts used for converting back and forth between
+different versions of the lyx files) converts old .lyx files, which may use 
+a number of different encodings, to UTF-8. This conversion depends on
+correctly identifying the language of the text. There were previously some
+edge-cases (insets embedded in different-language text type scenarios) in 
+which the language was incorrectly identified, which caused some text to 
+appear incorrectly after having upgraded from older versions. This has now been
+fixed. Unfortunately, however, the fix cannot be applied to files which have
+already been converted past format 249.  So if you have already converted 
+your old files (using a development version or release candidate), this fix
+won't help, unless you still have the originals lying around (and haven't 
+yet made too many changes to the newer versions ;) ).
+
+Generally, it is probably wise to keep a backup of the old version of your 
+files, at least until you are sure that the upgrade went smoothly (which it 
+almost always will).
+
+- RTL and keymaps
+
+Currently there is a bug where you can't use two non-RTL language keymaps if
+the RTL preference is set (which is now the default). If you need to use two
+non-RTL keymaps, for now you should just turn off the RTL preference (Tools -> 
+Preferences... -> Language settings -> Language, uncheck "Right-to-left
+language support").
+
+We hope to offer more comprehensive support for multiple keymaps in the future,
+which will solve this bug, as well as allow more than just two keymaps. If you 
+have any input on this issue, please chime in on the developers mailing list,
+or add your comments to http://bugzilla.lyx.org/show_bug.cgi?id=4051.
+
+
+Note: There may later be an updated list of known issues online at
+       http://wiki.lyx.org/LyX/ReleaseNotes