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