Add some release notes

[lyx.git] / lib / RELEASE-NOTES

diff --git a/lib/RELEASE-NOTES b/lib/RELEASE-NOTES
index 45aaabea929a24519dca453507e2d579869d8064..9d52b53c48d2f60b66192484291f47414567162c 100644 (file)
--- a/lib/RELEASE-NOTES
+++ b/lib/RELEASE-NOTES
@@ -3,6 +3,9 @@
 
 !!Interface changes
 
+- It is now possible to cancel background export processes. A menu entry
+  to do so will appear on the Document menu when such a process is underway.
+  The LFUN for this is export-cancel.
 
 
 !!Documents compilation process and images conversion
@@ -19,24 +22,59 @@
 
 !!!The following pref variables are obsoleted in 2.4:
 
+* \font_encoding
+  The font encoding is now automatically set depending on the document
+  fonts and languages.
+
 * \use_qimage
   This is no longer necessary due to the rewrite of the painter.
 
+* \use_pixmap_cacheqimage
+  There is no evidence that this painting mode was useful anymore.
+
+* \date_insert_format
+  The function date-insert has been removed and superseded by info-insert date.
+  The latter does not need a pref value anymore.
+
 
 !!!The following new LyX functions have been introduced in 2.4:
 
+* buffer-write-as-template is a new convenient function to ease saving a document
+  in the (personal) templates folder.
+
+* export-cancel: Used to cancel background export processes.
 
 
 !!!The following LyX functions have been changed in 2.4:
 
+* set-graphics-group was renamed to graphics-set-group.
+
+* info-insert buffer vcs-*: renamed to info-insert vcs *
+
+
+!!!The following LyX functions have been removed in 2.4:
+
+* date-insert: obsoleted by info-insert date.
+
 
 
 !!!The following LyX documents have been moved in 2.4:
 
+* As a result of a major restructuring of the templates and example
+  directories, almost all examples and templates files have been renamed and
+  moved to subfolders that reflect the layout category.
+  The files now have much more decriptive (and longer) names, and they use
+  URL encoding for specific special characters such as '(', ')' and '&'.
+  Notably also the file that opens for new users has been renamed (from
+  splash.lyx to Welcome.lyx).
 
 
 !!!The following new folders have been added to the LyX directory
 
+* The examples and templates directories have been completely re-organized.
+  They are now much more structured (by means of layout categories) and thus
+  consist of many new subfolders. 
+
 
 
 !!!The following preferences files have been removed from the tarball in 2.4:
@@ -49,6 +87,9 @@
 
 !!Changes with respect to external programs and libraries in 2.4:
 
+* The Qt5 libraries are now used by default. In order to link against
+  Qt4 the configure option --disable-qt5 has to be used.
+
 
 
 !!Known issues in version 2.4.0
@@ -58,4 +99,16 @@
 
 !!Caveats when upgrading from earlier versions to 2.4.x
 
+* Autotools monolithic build option for building LyX binaries was removed,
+  for compilation speedup use parallel building on multiple cores instead.
+
+!! If upgrading from a LyX version before 2.3.0
+
+* Please additionally see the release notes from the versions in-between:
+  https://wiki.lyx.org/LyX/ReleaseNotes
 
+* Several ttf fonts (esint10.ttf, stmary10.ttf, wasy10.ttf) were changed
+  to reflect the fact that newer Qt libraries do not support displaying certain
+  codepoints anymore (bug #8493, #10161). 
+  Distribution packagers need to repack those font files in case they are
+  delivering the fonts as a separated package dependent from core LyX.