[LyX/master] Adapt documentation of Japanese classes

Juergen Spitzmueller spitz at lyx.org
Wed Feb 8 09:27:02 UTC 2023 

commit 8820b0e4419c106730e0afec248857fad5214d90
Author: Juergen Spitzmueller <spitz at lyx.org>
Date:   Wed Feb 8 11:27:20 2023 +0100

    Adapt documentation of Japanese classes
---
 lib/doc/Additional.lyx    |  425 +++++++++++++++++++++++++++++++++++++--------
 lib/doc/LaTeXConfig.lyx   |   95 ++++++++++-
 lib/doc/de/Additional.lyx |  274 +++++++++++++++++++++++++++--
 3 files changed, 703 insertions(+), 91 deletions(-)

diff --git a/lib/doc/Additional.lyx b/lib/doc/Additional.lyx
index e1210ab..f7a568a 100644
--- a/lib/doc/Additional.lyx
+++ b/lib/doc/Additional.lyx
@@ -4056,11 +4056,108 @@ name "subsec:Japanese"
 \end_inset
 
 Japanese
+\change_inserted -712698321 1675848645
+ (Standard Classes)
+\change_inserted 564990737 1671383236
+
 \end_layout
 
 \begin_layout Standard
 
-\change_inserted 564990737 1671383236
+\change_inserted -712698321 1675848905
+\SpecialChar LyX
+ included a collection of several bundles that aim to facilitate typesetting Japanese documents.
+ The bundles have been developed at different times,
+ they thus support different typesetting engines and features.
+ This collection is the oldest one.
+ It adjusts the \SpecialChar LaTeX
+ standard classes to requirements of Japanese typesetting,
+ for horizontal and vertical writing.
+ The collection includes 
+\family sans
+Japanese Article (Standard Class)
+\family default
+,
+ 
+\family sans
+Japanese Article
+\begin_inset space \thinspace{}
+\end_inset
+
+(Standard Class Vertical Writing)
+\family default
+,
+ 
+\family sans
+Japanese Book
+\begin_inset space \thinspace{}
+\end_inset
+
+(Standard Class)
+\family default
+,
+ 
+\family sans
+Japanese Book
+\begin_inset space \thinspace{}
+\end_inset
+
+(Standard Class Vertical Writing)
+\family default
+,
+ 
+\family sans
+Japanese Report
+\begin_inset space \thinspace{}
+\end_inset
+
+(Japanese Standard Class)
+\family default
+,
+ and
+\family sans
+ Japanese Report
+\begin_inset space \thinspace{}
+\end_inset
+
+(Standard Class Vertical Writing).
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -712698321 1675848929
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Japanese-JS"
+
+\end_inset
+
+Japanese (JS Bundle)
+\change_unchanged
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1675849034
+This collection includes improved versions of the classes included in 
+\family sans
+Japanese (Standard Classes)
+\family default
+ (see
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Japanese"
+
+\end_inset
+
+).
+ It includes 
+\change_deleted -712698321 1675849038
 The document classes 
 \change_inserted -712698321 1673089024
 
@@ -4079,46 +4176,42 @@ rticle
 \change_deleted -712698321 1673089027
 Japanese 
 \change_inserted 564990737 1671383236
-JS Class)
+JS 
+\change_deleted -712698321 1675848222
+Class
+\change_inserted -712698321 1675848223
+Bundle
+\change_inserted 564990737 1671383236
+)
+\change_deleted -712698321 1675849103
+
 \family default
 ,
 
+\change_inserted 564990737 1671383236
+
 \family sans
  
-\change_deleted -712698321 1673089041
+\change_deleted -712698321 1675849055
 article
-\change_inserted -712698321 1673089041
-Japanese Article
-\change_inserted 564990737 1671383236
-
 \begin_inset space \thinspace{}
 \end_inset
 
-(
-\change_deleted -712698321 1673089044
-Japanese 
-\change_inserted 564990737 1671383236
-Standard Class Vertical Writing)
+(Japanese Standard Class Vertical Writing)
 \family default
 ,
  
-\change_deleted -712698321 1673089041
-
 \family sans
 article
 \begin_inset space \thinspace{}
 \end_inset
 
 (Japanese Standard Class)
-\change_inserted -712698321 1673088992
-Japanese Article (Standard Class)
-\change_inserted 564990737 1671383236
-
 \family default
 ,
  
-\change_inserted -712698321 1673089053
-
+\change_inserted -712698321 1675849107
+and 
 \family sans
 Japanese 
 \change_deleted -712698321 1673089053
@@ -4134,86 +4227,277 @@ ook
 \change_deleted -712698321 1673089067
 Japanese 
 \change_inserted 564990737 1671383236
-JS Class)
+JS 
+\change_deleted -712698321 1675849059
+Class
+\change_inserted -712698321 1675849059
+Bundle
+\change_inserted 564990737 1671383236
+)
+\change_deleted -712698321 1675849095
+
 \family default
 ,
 
 \family sans
+ book
+\begin_inset space \thinspace{}
+\end_inset
+
+(Japanese Standard Class Vertical Writing)
+\family default
+,
  
-\change_inserted -712698321 1673089073
-Japanese B
-\change_deleted -712698321 1673089270
-b
-\change_inserted 564990737 1671383236
-ook
+\family sans
+book
 \begin_inset space \thinspace{}
 \end_inset
 
-(
-\change_deleted -712698321 1673089077
-Japanese 
-\change_inserted 564990737 1671383236
-Standard Class Vertical Writing)
+(Japanese Standard Class)
 \family default
 ,
  
-\change_deleted -712698321 1673089083
+\family sans
+report
+\begin_inset space \thinspace{}
+\end_inset
 
+(Japanese Vertical Writing)
+\family default
+ and 
 \family sans
-b
-\change_inserted -712698321 1673089083
-Japanese B
-\change_inserted 564990737 1671383236
-ook
+report
 \begin_inset space \thinspace{}
 \end_inset
 
-(
-\change_deleted -712698321 1673089087
-Japanese 
+(Japanese Standard Class)
+\family default
+ provide document classes for the Japanese language
 \change_inserted 564990737 1671383236
-Standard Class)
+.
+
+\change_inserted -712698321 1675849238
+ A report class can be obtained by using 
+\family sans
+Japanese Book
+\begin_inset space \thinspace{}
+\end_inset
+
+(JS Bundle)
+\family default
+ with option 
+\family sans
+report
+\family default
+ in 
+\family sans
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Document Class\SpecialChar menuseparator
+Class Options\SpecialChar menuseparator
+Custom
+\family default
+.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -712698321 1675848572
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Japanese-BX"
+
+\end_inset
+
+Japanese (BX Bundle)
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1675851891
+This bundle contains the document classes 
+\family sans
+Japanese Article
+\begin_inset space \thinspace{}
+\end_inset
+
+(BX Bundle)
 \family default
 ,
- 
-\change_inserted -712698321 1673089094
 
 \family sans
-Japanese 
-\change_deleted -712698321 1673089094
-r
-\change_inserted -712698321 1673089094
-R
-\change_inserted 564990737 1671383236
-eport
+ Japanese Book
 \begin_inset space \thinspace{}
 \end_inset
 
-(
-\change_deleted -712698321 1673089097
-Japanese 
-\change_inserted 564990737 1671383236
-Vertical Writing)
+(BX Bundle)
 \family default
+,
  and 
-\change_deleted -712698321 1673089104
+\family sans
+Japanese Report
+\begin_inset space \thinspace{}
+\end_inset
 
+(BX Bundle)
+\family default
+ which provide alternative document classes for Japanese documents.
+ Furthermore,
+ a class 
 \family sans
-r
-\change_inserted -712698321 1673089104
-Japanese R
-\change_inserted 564990737 1671383236
-eport
+Japanese Slides (BX Bundle)
+\family default
+ for presentation slides,
+ is included.
+ As opposed to the classes of the 
+\family sans
+Standard Classes
+\family default
+ and 
+\family sans
+JS 
+\family default
+bundles (sec.
+ 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Japanese"
+
+\end_inset
+
+ and 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Japanese-JS"
+
+\end_inset
+
+),
+ which support only p\SpecialChar LaTeX
+ and up\SpecialChar LaTeX
+,
+ the classes of this bundle also support pdf\SpecialChar LaTeX
+,
+ Xe\SpecialChar LaTeX
+ and Lua\SpecialChar LaTeX
+,
+ with the aid of suitable packages that provide capability of Japanese typesetting.
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -712698321 1675850366
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Japanese-JLReq"
+
+\end_inset
+
+Japanese (JLReq Class)
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1675850768
+This bundle draws on the 
+\family sans
+jlreq
+\family default
+ class which faithfully traces the standard of 
+\emph on
+Requirements for Japanese Text Layout
+\emph default
+ set by the World Wide Web Consortium (W3C,
+ see 
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1675850769
+
+https://www.w3.org/TR/jlreq/?lang=en
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ It can be used with Lua\SpecialChar LaTeX
+ as well as p\SpecialChar LaTeX
+ and up\SpecialChar LaTeX
+.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1675850585
+LyX provides layouts for 
+\family sans
+Japanese Article
 \begin_inset space \thinspace{}
 \end_inset
 
-(
-\change_deleted -712698321 1673089107
-Japanese 
-\change_inserted 564990737 1671383236
-Standard Class)
+(JLReq Class)
+\family default
+,
+
+\family sans
+ Japanese Book
+\begin_inset space \thinspace{}
+\end_inset
+
+(JLReq Class)
 \family default
- provide document classes for the Japanese language.
+,
+ and 
+\family sans
+Japanese Report
+\begin_inset space \thinspace{}
+\end_inset
+
+(JLReq Class)
+\family default
+ which are all derived from the 
+\family sans
+jlreq
+\family default
+ \SpecialChar LaTeX
+ class via specific class options.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1675850701
+An example article document is available at 
+\family sans
+File\SpecialChar menuseparator
+Open Example\SpecialChar menuseparator
+Articles\SpecialChar menuseparator
+Japanese Article (JLReq Class)
+\family default
+.
+ English documentation is available at 
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1675850350
+
+http://mirrors.ctan.org/macros/jptex/latex/jlreq/jlreq.pdf
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\change_inserted 564990737 1671383236
+
 \end_layout
 
 \begin_layout Subsection
@@ -16469,8 +16753,9 @@ report
 \end_inset
 
 (Japanese in vertical writing)
-\change_inserted -712698321 1673690794
-Japanese Report (Vertical Writing)
+\change_inserted -712698321 1675851188
+Japanese Report (Standard Class,
+ vertical Writing)
 \change_inserted 564990737 1672743530
 
 \family default
diff --git a/lib/doc/LaTeXConfig.lyx b/lib/doc/LaTeXConfig.lyx
index 9583c55..c87eb2c 100644
--- a/lib/doc/LaTeXConfig.lyx
+++ b/lib/doc/LaTeXConfig.lyx
@@ -1,5 +1,5 @@
 #LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 614
+\lyxformat 615
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -4318,6 +4318,10 @@ t-
 
 \begin_layout Subsection
 Japanese new standard classes
+\change_inserted -712698321 1675846937
+ (JS Bundle)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -4394,7 +4398,13 @@ report
 \begin_layout Subsection
 
 \change_inserted 545138413 1674624942
-Japanese new standard classes (extended)
+Japanese new standard classes (
+\change_deleted -712698321 1675846861
+extended
+\change_inserted -712698321 1675846862
+BX bundle
+\change_inserted 545138413 1674624942
+)
 \end_layout
 
 \begin_layout Description
@@ -4462,10 +4472,91 @@ Notes:
  and Lua\SpecialChar LaTeX
 ,
  with the aid of suitable packages that provide capability of Japanese typesetting.
+\change_inserted -712698321 1675847177
+
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -712698321 1675847557
+Japanese new standard classes (JLReq class)
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1675847177
+Found:
+ 
+\begin_inset Info
+type  "textclass"
+arg   "jlreq"
+\end_inset
+
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1675847323
+CTAN:
+ 
+\family typewriter
+macros/jptex/latex/jlreq/
 \change_unchanged
 
 \end_layout
 
+\begin_layout Description
+
+\change_inserted -712698321 1675847462
+Notes:
+ The 
+\family sans
+jlreq
+\family default
+ class is a document class which faithfully traces the standard of 
+\emph on
+Requirements for Japanese Text Layout
+\emph default
+ set by the World Wide Web Consortium (W3C).
+ It can be used with Lua\SpecialChar LaTeX
+ as well as p\SpecialChar LaTeX
+ and up\SpecialChar LaTeX
+.
+ The default output of this document is via Lua\SpecialChar LaTeX
+.
+ The class includes equivalents of 
+\family sans
+article
+\family default
+,
+ 
+\family sans
+report
+\family default
+ and 
+\family sans
+book
+\family default
+ classes as a subset which is specified as a class option.
+ English documentation is available at 
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1675847462
+
+http://mirrors.ctan.org/macros/jptex/latex/jlreq/jlreq.pdf
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
 \begin_layout Subsection
 jss
 \end_layout
diff --git a/lib/doc/de/Additional.lyx b/lib/doc/de/Additional.lyx
index 0ea0526..bb37b33 100644
--- a/lib/doc/de/Additional.lyx
+++ b/lib/doc/de/Additional.lyx
@@ -3122,22 +3122,47 @@ name "subsec:Japanisch"
 
 \end_inset
 
-Japanisch
+Japanisch (Standardklassen)
 \end_layout
 
 \begin_layout Standard
-Die Dokumentklassen 
+\SpecialChar LyX
+ enthält mehrere Sammlungen,
+ die dazu dienen,
+ japanische Dokumente zu setzen.
+ Diese Sammlungen wurden zu verschiedenen Zeiten entwickelt,
+ entsprechend unterstützen sie unterschiedliche Ausgabewege und Features.
+ Diese Sammlung ist die älteste.
+ Sie passt die Standardklassen von \SpecialChar LaTeX
+ an,
+ sodass japanische Dokumente in horizontaler oder vertikaler Schreibrichtung gesetzt werden können.
+ Die Sammlung enthält die Klassen 
 \family sans
 Japanischer Aufsatz
 \begin_inset space \thinspace{}
 \end_inset
 
-(JS-Klasse)
+(Standardklasse)
 \family default
 ,
+ 
+\family sans
+Japanischer Aufsatz (Standardklasse,
+ vertikale Schreibrichtung)
+\family default
+,
+ 
+\family sans
+Japanisches Buch
+\begin_inset space \thinspace{}
+\end_inset
 
+(Standardklasse)
+\family default
+,
+ 
 \family sans
- Japanischer Aufsatz
+Japanisches Buch
 \begin_inset space \thinspace{}
 \end_inset
 
@@ -3147,16 +3172,113 @@ Japanischer Aufsatz
 ,
  
 \family sans
-Japanischer Aufsatz (Standardklasse)
+Japanischer Bericht
+\begin_inset space \thinspace{}
+\end_inset
+
+(Standardklasse)
 \family default
-,
- 
+ und 
+\family sans
+Japanischer Bericht
+\begin_inset space \thinspace{}
+\end_inset
+
+(Standardklasse,
+ vertikale Schreibrichtung).
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Japanisch-JS"
+
+\end_inset
+
+Japanisch (JS-Sammlung)
+\end_layout
+
+\begin_layout Standard
+Diese Sammlung bietet verbesserte Versionen der Klassen,
+ die in 
+\family sans
+Japanisch (Standardklassen)
+\family default
+ enthalten sind (s.
+\begin_inset space ~
+\end_inset
+
+Abschnitt
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Japanisch"
+
+\end_inset
+
+).
+ Sie enthält die Klassen 
+\family sans
+Japanischer Aufsatz
+\begin_inset space \thinspace{}
+\end_inset
+
+(JS-Sammlung)
+\family default
+ und 
+\family sans
+Japanisches Buch
+\begin_inset space \thinspace{}
+\end_inset
+
+(JS-Sammlung)
+\family default
+.
+ Eine Berichtsklasse kann mithilfe von 
 \family sans
 Japanisches Buch
 \begin_inset space \thinspace{}
 \end_inset
 
-(JS-Klasse)
+(JS-Sammlung)
+\family default
+ erzeugt werden,
+ indem die Option 
+\family sans
+report
+\family default
+ in 
+\family sans
+Dokument\SpecialChar menuseparator
+Einstellungen\SpecialChar ldots
+\SpecialChar menuseparator
+Dokumentklasse\SpecialChar menuseparator
+Klassenoptionen
+\family default
+ eingegeben wird.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Japanisch-BX"
+
+\end_inset
+
+Japanisch (BX-Sammlung)
+\end_layout
+
+\begin_layout Standard
+Die Dokumentklassen 
+\family sans
+Japanischer Aufsatz
+\begin_inset space \thinspace{}
+\end_inset
+
+(BX-Sammlung)
 \family default
 ,
 
@@ -3165,26 +3287,111 @@ Japanisches Buch
 \begin_inset space \thinspace{}
 \end_inset
 
-(Standardklasse,
- vertikale Schreibrichtung)
+(BX-Sammlung)
 \family default
+ und 
+\family sans
+Japanischer Bericht
+\begin_inset space \thinspace{}
+\end_inset
+
+(BX-Sammlung)
+\family default
+ bieten alternative Versionen für japanische Dokumente an.
+ Außerdem ist eine Klasse 
+\family sans
+Japanische Folien (BX-Sammlung)
+\family default
+ für Overheadfolien enthalten.
+ Im Gegensatz zu den Standardklassen und der JS-Sammlung (Abschnitt
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Japanisch"
+
+\end_inset
+
+ und 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Japanisch-JS"
+
+\end_inset
+
+),
+ die nur p\SpecialChar LaTeX
+ und up\SpecialChar LaTeX
+ unterstützen,
+ können die Klassen dieser Sammlung auch mit pdf\SpecialChar LaTeX
 ,
- 
+ Xe\SpecialChar LaTeX
+ und Lua\SpecialChar LaTeX
+ verwendet werden.
+ Hierzu werden Pakete zur Unterstützung japanischer Textausgabe herangezogen.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Japanisch-JLReq"
+
+\end_inset
+
+Japanisch (JLReq-Klasse)
+\end_layout
+
+\begin_layout Standard
+Diese Sammlung baut auf die \SpecialChar LaTeX
+-Klasse 
 \family sans
-Japanisches Buch
+jlreq
+\family default
+,
+ die sich an den Vorgaben des W3C-Konsortiums 
+\emph on
+\lang english
+Requirements for Japanese Text Layout
+\emph default
+\lang ngerman
+ orientiert (W3C,
+ siehe 
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+https://www.w3.org/TR/jlreq/?lang=en
+\end_layout
+
+\end_inset
+
+).
+ Sie kann sowohl mit Lua\SpecialChar LaTeX
+ als auch mit p\SpecialChar LaTeX
+ und up\SpecialChar LaTeX
+ verwendet werden.
+\end_layout
+
+\begin_layout Standard
+LyX bietet die Dokumentklassen 
+\family sans
+Japanischer Aufsatz
 \begin_inset space \thinspace{}
 \end_inset
 
-(Standardklasse)
+(JLReq-Klasse)
 \family default
 ,
- 
+
 \family sans
-Japanischer Bericht
+ Japanisches Buch
 \begin_inset space \thinspace{}
 \end_inset
 
-(Vertikale Schreibrichtung)
+(JLReq-Klasse)
 \family default
  und 
 \family sans
@@ -3192,9 +3399,38 @@ Japanischer Bericht
 \begin_inset space \thinspace{}
 \end_inset
 
-(Standardklasse)
+(JLReq-Klasse)
 \family default
- sind spezifisch für japanische Dokumente geeignet.
+,
+ welche alle von der \SpecialChar LaTeX
+-Klasse 
+\family sans
+jlreq
+\family default
+ über bestimmte Klassenoptionen abgeleitet sind.
+\end_layout
+
+\begin_layout Standard
+Eine Beispieldatei (für einen Aufsatz) finden Sie unter 
+\family sans
+Datei\SpecialChar menuseparator
+Beispiel öffnen\SpecialChar menuseparator
+Aufsätze/Artikel\SpecialChar menuseparator
+Japanischer Aufsatz (JLReq-Klasse)
+\family default
+.
+ Eine englische Anleitung ist unter 
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://mirrors.ctan.org/macros/jptex/latex/jlreq/jlreq.pdf
+\end_layout
+
+\end_inset
+
+ verfügbar.
 \end_layout
 
 \begin_layout Subsection
@@ -11646,7 +11882,7 @@ Japanischer Bericht (vertikale Schreibrichtung)
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "subsec:Japanisch"
+reference "subsec:Japanisch-JS"
 plural "false"
 caps "false"
 noprefix "false"

More information about the lyx-cvs mailing list