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