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
  18 !!Documents compilation process and images conversion
  19
  20 * LyX now uses utf8 encoding per default for all languages. This does not affect
  21   existing documents. Note that LyX also does not touch personal defaults and templates.
  22   That is to say, if you still see traditional encoding preset for new documents,
  23   you can change that by selecting "Unicode (utf8) [default]" and hitting "Save
  24   as Documents Defaults" afterwards. Your personal templates need to be changed manually
  25   if desired.
  26
  27 * LyX defaults to the "HE8" LaTeX font encoding with Hebrew if the
  28   "Culmus" LaTeX fonts are installed.
  29
  30 * Documents that use TeX fonts can only be compiled with XeTeX if the input
  31   encoding is set to "utf8-plain" or "ascii".
  32
  33 !!!The following pref variables were added in 2.4:
  34
  35 * \ct_additions_underlined true|false: determines whether additions in change tracking
  36   are underlined in the workarea (default: true).
  37
  38
  39 !!!The following pref variables were changed in 2.4:
  40
  41
  42
  43 !!!The following pref variables are obsoleted in 2.4:
  44
  45 * \font_encoding
  46   The font encoding is now automatically set depending on the document
  47   fonts and languages.
  48
  49 * \use_qimage
  50   This is no longer necessary due to the rewrite of the painter.
  51
  52 * \use_pixmap_cacheqimage
  53   There is no evidence that this painting mode was useful anymore.
  54
  55 * \date_insert_format
  56   The function date-insert has been removed and superseded by info-insert date.
  57   The latter does not need a pref value anymore.
  58
  59
  60 !!!The following new LyX functions have been introduced in 2.4:
  61
  62 * bidi is a helper function to implement icons that are different between LTR and RTL text.
  63
  64 * buffer-reset-export advises LyX to remove the auxiliary files before doing the next
  65   export.
  66
  67 * buffer-write-as-template is a new convenience function to ease saving a document
  68   in the (personal) templates folder.
  69
  70 * export-cancel: Used to cancel background export processes.
  71
  72 * ifrelatives is a helper function to check whether a buffer has a master or children.
  73
  74 * master-buffer-forall executes an lfun in the master and all children of a document.
  75
  76 * paragraph-select is a new convenience function to select the paragraph
  77   surrounding the actual cursor position.
  78
  79 * tabular-style-insert: Insert a table in a specified style.
  80
  81
  82 !!!The following LyX functions have been changed in 2.4:
  83
  84 * set-graphics-group was renamed to graphics-set-group.
  85
  86 * info-insert buffer vcs-*: renamed to info-insert vcs *
  87
  88 * file-insert: optional second parameter "ignorelang" to make the insertion
  89   ignore the inserted file's main language (and rather adapt it to the insertion
  90   context's language).
  91
  92
  93 !!!The following LyX functions have been removed in 2.4:
  94
  95 * date-insert: obsoleted by info-insert date.
  96
  97
  98
  99 !!!The following LyX documents have been moved in 2.4:
 100
 101 * As a result of a major restructuring of the templates and example
 102   directories, almost all examples and templates files have been renamed and
 103   moved to subfolders that reflect the layout category.
 104   The files now have much more decriptive (and longer) names, and they use
 105   URL encoding for specific special characters such as '(', ')' and '&'.
 106   Notably also the file that opens for new users has been renamed (from
 107   splash.lyx to Welcome.lyx).
 108
 109
 110 !!!The following new folders have been added to the LyX directory
 111
 112 * The examples and templates directories have been completely re-organized.
 113   They are now much more structured (by means of layout categories) and thus
 114   consist of many new subfolders.
 115
 116
 117
 118 !!!The following preferences files have been removed from the tarball in 2.4:
 119
 120
 121
 122 !!!The following metadata files have been added to the tarball in 2.4:
 123
 124
 125
 126 !!Changes with respect to external programs and libraries in 2.4:
 127
 128 * The Qt5 libraries are now used by default. In order to link against
 129   Qt4 the configure option --disable-qt5 has to be used.
 130
 131
 132
 133 !!Known issues in version 2.4.0
 134
 135 * See http://www.lyx.org/trac/wiki/BugTrackerHome
 136
 137
 138 !!Caveats when upgrading from earlier versions to 2.4.x
 139
 140 * Autotools monolithic build option for building LyX binaries was removed,
 141   for compilation speedup use parallel building on multiple cores instead.
 142
 143 !! If upgrading from a LyX version before 2.3.0
 144
 145 * Please additionally see the release notes from the versions in-between:
 146   https://wiki.lyx.org/LyX/ReleaseNotes
 147
 148 * Several ttf fonts (esint10.ttf, stmary10.ttf, wasy10.ttf) were changed
 149   to reflect the fact that newer Qt libraries do not support displaying certain
 150   codepoints anymore (bug #8493, #10161).
 151   Distribution packagers need to repack those font files in case they are
 152   delivering the fonts as a separated package dependent from core LyX.