Additional.lyx: replace quotes character by LyX quotes

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

diff --git a/lib/doc/Development.lyx b/lib/doc/Development.lyx
index 92628dfb1a6b6d4955289caac26245705e6e5518..845f22aaa6f89feb78a2205c37350c17b35a95b5 100644 (file)
--- a/lib/doc/Development.lyx
+++ b/lib/doc/Development.lyx
@@ -1,5 +1,5 @@
 #LyX 2.3 created this file. For more info see http://www.lyx.org/
 #LyX 2.3 created this file. For more info see http://www.lyx.org/

-\lyxformat 512
+\lyxformat 544

 \begin_document
 \begin_header
 \save_transient_properties true
 \begin_document
 \begin_header
 \save_transient_properties true


@@ -26,6 +26,7 @@ logicalmkup
 \font_sf_scale 100 100
 \font_tt_scale 100 100
 \use_microtype false
 \font_sf_scale 100 100
 \font_tt_scale 100 100
 \use_microtype false

+\use_dash_ligatures true

 \graphics default
 \default_output_format pdf2
 \output_sync 1
 \graphics default
 \default_output_format pdf2
 \output_sync 1


@@ -78,7 +79,10 @@ logicalmkup
 \tocdepth 4
 \paragraph_separation indent
 \paragraph_indentation default
 \tocdepth 4
 \paragraph_separation indent
 \paragraph_indentation default

-\quotes_language english
+\is_math_indent 0
+\math_numbering_side default
+\quotes_style english
+\dynamic_quotes 0

 \papercolumns 1
 \papersides 2
 \paperpagestyle headings
 \papercolumns 1
 \papersides 2
 \paperpagestyle headings


@@ -87,6 +91,7 @@ logicalmkup
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true

+\use_minted 0

 \end_header
 
 \begin_body
 \end_header
 
 \begin_body


@@ -459,30 +464,6 @@ src/version.h
 .
 \end_layout
 
 .
 \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
 \begin_layout Enumerate
 \begin_inset CommandInset label
 LatexCommand label


@@ -613,7 +594,8 @@ name "enu:updatefiles"
 
 \end_inset
 
 
 \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
  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 +669,52 @@ gen_lfuns.py
 \end_inset
 
  before being converted to the latest format.
 \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
 
 \begin_inset Flex Code
 status collapsed
 


@@ -744,7 +771,7 @@ updatedocs.py
 \end_layout
 
 \begin_layout Standard
 \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
 
 \begin_inset Flex Code
 status collapsed
 


@@ -1135,6 +1162,7 @@ officially supported
 \begin_inset CommandInset href
 LatexCommand href
 target "https://wiki.lyx.org/Layouts/Layouts"
 \begin_inset CommandInset href
 LatexCommand href
 target "https://wiki.lyx.org/Layouts/Layouts"

+literal "false"

 
 \end_inset
 
 
 \end_inset
 


@@ -1154,6 +1182,7 @@ See
 LatexCommand href
 name "the thread “Proposal for a guide on updating layouts”"
 target "http://permalink.gmane.org/gmane.editors.lyx.devel/161202"
 LatexCommand href
 name "the thread “Proposal for a guide on updating layouts”"
 target "http://permalink.gmane.org/gmane.editors.lyx.devel/161202"

+literal "false"

 
 \end_inset
 
 
 \end_inset
 


@@ -2006,13 +2035,26 @@ src/tex2lyx/test
 \end_layout
 
 \begin_layout Itemize
 \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
 \family sans
 updatetex2lyxtests
 \family default

- in the project explorer and chose 
+ in the project explorer and choose then 

 \family sans
 \family sans

-Create
+Project
+\begin_inset space ~
+\end_inset
+
+Only\SpecialChar menuseparator
+Rebuild
+\begin_inset space ~
+\end_inset
+
+only

 \family default
 .
 \end_layout
 \family default
 .
 \end_layout


@@ -3358,7 +3400,7 @@ If the export did not fail previously but led to wrong output (PDF, say),
 status collapsed
 
 \begin_layout Plain Layout
 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
 
 \begin_inset Quotes eld
 \end_inset
 


@@ -3402,9 +3444,17 @@ unreliable:nonstandard
 \begin_inset Quotes erd
 \end_inset
 
 \begin_inset Quotes erd
 \end_inset
 

- or testing on a system withonly a subset of TeXLive installed), ignore
+ or testing on a system with only a subset of TeXLive installed), ignore

  the failure, ask for someone else to run the test, or install the missing
  the failure, ask for someone else to run the test, or install the missing

- ressources and try again.
+ resources and try again.
+\end_layout
+
+\begin_layout Itemize
+Check the log file Testing/Temporary/LastTest.log.
+ In case of latex-errors rerun the failing test with environment variable
+ '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
 
 \begin_layout Paragraph
 \end_layout
 
 \begin_layout Paragraph


@@ -3784,8 +3834,10 @@ erratic Tests depending on local configuration or the phase of the moon.
 \end_layout
 
 \begin_layout Description
 \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
 \end_layout
 
 \begin_layout Description


@@ -3875,7 +3927,7 @@ Input Each test which passed 'ignoredTests'
 
 \begin_layout Labeling
 \labelwidthstring 00.00.0000
 
 \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
 \end_layout
 
 \end_deeper


@@ -3890,7 +3942,7 @@ invertedTests
 \begin_deeper
 \begin_layout Labeling
 \labelwidthstring 00.00.0000
 \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
 \end_layout
 
 \begin_layout Labeling


@@ -3929,14 +3981,18 @@ The following table may clarify label assignement
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard

+\begin_inset space \hspace{}
+\length -3cm
+\end_inset
+
+

 \begin_inset Tabular
 \begin_inset Tabular

-<lyxtabular version="3" rows="7" columns="9">
+<lyxtabular version="3" rows="6" columns="8">

 <features tabularvalignment="middle">
 <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">
 <column alignment="center" valignment="top">
 <column alignment="center" valignment="top">
 <column alignment="center" valignment="top">


@@ -3994,15 +4050,6 @@ Assigned label
 
 \end_layout
 
 
 \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">
 \end_inset
 </cell>
 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">


@@ -4029,7 +4076,8 @@ test property
 \begin_inset Text
 
 \begin_layout Plain Layout
 \begin_inset Text
 
 \begin_layout Plain Layout

-ignoredTests
+ignored\SpecialChar softhyphen
+Tests

 \end_layout
 
 \end_inset
 \end_layout
 
 \end_inset


@@ -4038,7 +4086,8 @@ ignoredTests
 \begin_inset Text
 
 \begin_layout Plain Layout
 \begin_inset Text
 
 \begin_layout Plain Layout

-unreliableTests
+unreliable\SpecialChar softhyphen
+Tests

 \end_layout
 
 \end_inset
 \end_layout
 
 \end_inset


@@ -4047,16 +4096,18 @@ unreliableTests
 \begin_inset Text
 
 \begin_layout Plain Layout
 \begin_inset Text
 
 \begin_layout Plain Layout

-invertedTests
+inverted\SpecialChar softhyphen
+Tests

 \end_layout
 
 \end_inset
 </cell>
 \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
 \begin_inset Text
 
 \begin_layout Plain Layout

-suspendedTests
+suspended\SpecialChar softhyphen
+Tests

 \end_layout
 
 \end_inset
 \end_layout
 
 \end_inset


@@ -4073,15 +4124,6 @@ export
 <cell alignment="center" valignment="top" topline="true" usebox="none">
 \begin_inset Text
 
 <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
 \begin_layout Plain Layout
 inverted
 \end_layout


@@ -4135,7 +4177,7 @@ Yes
 
 \end_inset
 </cell>
 
 \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
 \begin_inset Text
 
 \begin_layout Plain Layout


@@ -4156,15 +4198,6 @@ Yes
 <cell alignment="center" valignment="top" topline="true" usebox="none">
 \begin_inset Text
 
 <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
 \begin_layout Plain Layout
 -
 \end_layout


@@ -4200,94 +4233,19 @@ No
 
 \end_inset
 </cell>
 
 \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
 \begin_inset Text
 
 \begin_layout Plain Layout

-
-\end_layout
-
+If Yes,
+\begin_inset Newline newline

 \end_inset
 \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
 \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
 \end_layout
 
 \end_inset


@@ -4301,7 +4259,7 @@ Yes
 
 \end_inset
 </cell>
 
 \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
 \begin_inset Text
 
 \begin_layout Plain Layout


@@ -4326,15 +4284,6 @@ Yes
 -
 \end_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">
 \end_inset
 </cell>
 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">


@@ -4384,7 +4333,7 @@ WILL_FAIL
 
 \end_inset
 </cell>
 
 \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
 \begin_inset Text
 
 \begin_layout Plain Layout


@@ -4405,15 +4354,6 @@ No
 <cell alignment="center" valignment="top" topline="true" usebox="none">
 \begin_inset Text
 
 <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
 \begin_layout Plain Layout
 +
 \end_layout


@@ -4467,7 +4407,7 @@ No
 
 \end_inset
 </cell>
 
 \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
 \begin_inset Text
 
 \begin_layout Plain Layout


@@ -4492,15 +4432,6 @@ No
 -
 \end_layout
 
 -
 \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">
 \end_inset
 </cell>
 <cell alignment="center" valignment="top" topline="true" bottomline="true" rightline="true" usebox="none">


@@ -5176,9 +5107,98 @@ No.
 \end_layout
 
 \begin_layout Section
 \end_layout
 
 \begin_layout Section

+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Documentation-policies"
+
+\end_inset
+

 Documentation policies
 \end_layout
 
 Documentation policies
 \end_layout
 

+\begin_layout Subsection
+Rules
+\end_layout
+
+\begin_layout Standard
+There are 6
+\begin_inset space ~
+\end_inset
+
+rules in editing the docs:
+\end_layout
+
+\begin_layout Enumerate
+\begin_inset CommandInset label
+LatexCommand label
+name "enu:If-you-are"
+
+\end_inset
+
+If you are not the maintainer of a doc file or a chapter/section, you MUST
+ use change tracking so that the maintainer could review your changes
+\end_layout
+
+\begin_layout Enumerate
+Respect the formatting of the document.
+ The different files use different formatting styles.
+ That is OK and has historic reasons nobody fully knows ;-).
+ But it is important to be consistent within one file.
+\end_layout
+
+\begin_layout Enumerate
+All changes you make to a file in one language MUST also go the file in
+ the other actively maintained languages.
+ Normally the maintainer does this for you, if you are the maintainer, you
+ must do this by copying or changing the changed or added text to the other
+ files so that the translators sees the blue underlined text and know what
+ they have to translate and what was changed.
+\end_layout
+
+\begin_layout Enumerate
+You MUST assure that the document is compilable as 
+\begin_inset Quotes eld
+\end_inset
+
+PDF (pdflatex)
+\begin_inset Quotes erd
+\end_inset
+
+ or the document's default output format after your changes.
+\end_layout
+
+\begin_layout Enumerate
+All fixes (typos, compilation fixes, updates info etc.) go at first into
+ the current GIT branch because the user should benefit from all fixes with
+ every minor release.
+ Feel free to commit directly to branch as long as you follow rule
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "enu:If-you-are"
+
+\end_inset
+
+.
+ You can immediately commit to master as well.
+\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
+ port/backport changes to from master/branch.
+\end_layout
+

 \begin_layout Standard
 The main documentation consists of these files:
 \end_layout
 \begin_layout Standard
 The main documentation consists of these files:
 \end_layout


@@ -5273,46 +5293,5 @@ Customization.lyx this manual covers information how to customize \SpecialChar L
  distributions (meaning be as objective as possible).
 \end_layout
 
  distributions (meaning be as objective as possible).
 \end_layout
 

-\begin_layout Standard
-There are only 4
-\begin_inset space ~
-\end_inset
-
-rules in editing the docs:
-\end_layout
-
-\begin_layout Enumerate
-If you are not the maintainer of a doc file or a chapter/section, you MUST
- use change tracking so that the maintainer could review your changes
-\end_layout
-
-\begin_layout Enumerate
-Respect the formatting of the document.
- The different files use different formatting styles.
- That is OK and has historic reasons nobody fully knows ;-).
- But it is important to be consistent within one file.
-\end_layout
-
-\begin_layout Enumerate
-All changes you make to a file in one language MUST also go the file in
- the other actively maintained languages.
- Normally the maintainer does this for you, if you are the maintainer, you
- must do this by copying or changing the changed or added text to the other
- files so that the translators sees the blue underlined text and know what
- they have to translate and what was changed.
-\end_layout
-
-\begin_layout Enumerate
-You MUST assure that the document is compilable as 
-\begin_inset Quotes eld
-\end_inset
-
-PDF (pdflatex)
-\begin_inset Quotes erd
-\end_inset
-
- after your changes.
-\end_layout
-

 \end_body
 \end_document
 \end_body
 \end_document