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