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 Whenever the user closes a (tabbed) view on a document, either by
  10 clicking on the tab close button, or by using the File->Close menu,
  11 LyX now closes exclusively that specific view. If there are other
  12 views showing the same document, they are not closed. When the user
  13 closes the last view, LyX can be configured for either closing the
  14 document, or keeping it into memory as a hidden document (that can be
  15 shown again through the View->Hidden-> submenu).
  16
  17 A new configurable preference option has been added, allowing for either
  18 (close_buffer_with_last_view)
  19
  20 There have been some changes to the LyX command line. The following new
  21 options have been added:
  22
  23 -export-to <format> <dest>    (-E <format> <dest>)
  24
  25   Allows one to perform a batch export of the LyX file that is opened
  26   to the specified destination file <dest> and format <format>.
  27   For example, to create a PDF of a LyX document, you can run:
  28     lyx -export-to pdf /path/to/dest.pdf /path/to/source.lyx
  29   See the manual page for details.
  30   This functionality is also available via a new menu voice
  31   Export->Export As..., that pops up a dialog allowing one to
  32   choose the export format, as well as the destination pathname.
  33   Also, it is available via the mini-buffer (or the -x switch)
  34   through a proper new LFUN (see below).
  35
  36 The Advanced Find and Replace feature now supports cancel of a long
  37 search operation by hitting the ESC key.
  38
  39 The following pref variables were changed in 2.1:
  40
  41 - \\close_buffer_with_last_view [yes|no|ask]
  42   When user closes the last view on a document, close the document
  43   as well ("yes"), or hide the document ("no"), or ask the user
  44   ("ask").
  45
  46 The following pref variables are obsoleted in 2.1:
  47
  48 - \\default_language
  49 - \\default_papersize
  50
  51 To set the default language and paper size for new documents, use the
  52 "Save As Document Defaults" button in Document > Settings.
  53
  54 The format pdf aka "PDF (ps2pdf)" was split in two formats: pdf aka
  55 "PDF (ps2pdf)" and pdf6 aka "PDF (graphics)". pdf6 is used for PDF files
  56 included as graphics. Custom external templates and converters might need
  57 to be adjusted. The format split was needed since otherwise an odt->pdf
  58 converter which is intended for included graphics only did interfere with
  59 document export via ps2pdf.
  60
  61 The support for ArmTeX (a special typesetting engine for Armenian) was removed.
  62 Writing text in Armenian is now possible in a native way using XeTeX.
  63
  64 The following new LyX functions have been introduced:
  65
  66 - LFUN_BRANCH_MASTER_ACTIVATE <branch>:
  67   LFUN_BRANCH_MASTER_DEACTIVATE <branch>:
  68   Activates or deactivates a branch in a master document from within
  69   a child (as opposed to the existing LFUN_BRANCH_[DE]ACTIVATE, which
  70   toggle the branch in the document itself).
  71
  72 - LFUN_BUFFER_EXPORT_AS <format> <filename>
  73   Equivalent to the new -export-to command-line switch (see above).
  74
  75 - LFUN_CLIPBOARD_PASTE_SIMPLE ("clipboard-paste-simple")
  76   Paste the clipboard contents as simple unformatted text.
  77   This is also available through a new menu voice within the
  78   [Edit]->[Paste Special...] sub-menu.
  79
  80 - LFUN_VIEW_CLOSE
  81   Close the current document view only, if there are no more views
  82   on the document, either close or hide it (see the new preference
  83   option \\close_buffer_with_last_view)
  84
  85 The following LyX functions have been removed:
  86
  87 //template, remove this entry later on
  88 - LFUN_NEXT_INSET_TOGGLE ("next-inset-toggle"): use "inset-toggle" instead.
  89
  90
  91 The following LyX functions have been changed:
  92
  93 //template, remove this entry later on
  94 - LFUN_INSET_TOGGLE ("inset-toggle"): For some insets, this function was used
  95   to show the settings dialog. This is no longer possible and one should use
  96   inset-settings for this purpose.
  97
  98 -  LFUN_CLOSE_TAB_GROUP_CLOSE ("close-tab-group") was renamed to
  99    LFUN_TAB_GROUP_CLOSE ("tab-group-close").
 100
 101 -  LFUN_SPIT_VIEW ("split-view") was renamed to
 102    LFUN_VIEW_SPLIT ("view-split").
 103
 104 - LFUN_BREAK_PARAGRAPH ("break-paragraph") was renamed to
 105   LFUN_PARAGRAPH_BREAK ("paragraph-break").
 106
 107 The following LyX key bindings have been changed:
 108
 109 //template, remove this entry later on
 110 - LFUN_MATH_MACRO_FOLD ("math-macro-fold")
 111   The binding to "C-minus" has changed to "C-S-underscore".
 112
 113 - The binding "C-w" was moved from "buffer-close" to "view-close"
 114   (only in cua.bind).
 115
 116
 117 Linux desktop file specification and scalable icon has been included
 118 into the tarball.
 119
 120
 121 New external programs and libraries:
 122 ------------------------------------
 123
 124 - LyX links now against libmagic (http://www.darwinsys.com/file/) if it is
 125   available at compile time. This improves the file format detection of
 126   included graphics and other files. The old builtin format detection code
 127   is used if libmagic is not available.
 128
 129
 130 Known issues in version 2.1.0
 131 -----------------------------
 132
 133 - LyX needs to be run under Python 2 and will not work properly on systems
 134   where Python 3 is the default binary. See bug #7030 to know how to fix
 135   this properly, since simple sheebang conversion in *.py files will not
 136   be enough.
 137
 138 Caveats when upgrading from earlier versions to 2.1.x
 139 -------------------------------------------------------
 140
 141 In order to improve reported scrolling slowness, we changed the way screen
 142 painting is done. This, however, can slow down the performance on remote
 143 X connections and we provide RC_USE_QIMAGE variable, which brings back
 144 the old way of painting (when set to false).
 145