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