]> git.lyx.org Git - lyx.git/blobdiff - lib/layouts/tcolorbox.module
DocBook: implement title for layouts that previously missed it.
[lyx.git] / lib / layouts / tcolorbox.module
index c27a6b40eade570f83da1d361d5a1bb2e380d165..92be7a0f9f3ddc054377ec502a99dd07fe1fd74a 100644 (file)
@@ -1,11 +1,13 @@
-#\DeclareLyXModule[tcolorbox.sty]{Fancy Colored Boxes}
+#\DeclareLyXModule[tcolorbox.sty,environ.sty,etoolbox.sty,pgf.sty]{Fancy Colored Boxes}
+#\DeclareCategory{Boxes}
 #DescriptionBegin
 #Adds custom insets that support colored boxes via the tcolorbox package.
 #See the tcolorbox documentation for details.
 #DescriptionEnd
 #Authors: Jürgen Spitzmüller
+#         Uwe Stöhr <uwestoehr@lyx.org>
 
-Format 54
+Format 85
 
 InsetLayout Flex:Color_Box
   LyXType               custom
@@ -17,36 +19,48 @@ InsetLayout Flex:Color_Box
   Argument 1
     LabelString         "Color Box Options"
     Tooltip             "Insert the color box options here (see tcolorbox manual)"
+    PassThruChars       "\[]{}"
+       DocBookTag          IGNORE
   EndArgument
   ResetsFont            true
+  DocBookTag            phrase
+  DocBookAttr           role='color-box'
 End
 
 InsetLayout Flex:Dynamic_Color_Box
-  LyXType               custom
-  Decoration            classic
-  LabelString           "Color Box (Dynamic)"
+  CopyStyle             Flex:Color_Box
   LatexType             command
+  LabelString           "Color Box (Dynamic)"
   LatexName             tcbox
-  Requires              tcolorbox
-  Argument 1
-    LabelString         "Color Box Options"
-    Tooltip             "Insert the color box options here (see tcolorbox manual)"
-  EndArgument
-  ResetsFont            true
+  DocBookTag            phrase
+  DocBookAttr           role='dynamic-color-box'
 End
 
 InsetLayout Flex:Fit_Color_Box
-  LyXType               custom
-  Decoration            classic
+  CopyStyle             Flex:Dynamic_Color_Box
   LabelString           "Color Box (Fit Contents)"
-  LatexType             command
   LatexName             tcboxfit
-  Requires              tcolorbox
+  DocBookTag            phrase
+  DocBookAttr           role='fit-color-box'
+End
+
+InsetLayout Flex:Raster_Color_Box
+  CopyStyle             Flex:Color_Box
+  LabelString           "Raster Color Box"
+  LatexName             tcbraster
+  DocBookTag            phrase
+  DocBookAttr           role='raster-color-box'
+End
+
+InsetLayout Flex:Subtitle
+  CopyStyle            Flex:Dynamic_Color_Box
+  LatexName            tcbsubtitle
+  LabelString          "Subtitle"
   Argument 1
-    LabelString         "Color Box Options"
-    Tooltip             "Insert the color box options here (see tcolorbox manual)"
+    LabelString        "Subtitle Options"
+    ToolTip            "Insert the options here"
+    PassThruChars      "\[]{}"
   EndArgument
-  ResetsFont            true
 End
 
 Style Color_Box_Separator
@@ -111,3 +125,84 @@ Style Color_Box_Setup
   Spellcheck       0
 End
 
+Style New_Color_Box_Type
+  CopyStyle           Color_Box_Setup
+  LatexName        newtcolorbox
+  LabelString      "New Color Box Type"
+  Font
+    Family         roman
+  EndFont
+  LabelFont
+    Color          green
+  EndFont
+  Argument 1
+    LabelString    "New Box Options"
+    Tooltip        "Options for the new box type (optional)"
+    PassThruChars  "\[]{}"
+  EndArgument
+  Argument 2
+    LabelString    "Name"
+    Tooltip        "Name of the new box type"
+    Mandatory      1
+    AutoInsert     1
+  EndArgument
+  Argument 3
+    LabelString    "Arguments"
+    Tooltip        "Number of arguments (remove this inset if none!)"
+    Requires       4
+    PassThru       1
+  EndArgument
+  Argument 4
+    LabelString    "Default Value"
+    Tooltip        "Default value for argument (keep empty!)"
+    Requires       3
+  EndArgument
+  DocBookTag       IGNORE
+End
+
+# define 5 different box environments that can be customized by the user
+
+InsetLayout Flex:Custom_Color_Box_1
+  CopyStyle        Flex:Color_Box
+  LabelString      "Custom Color Box 1"
+  LatexName        cBoxA
+  Argument 2
+    LabelString    "More Color Box Options"
+    Tooltip        "Insert more color box options here"
+    Mandatory      1
+  EndArgument
+  DocBookTag       phrase
+  DocBookAttr      role='color-box-1'
+End
+
+InsetLayout Flex:Custom_Color_Box_2
+  CopyStyle        Flex:Custom_Color_Box_1
+  LabelString      "Custom Color Box 2"
+  LatexName        cBoxB
+  DocBookTag       phrase
+  DocBookAttr      role='color-box-2'
+End
+
+InsetLayout Flex:Custom_Color_Box_3
+  CopyStyle        Flex:Custom_Color_Box_1
+  LabelString      "Custom Color Box 3"
+  LatexName        cBoxC
+  DocBookTag       phrase
+  DocBookAttr      role='color-box-3'
+End
+
+InsetLayout Flex:Custom_Color_Box_4
+  CopyStyle        Flex:Custom_Color_Box_1
+  LabelString      "Custom Color Box 4"
+  LatexName        cBoxD
+  DocBookTag       phrase
+  DocBookAttr      role='color-box-4'
+End
+
+InsetLayout Flex:Custom_Color_Box_5
+  CopyStyle        Flex:Custom_Color_Box_1
+  LabelString      "Custom Color Box 5"
+  LatexName        cBoxE
+  DocBookTag       phrase
+  DocBookAttr      role='color-box-5'
+End