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