[LyX/master] Highlight limitations of current multicol DocBook implementation.

[Richard Kimberly Heck]

commit d1398a5ba29273c8690707722a5d9a1aa16a33d8
Author: Thibaut Cuvelier <thibaut at tcuvelier.be>
Date:   Mon Jul 31 21:27:18 2023 -0400

    Highlight limitations of current multicol DocBook implementation.
---
 lib/layouts/multicol.module |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)

diff --git a/lib/layouts/multicol.module b/lib/layouts/multicol.module
index 3d40754..c3148ff 100644
--- a/lib/layouts/multicol.module
+++ b/lib/layouts/multicol.module
@@ -38,6 +38,16 @@ InsetLayout Flex:Multiple_Columns
 	DocBookTag      IGNORE
   EndArgument
   ResetsFont        true
+
+  # The current DocBook implementation is quite lacking, but it would require
+  # a lot more C++ code to have perfect output. The major problem: not all
+  # elements within a column should be wrapped in an item. It has been
+  # designed for pure text (like in Modules > Page Layout > Multiple Columns,
+  # the excerpt of "The Adventure of the Empty House"), it produces wrong
+  # output for lists (such as Document classes > Articles > Astronomy >
+  # Supported environments, the Columns flex only contains a list). Columns
+  # within columns are not supported either (as in Modules > Page Layout >
+  # Multiple Columns > Columns inside Columns).
   DocBookWrapperTag NONE
   DocBookTag        NONE
   DocBookNotInPara  true