]> git.lyx.org Git - lyx.git/blobdiff - lib/layouts/stdinsets.inc
Allow literate documents other than noweb to work out of the box. Currently
[lyx.git] / lib / layouts / stdinsets.inc
index 731104e9f2e545a369150a1ea80d14783f0fa910..075a49af619aaa1b7a877417ccd2a37958a745ca 100644 (file)
@@ -1,8 +1,61 @@
 # 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. Defaults to false. Sets CustomPars, as well, to the same
+#                         value, and sets ForcePlain to the opposite value. If you want
+#                         those to be different, then, you must set them after you set 
+#                         MultiPar.
+# CustomPars            Whether to allow the use of the Paragraph Settings dialog. Default is
+#                         false.
+# ForcePlain            Whether to force the PlainLayout. Default is true.
+#      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 11
+
+Provides stdinsets 1
 
 InsetLayout Marginal
        LabelString           margin
@@ -19,7 +72,7 @@ InsetLayout Marginal
          Misc                No_Bar
        EndFont
        LabelFont
-         Color               Red
+         Color               marginlabel
          Size                Small
        EndFont
        MultiPar              true
@@ -40,7 +93,7 @@ InsetLayout Foot
          Misc                No_Bar
        EndFont
        LabelFont
-         Color               Green
+         Color               footlabel
          Size                Small
        EndFont
        MultiPar              true
@@ -83,30 +136,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
@@ -120,12 +149,23 @@ InsetLayout ERT
          Size                Small
        EndFont
        MultiPar              true
+       CustomPars            false
+       ForcePlain            true
        PassThru              true
        KeepEmpty             true
        FreeSpacing           true
        ForceLTR              true
 End
 
+InsetLayout Phantom
+       Decoration            minimalistic
+       Font
+         Color               phantomtext
+       EndFont
+       CustomPars            false
+       ForcePlain            true
+End
+
 InsetLayout Listings
        LabelString           Listings
        LatexType             none
@@ -138,28 +178,31 @@ InsetLayout Listings
          Color               foreground
          Size                Small
        EndFont
+       BgColor               listingsbg
        MultiPar              true
        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
+       InToc                 true
 End
 
 InsetLayout Index
        LabelString           Idx
        LatexType             command
        LatexName             index
-       Decoration            minimalistic
+       Decoration            classic
        Font
-         Color               Green
+         Color               foreground
          Size                Small
          Family              Roman
          Shape               Up
@@ -169,10 +212,12 @@ InsetLayout Index
          Misc                No_Bar
        EndFont
        LabelFont
-         Color               Green
+         Color               indexlabel
          Size                Small
        EndFont
        MultiPar              false
+       CustomPars            false
+       ForcePlain            true
        NeedProtect           true
 End
 
@@ -184,4 +229,96 @@ InsetLayout Box
        MultiPar              true
 End
 
+InsetLayout Box:Shaded
+       BgColor               shaded
+       LabelFont
+         Color               foreground
+         Size                Small
+       EndFont
+       MultiPar              true
+End
 
+InsetLayout Float
+       LabelFont
+         Color               collapsable
+         Size                Small
+       EndFont
+       MultiPar              true
+End
+
+InsetLayout Wrap
+       LabelFont
+         Color               collapsable
+         Size                Small
+       EndFont
+       MultiPar              true
+End
+
+InsetLayout URL
+       LyXType               standard
+       LatexName             url
+       LatexType             command
+       Decoration            classic
+       LabelString           URL
+       PassThru              true
+       ForceLTR              true
+       Font
+         Family              Typewriter
+         Color               urltext
+       EndFont
+       LabelFont
+         Family              Typewriter
+         Color               urllabel
+         Size                Small
+       EndFont
+       Requires              url
+End
+
+InsetLayout OptArg
+       LabelString           opt
+       LabelFont
+         Color               collapsable
+         Size                Small
+       EndFont
+       MultiPar              false
+End
+
+InsetLayout Info
+       Decoration            conglomerate
+End
+
+InsetLayout Info:menu
+       LatexType             command
+       LatexName             menuitem
+       Preamble
+         \providecommand{\menuitem}[1]{\textsf{#1}}
+       EndPreamble
+       Decoration            conglomerate
+       Font
+         Family              sans
+       EndFont
+End
+
+InsetLayout Info:shortcut
+       LatexType             command
+       LatexName             shortcut
+       Preamble
+         \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
+       EndPreamble
+       Decoration            conglomerate
+       Font
+         Family              sans
+       EndFont
+End
+
+InsetLayout Info:shortcuts
+       LatexType             command
+       LatexName             shortcut
+       Preamble
+         \providecommand{\shortcut}[1]{\textsf{#1}}
+       EndPreamble
+       Decoration            conglomerate
+       Font
+         Family              sans
+       EndFont
+End