]> git.lyx.org Git - lyx.git/blobdiff - lib/RELEASE-NOTES
* lib/RELEASE-NOTES
[lyx.git] / lib / RELEASE-NOTES
index 4fab9b7e1f04b46bc3a11205a7ac5e2bce07fff2..b8530aba8a9750ca9d5cc9693867bfe84d462c5f 100644 (file)
-!Important Changes in LyX 2.2.0
-
-(: This file lists interface changes that might affect users in 2.2.0, some
-   known problems in LyX 2.2.0 and some things you have to take into account
-   when upgrading from earlier versions to a version of the 2.2.x series. :)
+!Important Changes in LyX 2.4.0
 
 
 !!Interface changes
 
-* The --Separator-- layout has been removed in favor of an environment
-  separator inset. There is no provision for inserting this inset from
-  the GUI (though some menu entries use it) as it is automatically inserted
-  when needed. See Section 3.4.6 of the User Guide for details.
+* It is now possible to cancel background export processes. A menu entry
+  to do so will appear on the Document menu when such a process is underway.
+  The LFUN for this is export-cancel. One can also click on the 'spinner'
+  to cancel export.
+
+* The items on the Edit menu have been reordered, and many of the shortcuts
+  have been changed so that they are more intuitive in the case of often
+  used items. We understand that this may frustrate some users and apologize,
+  while noting that menu shortcuts can always be customized by copying the
+  stdmenus.inc file to the user directory and editing it.
+
+
+!!Documents compilation process and images conversion
+
+* LyX now uses utf8 encoding per default for all languages. This does
+  not affect existing documents. Note that LyX also does not touch
+  personal defaults and templates. That is to say, if you still see
+  traditional encoding preset for new documents, you can change that
+  by selecting "Unicode (utf8) [default]" and hitting "Save as
+  Documents Defaults" afterwards. Your personal templates need to be
+  changed manually if desired.
+
+* LyX defaults to the "HE8" LaTeX font encoding with Hebrew if the
+  "Culmus" LaTeX fonts are installed.
+
+* Documents that use TeX fonts can only be compiled with XeTeX if the input
+  encoding is set to "utf8-plain" or "ascii".
+  
+* DocBook support has been revamped and now targets DocBook 5 (i.e. 
+  only XML, SGML is gone). Some supporting files for the previous 
+  implementation have been removed: all examples (lib/examples), 
+  some layouts (existing documents should still work, but with a 
+  DocBook 5 output instead of DocBook 4 SGML). The dependency on 
+  sgmltools has been removed, this new support is always enabled.
+  Having sgmltools installed or not will not change anything in LyX.
+
+!!!The following pref variables were added in 2.4:
+
+* \ct_additions_underlined true|false: determines whether additions in change tracking
+  are underlined in the workarea (default: true).
+
+* \ct_markup_copied true|false: determines whether change tracking markup should be
+  preserved on copy/paste (default: false).
+
+
+!!!The following pref variables were changed in 2.4:
+
+
+
+!!!The following pref variables are obsoleted in 2.4:
+
+* \font_encoding
+  The font encoding is now automatically set depending on the document
+  fonts and languages.
+
+* \use_qimage
+  This is no longer necessary due to the rewrite of the painter.
+
+* \use_pixmap_cacheqimage
+  There is no evidence that this painting mode was useful anymore.
+
+* \date_insert_format
+  The function date-insert has been removed and superseded by info-insert date.
+  The latter does not need a pref value anymore.
+
+
+!!!The following new LyX functions have been introduced in 2.4:
 
-* The prefix for subsections in labels and references has been changed from
-  "sub:" to "subsec:" in order to avoid a clash with subfloats (conflicting
-  \subref command, see #7550). Files are automatically converted to the new
-  scheme. Please assure that you adapt external refstyle or prettyref
-  definitions and your own layout files.
+* bidi is a helper function to implement icons that are different between LTR and RTL text. 
 
-* Support for printing from within LyX (File> Print) has been removed. LyX's
-  printing support was very limited, and most users will want to print after
-  reviewing an output document (e.g., a PDF), anyway, which can be done from the
-  PDF viewer.
-  Users who would like to restore this functionality can create a
-  "printer" format from within LyX and then define, say, a
-  pdf->printer converter that does nothing but call lpd, or a2ps, or
-  whatever. The "printer" will then be available as an export option.
+* buffer-reset-export advises LyX to remove the auxiliary files before doing the next
+  export.
 
+* buffer-write-as-template is a new convenience function to ease saving a document
+  in the (personal) templates folder.
 
-!!!The following pref variables were added in 2.2:
+* export-cancel: Used to cancel background export processes.
 
-* \save_origin
-  This variable was introduced to allow saving the document directory
-  path in the document. If allowed, LyX will be able to locate all
-  included files even when the document is manually moved/copied to
-  a different location. If a valid \origin tag is present and the
-  document was actually moved, the path of all included files is
-  updated relative to the new location and the new origin will be
-  recorded when saving again the document.
+* ifrelatives is a helper function to check whether a buffer has a master or children.
 
-!!!The following pref variables were changed in 2.2:
+* master-buffer-forall executes an lfun in the master and all children of a document.
 
+* paragraph-select is a new convenience function to select the paragraph
+  surrounding the actual cursor position.
 
+* tabular-style-insert: Insert a table in a specified style.
 
-!!!The following pref variables are obsoleted in 2.2:
 
-* \rtl
-  This variable was introduced to guard against any bad consequence of
-  the then-new right-to-left languages support. It is no longer needed
-  because of improvements. Now right-to-left support is always enabled.
+!!!The following LyX functions have been changed in 2.4:
 
-* \printer
-* \print_adapt_output
-* \print_command
-* \print_evenpage_flag
-* \print_oddpage_flag
-* \print_pagerange_flag
-* \print_copies_flag
-* \print_collcopies_flag
-* \print_reverse_flag
-* \print_to_printer
-* \print_to_file
-* \print_file_extension:
-  These were used for print support, which has been removed.
+* set-graphics-group was renamed to graphics-set-group.
 
+* info-insert buffer vcs-*: renamed to info-insert vcs *
 
-!!!The following new LyX functions have been introduced in 2.2:
+* file-insert: optional second parameter "ignorelang" to make the insertion
+  ignore the inserted file's main language (and rather adapt it to the insertion
+  context's language).
 
-* buffer-view-cache
-  Opens the last previewed output of the buffer, if it exists.
 
-* buffer-move-next
-  Moves the current tab one spot to the right.
+!!!The following LyX functions have been removed in 2.4:
 
-* buffer-move-previous
-  Moves the current tab one spot to the left.
+* date-insert: obsoleted by info-insert date.
 
-* tabular-feature is reintroduced to allow more flexibility for user
-  commands, whereas "inset-modify tabular" is now reserved for the tabular
-  dialog. In particular, "inset-modify tabular" is no longer caught by math grid
-  insets. The name tabular-feature is kept to avoid renaming icons. For more
-  information, see #9794.
+!!!The following LyX function has been added and then removed in 2.4 development cycle.
 
-!!!The following LyX functions have been changed in 2.2:
+* bidi: used as a first solution to provide icons that change
+  direction with language.
 
-* word-upcase, word-lowcase and word-capitalize do not select the word
-  to operate on in the emacs way (that is, starting at cursor
-  position); this behaviour can be restored by using the argument
-  "partial".
 
-* Functionality of "inset-modify tabular" has changed. See description of the
-  new LyX function "tabular-feature" above.
+!!!The following LyX documents have been moved in 2.4:
 
-!!!The following LyX key bindings have been changed in 2.2:
+* As a result of a major restructuring of the templates and example
+  directories, almost all examples and templates files have been renamed and
+  moved to subfolders that reflect the layout category.
+  The files now have much more decriptive (and longer) names, and they use
+  URL encoding for specific special characters such as '(', ')' and '&'.
+  Notably also the file that opens for new users has been renamed (from
+  splash.lyx to Welcome.lyx).
 
-* For bindings where Control + {PgDn, PgUp} switches to the
-  {next, previous} tab, Control + Shift + {PgDn, PgUp} moves the current
-  tab to the {next, previous} tab.
 
-* The shortcuts for "bookmark-save x" have been changed from C-M-S-x to S-Fx
-  ("x" stands for the number of the bookmark.)
+!!!The following new folders have been added to the LyX directory
 
-!!!The following LyX documents have been moved in 2.2:
+* The examples and templates directories have been completely re-organized.
+  They are now much more structured (by means of layout categories) and thus
+  consist of many new subfolders. 
 
 
 
-!!!The following metadata files have been added to the tarball in 2.2:
+!!!The following preferences files have been removed from the tarball in 2.4:
 
 
 
-!!Changes with respect to external programs and libraries in 2.2:
+!!!The following metadata files have been added to the tarball in 2.4:
 
-* LyX 2.2.0 and the following 2.2.x releases will continue to work well with
-  Qt 4.5 (and later Qt 4.x) but will also support Qt 5.6, which brings some
-  advantages most notably for users with HiDPI displays. Note that if you
-  compile LyX with a Qt 5 release before 5.6 you are likely to run into
-  several regressions with respect to Qt 4.x. See #9215 for a list of bugs
-  related to compiling LyX with different versions of Qt.
 
-* The Qt libraries must have support for the SVG graphic format, because
-  LyX now uses svg icons. If this support is lacking, icons cannot be shown.
 
-* If compiling LyX on Windows with Qt 5.6, it is recommended to use MSVC 2015
-  update 2 to avoid #9892.
+!!Changes with respect to external programs and libraries in 2.4:
 
-* LyX now gives an error if the underlying LaTeX command exited with error.
+* The Qt5 libraries are now used by default. In order to link against
+  Qt4 the configure option --disable-qt5 has to be used.
 
+* The dependency on pplatex/dvipost was dropped.
 
-!!Known issues in version 2.2.0
+* The dependency on sgmltools was dropped, see DocBook 5 section.
 
-* LyX needs Python 2.7 at runtime. The python 2 interpreter needs to be named
-  either 'python' or 'python2'.
-  Building LyX usually works with Python 3 as well, but there might be cases
-  where it does not work properly on systems where Python 3 is the default
-  binary. See #7030 to know how to fix this properly, since simple shebang
-  conversion in *.py files will not be enough.
 
-* If using LyX with Qt 4, it is possible to suddenly get keyboard keys wrong,
-  and deadlock. To work around the issue, you can disable IBus for LyX by
-  starting LyX as 'XMODIFIERS= lyx'. For further discussion and alternative
-  workarounds, see #9362.
+!!Known issues in version 2.4.0
 
-* LyX can produce LuaTeX output that is not compatible with the newest versions
-  of the engine (e.g. 0.95.0, the version in TeX Live 2016). In a later 2.2.x
-  version we plan to implement exporting of LuaTeX code that is compatible
-  with the LuaTeX versions shipped with both TeX Live 2015 and TeX Live 2016.
-  For more information, see the following mailing list thread:
-  https://www.mail-archive.com/search?l=mid&q=20160520075810.yi3uspufehev5aln%40cotopaxi
+* See http://www.lyx.org/trac/wiki/BugTrackerHome
 
 
-!!Caveats when upgrading from earlier versions to 2.2.x
+!!Caveats when upgrading from earlier versions to 2.4.x
 
-* BibTeX errors are now processed and cause LyX to show the errors dialog.
-  Before, these errors were ignored, which means that it may happen that
-  documents that compiled without error with a previous version now
-  compile with error. However, because now in 2.2.x users can click on
-  the "Show Output Anyway" button, the document can still be viewed.
+* Autotools monolithic build option for building LyX binaries was removed,
+  for compilation speedup use parallel building on multiple cores instead.
 
-* Missing characters in the output are now reported as errors. This leads
-  to error reports for documents that compiled without error before.
-  However, the error was always present but went undetected!
+* Several ttf fonts (esint10.ttf, stmary10.ttf, wasy10.ttf) were changed
+  to reflect the fact that newer Qt libraries do not support displaying certain
+  codepoints anymore (bug #8493, #10161). 
+  Distribution packagers need to repack those font files in case they are
+  delivering the fonts as a separated package dependent from core LyX
+  in order to display correctly math symbols like \oint.
 
-* Documents using Times fonts and containing Greek characters may now fail
-  to compile under pdflatex for users of MikTeX due to an automatically
-  half-installed "grtimes" package. A workaround in LyX was removed as it
-  stands in the way of alternative approaches (see #6469).
+  Also note, that while it is still possible to compile LyX against Qt 4
+  these math symbols will not be displayed correctly anymore on Qt 4.
 
-* With LuaTeX, LyX now uses polyglossia instead of babel if the language
-  package option "Automatic" is selected. In order to use babel, select
-  "Always babel" instead. This may be needed if a document uses code that
-  is specific to babel.
+!! If upgrading from a LyX version before 2.3.0
 
-* As usual, when opening and saving a document that was created by a previous
-  major version of LyX (in this case 2.1.x), the file format is changed to
-  the new file format (in this case 2.2.x). What is different starting with
-  2.2.0 is that when we save a file that was not originally in the current LyX
-  format, we create a backup of the original file. We put it in the backup
-  directory, if one exists, otherwise in the directory the original file is
-  in. This is the same strategy as for normal backups. This backup file can be
-  helpful in case a bug in lyx2lyx caused data loss. For more information, see
-  #9554.
+* Please additionally see the release notes from the versions in-between:
+  https://wiki.lyx.org/LyX/ReleaseNotes