Create Chapter 6 Bullets in Additional.lyx and move the bullet section into it; this...

[lyx.git] / lib / scripts / docbook_copy.py

diff --git a/lib/scripts/docbook_copy.py b/lib/scripts/docbook_copy.py
index d2e4fe005857f05986564268d19cee83b8aed3ba..186bbe554f78e6bcb1949495c43a87d80a9ae4e0 100644 (file)
--- a/lib/scripts/docbook_copy.py
+++ b/lib/scripts/docbook_copy.py
@@ -61,10 +61,22 @@ class DocBookCopier:
     def preprocess_input_for_lilypond(self):
         # LilyPond requires that its input file has the .lyxml extension. Due to a bug in LilyPond,
         # use " instead of ' to encode XML attributes.
-        # https://lists.gnu.org/archive/html/bug-lilypond/2021-09/msg00039.html
+        # Bug report: https://gitlab.com/lilypond/lilypond/-/issues/6185
         # Typical transformation:
+        # Fixed by 2.23.4.
         #     FROM:  language='lilypond' role='fragment verbatim staffsize=16 ragged-right relative=2'
         #     TO:    language="lilypond" role="fragment verbatim staffsize=16 ragged-right relative=2"
+
+        # Another problem to fix: the output is in XML, with some characters encoded as XML
+        # entities. For instance, this could be in a LilyPond snippet:
+        #     \new PianoStaff <<
+        # instead of:
+        #     \new PianoStaff <<
+        # (More complete example:
+        # https://lilypond.org/doc/v2.23/Documentation/learning/piano-centered-lyrics.)
+        # This issue must be fixed by LilyPond, as any change in this part would make the XML
+        # file invalid.
+        # Bug report: https://gitlab.com/lilypond/lilypond/-/issues/6204
         with open(self.in_file, 'r', encoding='utf-8') as f, open(self.in_lily_file, 'w', encoding='utf-8') as f_lily:
             for line in f:
                 if "language='lilypond'" in line:
@@ -77,15 +89,12 @@ class DocBookCopier:
         os.unlink(self.in_file)
 
     def postprocess_output_for_lilypond(self):
+        # Major problem: LilyPond used to output the LilyPond code outside the image, which is then always displayed
+        # before the image (instead of only the generated image).
+        # Bug report: https://gitlab.com/lilypond/lilypond/-/issues/6186
+        # No more necessary with the new version of LilyPond (2.23.4). No efficient way to decide how to post-process
+        # for previous versions of LilyPond. Basically, it does not make sense to post-process.
         pass
-        # # Erase the <programlisting> that LilyPond left behind in the XML.
-        # in_file_before = self.in_file + '.tmp'
-        # shutil.move(self.in_file, in_file_before)
-        # with open(in_file_before, 'r', encoding='utf-8') as f_before, open(self.in_file, 'w', encoding='utf-8') as f_after:
-        #     looking_for_end_programlisting = False
-        #     for line in f_before:
-        #         # TODO: find an efficient way to distinguish those left-overs.
-        # https://lists.gnu.org/archive/html/bug-lilypond/2021-09/msg00040.html
 
     def call_lilypond(self):
         # LilyPond requires that its input file has the .lyxml extension (plus bugs in LilyPond).