lib/layouts/stdinsets.inc

   1 # Textclass definition file for LaTeX.
   2 # Author : Martin vermeer <martin.vermeer@hut.fi>
   3 # Inset layouts definition
   4 #
   5 # More detailled format description is available in the customization manual
   6 # FIXME: create the contents in the manual and put the link here.
   7 #
   8 #InsetLayout <string identifier used by LyX>
   9 #       LabelString           used for the inset decoration (either the inset button
  10 #                             or the text underneath the inset).
  11 #       LatexType             associated LateX type: command, environment, or none.
  12 #       LatexName             associated LateX command.
  13 #       BgColor               Color of the inset background within LyX.
  14 #                         FIXME: link to a doc file describing the different
  15 #                         color codes as defined in 'ColorCode.h'
  16 #       Font                  Nothing to put here, below are descriptions of the different
  17 #                         allowable adjustments for the font used to draw the text
  18 #                         appearing within the inset text. All these items are optional.
  19 #         Color               Color of
  20 #         Size                Font size of the textallowed value: Small, Smaller, ...
  21 #                         FIXME defined in FontSize in FontEnums.h
  22 #         Family              FIXME defined in FontFamily in FontEnums.h
  23 #         Shape               FIXME defined in FontShape in FontEnums.h
  24 #         Series              FIXME defined in FontSeries in FontEnums.h
  25 #         Misc                FIXME defined in FontMisc in FontEnums.h
  26 #       EndFont               Nothing to put here, it's just a markup to indicate that we are
  27 #                         finished with the Font definition.
  28 #       LabelFont             Nothing to put here, below are descriptions of the different
  29 #                         allowable adjustments for the font used to draw the text
  30 #                         appearing within the inset decoration. All these items are
  31 #                         optional.
  32 #         Color               see definition above (in the Font node).
  33 #         Size                see definition above (in the Font node).
  34 #         ...
  35 #       EndFont               Nothing to put here, it's just a markup to indicate that we are
  36 #                         finished with the LabelFont definition.
  37 #       MultiPar              Indicates that multiple paragraphs are allowed within the inset
  38 #                         or not. FIXME: what is the default?
  39 #       Decoration:           Classic, Minimalistic, Conglomerate. Decoration styles
  40 #       PassThru              Do not do various LaTeX conversions, like the phrases
  41 #                             LaTeX, LyX, quote commands, etc.
  42 #       KeepEmpty             Do not delete empty paragraphs (?)
  43 #       FreeSpacing           Preserve multiple spaces etc.
  44 #       ForceLTR              Force the "latex" language, leading to Left-to-Right
  45 #                            (latin) output, e.g., in ERT or URL. A kludge.
  46 #       Requires              Require a given (supported) feature. Multiple features must
  47 #                             be comma-separated.
  48 #End
  49
  50 Format 6
  51
  52 InsetLayout Marginal
  53         LabelString           margin
  54         LatexType             command
  55         LatexName             marginpar
  56         Font
  57           Color               foreground
  58           Size                Small
  59           Family              Roman
  60           Shape               Up
  61           Series              Medium
  62           Misc                No_Emph
  63           Misc                No_Noun
  64           Misc                No_Bar
  65         EndFont
  66         LabelFont
  67           Color               Red
  68           Size                Small
  69         EndFont
  70         MultiPar              true
  71 End
  72
  73 InsetLayout Foot
  74         LabelString           foot
  75         LatexType             command
  76         LatexName             footnote
  77         Font
  78           Color               foreground
  79           Size                Small
  80           Family              Roman
  81           Shape               Up
  82           Series              Medium
  83           Misc                No_Emph
  84           Misc                No_Noun
  85           Misc                No_Bar
  86         EndFont
  87         LabelFont
  88           Color               Green
  89           Size                Small
  90         EndFont
  91         MultiPar              true
  92 End
  93
  94 InsetLayout Note:Comment
  95         LabelString           comment
  96         LatexType             environment
  97         LatexName             comment
  98         BgColor               commentbg
  99         LabelFont
 100           Color               comment
 101           Size                Small
 102         EndFont
 103         MultiPar              true
 104 End
 105
 106
 107 InsetLayout Note:Note
 108         LabelString           note
 109         LatexType             command
 110         LatexName             note
 111         BgColor               notebg
 112         LabelFont
 113           Color               note
 114           Size                Small
 115         EndFont
 116         MultiPar              true
 117 End
 118
 119 InsetLayout Note:Greyedout
 120         LabelString           greyedout
 121         LatexType             environment
 122         LatexName             lyxgreyedout
 123         BgColor               greyedoutbg
 124         LabelFont
 125           Color               greyedout
 126           Size                Small
 127         EndFont
 128         MultiPar              true
 129 End
 130
 131 InsetLayout ERT
 132         LabelString           ERT
 133         LatexType             none
 134         Decoration            minimalistic
 135         Font
 136           Color               latex
 137           Family              typewriter
 138         EndFont
 139         LabelFont
 140           Color               latex
 141           Size                Small
 142         EndFont
 143         MultiPar              true
 144         PassThru              true
 145         KeepEmpty             true
 146         FreeSpacing           true
 147         ForceLTR              true
 148 End
 149
 150 InsetLayout Listings
 151         LabelString           Listings
 152         LatexType             none
 153         Decoration            minimalistic
 154         Font
 155           Color               foreground
 156           Family              typewriter
 157         EndFont
 158         LabelFont
 159           Color               foreground
 160           Size                Small
 161         EndFont
 162         MultiPar              true
 163         PassThru              true
 164         KeepEmpty             true
 165         FreeSpacing           true
 166 End
 167
 168 InsetLayout Branch
 169         Decoration            minimalistic
 170         LabelFont
 171           Color               Red
 172           Size                Small
 173         EndFont
 174         MultiPar              true
 175 End
 176
 177 InsetLayout Index
 178         LabelString           Idx
 179         LatexType             command
 180         LatexName             index
 181         Decoration            minimalistic
 182         Font
 183           Color               Green
 184           Size                Small
 185           Family              Roman
 186           Shape               Up
 187           Series              Medium
 188           Misc                No_Emph
 189           Misc                No_Noun
 190           Misc                No_Bar
 191         EndFont
 192         LabelFont
 193           Color               Green
 194           Size                Small
 195         EndFont
 196         MultiPar              false
 197         NeedProtect           true
 198 End
 199
 200 InsetLayout Box
 201         LabelFont
 202           Color               foreground
 203           Size                Small
 204         EndFont
 205         MultiPar              true
 206 End
 207
 208 InsetLayout Box:Shaded
 209         BgColor               shaded
 210         LabelFont
 211           Color               foreground
 212           Size                Small
 213         EndFont
 214         MultiPar              true
 215 End
 216
 217 InsetLayout figure
 218         LabelString           Figure
 219         LabelFont
 220           Color               collapsable
 221           Size                Small
 222         EndFont
 223         MultiPar              true
 224 End
 225
 226 InsetLayout table
 227         LabelString           Table
 228         LabelFont
 229           Color               collapsable
 230           Size                Small
 231         EndFont
 232         MultiPar              true
 233 End
 234
 235 InsetLayout URL
 236         LyXType               standard
 237         LatexName             url
 238         LatexType             command
 239         Decoration            minimalistic
 240         LabelString           URL
 241         PassThru              true
 242         ForceLTR              true
 243         Font
 244           Family              Typewriter
 245           Color               Blue
 246         EndFont
 247         LabelFont
 248           Family              Typewriter
 249           Color               Blue
 250           Size                Small
 251         EndFont
 252         Requires              url
 253 End
 254
 255 InsetLayout OptArg
 256         LabelString           opt
 257         LabelFont
 258           Color               collapsable
 259           Size                Small
 260         EndFont
 261         MultiPar              false
 262 End