Update release notes again

[lyx.git] / lib / RELEASE-NOTES

diff --git a/lib/RELEASE-NOTES b/lib/RELEASE-NOTES
index 9da7d8cec1e3053f37d7e94b0f62b699f4eb1200..c3b89d3eb1f1d2dd46501bc2b837c9bb52ba1781 100644 (file)
--- a/lib/RELEASE-NOTES
+++ b/lib/RELEASE-NOTES
@@ -14,27 +14,55 @@
   while noting that menu shortcuts can always be customized by copying the
   stdmenus.inc file to the user directory and editing it.
 
   while noting that menu shortcuts can always be customized by copying the
   stdmenus.inc file to the user directory and editing it.
 

+* Backspace will now merge paragraphs even when they have different layouts.
+
+* Ctrl-click on a cross-reference will now take you to its label.
+
+* Default shortcuts for saving bookmarks have been changed to Alt-NUM, where
+  NUM is the number of the bookmark. (They were previously Shift-F1, etc.) 
+
+* This allows Shift-F3 to be used for word-find-backwards (i.e., find previous)
+  on Linux and Windows.
+
+* The shortcut for word-find on OSX is now Cmd-E, as is the Apple standard. The
+  shortcut for word-find-previous is Cmd-G.
+

 
 !!Documents compilation process and images conversion
 
 
 !!Documents compilation process and images conversion
 

-* LyX now uses utf8 encoding per default for all languages. This does not affect
-  existing documents. Note that LyX also does not touch personal defaults and templates.
-  That is to say, if you still see traditional encoding preset for new documents,
-  you can change that by selecting "Unicode (utf8) [default]" and hitting "Save
-  as Documents Defaults" afterwards. Your personal templates need to be changed manually
-  if desired.
+* LyX now uses utf8 encoding per default for all languages. This does
+  not affect existing documents. Note that LyX also does not touch
+  personal defaults and templates. That is to say, if you still see
+  traditional encoding preset for new documents, you can change that
+  by selecting "Unicode (utf8) [default]" and hitting "Save as
+  Documents Defaults" afterwards. Your personal templates need to be
+  changed manually if desired.

 
 * LyX defaults to the "HE8" LaTeX font encoding with Hebrew if the
   "Culmus" LaTeX fonts are installed.
 
 * Documents that use TeX fonts can only be compiled with XeTeX if the input
   encoding is set to "utf8-plain" or "ascii".
 
 * LyX defaults to the "HE8" LaTeX font encoding with Hebrew if the
   "Culmus" LaTeX fonts are installed.
 
 * Documents that use TeX fonts can only be compiled with XeTeX if the input
   encoding is set to "utf8-plain" or "ascii".

+  
+* DocBook support has been revamped and now targets DocBook 5 (i.e. 
+  only XML, SGML is gone). Some supporting files for the previous 
+  implementation have been removed: all examples (lib/examples), 
+  some layouts (existing documents should still work, but with a 
+  DocBook 5 output instead of DocBook 4 SGML). The dependency on 
+  sgmltools has been removed, this new support is always enabled.
+  Having sgmltools installed or not will not change anything in LyX.

 
 !!!The following pref variables were added in 2.4:
 
 * \ct_additions_underlined true|false: determines whether additions in change tracking
   are underlined in the workarea (default: true).
 
 
 !!!The following pref variables were added in 2.4:
 
 * \ct_additions_underlined true|false: determines whether additions in change tracking
   are underlined in the workarea (default: true).
 

+* \ct_markup_copied true|false: determines whether change tracking markup should be
+  preserved on copy/paste (default: false).
+
+* \citation_search_view lyxpaperview: determines whether external script "lyxpaperview"
+  should be used for looking up citation source.
+

 
 !!!The following pref variables were changed in 2.4:
 
 
 !!!The following pref variables were changed in 2.4:
 


@@ -69,11 +97,22 @@
 
 * export-cancel: Used to cancel background export processes.
 
 
 * export-cancel: Used to cancel background export processes.
 

+* ifrelatives is a helper function to check whether a buffer has a master or children.
+
+* lyxfiles-open opens the new examples or templates dialog.
+

 * master-buffer-forall executes an lfun in the master and all children of a document.
 
 * paragraph-select is a new convenience function to select the paragraph
   surrounding the actual cursor position.
 
 * master-buffer-forall executes an lfun in the master and all children of a document.
 
 * paragraph-select is a new convenience function to select the paragraph
   surrounding the actual cursor position.
 

+* search-string-set [arg] stores the <arg>, the currently selected text or the word under
+  cursor in the search cache that is used by word-find[-backward|-forward] if no argument
+  is given to those.
+
+* inset-split is a new convenience function that splits an inset into two at the given
+  cursor position. This is only implemented for text insets currently.
+

 * tabular-style-insert: Insert a table in a specified style.
 
 
 * tabular-style-insert: Insert a table in a specified style.
 
 


@@ -92,6 +131,10 @@
 
 * date-insert: obsoleted by info-insert date.
 
 
 * date-insert: obsoleted by info-insert date.
 

+!!!The following LyX function has been added and then removed in 2.4 development cycle.
+
+* bidi: used as a first solution to provide icons that change
+  direction with language.

 
 
 !!!The following LyX documents have been moved in 2.4:
 
 
 !!!The following LyX documents have been moved in 2.4:


@@ -126,6 +169,25 @@
 * The Qt5 libraries are now used by default. In order to link against
   Qt4 the configure option --disable-qt5 has to be used.
 
 * The Qt5 libraries are now used by default. In order to link against
   Qt4 the configure option --disable-qt5 has to be used.
 

+* The dependency on pplatex/dvipost was dropped.
+
+* The dependency on sgmltools was dropped, see DocBook 5 section.
+
+!!! Dependencies to generate ePub files:
+
+* The DocBook XSLT 1.0 style sheets are a required dependency to generate
+  ePub files. All versions since 1.76.0 are supported. Version 1.79.2 is
+  bundled with LyX.
+
+* XSLT processor is needed, two options were successfully tested
+  a) xsltproc
+     - Works on Linux and OSX (tested with xsltproc 1.1.32).
+     - Fails on Windows.
+  b) Saxon
+     - Tested on Linux, OSX and Windows.
+     - Java is a required dependency. Any JVM for Java 1.4 should be supported.
+     - Only Saxon versions 6.5.4 and 6.5.5 are supported.
+     - Version 6.5.5 is bundled with LyX.

 
 
 !!Known issues in version 2.4.0
 
 
 !!Known issues in version 2.4.0


@@ -138,13 +200,17 @@
 * Autotools monolithic build option for building LyX binaries was removed,
   for compilation speedup use parallel building on multiple cores instead.
 
 * 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
 * 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.
+  delivering the fonts as a separated package dependent from core LyX
+  in order to display correctly math symbols like \oint.
+
+  Also note, that while it is still possible to compile LyX against Qt 4
+  these math symbols will not be displayed correctly anymore on Qt 4.
+
+!! 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