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