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
  22 !!Documents compilation process and images conversion
  23
  24 * LyX now uses utf8 encoding per default for all languages. This does
  25   not affect existing documents. Note that LyX also does not touch
  26   personal defaults and templates. That is to say, if you still see
  27   traditional encoding preset for new documents, you can change that
  28   by selecting "Unicode (utf8) [default]" and hitting "Save as
  29   Documents Defaults" afterwards. Your personal templates need to be
  30   changed manually if desired.
  31
  32 * LyX defaults to the "HE8" LaTeX font encoding with Hebrew if the
  33   "Culmus" LaTeX fonts are installed.
  34
  35 * Documents that use TeX fonts can only be compiled with XeTeX if the input
  36   encoding is set to "utf8-plain" or "ascii".
  37
  38 * DocBook support has been revamped and now targets DocBook 5 (i.e.
  39   only XML, SGML is gone). Some supporting files for the previous
  40   implementation have been removed: all examples (lib/examples),
  41   some layouts (existing documents should still work, but with a
  42   DocBook 5 output instead of DocBook 4 SGML). The dependency on
  43   sgmltools has been removed, this new support is always enabled.
  44   Having sgmltools installed or not will not change anything in LyX.
  45
  46 !!!The following pref variables were added in 2.4:
  47
  48 * \ct_additions_underlined true|false: determines whether additions in change tracking
  49   are underlined in the workarea (default: true).
  50
  51 * \ct_markup_copied true|false: determines whether change tracking markup should be
  52   preserved on copy/paste (default: false).
  53
  54 * \citation_search_view lyxpaperview: determines whether external script "lyxpaperview"
  55   should be used for looking up citation source.
  56
  57
  58 !!!The following pref variables were changed in 2.4:
  59
  60
  61
  62 !!!The following pref variables are obsoleted in 2.4:
  63
  64 * \font_encoding
  65   The font encoding is now automatically set depending on the document
  66   fonts and languages.
  67
  68 * \use_qimage
  69   This is no longer necessary due to the rewrite of the painter.
  70
  71 * \use_pixmap_cacheqimage
  72   There is no evidence that this painting mode was useful anymore.
  73
  74 * \date_insert_format
  75   The function date-insert has been removed and superseded by info-insert date.
  76   The latter does not need a pref value anymore.
  77
  78
  79 !!!The following new LyX functions have been introduced in 2.4:
  80
  81 * bidi is a helper function to implement icons that are different between LTR and RTL text.
  82
  83 * buffer-reset-export advises LyX to remove the auxiliary files before doing the next
  84   export.
  85
  86 * buffer-write-as-template is a new convenience function to ease saving a document
  87   in the (personal) templates folder.
  88
  89 * export-cancel: Used to cancel background export processes.
  90
  91 * ifrelatives is a helper function to check whether a buffer has a master or children.
  92
  93 * lyxfiles-open opens the new examples or templates dialog.
  94
  95 * master-buffer-forall executes an lfun in the master and all children of a document.
  96
  97 * paragraph-select is a new convenience function to select the paragraph
  98   surrounding the actual cursor position.
  99
 100 * search-string-set [arg] stores the <arg>, the currently selected text or the word under
 101   cursor in the search cache that is used by word-find[-backward|-forward] if no argument
 102   is given to those.
 103
 104 * inset-split is a new convenience function that splits an inset into two at the given
 105   cursor position. This is only implemented for text insets currently.
 106
 107 * tabular-style-insert: Insert a table in a specified style.
 108
 109
 110 !!!The following LyX functions have been changed in 2.4:
 111
 112 * set-graphics-group was renamed to graphics-set-group.
 113
 114 * info-insert buffer vcs-*: renamed to info-insert vcs *
 115
 116 * file-insert: optional second parameter "ignorelang" to make the insertion
 117   ignore the inserted file's main language (and rather adapt it to the insertion
 118   context's language).
 119
 120
 121 !!!The following LyX functions have been removed in 2.4:
 122
 123 * date-insert: obsoleted by info-insert date.
 124
 125 !!!The following LyX function has been added and then removed in 2.4 development cycle.
 126
 127 * bidi: used as a first solution to provide icons that change
 128   direction with language.
 129
 130
 131 !!!The following LyX documents have been moved in 2.4:
 132
 133 * As a result of a major restructuring of the templates and example
 134   directories, almost all examples and templates files have been renamed and
 135   moved to subfolders that reflect the layout category.
 136   The files now have much more decriptive (and longer) names, and they use
 137   URL encoding for specific special characters such as '(', ')' and '&'.
 138   Notably also the file that opens for new users has been renamed (from
 139   splash.lyx to Welcome.lyx).
 140
 141
 142 !!!The following new folders have been added to the LyX directory
 143
 144 * The examples and templates directories have been completely re-organized.
 145   They are now much more structured (by means of layout categories) and thus
 146   consist of many new subfolders.
 147
 148
 149
 150 !!!The following preferences files have been removed from the tarball in 2.4:
 151
 152
 153
 154 !!!The following metadata files have been added to the tarball in 2.4:
 155
 156
 157
 158 !!Changes with respect to external programs and libraries in 2.4:
 159
 160 * The Qt5 libraries are now used by default. In order to link against
 161   Qt4 the configure option --disable-qt5 has to be used.
 162
 163 * The dependency on pplatex/dvipost was dropped.
 164
 165 * The dependency on sgmltools was dropped, see DocBook 5 section.
 166
 167 !!! Dependencies to generate ePub files:
 168
 169 * The DocBook XSLT 1.0 style sheets are a required dependency to generate
 170   ePub files. All versions since 1.76.0 are supported. Version 1.79.2 is
 171   bundled with LyX.
 172
 173 * XSLT processor is needed, two options were successfully tested
 174   a) xsltproc
 175      - Works on Linux and OSX (tested with xsltproc 1.1.32).
 176      - Fails on Windows.
 177   b) Saxon
 178      - Tested on Linux, OSX and Windows.
 179      - Java is a required dependency. Any JVM for Java 1.4 should be supported.
 180      - Only Saxon versions 6.5.4 and 6.5.5 are supported.
 181      - Version 6.5.5 is bundled with LyX.
 182
 183
 184 !!Known issues in version 2.4.0
 185
 186 * See http://www.lyx.org/trac/wiki/BugTrackerHome
 187
 188
 189 !!Caveats when upgrading from earlier versions to 2.4.x
 190
 191 * Autotools monolithic build option for building LyX binaries was removed,
 192   for compilation speedup use parallel building on multiple cores instead.
 193
 194 * Several ttf fonts (esint10.ttf, stmary10.ttf, wasy10.ttf) were changed
 195   to reflect the fact that newer Qt libraries do not support displaying certain
 196   codepoints anymore (bug #8493, #10161).
 197   Distribution packagers need to repack those font files in case they are
 198   delivering the fonts as a separated package dependent from core LyX
 199   in order to display correctly math symbols like \oint.
 200
 201   Also note, that while it is still possible to compile LyX against Qt 4
 202   these math symbols will not be displayed correctly anymore on Qt 4.
 203
 204 !! If upgrading from a LyX version before 2.3.0
 205
 206 * Please additionally see the release notes from the versions in-between:
 207   https://wiki.lyx.org/LyX/ReleaseNotes