RELEASE-NOTES

   1 This file lists interface changes that might affect users in 2.1.0, some
   2 known problems in LyX 2.1.0 and some things you have to take into account
   3 when upgrading from earlier versions to a version of the 2.1.x series.
   4
   5
   6 Interface changes
   7 -----------------
   8
   9 - There have been changes to some often used menu items.
  10
  11   The following menu items moved from View to Document:
  12     * View (Default format)
  13     * View (Other formats)
  14     * Update (Default format)
  15     * Update (Other formats)
  16
  17   The following menu item moved from Document to View:
  18     * Outline -> Outline Pane
  19
  20 - Whenever the user closes a (tabbed) view on a document, either by
  21   clicking on the tab close button, or by using the File->Close menu,
  22   LyX now closes exclusively that specific view. If there are other
  23   views showing the same document, they are not closed. When the user
  24   closes the last view, LyX can be configured for either closing the
  25   document, or keeping it in memory as a hidden document (that can be
  26   shown again through the View->Hidden-> submenu).
  27
  28   A new configurable preference option has been added, allowing for
  29   either (close_buffer_with_last_view).
  30
  31 - There have been some changes to the LyX command line. The following
  32   new options have been added:
  33
  34   --export-to <format> <dest>    (-E <format> <dest>)
  35
  36     Allows one to perform a batch export of the LyX file that is
  37     opened to the specified destination file <dest> and format
  38     <format>. For example, to create a PDF of a LyX document,
  39     you can run:
  40       lyx --export-to pdf /path/to/dest.pdf /path/to/source.lyx
  41     See the manual page for details.
  42
  43     This functionality is also available via a new menu voice
  44     Export->Export As..., that pops up a dialog allowing one to
  45     choose the export format, as well as the destination pathname.
  46     Also, it is available via the mini-buffer (or the -x switch)
  47     through a proper new LFUN (see below).
  48
  49 - The Advanced Find and Replace feature now supports cancel of a
  50   long search operation by hitting the ESC key.
  51
  52 - The format pdf aka "PDF (ps2pdf)" was split in two formats: pdf aka
  53   "PDF (ps2pdf)" and pdf6 aka "PDF (graphics)". pdf6 is used for PDF
  54   files included as graphics. Custom external templates and converters
  55   might need to be adjusted. The format split was needed since otherwise
  56   an odt->pdf converter which is intended for included graphics only
  57   did interfere with document export via ps2pdf.
  58
  59 - The support for ArmTeX (a special typesetting engine for Armenian)
  60   was removed. Writing text in Armenian is now possible in a native
  61   way using XeTeX.
  62
  63
  64 The following pref variables were added in 2.1:
  65
  66 - \\close_buffer_with_last_view [yes|no|ask]
  67   When the user closes the last view on a document, close the
  68   document as well ("yes"), or hide the document ("no"), or ask
  69   the user ("ask").
  70
  71 - \\completion_minlength
  72   Defines the minimal length of a word to be added to the list of
  73   words for text completion.
  74
  75 - \\default_length_unit
  76   Defines the default length unit: 2 for centimers, 6 for inches.
  77
  78 - \\default_otf_view_format
  79   Defines the default output format for documents with non-tex
  80   fonts (OpenType fonts).
  81
  82 - \\fullscreen_statusbar
  83   Controls whether the statusbar is shown in fullscreen mode.
  84
  85 - \\texinputs_prefix
  86   Defines the prefix for the TEXINPUTS environment variable. A
  87   single '.' in the paths will get replaced with the current
  88   document dir and also non-absolute paths will be prefixed with
  89   that dir.
  90
  91   The default semantics of TEXINPUTS apply, such that, for example,
  92   if a path is terminated with a double slash, all subdirectories
  93   will also be searched by both the TeX engine and ancillary programs
  94   such as dvi previewers or dvips.
  95
  96   (see also commit 1717ef20)
  97
  98 - \\use_qimage
  99   See Caveats section below.
 100
 101 - \\use_system_theme_icons
 102   If set to true, LyX tries to use the theme icons as defined by
 103   the OS.
 104
 105
 106 The following pref variables were changed in 2.1:
 107
 108 - \\mac_like_word_movement -> \\mac_like_cursor_movement
 109   When this option is set, the cursor is now moved to the end of
 110   the current paragraph on paragraph-down. The pref variable was
 111   renamed to better reflect this new behaviour.
 112
 113
 114 The following pref variables are obsoleted in 2.1:
 115
 116 - \\default_language and \\default_papersize
 117   To set the default language and paper size for new documents, use
 118   the "Save As Document Defaults" button in Document > Settings.
 119
 120
 121 The following new LyX functions have been introduced:
 122
 123 - ipa-insert
 124   Inserts an IPA (International Phonetic Alphabet) inset.
 125
 126 - ipamacro-insert <char>
 127   Inserts special IPA macros into the document. <char> can be
 128   one of 'tone-falling', 'tone-rising', 'tone-high-rising',
 129   'tone-low-rising', 'tone-high-rising-falling', 'deco bottomtiebar',
 130   'deco toptiebar'.
 131
 132 - spelling-continuously
 133   Toggles continuous spell-checking.
 134
 135 - vc-rename
 136 - vc-copy
 137   Renames or copies a file under version control.
 138
 139 - buffer-forall <command>
 140   Applies <command> to all non-hidden buffers.
 141
 142 - environment-split
 143   Splits the current environment with a Separator.
 144
 145 - branch-master-activate <branch>
 146 - branch-master-deactivate <branch>
 147   Activates or deactivates a branch in a master document from within
 148   a child (as opposed to the existing branch-[de]activate, which
 149   toggle the branch in the document itself).
 150
 151 - buffer-export-as <format> <filename>
 152   Equivalent to the new -export-to command-line switch (see above).
 153
 154 - clipboard-paste-simple
 155   Paste the clipboard contents as simple unformatted text.
 156   This is also available through a new menu voice within the
 157   [Edit]->[Paste Special...] sub-menu.
 158
 159 - view-close
 160   Close the current document view only, if there are no more views
 161   on the document, either close or hide it (see the new preference
 162   option \\close_buffer_with_last_view)
 163
 164
 165 The following LyX functions have been changed:
 166
 167 - close-tab-group was renamed to tab-group-close.
 168
 169 - split-view was renamed to view-split.
 170
 171 - break-paragraph was renamed to paragraph-break.
 172
 173 - copy-label-as-reference was renamed to label-copy-as-reference.
 174
 175
 176 The following LyX key bindings have been changed:
 177
 178 - The binding "C-w" was moved from "buffer-close" to "view-close"
 179   (only in cua.bind).
 180
 181 - sciword.bind was changed significantly (see #8364). The most important
 182   change is that "math-delim" commands now work under Windows.
 183
 184 The following LyX documents have been moved:
 185
 186 - all thesis template files have been moved to the examples folder
 187
 188
 189 The following metadata files have been added to the tarball:
 190
 191 - Linux desktop file specification and scalable icon has been
 192   included in the tarball.
 193
 194 - AppData file (appdata.xml). It will not be installed by default and
 195   distribution maintainers need to handle this file themselves.
 196
 197
 198 Changes with respect to external programs and libraries:
 199 --------------------------------------------------------
 200
 201 - LyX now links against libmagic (http://www.darwinsys.com/file/) if it is
 202   available at compile time. This improves the file format detection of
 203   included graphics and other files. The old builtin format detection code
 204   is used if libmagic is not available.
 205
 206 - LyX no longer uses gettext for handling the translation files. This
 207   especially is an advantage on Windows, where translating strings is faster.
 208
 209 - LyX is not yet supposed to work with Qt5. It is advised to compile and
 210   run LyX against Qt 4.8.x.
 211
 212
 213 Known issues in version 2.1.0
 214 -----------------------------
 215
 216 - LyX needs to be run under Python 2 and will not work properly on systems
 217   where Python 3 is the default binary. See bug #7030 to know how to fix
 218   this properly, since simple sheebang conversion in *.py files will not
 219   be enough.
 220
 221
 222 Caveats when upgrading from earlier versions to 2.1.x
 223 -------------------------------------------------------
 224
 225 - In order to improve reported scrolling slowness, we changed the way
 226   screen painting is done. This, however, can slow down the performance
 227   on remote X connections and we provide the \\use_qimage preference
 228   variable, which brings back the old way of painting (when set to false).
 229