]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Development.lyx
Merge branch 'master' into biblatex2
[lyx.git] / lib / doc / Development.lyx
index 6deb3d7575780b65301f7086186954e7b9525b49..18f0861f1579fb849dd7e73c508372ed799da1ba 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 512
+\lyxformat 527
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -78,7 +78,8 @@ logicalmkup
 \tocdepth 4
 \paragraph_separation indent
 \paragraph_indentation default
-\quotes_language english
+\quotes_style english
+\dynamic_quotes 0
 \papercolumns 1
 \papersides 2
 \paperpagestyle headings
@@ -459,30 +460,6 @@ src/version.h
 .
 \end_layout
 
-\begin_layout Enumerate
-Update the range of file formats in the array 
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-format_relation
-\end_layout
-
-\end_inset
-
- in 
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lib/lyx2lyx/LyX.py
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
 \begin_layout Enumerate
 \begin_inset CommandInset label
 LatexCommand label
@@ -613,7 +590,8 @@ name "enu:updatefiles"
 
 \end_inset
 
-Update LyX's .lyx documentation files to the new format.
+Test your lyx2lyx code by updating LyX's .lyx documentation files to the
+ new format.
  The developer who makes the change knows best what changes to expect when
  inspecting the resulting diff.
  Because of this, you might be able to catch a bug in the lyx2lyx code that
@@ -687,7 +665,52 @@ gen_lfuns.py
 \end_inset
 
  before being converted to the latest format.
- Finally, commit using 
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ Only commit file format changes in the doc files if these files are using
+ the new feature of the new file format.
+ The reason is rule
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "enu:The-fileformat-of"
+
+\end_inset
+
+ of the documentation policies described in sec.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Documentation-policies"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Enumerate
+Finally, commit using 
 \begin_inset Flex Code
 status collapsed
 
@@ -744,7 +767,7 @@ updatedocs.py
 \end_layout
 
 \begin_layout Standard
-Note that we do not automatically any local layout used in the 
+Note that we do not automatically update any local layout used in the 
 \begin_inset Flex Code
 status collapsed
 
@@ -2006,13 +2029,26 @@ src/tex2lyx/test
 \end_layout
 
 \begin_layout Itemize
-In the appearing MSVC program right-click on the project 
+In the appearing MSVC program assure that you build the 
+\emph on
+Release
+\emph default
+ version, then right-click on the project 
 \family sans
 updatetex2lyxtests
 \family default
- in the project explorer and chose 
+ in the project explorer and choose then 
 \family sans
-Create
+Project
+\begin_inset space ~
+\end_inset
+
+Only\SpecialChar menuseparator
+Rebuild
+\begin_inset space ~
+\end_inset
+
+only
 \family default
 .
 \end_layout
@@ -3358,7 +3394,7 @@ If the export did not fail previously but led to wrong output (PDF, say),
 status collapsed
 
 \begin_layout Plain Layout
-Non-failing test with wrong output should be labeledas 
+Non-failing test with wrong output should be labeled as 
 \begin_inset Quotes eld
 \end_inset
 
@@ -3410,7 +3446,7 @@ unreliable:nonstandard
 \begin_layout Itemize
 Check the log file Testing/Temporary/LastTest.log.
  In case of latex-errors rerun the failing test with environment variable
- 'LAX_DEBUG_LATEX' set to '1'.
+ 'LYX_DEBUG_LATEX' set to '1'.
  This will include latex messages in LastTest.log, so it should be easier
  to interpret the fail-reason.
 \end_layout
@@ -3792,8 +3828,10 @@ erratic Tests depending on local configuration or the phase of the moon.
 \end_layout
 
 \begin_layout Description
-varying_versions Test depending on TeX distribution, package versions or
- OS.
+varying_versions Tests depending on e.g.
+ OS or version of a non-TeX-Live dependency.
+ Note that a full, up-to-date TeX Live installation is required so this
+ sublabel is about versions of other dependencies.
 \end_layout
 
 \begin_layout Description
@@ -3883,7 +3921,7 @@ Input Each test which passed 'ignoredTests'
 
 \begin_layout Labeling
 \labelwidthstring 00.00.0000
-Output Stop if test selected, gain label 'unreliable'.
+Output Gain label 'unreliable', proceed with checking for 'inverted'.
 \end_layout
 
 \end_deeper
@@ -3898,7 +3936,7 @@ invertedTests
 \begin_deeper
 \begin_layout Labeling
 \labelwidthstring 00.00.0000
-Input Each test which passed 'unreliableTests'
+Input Each test which passed 'ignoredTests'
 \end_layout
 
 \begin_layout Labeling
@@ -3937,14 +3975,18 @@ The following table may clarify label assignement
 \end_layout
 
 \begin_layout Standard
+\begin_inset space \hspace{}
+\length -3cm
+\end_inset
+
+
 \begin_inset Tabular
-<lyxtabular version="3" rows="7" columns="9">
+<lyxtabular version="3" rows="6" columns="8">
 <features tabularvalignment="middle">
-<column alignment="left" valignment="top" width="0pt">
-<column alignment="left" valignment="top" width="0pt">
-<column alignment="left" valignment="top" width="0pt">
-<column alignment="left" valignment="top" width="0pt">
-<column alignment="center" valignment="top">
+<column alignment="left" valignment="top" width="2cm">
+<column alignment="left" valignment="top" width="2.5cm">
+<column alignment="left" valignment="top" width="2cm">
+<column alignment="center" valignment="top" width="2.5cm">
 <column alignment="center" valignment="top">
 <column alignment="center" valignment="top">
 <column alignment="center" valignment="top">
@@ -4002,15 +4044,6 @@ Assigned label
 
 \end_layout
 
-\end_inset
-</cell>
-<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\end_layout
-
 \end_inset
 </cell>
 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
@@ -4037,7 +4070,8 @@ test property
 \begin_inset Text
 
 \begin_layout Plain Layout
-ignoredTests
+ignored\SpecialChar softhyphen
+Tests
 \end_layout
 
 \end_inset
@@ -4046,7 +4080,8 @@ ignoredTests
 \begin_inset Text
 
 \begin_layout Plain Layout
-unreliableTests
+unreliable\SpecialChar softhyphen
+Tests
 \end_layout
 
 \end_inset
@@ -4055,16 +4090,18 @@ unreliableTests
 \begin_inset Text
 
 \begin_layout Plain Layout
-invertedTests
+inverted\SpecialChar softhyphen
+Tests
 \end_layout
 
 \end_inset
 </cell>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
-suspendedTests
+suspended\SpecialChar softhyphen
+Tests
 \end_layout
 
 \end_inset
@@ -4081,15 +4118,6 @@ export
 <cell alignment="center" valignment="top" topline="true" usebox="none">
 \begin_inset Text
 
-\begin_layout Plain Layout
-unreliable
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
 \begin_layout Plain Layout
 inverted
 \end_layout
@@ -4143,7 +4171,7 @@ Yes
 
 \end_inset
 </cell>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
@@ -4164,15 +4192,6 @@ Yes
 <cell alignment="center" valignment="top" topline="true" usebox="none">
 \begin_inset Text
 
-\begin_layout Plain Layout
-
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
 \begin_layout Plain Layout
 -
 \end_layout
@@ -4208,94 +4227,19 @@ No
 
 \end_inset
 </cell>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-Yes
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
--
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
--
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
--
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-+
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
--
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
--
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
+<cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
-
-\end_layout
-
+If Yes,
+\begin_inset Newline newline
 \end_inset
-</cell>
-</row>
-<row>
-<cell multirow="4" alignment="left" valignment="middle" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\end_layout
 
+add label
+\begin_inset Newline newline
 \end_inset
-</cell>
-<cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
 
-\begin_layout Plain Layout
-No
+'unreliable'
 \end_layout
 
 \end_inset
@@ -4309,7 +4253,7 @@ Yes
 
 \end_inset
 </cell>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
@@ -4334,15 +4278,6 @@ Yes
 -
 \end_layout
 
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
--
-\end_layout
-
 \end_inset
 </cell>
 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
@@ -4392,7 +4327,7 @@ WILL_FAIL
 
 \end_inset
 </cell>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
@@ -4413,15 +4348,6 @@ No
 <cell alignment="center" valignment="top" topline="true" usebox="none">
 \begin_inset Text
 
-\begin_layout Plain Layout
--
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
 \begin_layout Plain Layout
 +
 \end_layout
@@ -4475,7 +4401,7 @@ No
 
 \end_inset
 </cell>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
@@ -4500,15 +4426,6 @@ No
 -
 \end_layout
 
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
--
-\end_layout
-
 \end_inset
 </cell>
 <cell alignment="center" valignment="top" topline="true" bottomline="true" rightline="true" usebox="none">
@@ -5184,6 +5101,12 @@ No.
 \end_layout
 
 \begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Documentation-policies"
+
+\end_inset
+
 Documentation policies
 \end_layout
 
@@ -5258,6 +5181,12 @@ reference "enu:If-you-are"
 \end_layout
 
 \begin_layout Enumerate
+\begin_inset CommandInset label
+LatexCommand label
+name "enu:The-fileformat-of"
+
+\end_inset
+
 The fileformat of a file must not be changed unless you document a new feature
  in LyX that requires a new fileformat.
  The reason for this rule is to keep it easy for the doc maintainers to