Clarify instructions on how to set up the thesaurus (#8811)

[lyx.git] / lib / doc / Development.lyx

diff --git a/lib/doc/Development.lyx b/lib/doc/Development.lyx
index f16e8bba3d03446a55ab191ab21ee04fa42b1627..5b32e6e5202c2c63780033e3c94510e82ad87b58 100644 (file)
--- a/lib/doc/Development.lyx
+++ b/lib/doc/Development.lyx
@@ -1,5 +1,5 @@
 #LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 462
+\lyxformat 474
 \begin_document
 \begin_header
 \textclass scrbook
@@ -56,7 +56,7 @@ End
 \pdf_keywords "LyX, Documentation, Development"
 \pdf_bookmarks true
 \pdf_bookmarksnumbered true
-\pdf_bookmarksopen false
+\pdf_bookmarksopen true
 \pdf_bookmarksopenlevel 1
 \pdf_breaklinks false
 \pdf_pdfborder false
@@ -68,6 +68,7 @@ End
 \use_geometry false
 \use_package amsmath 1
 \use_package amssymb 1
+\use_package cancel 0
 \use_package esint 0
 \use_package mathdots 1
 \use_package mathtools 0
@@ -76,7 +77,7 @@ End
 \use_package stmaryrd 0
 \use_package undertilde 0
 \cite_engine basic
-\cite_engine_type numerical
+\cite_engine_type default
 \biblio_style plain
 \use_bibtopic false
 \use_indices false
@@ -215,8 +216,15 @@ document
 setting Whenever you introduce a new setting that is stored in the document
  header, a file format update is needed.
  This is also true if you add a new valid value to an existing setting,
- e.g.
- a new language that is stored in 
+ e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+a new language that is stored in 
 \begin_inset Flex Code
 status collapsed
 
@@ -344,19 +352,30 @@ src/version.h
 \end_layout
 
 \begin_layout Enumerate
-Add an entry to both format lists (for conversion and reversion) in 
+Add an entry to both format lists (for conversion and reversion) in
+\begin_inset Newline newline
+\end_inset
+
+
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-lib/lyx2lyx_lyx2lyx_2_1.py
+lib/lyx2lyx/lyx_2_1.py
 \end_layout
 
 \end_inset
 
 .
- Add a conversion routine if needed (e.g.
- a new header setting always needs a conversion that adds the new setting,
+ Add a conversion routine if needed (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+a new header setting always needs a conversion that adds the new setting,
  a new document language does not need one).
  Add a reversion routine if needed.
  While the conversion routine is required to produce a document that is
@@ -435,6 +454,95 @@ src/tex2lyx/TODO.txt
  recommendation were related to mixed version syntax, not ERT.
 \end_layout
 
+\begin_layout Section
+Backporting new styles to the stable version
+\end_layout
+
+\begin_layout Standard
+Starting with the stable LyX 2.1 branch, there is a mechanism in place to
+ backport new styles to the stable version without the need to update the
+ file format.
+ The basic idea is that the new style definition is automatically copied
+ to the document preamble, so that it can even be used by older minor revisions
+ that did not yet include the style.
+ To backport a new style to the stable version, the following steps are
+ needed:
+\end_layout
+
+\begin_layout Enumerate
+Add the line 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForceLocal -1
+\end_layout
+
+\end_inset
+
+ to the style definition in the development version.
+\end_layout
+
+\begin_layout Enumerate
+Copy the style definition to the stable version, but use 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForceLocal 1
+\end_layout
+
+\end_inset
+
+ instead.
+ If needed adjust the format to the one used by the stable version (see
+ the customization manual for details of the layout file format).
+\end_layout
+
+\begin_layout Enumerate
+For each update of the style in a later stable version, increase the argument
+ of 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForceLocal
+\end_layout
+
+\end_inset
+
+ by one (in the stable version, the development version should not be touched).
+\end_layout
+
+\begin_layout Standard
+For details about the 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForceLocal
+\end_layout
+
+\end_inset
+
+ flag see the customization manual.
+ No 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyx2lyx
+\end_layout
+
+\end_inset
+
+ support is needed for backported styles: Since the style of the development
+ version has an infinite version number, it will always be used.
+ Furthermore, since its version number is less than one, the style will
+ not be written anymore to the document header for files saved by the new
+ version.
+\end_layout
+
 \begin_layout Chapter
 Tests
 \end_layout
@@ -624,8 +732,15 @@ name "sec:Updating-test-references"
 
 \begin_layout Standard
 In some cases a changed tex2lyx output is not a test failure, but wanted,
- e.g.
- if a tex2lyx bug was fixed, or a new feature was added.
+ e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+if a tex2lyx bug was fixed, or a new feature was added.
  In these cases the stored references need to be updated.
  To do so, call 
 \begin_inset Flex Code