Introduce index-tag-all lfun

[features.git] / lib / RELEASE-NOTES

diff --git a/lib/RELEASE-NOTES b/lib/RELEASE-NOTES
index 6cfec8acf137250eb981fb705ca5bc43862cbbec..3c211a2025d7de4f47ce2a792f38cbf55c658417 100644 (file)
--- a/lib/RELEASE-NOTES
+++ b/lib/RELEASE-NOTES
@@ -16,6 +16,27 @@
 
 * Backspace will now merge paragraphs even when they have different layouts.
 
 
 * 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 to use the selection for a find on macOS is now Cmd-E, as is the
+  Apple standard.  The shortcut for find the next occurrence of the current
+  find buffer text is Cmd-G.  The shortcut for toggle of font emphasis has been
+  changed to Cmd-Ctrl-E.
+
+* Continuous spellcheck is now on by default, but only if the user does not have
+  an existing preferences file. In that case, the old setting is preserved.
+
+* Document (or selection statistics) is now shown in status bar and can be
+  disabled by the context menu.
+
+* The actual enabled state of the synchronize TeX output option of the document
+  is used to enable or disable the menu item for forward-search.

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


@@ -32,12 +53,12 @@
 
 * Documents that use TeX fonts can only be compiled with XeTeX if the input
   encoding is set to "utf8-plain" or "ascii".
 
 * 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 
+
+* 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.
 
   sgmltools has been removed, this new support is always enabled.
   Having sgmltools installed or not will not change anything in LyX.
 


@@ -52,6 +73,16 @@
 * \citation_search_view lyxpaperview: determines whether external script "lyxpaperview"
   should be used for looking up citation source.
 
 * \citation_search_view lyxpaperview: determines whether external script "lyxpaperview"
   should be used for looking up citation source.
 

+* \draw_strategy partial|backingstore: when this is set to
+  "backingstore", the drawing code will force the use of an
+  intermediate surface, instead of just drawing changed regions on
+  screen. Note that "backingstore" is actually always enforced on
+  macOS and Wayland (default: partial).
+
+* \screen_limit true|false: determines whether the text width on screen is limited
+  (both fullscreen and normal view).
+
+* \screen_width <length>: sets the width of the text on screen if \screen_limit is true.

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


@@ -63,6 +94,12 @@
   The font encoding is now automatically set depending on the document
   fonts and languages.
 
   The font encoding is now automatically set depending on the document
   fonts and languages.
 

+* \fullscreen_limit
+  Removed in favor of \screen_limit
+
+* \fullscreen_width
+  Removed in favor of \screen_width
+

 * \use_qimage
   This is no longer necessary due to the rewrite of the painter.
 
 * \use_qimage
   This is no longer necessary due to the rewrite of the painter.
 


@@ -76,8 +113,6 @@
 
 !!!The following new LyX functions have been introduced in 2.4:
 
 
 !!!The following new LyX functions have been introduced in 2.4:
 

-* bidi is a helper function to implement icons that are different between LTR and RTL text. 
-

 * buffer-reset-export advises LyX to remove the auxiliary files before doing the next
   export.
 
 * buffer-reset-export advises LyX to remove the auxiliary files before doing the next
   export.
 


@@ -86,13 +121,36 @@
 
 * export-cancel: Used to cancel background export processes.
 
 
 * export-cancel: Used to cancel background export processes.
 

+* font-nospellcheck marks the word under cursor or selection to the effect that the
+  spellchecker ignores it.
+

 * ifrelatives is a helper function to check whether a buffer has a master or children.
 
 * 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.
+
+* spelling-add-local adds words for a given language to the document's local spelling
+  dictionary.
+
+* spelling-remove-local removes words for a given language from the document's local
+  spelling dictionary.
+
+* index-tag-all adds a copy of the index entry under cursor to after all occurrences of the
+  word that precedes the index inset.
+  
+* inset-insert-copy inserts the inset's content (in ToC pane) at the position of the cursor.
+
+* 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.
 
 


@@ -106,6 +164,11 @@
   ignore the inserted file's main language (and rather adapt it to the insertion
   context's language).
 
   ignore the inserted file's main language (and rather adapt it to the insertion
   context's language).
 

+* tabular-feature: added toggle parameters "toggle-all-lines", "toggle-border-lines"
+  and "toggle-inner-lines"
+
+* branch-sync-all: Open/close all insets of selected branch (depending on its activation status).
+

 
 !!!The following LyX functions have been removed in 2.4:
 
 
 !!!The following LyX functions have been removed in 2.4:
 


@@ -132,7 +195,7 @@
 
 * The examples and templates directories have been completely re-organized.
   They are now much more structured (by means of layout categories) and thus
 
 * 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. 
+  consist of many new subfolders.

 
 
 
 
 
 


@@ -142,6 +205,9 @@
 
 !!!The following metadata files have been added to the tarball in 2.4:
 
 
 !!!The following metadata files have been added to the tarball in 2.4:
 

+* Metainfo was updated from appdata.xml to org.lyx.LyX.metainfo.xml
+  and is by default installed to /usr/share/metainfo/ per freedesktop.org
+  recommendation.

 
 
 !!Changes with respect to external programs and libraries in 2.4:
 
 
 !!Changes with respect to external programs and libraries in 2.4:


@@ -153,6 +219,30 @@
 
 * The dependency on sgmltools was dropped, see DocBook 5 section.
 
 
 * 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. If your system already provides xslt
+  style sheets you can use configure parameter --without-xslt-stylesheets to
+  avoid installing them.
+
+
+* 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. If your system already provides Saxon
+       (or xsltproc) you can use configure parameter --without-saxon to avoid
+       installation of this library.
+
+* bash_completion script was updated for a newer syntax.
+

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


@@ -161,12 +251,21 @@
 
 !!Caveats when upgrading from earlier versions to 2.4.x
 
 
 !!Caveats when upgrading from earlier versions to 2.4.x
 

+* LyX now uses the parskip package for vertical paragraph separation. Since the
+  output differs from the previous (sub-optimal) approach which applied paragraph
+  separation to sections, lists etc. as well, existing documents
+  are converted to use preamble code that maintains the previous layout.
+  The downside is that the workarea looks as if paragraph indendation rather
+  than paragraph separation was used (output is correct). We encourage you
+  to try if the new layout suits you, remove the respective preamble code
+  and re-set the paragraph separation to use the new layout.
+

 * Autotools monolithic build option for building LyX binaries was removed,
   for compilation speedup use parallel building on multiple cores instead.
 
 * Several ttf fonts (esint10.ttf, stmary10.ttf, wasy10.ttf) were changed
   to reflect the fact that newer Qt libraries do not support displaying certain
 * Autotools monolithic build option for building LyX binaries was removed,
   for compilation speedup use parallel building on multiple cores instead.
 
 * 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). 
+  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
   in order to display correctly math symbols like \oint.
   Distribution packagers need to repack those font files in case they are
   delivering the fonts as a separated package dependent from core LyX
   in order to display correctly math symbols like \oint.