]> git.lyx.org Git - lyx.git/blobdiff - lib/layouts/stdinsets.inc
stdinset.inc: Some more documentation from Martin.
[lyx.git] / lib / layouts / stdinsets.inc
index 4c3af0837b5c1480cf58d367a3e4064524974b69..6a828077c8917da034eec802f189c3d38d0985e8 100644 (file)
 # 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 
+#        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\r
+#      PassThru              Do not do various LaTeX conversions, like the phrases\r
+#                            LaTeX, LyX, quote commands, etc.\r
+#      KeepEmpty             Do not delete empty paragraphs (?)\r
+#      FreeSpacing           Preserve multiple spaces etc.\r
+#      ForceLTR              Force the "latex" language, leading to Left-to-Right\r
+#                           (latin) output, e.g., in ERT or URL. A kludge.\r
+#End
 
-Format 4
+Format 5
 
 InsetLayout Marginal
        LabelString           margin
        LatexType             command
        LatexName             marginpar
+       Font
+         Color               foreground
+         Size                Small
+         Family              Roman
+         Shape               Up
+         Series              Medium
+         Misc                No_Emph
+         Misc                No_Noun
+         Misc                No_Bar
+       EndFont
        LabelFont
          Color               Red
          Size                Small
        EndFont
+       MultiPar              true
 End
 
 InsetLayout Foot
        LabelString           foot
        LatexType             command
        LatexName             footnote
+       Font
+         Color               foreground
+         Size                Small
+         Family              Roman
+         Shape               Up
+         Series              Medium
+         Misc                No_Emph
+         Misc                No_Noun
+         Misc                No_Bar
+       EndFont
        LabelFont
          Color               Green
          Size                Small
        EndFont
+       MultiPar              true
 End
 
 InsetLayout Note:Comment
        LabelString           comment
        LatexType             environment
        LatexName             comment
+       BgColor               commentbg
        LabelFont
          Color               comment
          Size                Small
        EndFont
+       MultiPar              true
 End
 
 
@@ -39,40 +106,157 @@ InsetLayout Note:Note
        LabelString           note
        LatexType             command
        LatexName             note
+       BgColor               notebg
        LabelFont
          Color               note
          Size                Small
        EndFont
+       MultiPar              true
 End
 
 InsetLayout Note:Greyedout
        LabelString           greyedout
        LatexType             environment
        LatexName             lyxgreyedout
+       BgColor               greyedoutbg
        LabelFont
          Color               greyedout
          Size                Small
        EndFont
+       MultiPar              true
 End
 
-InsetLayout Note:Framed
-       LabelString           framed
-       LatexType             environment
-       LatexName             framed
+InsetLayout ERT
+       LabelString           ERT
+       LatexType             none
+       Decoration            minimalistic
+       Font
+         Color               latex
+         Family              typewriter
+       EndFont
        LabelFont
-         Color               greyedout
+         Color               latex
          Size                Small
        EndFont
+       MultiPar              true
+       PassThru              true
+       KeepEmpty             true
+       FreeSpacing           true
+       ForceLTR              true
 End
 
-InsetLayout Note:Shaded
-       LabelString           shaded
-       LatexType             environment
-       LatexName             shaded
+InsetLayout Listings
+       LabelString           Listings
+       LatexType             none
+       Decoration            minimalistic
+       Font
+         Color               foreground
+         Family              typewriter
+       EndFont
        LabelFont
-         Color               greyedout
+         Color               foreground
+         Size                Small
+       EndFont
+       MultiPar              true
+       PassThru              true
+       KeepEmpty             true
+       FreeSpacing           true
+End
+
+InsetLayout Branch
+       Decoration            minimalistic
+       LabelFont
+         Color               Red
+         Size                Small
+       EndFont
+       MultiPar              true
+End
+
+InsetLayout Index
+       LabelString           Idx
+       LatexType             command
+       LatexName             index
+       Decoration            minimalistic
+       Font
+         Color               Green
+         Size                Small
+         Family              Roman
+         Shape               Up
+         Series              Medium
+         Misc                No_Emph
+         Misc                No_Noun
+         Misc                No_Bar
+       EndFont
+       LabelFont
+         Color               Green
+         Size                Small
+       EndFont
+       MultiPar              false
+       NeedProtect           true
+End
+
+InsetLayout Box
+       LabelFont
+         Color               foreground
+         Size                Small
+       EndFont
+       MultiPar              true
+End
+
+InsetLayout Box:Shaded
+       BgColor               shaded
+       LabelFont
+         Color               foreground
+         Size                Small
+       EndFont
+       MultiPar              true
+End
+
+InsetLayout figure
+       LabelString           Figure
+       LabelFont
+         Color               collapsable
+         Size                Small
+       EndFont
+       MultiPar              true
+End
+
+InsetLayout table
+       LabelString           Table
+       LabelFont
+         Color               collapsable
          Size                Small
        EndFont
+       MultiPar              true
 End
 
+InsetLayout URL
+       LyXType               standard
+       LatexName             url
+       LatexType             command
+       Decoration            minimalistic
+       LabelString           URL
+       PassThru              true
+       ForceLTR              true
+       Font
+         Family              Typewriter
+         Color               Blue
+       EndFont
+       LabelFont
+         Family              Typewriter
+         Color               Blue
+         Size                Small
+       EndFont
+       Preamble
+         \usepackage{url}
+       EndPreamble
+End
 
+InsetLayout OptArg
+       LabelString           opt
+       LabelFont
+         Color               collapsable
+         Size                Small
+       EndFont
+       MultiPar              false
+End