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 - \\texinputs_prefix
  83   Defines the prefix for the TEXINPUTS environment variable. A
  84   single '.' in the paths will get replaced with the current
  85   document dir and also non-absolute paths will be prefixed with
  86   that dir.
  87
  88   The default semantics of TEXINPUTS apply, such that, for example,
  89   if a path is terminated with a double slash, all subdirectories
  90   will also be searched by both the TeX engine and ancillary programs
  91   such as dvi previewers or dvips.
  92
  93   (see also commit 1717ef20)
  94
  95 - \\use_qimage
  96   See Caveats section below.
  97
  98 - \\use_system_theme_icons
  99   If set to true, LyX tries to use the theme icons as defined by
 100   the OS.
 101
 102
 103 The following pref variables were changed in 2.1:
 104
 105 - \\mac_like_word_movement -> \\mac_like_cursor_movement
 106   When this option is set, the cursor is now moved to the end of
 107   the current paragraph on paragraph-down. The pref variable was
 108   renamed to better reflect this new behaviour.
 109
 110
 111 The following pref variables are obsoleted in 2.1:
 112
 113 - \\default_language and \\default_papersize
 114   To set the default language and paper size for new documents, use
 115   the "Save As Document Defaults" button in Document > Settings.
 116
 117
 118 The following new LyX functions have been introduced:
 119
 120 - LFUN_IPA_INSERT
 121   Inserts an IPA (International Phonetic Alphabet) inset.
 122
 123 - LFUN_IPAMACRO_INSERT <char>
 124   Inserts special IPA macros into the document. <char> can be
 125   one of 'tone-falling', 'tone-rising', 'tone-high-rising',
 126   'tone-low-rising', 'tone-high-rising-falling', 'deco bottomtiebar',
 127   'deco toptiebar'.
 128
 129 - LFUN_SPELLING_CONTINUOUSLY
 130   Toggles continuous spell-checking.
 131
 132 - LFUN_VC_RENAME
 133 - LFUN_VC_COPY
 134   Renames or copies a file under version control.
 135
 136 - LFUN_BUFFER_FORALL <command>
 137   Applies <command> to all non-hidden buffers.
 138
 139 - LFUN_ENVIRONMENT_SPLIT
 140   Splits the current environment with a Separator.
 141
 142 - LFUN_BRANCH_MASTER_ACTIVATE <branch>
 143   LFUN_BRANCH_MASTER_DEACTIVATE <branch>
 144   Activates or deactivates a branch in a master document from within
 145   a child (as opposed to the existing LFUN_BRANCH_[DE]ACTIVATE, which
 146   toggle the branch in the document itself).
 147
 148 - LFUN_BUFFER_EXPORT_AS <format> <filename>
 149   Equivalent to the new -export-to command-line switch (see above).
 150
 151 - LFUN_CLIPBOARD_PASTE_SIMPLE ("clipboard-paste-simple")
 152   Paste the clipboard contents as simple unformatted text.
 153   This is also available through a new menu voice within the
 154   [Edit]->[Paste Special...] sub-menu.
 155
 156 - LFUN_VIEW_CLOSE
 157   Close the current document view only, if there are no more views
 158   on the document, either close or hide it (see the new preference
 159   option \\close_buffer_with_last_view)
 160
 161
 162 The following LyX functions have been changed:
 163
 164 - LFUN_CLOSE_TAB_GROUP ("close-tab-group") was renamed to
 165   LFUN_TAB_GROUP_CLOSE ("tab-group-close").
 166
 167 - LFUN_SPIT_VIEW ("split-view") was renamed to
 168   LFUN_VIEW_SPLIT ("view-split").
 169
 170 - LFUN_BREAK_PARAGRAPH ("break-paragraph") was renamed to
 171   LFUN_PARAGRAPH_BREAK ("paragraph-break").
 172
 173 - LFUN_COPY_LABEL_AS_REF ("copy-label-as-reference") has been renamed to
 174   LFUN_LABEL_COPY_AS_REFERENCE ("label-copy-as-reference").
 175
 176
 177 The following LyX key bindings have been changed:
 178
 179 - The binding "C-w" was moved from "buffer-close" to "view-close"
 180   (only in cua.bind).
 181
 182 - sciword.bind was changed significantly (see #8364). The most important
 183   change is that "math-delim" commands now work under Windows.
 184
 185 The following LyX documents have been moved:
 186
 187 - 'AEA', 'JASA', 'springer', 'ACM-siggraph', and 'thesis' have been moved
 188   from templates to examples (see #8643).
 189
 190
 191 The following metadata files have been added to the tarball:
 192
 193 - Linux desktop file specification and scalable icon has been
 194   included in the tarball.
 195
 196 - AppData file (appdata.xml). It will not be installed by default and
 197   distribution maintainers need to handle this file themselves.
 198
 199
 200 Changes with respect to external programs and libraries:
 201 --------------------------------------------------------
 202
 203 - LyX now links against libmagic (http://www.darwinsys.com/file/) if it is
 204   available at compile time. This improves the file format detection of
 205   included graphics and other files. The old builtin format detection code
 206   is used if libmagic is not available.
 207
 208 - LyX no longer uses gettext for reading the translation files. This
 209   especially has an advantage on Windows, reducing the time it takes to
 210   find the correct translation.
 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