lib/RELEASE-NOTES

   1 !Important Changes in LyX 2.2.0
   2
   3 (: This file lists interface changes that might affect users in 2.2.0, some
   4    known problems in LyX 2.2.0 and some things you have to take into account
   5    when upgrading from earlier versions to a version of the 2.2.x series. :)
   6
   7
   8 !!Interface changes
   9
  10 * The --Separator-- layout has been removed in favor of an environment
  11   separator inset. There is no provision for inserting this inset from
  12   the GUI (though some menu entries use it) as it is automatically inserted
  13   when needed. See Section 3.4.6 of the User Guide for details.
  14
  15 * The prefix for subsections in labels and references has been changed from
  16   "sub:" to "subsec:" in order to avoid a clash with subfloats (conflicting
  17   \subref command, see #7550). Files are automatically converted to the new
  18   scheme. Please assure that you adapt external refstyle or prettyref
  19   definitions and your own layout files.
  20
  21 * Support for printing from within LyX (File> Print) has been removed. LyX's
  22   printing support was very limited, and most users will want to print after
  23   reviewing an output document (e.g., a PDF), anyway, which can be done from the
  24   PDF viewer.
  25   Users who would like to restore this functionality can create a
  26   "printer" format from within LyX and then define, say, a
  27   pdf->printer converter that does nothing but call lpd, or a2ps, or
  28   whatever. The "printer" will then be available as an export option.
  29
  30
  31 !!!The following pref variables were added in 2.2:
  32
  33 * \save_origin
  34   This variable was introduced to allow saving the document directory
  35   path in the document. If allowed, LyX will be able to locate all
  36   included files even when the document is manually moved/copied to
  37   a different location. If a valid \origin tag is present and the
  38   document was actually moved, the path of all included files is
  39   updated relative to the new location and the new origin will be
  40   recorded when saving again the document.
  41
  42 !!!The following pref variables were changed in 2.2:
  43
  44
  45
  46 !!!The following pref variables are obsoleted in 2.2:
  47
  48 * \rtl
  49   This variable was introduced to guard against any bad consequence of
  50   the then-new right-to-left languages support. It is no longer needed
  51   because of improvements. Now right-to-left support is always enabled.
  52
  53 * \printer
  54 * \print_adapt_output
  55 * \print_command
  56 * \print_evenpage_flag
  57 * \print_oddpage_flag
  58 * \print_pagerange_flag
  59 * \print_copies_flag
  60 * \print_collcopies_flag
  61 * \print_reverse_flag
  62 * \print_to_printer
  63 * \print_to_file
  64 * \print_file_extension:
  65   These were used for print support, which has been removed.
  66
  67
  68 !!!The following new LyX functions have been introduced in 2.2:
  69
  70 * buffer-view-cache
  71   Opens the last previewed output of the buffer, if it exists.
  72
  73 * buffer-move-next
  74   Moves the current tab one spot to the right.
  75
  76 * buffer-move-previous
  77   Moves the current tab one spot to the left.
  78
  79 * tabular-feature is reintroduced to allow more flexibility for user
  80   commands, whereas "inset-modify tabular" is now reserved for the tabular
  81   dialog. In particular, "inset-modify tabular" is no longer caught by math grid
  82   insets. The name tabular-feature is kept to avoid renaming icons. For more
  83   information, see #9794.
  84
  85 !!!The following LyX functions have been changed in 2.2:
  86
  87 * word-upcase, word-lowcase and word-capitalize do not select the word
  88   to operate on in the emacs way (that is, starting at cursor
  89   position); this behaviour can be restored by using the argument
  90   "partial".
  91
  92 * Functionality of "inset-modify tabular" has changed. See description of the
  93   new LyX function "tabular-feature" above.
  94
  95 !!!The following LyX key bindings have been changed in 2.2:
  96
  97 * For bindings where Control + {PgDn, PgUp} switches to the
  98   {next, previous} tab, Control + Shift + {PgDn, PgUp} moves the current
  99   tab to the {next, previous} tab.
 100
 101 * The shortcuts for "bookmark-save x" have been changed from C-M-S-x to S-Fx
 102   ("x" stands for the number of the bookmark.)
 103
 104 !!!The following LyX documents have been moved in 2.2:
 105
 106
 107
 108 !!!The following metadata files have been added to the tarball in 2.2:
 109
 110
 111
 112 !!Changes with respect to external programs and libraries in 2.2:
 113
 114 * LyX 2.2.0 and the following 2.2.x releases will continue to work well with
 115   Qt 4.5 (and later Qt 4.x) but will also support Qt 5.6, which brings some
 116   advantages most notably for users with HiDPI displays. Note that if you
 117   compile LyX with a Qt 5 release before 5.6 you are likely to run into
 118   several regressions with respect to Qt 4.x. See #9215 for a list of bugs
 119   related to compiling LyX with different versions of Qt.
 120
 121 * The Qt libraries must have support for the SVG graphic format, because
 122   LyX now uses svg icons. If this support is lacking, icons cannot be shown.
 123
 124 * If compiling LyX on Windows with Qt 5.6, it is recommended to use MSVC 2015
 125   update 2 to avoid #9892.
 126
 127 * LyX now gives an error if the underlying LaTeX command exited with error.
 128
 129
 130 !!Known issues in version 2.2.0
 131
 132 * LyX needs Python 2.7 at runtime. The python 2 interpreter needs to be named
 133   either 'python' or 'python2'.
 134   Building LyX usually works with Python 3 as well, but there might be cases
 135   where it does not work properly on systems where Python 3 is the default
 136   binary. See #7030 to know how to fix this properly, since simple shebang
 137   conversion in *.py files will not be enough.
 138
 139 * If using LyX with Qt 4, it is possible to suddenly get keyboard keys wrong,
 140   and deadlock. To work around the issue, you can disable IBus for LyX by
 141   starting LyX as 'XMODIFIERS= lyx'. For further discussion and alternative
 142   workarounds, see #9362.
 143
 144 * LyX can produce LuaTeX output that is not compatible with the newest versions
 145   of the engine (e.g. 0.95.0, the version in TeX Live 2016). In a later 2.2.x
 146   version we plan to implement exporting of LuaTeX code that is compatible
 147   with the LuaTeX versions shipped with both TeX Live 2015 and TeX Live 2016.
 148   For more information, see the following mailing list thread:
 149   https://www.mail-archive.com/search?l=mid&q=20160520075810.yi3uspufehev5aln%40cotopaxi
 150
 151
 152 !!Caveats when upgrading from earlier versions to 2.2.x
 153
 154 * BibTeX errors are now processed and cause LyX to show the errors dialog.
 155   Before, these errors were ignored, which means that it may happen that
 156   documents that compiled without error with a previous version now
 157   compile with error. However, because now in 2.2.x users can click on
 158   the "Show Output Anyway" button, the document can still be viewed.
 159
 160 * Missing characters in the output are now reported as errors. This leads
 161   to error reports for documents that compiled without error before.
 162   However, the error was always present but went undetected!
 163
 164 * Documents using Times fonts and containing Greek characters may now fail
 165   to compile under pdflatex for users of MikTeX due to an automatically
 166   half-installed "grtimes" package. A workaround in LyX was removed as it
 167   stands in the way of alternative approaches (see #6469).
 168
 169 * With LuaTeX, LyX now uses polyglossia instead of babel if the language
 170   package option "Automatic" is selected. In order to use babel, select
 171   "Always babel" instead. This may be needed if a document uses code that
 172   is specific to babel.
 173
 174 * As usual, when opening and saving a document that was created by a previous
 175   major version of LyX (in this case 2.1.x), the file format is changed to
 176   the new file format (in this case 2.2.x). What is different starting with
 177   2.2.0 is that when we save a file that was not originally in the current LyX
 178   format, we create a backup of the original file. We put it in the backup
 179   directory, if one exists, otherwise in the directory the original file is
 180   in. This is the same strategy as for normal backups. This backup file can be
 181   helpful in case a bug in lyx2lyx caused data loss. For more information, see
 182   #9554.