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 text
  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. Defaults to false. Sets CustomPars, as well, to the same
  39 #                         value, and sets ForcePlain to the opposite value. If you want
  40 #                         those to be different, then, you must set them after you set
  41 #                         MultiPar.
  42 # CustomPars            Whether to allow the use of the Paragraph Settings dialog. Default is
  43 #                         false.
  44 # ForcePlain            Whether to force the PlainLayout. Default is true.
  45 #       Decoration:           Classic, Minimalistic, Conglomerate. Decoration styles
  46 #       PassThru              Do not do various LaTeX conversions, like the phrases
  47 #                               LaTeX, LyX, quote commands, etc.
  48 #       KeepEmpty             Do not delete empty paragraphs (?)
  49 #       FreeSpacing           Preserve multiple spaces etc.
  50 #       ForceLTR              Force the "latex" language, leading to Left-to-Right
  51 #                               (latin) output, e.g., in ERT or URL. A kludge.
  52 #       Requires              Require a given (supported) feature. Multiple features must
  53 #                         be comma-separated.
  54 #End
  55
  56 Format 11
  57
  58 Provides stdinsets 1
  59
  60 InsetLayout Marginal
  61         LabelString           margin
  62         LatexType             command
  63         LatexName             marginpar
  64         Font
  65           Color               foreground
  66           Size                Small
  67           Family              Roman
  68           Shape               Up
  69           Series              Medium
  70           Misc                No_Emph
  71           Misc                No_Noun
  72           Misc                No_Bar
  73         EndFont
  74         LabelFont
  75           Color               marginlabel
  76           Size                Small
  77         EndFont
  78         MultiPar              true
  79 End
  80
  81 InsetLayout Foot
  82         LabelString           foot
  83         LatexType             command
  84         LatexName             footnote
  85         Font
  86           Color               foreground
  87           Size                Small
  88           Family              Roman
  89           Shape               Up
  90           Series              Medium
  91           Misc                No_Emph
  92           Misc                No_Noun
  93           Misc                No_Bar
  94         EndFont
  95         LabelFont
  96           Color               footlabel
  97           Size                Small
  98         EndFont
  99         MultiPar              true
 100 End
 101
 102 InsetLayout Note:Comment
 103         LabelString           comment
 104         LatexType             environment
 105         LatexName             comment
 106         BgColor               commentbg
 107         LabelFont
 108           Color               comment
 109           Size                Small
 110         EndFont
 111         MultiPar              true
 112 End
 113
 114
 115 InsetLayout Note:Note
 116         LabelString           note
 117         LatexType             command
 118         LatexName             note
 119         BgColor               notebg
 120         LabelFont
 121           Color               note
 122           Size                Small
 123         EndFont
 124         MultiPar              true
 125 End
 126
 127 InsetLayout Note:Greyedout
 128         LabelString           greyedout
 129         LatexType             environment
 130         LatexName             lyxgreyedout
 131         BgColor               greyedoutbg
 132         LabelFont
 133           Color               greyedout
 134           Size                Small
 135         EndFont
 136         MultiPar              true
 137 End
 138
 139 InsetLayout ERT
 140         LabelString           ERT
 141         LatexType             none
 142         Decoration            minimalistic
 143         Font
 144           Color               latex
 145           Family              typewriter
 146         EndFont
 147         LabelFont
 148           Color               latex
 149           Size                Small
 150         EndFont
 151         MultiPar              true
 152         CustomPars            false
 153         ForcePlain            true
 154         PassThru              true
 155         KeepEmpty             true
 156         FreeSpacing           true
 157         ForceLTR              true
 158 End
 159
 160 InsetLayout Phantom
 161         Decoration            minimalistic
 162         Font
 163           Color               phantomtext
 164         EndFont
 165         CustomPars            false
 166         ForcePlain            true
 167 End
 168
 169 InsetLayout Listings
 170         LabelString           Listings
 171         LatexType             none
 172         Decoration            minimalistic
 173         Font
 174           Color               foreground
 175           Family              typewriter
 176         EndFont
 177         LabelFont
 178           Color               foreground
 179           Size                Small
 180         EndFont
 181         BgColor               listingsbg
 182         MultiPar              true
 183         PassThru              true
 184         KeepEmpty             true
 185         FreeSpacing           true
 186         ForceLTR              true
 187 End
 188
 189 InsetLayout Branch
 190         Decoration            classic
 191         LabelFont
 192           Color               branchlabel
 193           Size                Small
 194         EndFont
 195         MultiPar              true
 196         InToc                 true
 197 End
 198
 199 InsetLayout Index
 200         LabelString           Idx
 201         LatexType             command
 202         LatexName             index
 203         Decoration            classic
 204         Font
 205           Color               foreground
 206           Size                Small
 207           Family              Roman
 208           Shape               Up
 209           Series              Medium
 210           Misc                No_Emph
 211           Misc                No_Noun
 212           Misc                No_Bar
 213         EndFont
 214         LabelFont
 215           Color               indexlabel
 216           Size                Small
 217         EndFont
 218         MultiPar              false
 219         CustomPars            false
 220         ForcePlain            true
 221         NeedProtect           true
 222 End
 223
 224 InsetLayout Box
 225         LabelFont
 226           Color               foreground
 227           Size                Small
 228         EndFont
 229         MultiPar              true
 230 End
 231
 232 InsetLayout Box:Shaded
 233         BgColor               shaded
 234         LabelFont
 235           Color               foreground
 236           Size                Small
 237         EndFont
 238         MultiPar              true
 239 End
 240
 241 InsetLayout Float
 242         LabelFont
 243           Color               collapsable
 244           Size                Small
 245         EndFont
 246         MultiPar              true
 247 End
 248
 249 InsetLayout Wrap
 250         LabelFont
 251           Color               collapsable
 252           Size                Small
 253         EndFont
 254         MultiPar              true
 255 End
 256
 257 InsetLayout URL
 258         LyXType               standard
 259         LatexName             url
 260         LatexType             command
 261         Decoration            classic
 262         LabelString           URL
 263         PassThru              true
 264         ForceLTR              true
 265         Font
 266           Family              Typewriter
 267           Color               urltext
 268         EndFont
 269         LabelFont
 270           Family              Typewriter
 271           Color               urllabel
 272           Size                Small
 273         EndFont
 274         Requires              url
 275 End
 276
 277 InsetLayout OptArg
 278         LabelString           opt
 279         LabelFont
 280           Color               collapsable
 281           Size                Small
 282         EndFont
 283         MultiPar              false
 284 End
 285
 286 InsetLayout Info
 287         Decoration            conglomerate
 288 End
 289
 290 InsetLayout Info:menu
 291         LatexType             command
 292         LatexName             menuitem
 293         Preamble
 294           \providecommand{\menuitem}[1]{\textsf{#1}}
 295         EndPreamble
 296         Decoration            conglomerate
 297         Font
 298           Family              sans
 299         EndFont
 300 End
 301
 302 InsetLayout Info:shortcut
 303         LatexType             command
 304         LatexName             shortcut
 305         Preamble
 306           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 307         EndPreamble
 308         Decoration            conglomerate
 309         Font
 310           Family              sans
 311         EndFont
 312 End
 313
 314 InsetLayout Info:shortcuts
 315         LatexType             command
 316         LatexName             shortcut
 317         Preamble
 318           \providecommand{\shortcut}[1]{\textsf{#1}}
 319         EndPreamble
 320         Decoration            conglomerate
 321         Font
 322           Family              sans
 323         EndFont
 324 End