lib/RELEASE-NOTES

   1 !Important Changes in LyX 2.4.0
   2
   3
   4 !!Interface changes
   5
   6 * It is now possible to cancel background export processes. A menu entry
   7   to do so will appear on the Document menu when such a process is underway.
   8   The LFUN for this is export-cancel. One can also click on the 'spinner'
   9   to cancel export.
  10
  11 * The items on the Edit menu have been reordered, and many of the shortcuts
  12   have been changed so that they are more intuitive in the case of often
  13   used items. We understand that this may frustrate some users and apologize,
  14   while noting that menu shortcuts can always be customized by copying the
  15   stdmenus.inc file to the user directory and editing it.
  16
  17 * Backspace will now merge paragraphs even when they have different layouts.
  18
  19 * Ctrl-click on a cross-reference will now take you to its label.
  20
  21 * Default shortcuts for saving bookmarks have been changed to Alt-NUM, where
  22   NUM is the number of the bookmark. (They were previously Shift-F1, etc.)
  23
  24 * Shift-F3 can be used for word-find-backwards (i.e., find previous) on Linux
  25   and Windows.
  26
  27 * The shortcut to use the selection for a find on macOS is now Cmd-E, as is the
  28   Apple standard.  The shortcut for find the next occurrence of the current
  29   find buffer text is Cmd-G.  The shortcut for toggle of font emphasis has been
  30   changed to Cmd-Ctrl-E.
  31
  32 * Continuous spellcheck is now on by default, but only if the user does not have
  33   an existing preferences file. In that case, the old setting is preserved.
  34
  35 * Document (or selection statistics) is now shown in status bar and can be
  36   disabled by the context menu.
  37
  38 * The actual enabled state of the synchronize TeX output option of the document
  39   is used to enable or disable the menu item for forward-search.
  40
  41 !!Documents compilation process and images conversion
  42
  43 * LyX now uses utf8 encoding per default for all languages. This does
  44   not affect existing documents. Note that LyX also does not touch
  45   personal defaults and templates. That is to say, if you still see
  46   traditional encoding preset for new documents, you can change that
  47   by selecting "Unicode (utf8) [default]" and hitting "Save as
  48   Documents Defaults" afterwards. Your personal templates need to be
  49   changed manually if desired.
  50
  51 * LyX defaults to the "HE8" LaTeX font encoding with Hebrew if the
  52   "Culmus" LaTeX fonts are installed.
  53
  54 * Documents that use TeX fonts can only be compiled with XeTeX if the input
  55   encoding is set to "utf8-plain" or "ascii".
  56
  57 * DocBook support has been revamped and now targets DocBook 5 (i.e.
  58   only XML, SGML is gone). Some supporting files for the previous
  59   implementation have been removed: all examples (lib/examples),
  60   some layouts (existing documents should still work, but with a
  61   DocBook 5 output instead of DocBook 4 SGML). The dependency on
  62   sgmltools has been removed, this new support is always enabled.
  63   Having sgmltools installed or not will not change anything in LyX.
  64
  65 !!!The following pref variables were added in 2.4:
  66
  67 * \ct_additions_underlined true|false: determines whether additions in change tracking
  68   are underlined in the workarea (default: true).
  69
  70 * \ct_markup_copied true|false: determines whether change tracking markup should be
  71   preserved on copy/paste (default: false).
  72
  73 * \citation_search_view lyxpaperview: determines whether external script "lyxpaperview"
  74   should be used for looking up citation source.
  75
  76 * \draw_strategy partial|backingstore: when this is set to
  77   "backingstore", the drawing code will force the use of an
  78   intermediate surface, instead of just drawing changed regions on
  79   screen. Note that "backingstore" is actually always enforced on
  80   macOS and Wayland (default: partial).
  81
  82 * \screen_limit true|false: determines whether the text width on screen is limited
  83   (both fullscreen and normal view).
  84
  85 * \screen_width <length>: sets the width of the text on screen if \screen_limit is true.
  86
  87 !!!The following pref variables were changed in 2.4:
  88
  89
  90
  91 !!!The following pref variables are obsoleted in 2.4:
  92
  93 * \font_encoding
  94   The font encoding is now automatically set depending on the document
  95   fonts and languages.
  96
  97 * \fullscreen_limit
  98   Removed in favor of \screen_limit
  99
 100 * \fullscreen_width
 101   Removed in favor of \screen_width
 102
 103 * \use_qimage
 104   This is no longer necessary due to the rewrite of the painter.
 105
 106 * \use_pixmap_cacheqimage
 107   There is no evidence that this painting mode was useful anymore.
 108
 109 * \date_insert_format
 110   The function date-insert has been removed and superseded by info-insert date.
 111   The latter does not need a pref value anymore.
 112
 113
 114 !!!The following new LyX functions have been introduced in 2.4:
 115
 116 * buffer-reset-export advises LyX to remove the auxiliary files before doing the next
 117   export.
 118
 119 * buffer-write-as-template is a new convenience function to ease saving a document
 120   in the (personal) templates folder.
 121
 122 * export-cancel: Used to cancel background export processes.
 123
 124 * font-nospellcheck marks the word under cursor or selection to the effect that the
 125   spellchecker ignores it.
 126
 127 * ifrelatives is a helper function to check whether a buffer has a master or children.
 128
 129 * lyxfiles-open opens the new examples or templates dialog.
 130
 131 * master-buffer-forall executes an lfun in the master and all children of a document.
 132
 133 * paragraph-select is a new convenience function to select the paragraph
 134   surrounding the actual cursor position.
 135
 136 * search-string-set [arg] stores the <arg>, the currently selected text or the word under
 137   cursor in the search cache that is used by word-find[-backward|-forward] if no argument
 138   is given to those.
 139
 140 * spelling-add-local adds words for a given language to the document's local spelling
 141   dictionary.
 142
 143 * spelling-remove-local removes words for a given language from the document's local
 144   spelling dictionary.
 145
 146 * index-tag-all adds a copy of the index entry under cursor to after all occurrences of the
 147   word that precedes the index inset.
 148
 149 * inset-insert-copy inserts the inset's content (in ToC pane) at the position of the cursor.
 150
 151 * inset-split is a new convenience function that splits an inset into two at the given
 152   cursor position. This is only implemented for text insets currently.
 153
 154 * tabular-style-insert: Insert a table in a specified style.
 155
 156
 157 !!!The following LyX functions have been changed in 2.4:
 158
 159 * set-graphics-group was renamed to graphics-set-group.
 160
 161 * info-insert buffer vcs-*: renamed to info-insert vcs *
 162
 163 * file-insert: optional second parameter "ignorelang" to make the insertion
 164   ignore the inserted file's main language (and rather adapt it to the insertion
 165   context's language).
 166
 167 * tabular-feature: added toggle parameters "toggle-all-lines", "toggle-border-lines"
 168   and "toggle-inner-lines"
 169
 170 * branch-sync-all: Open/close all insets of selected branch (depending on its activation status).
 171
 172
 173 !!!The following LyX functions have been removed in 2.4:
 174
 175 * date-insert: obsoleted by info-insert date.
 176
 177 !!!The following LyX function has been added and then removed in 2.4 development cycle.
 178
 179 * bidi: used as a first solution to provide icons that change
 180   direction with language.
 181
 182
 183 !!!The following LyX documents have been moved in 2.4:
 184
 185 * As a result of a major restructuring of the templates and example
 186   directories, almost all examples and templates files have been renamed and
 187   moved to subfolders that reflect the layout category.
 188   The files now have much more decriptive (and longer) names, and they use
 189   URL encoding for specific special characters such as '(', ')' and '&'.
 190   Notably also the file that opens for new users has been renamed (from
 191   splash.lyx to Welcome.lyx).
 192
 193
 194 !!!The following new folders have been added to the LyX directory
 195
 196 * The examples and templates directories have been completely re-organized.
 197   They are now much more structured (by means of layout categories) and thus
 198   consist of many new subfolders.
 199
 200
 201
 202 !!!The following preferences files have been removed from the tarball in 2.4:
 203
 204
 205
 206 !!!The following metadata files have been added to the tarball in 2.4:
 207
 208 * Metainfo was updated from appdata.xml to org.lyx.LyX.metainfo.xml
 209   and is by default installed to /usr/share/metainfo/ per freedesktop.org
 210   recommendation.
 211
 212
 213 !!Changes with respect to external programs and libraries in 2.4:
 214
 215 * The Qt5 libraries are now used by default. In order to link against
 216   Qt4 the configure option --disable-qt5 has to be used.
 217
 218 * The dependency on pplatex/dvipost was dropped.
 219
 220 * The dependency on sgmltools was dropped, see DocBook 5 section.
 221
 222 !!! Dependencies to generate ePub files:
 223
 224 * The DocBook XSLT 1.0 style sheets are a required dependency to generate
 225   ePub files. All versions since 1.76.0 are supported.
 226
 227   Version 1.79.2 is bundled with LyX. If your system already provides xslt
 228   style sheets you can use configure parameter --without-xslt-stylesheets to
 229   avoid installing them.
 230
 231
 232 * XSLT processor is needed, two options were successfully tested
 233   a) xsltproc
 234      - Works on Linux and OSX (tested with xsltproc 1.1.32).
 235      - Fails on Windows.
 236   b) Saxon
 237      - Tested on Linux, OSX and Windows.
 238      - Java is a required dependency. Any JVM for Java 1.4 should be supported.
 239      - Only Saxon versions 6.5.4 and 6.5.5 are supported.
 240      - Version 6.5.5 is bundled with LyX. If your system already provides Saxon
 241        (or xsltproc) you can use configure parameter --without-saxon to avoid
 242        installation of this library.
 243
 244 * bash_completion script was updated for a newer syntax.
 245
 246
 247 !!Known issues in version 2.4.0
 248
 249 * See http://www.lyx.org/trac/wiki/BugTrackerHome
 250
 251
 252 !!Caveats when upgrading from earlier versions to 2.4.x
 253
 254 * LyX now uses the parskip package for vertical paragraph separation. Since the
 255   output differs from the previous (sub-optimal) approach which applied paragraph
 256   separation to sections, lists etc. as well, existing documents
 257   are converted to use preamble code that maintains the previous layout.
 258   The downside is that the workarea looks as if paragraph indendation rather
 259   than paragraph separation was used (output is correct). We encourage you
 260   to try if the new layout suits you, remove the respective preamble code
 261   and re-set the paragraph separation to use the new layout.
 262
 263 * Autotools monolithic build option for building LyX binaries was removed,
 264   for compilation speedup use parallel building on multiple cores instead.
 265
 266 * Several ttf fonts (esint10.ttf, stmary10.ttf, wasy10.ttf) were changed
 267   to reflect the fact that newer Qt libraries do not support displaying certain
 268   codepoints anymore (bug #8493, #10161).
 269   Distribution packagers need to repack those font files in case they are
 270   delivering the fonts as a separated package dependent from core LyX
 271   in order to display correctly math symbols like \oint.
 272
 273   Also note, that while it is still possible to compile LyX against Qt 4
 274   these math symbols will not be displayed correctly anymore on Qt 4.
 275
 276 !! If upgrading from a LyX version before 2.3.0
 277
 278 * Please additionally see the release notes from the versions in-between:
 279   https://wiki.lyx.org/LyX/ReleaseNotes