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