Update layout format.

[features.git] / lib / layouts / stdinsets.inc

diff --git a/lib/layouts/stdinsets.inc b/lib/layouts/stdinsets.inc
index 5e051a151704da8dc376988fbbfe64a9730c65d1..5cb4e77f3f61980c136293ad48e7dae0e0279d08 100644 (file)
--- a/lib/layouts/stdinsets.inc
+++ b/lib/layouts/stdinsets.inc
@@ -1,8 +1,55 @@
 # Textclass definition file for LaTeX.
-# Author : Martin vermeer <amrtin.vermeer@hut.fi>
+# Author : Martin vermeer <martin.vermeer@hut.fi>
 # Inset layouts definition
+#
+# More detailled format description is available in the customization manual
+# FIXME: create the contents in the manual and put the link here.  
+#
+#InsetLayout <string identifier used by LyX>
+#      LabelString           used for the inset decoration (either the inset button
+#                            or the text underneath the inset).
+#      LatexType             associated LateX type: command, environment, or none.
+#      LatexName             associated LateX command.
+#      BgColor               Color of the inset background within LyX.
+#                         FIXME: link to a doc file describing the different
+#                         color codes as defined in 'ColorCode.h'
+#      Font                  Nothing to put here, below are descriptions of the different
+#                         allowable adjustments for the font used to draw the text
+#                         appearing within the inset text. All these items are optional.
+#        Color               Color of text
+#        Size                Font size of the textallowed value: Small, Smaller, ...
+#                         FIXME defined in FontSize in FontEnums.h
+#        Family              FIXME defined in FontFamily in FontEnums.h
+#        Shape               FIXME defined in FontShape in FontEnums.h
+#        Series              FIXME defined in FontSeries in FontEnums.h
+#        Misc                FIXME defined in FontMisc in FontEnums.h
+#      EndFont               Nothing to put here, it's just a markup to indicate that we are
+#                         finished with the Font definition.
+#      LabelFont             Nothing to put here, below are descriptions of the different
+#                         allowable adjustments for the font used to draw the text
+#                         appearing within the inset decoration. All these items are
+#                         optional.
+#        Color               see definition above (in the Font node).
+#        Size                see definition above (in the Font node).
+#
+#      EndFont               Nothing to put here, it's just a markup to indicate that we are
+#                         finished with the LabelFont definition.
+#      MultiPar              Indicates that multiple paragraphs are allowed within the inset
+#                         or not. FIXME: what is the default?
+#      Decoration:           Classic, Minimalistic, Conglomerate. Decoration styles
+#      PassThru              Do not do various LaTeX conversions, like the phrases
+#                              LaTeX, LyX, quote commands, etc.
+#      KeepEmpty             Do not delete empty paragraphs (?)
+#      FreeSpacing           Preserve multiple spaces etc.
+#      ForceLTR              Force the "latex" language, leading to Left-to-Right
+#                              (latin) output, e.g., in ERT or URL. A kludge.
+#      Requires              Require a given (supported) feature. Multiple features must
+#                         be comma-separated.
+#End
 
-Format 5
+Format 8
+
+Provides stdinsets 1
 
 InsetLayout Marginal
        LabelString           margin
@@ -19,7 +66,7 @@ InsetLayout Marginal
          Misc                No_Bar
        EndFont
        LabelFont
-         Color               Red
+         Color               marginlabel
          Size                Small
        EndFont
        MultiPar              true
@@ -40,7 +87,7 @@ InsetLayout Foot
          Misc                No_Bar
        EndFont
        LabelFont
-         Color               Green
+         Color               footlabel
          Size                Small
        EndFont
        MultiPar              true
@@ -83,30 +130,6 @@ InsetLayout Note:Greyedout
        MultiPar              true
 End
 
-InsetLayout Note:Framed
-       LabelString           framed
-       LatexType             environment
-       LatexName             framed
-       BgColor               greyedoutbg
-       LabelFont
-         Color               greyedout
-         Size                Small
-       EndFont
-       MultiPar              true
-End
-
-InsetLayout Note:Shaded
-       LabelString           shaded
-       LatexType             environment
-       LatexName             shaded
-       BgColor               shaded
-       LabelFont
-         Color               greyedout
-         Size                Small
-       EndFont
-       MultiPar              true
-End
-
 InsetLayout ERT
        LabelString           ERT
        LatexType             none
@@ -142,12 +165,13 @@ InsetLayout Listings
        PassThru              true
        KeepEmpty             true
        FreeSpacing           true
+       ForceLTR              true
 End
 
 InsetLayout Branch
-       Decoration            minimalistic
+       Decoration            classic
        LabelFont
-         Color               Red
+         Color               branchlabel
          Size                Small
        EndFont
        MultiPar              true
@@ -157,9 +181,9 @@ InsetLayout Index
        LabelString           Idx
        LatexType             command
        LatexName             index
-       Decoration            minimalistic
+       Decoration            classic
        Font
-         Color               Green
+         Color               foreground
          Size                Small
          Family              Roman
          Shape               Up
@@ -169,7 +193,7 @@ InsetLayout Index
          Misc                No_Bar
        EndFont
        LabelFont
-         Color               Green
+         Color               indexlabel
          Size                Small
        EndFont
        MultiPar              false
@@ -184,6 +208,15 @@ InsetLayout Box
        MultiPar              true
 End
 
+InsetLayout Box:Shaded
+       BgColor               shaded
+       LabelFont
+         Color               foreground
+         Size                Small
+       EndFont
+       MultiPar              true
+End
+
 InsetLayout figure
        LabelString           Figure
        LabelFont
@@ -202,25 +235,40 @@ InsetLayout table
        MultiPar              true
 End
 
+InsetLayout algorithm
+       LabelString           Algorithm
+       LabelFont
+         Color               collapsable
+         Size                Small
+       EndFont
+       MultiPar              true
+End
+
 InsetLayout URL
        LyXType               standard
        LatexName             url
        LatexType             command
-       Decoration            minimalistic
+       Decoration            classic
        LabelString           URL
        PassThru              true
        ForceLTR              true
        Font
          Family              Typewriter
-         Color               Blue
+         Color               urltext
        EndFont
        LabelFont
          Family              Typewriter
-         Color               Blue
+         Color               urllabel
          Size                Small
        EndFont
-       Preamble
-         \usepackage{url}
-       EndPreamble
+       Requires              url
 End
 
+InsetLayout OptArg
+       LabelString           opt
+       LabelFont
+         Color               collapsable
+         Size                Small
+       EndFont
+       MultiPar              false
+End