* README:

* RELEASE-NOTES:
* UPGRADING:
* NEWS:
* development/lyx.rpm.README:
	- updates

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@20487 a592a061-630c-0410-9148-cb99ea01b6c8

NEWS

@@ -1,21 +1,75 @@
-Public release of LyX version 1.5.0
+What's new in version 1.5.1?
-===================================
+----------------------------
 
-We are pleased to announce the release of LyX 1.5.0.
+** Updates:
+***********
 
-Since the announcement of release candidate 2, we have fixed bugs and
+* DOCUMENTATION AND LOCALIZATION
-we have updated the documentation.
 
-Following the ad hoc tradition of 1.5.0 pre-releases, called
+- Add template for the APA class (bug 2390).
-respectively Ruby (alpha), Towny (beta) and Quinta ("farm" in
-Portuguese for the release candidates) this release starts the Vintage
-selection that is (will be) the 1.5 series.
 
-LyX 1.5.0 is the culmination of 15 months of hard work since the
+
-release of the LyX 1.4 series. We sincerely hope you will enjoy the
+** Bug fixes:
-result.  The changes are too numerous to summarize in a few words, but
+*************
-initial unicode support is the flagship among the new features. See
+
-the end of this announcement for further details.
+* DOCUMENT INPUT/OUTPUT
+
+- Fix output of LyX files on windows when Document>Compressed is set.
+  This is a dataloss bug that was the main reason for releasing 1.5.1
+  earlier than anticipated.
+
+- Get rid of annoying LaTeX error after changing the document language
+  (bug 2468).
+
+- Fix a LaTeX error with caption inset in a listing inset (some
+  problems remain).
+
+- Fix crashes relating to command line export (bugs 4077 and 4086).
+
+- Fix export to FAT32 under Linux (bug 4094).
+
+* USER INTERFACE:
+
+- Fix crash with TOC and child documents (bug 4096).
+
+- Fix redrawing artefacts when switching tabs (bug 3969).
+
+- Fix pasting a selection from the same LyX document with middle mouse
+  button.
+
+- Fix pasting of a selection from other applications (X11 only).
+
+- Coherent behaviour when inserting over a selection: now the selection
+  is always replaced by the insertion (bug 672).
+
+- When inserting an URL over selected text, insert the selected
+  text in the URL inset (bug 683).
+
+- Don't allow invalid listings parameters to be passed when
+  updating other controls in listings-related dialogs (bug 4053).
+
+- Fix bug with math-matrix dialog always producing 1x1 matrices on
+  platforms lacking proper support for wide characters (bug 4076).
+
+- Sort colors in the Preferences dialog (bug 2571).
+
+- Fix bug where using pdfsync marks the document 'changed' (bug 4023).
+
+
+* BUILD/INSTALLATION:
+
+- scons now accepts SConstruct file from top source directory, which
+  can be a symbolic link to development/scons/SConstruct.
+
+- LyX configuration script now checks for htlatex as an OpenDocument
+  converter, since some platforms have htlatex but not oolatex. It also
+  checks for oowriter as an OpenDocument viewer and editor.
+
+- Fix building on Mac OS X when pkg-config is installed.
+
+
+What's new in version 1.5.0?
+----------------------------
 
 As usual with a major release, a lot of work that is not directly
 visible has taken place. The core of LyX has seen more cleanups and
@@ -381,6 +435,13 @@ code is sometimes faster than pretty code. We're well aware that LyX
 series has been to bring this speed back.
 
 
+What's new in version 1.4.5.1?
+------------------------------
+
+The only change over release 1.4.5 is the addition to the distribution
+of one file necessary to read and write lyx 1.5 files.
+
+
 What's new in version 1.4.5?
 ---------------------------- 
 

README

@@ -41,9 +41,9 @@ How does the LyX version scheme work?
 
     LyX uses a contiguous numbering scheme for versions, where a
     number "1.x.y" indicates a stable release '1.x', maintenance
-    release 'y'.  In other words, LyX 1.4.0 was the first stable
+    release 'y'.  In other words, LyX 1.5.0 was the first stable
-    release in the 1.4-series of LyX. At the time of writing, the
+    release in the 1.5-series of LyX. At the time of writing, the
-    latest maintenance release in the 1.4-series was LyX 1.4.4.
+    latest maintenance release in the 1.5-series was LyX 1.5.2
 
     Please note that maintenance releases are designed primarily to
     fix bugs, and that the file format will _never_ change due to a

RELEASE-NOTES

@@ -1,7 +1,8 @@
-This file lists interface changes that might affect users in 1.5.0 and
+This file lists interface changes that might affect users in 1.6.0, some 
-also some known problems in LyX 1.5.0 that did not occur in
+known problems in LyX 1.6.0 and some things you have to take into account
-1.4.5. Note that fixes are available for many of these, but they have
+when upgrading from earlier versions to a version of the 1.6.x series.
-not yet been applied because of incomplete testing.
+Note that fixes are available for some of these, but they have not yet
+been applied because of incomplete testing.
 
 
 Interface changes
@@ -10,83 +11,43 @@ Interface changes
 Some of the LyX functions have changed names :
 
 
-Known issues with version 1.5.0
+Known issues in version 1.5.2
 ------------------------------------
 
-- User layout files must be converted to UTF-8
+- LyX might crash if you switch the encoding of a document while the
+  View->Source pane is opened.
+  http://bugzilla.lyx.org/show_bug.cgi?id=3561
 
-In previous versions, layout styles were allowed to use non-ASCII names
+- LyX might suddenly slow down when you have copied something in another
-using the local encodings. LyX-1.5 now assumes that all layout files are
+  instance of LyX or in another application. Known workaround: Ctrl+C of
-UTF-8 encoded. This means that non-ASCII style names are still allowed
+  some text inside the active window bring the speed back.
-but they must be valid UTF-8 strings. One way of doing the conversion
+  http://bugzilla.lyx.org/show_bug.cgi?id=4045
-is to use iconv. Using bash, the script below should work:
-
-#! /bin/sh
-
-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
-
-- Cursor restoration problems with Multiple-View
 
+- Cursor restoration problems with Multiple-View:
   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.
 
-- Languages/encodings and insets
+- RTL and keymaps:
-
-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.
 
 
+Caveats when upgrading from earlier versions to 1.5.x
+-------------------------------------------------------
+
+Due to the change to Unicode, there are some general things you'll have to take care
+about when upgrading from an older version to LyX 1.5.0 or newer. Please refer to the
+file UPGRADING for details.
+
+
 Note: There may later be an updated list of known issues online at
 	http://wiki.lyx.org/LyX/ReleaseNotes
 

UPGRADING

@@ -1,23 +1,31 @@
-How do I upgrade my existing LyX system to version 1.4.x?
+How do I upgrade my existing LyX system to version 1.6.x?
 ---------------------------------------------------------
 
-The format of the preferences file has changed slightly. LyX 1.4.x is
+* Upgrading from LyX 1.4.x and earlier:
+
+The biggest change in 1.5 is the switch to Unicode. Please refer to
+the section "Document transfer" below for some things you might take
+into account before upgrading.
+
+The format of the preferences file has changed slightly. LyX 1.5.x is
 able to read old preferences files, but it will save them in the new
-format, so it is not possible to run LyX 1.3.x and 1.4.x with the same
+format, so it is not possible to run LyX 1.4.x and 1.5.x with the same
 personal configuration directory.
 
-The format of the layout files has also changed, but LyX 1.4.x uses a
+The format of the layout files has also changed, but LyX 1.5.x uses a
 converter layout2layout.py written in python that will convert old layout
-files on the fly. You can also call it manually on your layout files if
+files on the fly (see below, section "Document transfer").
-you want to convert them to 1.4.x format permanently.
 
-The format of the external template file has changed substantially.
+* Upgrading from LyX 1.3.x:
-Automatic conversion is not available, so you need to convert your
+
-external templates manually. The new format of the external template
+The format of the external template file has changed substantially with 
+LyX 1.4.0. Automatic conversion is not available, so you need to convert 
+your external templates manually. The new format of the external template
 configuration file is described in chapter 6.5 of the Customization Guide.
 
-And of course, if you upgrade from LyX 1.2.x, remember that since
+* Upgrading from LyX 1.2.x:
-1.3.0, you have to do the following changes:
+
+Since 1.3.0, you have to do the following changes:
 
 One of the perennial bug bears of LyX users in the past has been that
 they have had to run Edit->Reconfigure when starting their new version
@@ -35,8 +43,7 @@ If you have your own layout files, you may need to update them a little:
   "Counter"..."End" construct. As for floats, adding "Input
   stdfloats.inc" is probably a good idea.
 
-And of course, if you upgrade from LyX 1.1.x, remember that since
+* Upgrading from LyX 1.1.x:
-1.2.0, you have to do the following changes:
 
 - all layout files should have a "DefaultStyle" entry
 
@@ -61,6 +68,10 @@ have to update them
 Build requirements
 ------------------
 
+LyX 1.5 uses the Qt 4.x toolkit (version 4.1.1 or newer). Contrary to 
+previous versions of LyX, it won't build against Qt 2.x or 3.x.
+Furthermore, the XForms frontend was dropped.
+
 LyX's graphics handling system has changed substantially. If you
 do not have the JPEG library installed, you may need to install
 it before you can use the graphics capabilities of LyX. If you
@@ -71,33 +82,102 @@ in order to get previews of your document's graphics.
 Document transfer
 -----------------
 
-LyX 1.4.x uses an external python script, lyx2lyx, to import documents
+* Compatibility with older documents/layouts
+
+LyX 1.5.x uses an external python script, lyx2lyx, to import documents
 written using previous versions of LyX. All versions of LyX as far back as
 0.12 are supported, so any klyx users still holding out for an alternative
 to xforms will finally be able to put their dinosaur to rest ;-)
 
-Of course, this means that you must have python (at least version 1.5.2)
+Of course, this means that you must have python (at least version 2.3)
-installed in order to use LyX 1.4.x with your old documents.
+installed in order to use LyX 1.5.x with your old documents.
 
 lyx2lyx also has the framework in place to be able to convert documents
-to an earlier format. However, these converters have only been written
+to an earlier format (which requires python 2.3.4 at least). However,
-for the conversion from 1.4.x to 1.3.x, so versions of LyX older than
+these converters have only been written for the conversion from 1.5.x 
-1.3.0 will NOT be able to read documents saved with LyX 1.4.x.
+to 1.4.x and 1.3.x, so versions of LyX older than 1.3.0 will NOT be able 
-The conversion from 1.4.x to 1.3.x is lossless as long as no new features
+to read documents saved with LyX 1.5.x. The conversion from 1.5.x to 
-are used. lyx2lyx tries hard to find something equivalent for new
+1.4.x/1.3.x is lossless as long as no new features are used. lyx2lyx 
-features such as boxes, but this is known to fail sometimes.
+tries hard to find something equivalent for new features such as boxes, 
-LyX 1.3.7 contains an updated lyx2lyx that can read documents in 1.4.x
+but this is known to fail sometimes. LyX 1.4.5.1 contains an updated 
-format. LyX 1.4.x can also export to 1.3.x format for document transfer to
+lyx2lyx that can read documents in 1.5.x format. LyX 1.5.x can also 
-older 1.3.x releases.
+export to 1.4.x format for document transfer to older 1.4.x releases.
+
+Furthermore, LyX uses a converter layout2layout.py, also written in python 
+that will convert old layout files on the fly. You can also call it manually 
+on your layout files if you want to convert them to 1.5.x format permanently.
+
+* Preparing for Unicode:
+
+As of version 1.5.0, LyX uses Unicode internally. This is a major change that
+affects documents and layouts likewise. We have tried to do out best to make the
+transition as smooth as possible for you. However, there are some caveats:
+
+- User layout files must be converted to UTF-8
+
+  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:
+
+     #! /bin/sh
+
+     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
+
+- Inset encodings and Conversion from earlier LyX versions
+
+  As part of the transition to unicode, 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).
+
+* Languages/encodings and insets
+
+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.
+
+* Floatflt in 1.2.x and older
 
 If you were previously (in LyX 1.1.x) using the floatflt paragraph
 option to wrap text around a figure, it was necessary to modify this
 for LyX 1.2.0 manually, as described in the manuals. The feature has
-been re-implemented as "Floting figure" inset in 1.3.0. Old files will
+been re-implemented as "Floating figure" inset in 1.3.0. Old files will
 be converted automatically, but you may want to convert the
 1.2.x-style ERT constructs with the native solution (see section 3.8
 of the Extended Features manual).
 
+* Babel changes since 1.2.x
+
 Since LyX 1.2.0, the babel package is loaded after the user-defined
 preamble (because some packages really need to be loaded before
 babel). If you relied, on babel being loaded before your own

development/lyx.rpm.README

@@ -1,44 +1,43 @@
-********** WARNING **********
-
-This file is out-dated!
-
-Its description is based on the xforms frontend, which was dropped in
-LyX 1.5. This file should eventually be adjusted to the qt4 frontend.
-
-*****************************
-
 Here is what to do to make a binary rpm using the spec file lyx.spec.
 The description below apply only to the Intel platform, but only minor
 changes should be needed for other platforms.
 
-1) Install xforms-88 or later. You can find an xforms-0.88 rpm
+1) Install qt-4.1.1 or later. If you are using RPMs, make sure to install
-at
+   the qt-devel packages as well.
 
-ftp://moni.msci.memphis.edu/pub
+2) Install LaTeX. You can do this using RPMs from your distribution that
+   might be splitted in multiple packages (e.g. tetex-xdvi, tetex, 
+   tetex-latex), or you can install TeXLive straight from the DVD.
 
-2) Install LaTeX.  You can do this using rpms (you need tetex-xdvi,
+3) Copy lyx.spec to the SPECS directory (on Redhat, this is located at
-tetex, tetex-latex) from your RH distribution.
+   /usr/src/redhat/SPECS, on other systems at /usr/src/packages/SPECS)
 
-3) Copy lyx.spec to /usr/src/redhat/SPECS
+4) Copy lyx-1.5.2.tar.gz to your SOURCES directory (located in the same
-
+   path as SPECS, e.g. /usr/src/packages/SOURCES)
-4) Copy lyx-1.0.0.tar.gz to /usr/src/redhat/SOURCES
 
 5) Issue the command
 
-	rpm -bb /usr/src/redhat/SPECS/lyx.spec
+	rpmbuild -bb /usr/src/packages/SPECS/lyx.spec
 
-This builds the binary rpm, and puts it in /usr/src/redhat/RPMS/i386.
+(adjust the path if needed)
-Note that building lyx requires about 35M free space on your disk.
+
+This builds the binary rpm, and puts it in /usr/src/packages/RPMS/i386
+(alternatively in /i586 or /x86_64, depending on your system).
+Note that building lyx requires about 150M free space on your disk.
 
 6) Now install the package:
 
-	rpm -Uvh /usr/src/redhat/RPMS/i386/lyx-1.0.0-1.i386.rpm
+	rpm -Uvh /usr/src/redhat/RPMS/i386/lyx-1.5.2-1.i386.rpm
 
-If you get dependency errors about xforms or tetex, then you need to
+(again, adjust the path and filename if needed)
-use the --nodeps option (because you installed xforms or tetex not in
+
+If you get dependency errors about qt4 or tetex/texlive, then you need to
+use the --nodeps option (because you installed qt4 or TeX not in
 rpm form):
 
-        rpm -Uvh --nodeps /usr/src/redhat/RPMS/i386/lyx-1.0.0-1.i386.rpm
+        rpm -Uvh --nodeps /usr/src/redhat/RPMS/i386/lyx-1.5.2-1.i386.rpm
+
+(again, adjust the path and filename if needed)
 
 You should not get any more errors.