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 End
 166
 167 InsetLayout Listings
 168         LabelString           Listings
 169         LatexType             none
 170         Decoration            minimalistic
 171         Font
 172           Color               foreground
 173           Family              typewriter
 174         EndFont
 175         LabelFont
 176           Color               foreground
 177           Size                Small
 178         EndFont
 179         BgColor               listingsbg
 180         MultiPar              true
 181         PassThru              true
 182         KeepEmpty             true
 183         FreeSpacing           true
 184         ForceLTR              true
 185 End
 186
 187 InsetLayout Branch
 188         Decoration            classic
 189         LabelFont
 190           Color               branchlabel
 191           Size                Small
 192         EndFont
 193         MultiPar              true
 194 End
 195
 196 InsetLayout Index
 197         LabelString           Idx
 198         LatexType             command
 199         LatexName             index
 200         Decoration            classic
 201         Font
 202           Color               foreground
 203           Size                Small
 204           Family              Roman
 205           Shape               Up
 206           Series              Medium
 207           Misc                No_Emph
 208           Misc                No_Noun
 209           Misc                No_Bar
 210         EndFont
 211         LabelFont
 212           Color               indexlabel
 213           Size                Small
 214         EndFont
 215         MultiPar              false
 216 #       CustomPars            false
 217 #       ForcePlain            true
 218         NeedProtect           true
 219 End
 220
 221 InsetLayout Box
 222         LabelFont
 223           Color               foreground
 224           Size                Small
 225         EndFont
 226         MultiPar              true
 227 End
 228
 229 InsetLayout Box:Shaded
 230         BgColor               shaded
 231         LabelFont
 232           Color               foreground
 233           Size                Small
 234         EndFont
 235         MultiPar              true
 236 End
 237
 238 InsetLayout Float
 239         LabelFont
 240           Color               collapsable
 241           Size                Small
 242         EndFont
 243         MultiPar              true
 244 End
 245
 246 InsetLayout Wrap
 247         LabelFont
 248           Color               collapsable
 249           Size                Small
 250         EndFont
 251         MultiPar              true
 252 End
 253
 254 InsetLayout URL
 255         LyXType               standard
 256         LatexName             url
 257         LatexType             command
 258         Decoration            classic
 259         LabelString           URL
 260         PassThru              true
 261         ForceLTR              true
 262         Font
 263           Family              Typewriter
 264           Color               urltext
 265         EndFont
 266         LabelFont
 267           Family              Typewriter
 268           Color               urllabel
 269           Size                Small
 270         EndFont
 271         Requires              url
 272 End
 273
 274 InsetLayout OptArg
 275         LabelString           opt
 276         LabelFont
 277           Color               collapsable
 278           Size                Small
 279         EndFont
 280 #       MultiPar              false
 281 End
 282
 283 InsetLayout Info
 284         Decoration            conglomerate
 285 End
 286
 287 InsetLayout Info:menu
 288         LatexType             command
 289         LatexName             menuitem
 290         Preamble
 291           \providecommand{\menuitem}[1]{\textsf{#1}}
 292         EndPreamble
 293         Decoration            conglomerate
 294         Font
 295           Family              sans
 296         EndFont
 297 End
 298
 299 InsetLayout Info:shortcut
 300         LatexType             command
 301         LatexName             shortcut
 302         Preamble
 303           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 304         EndPreamble
 305         Decoration            conglomerate
 306         Font
 307           Family              sans
 308         EndFont
 309 End
 310
 311 InsetLayout Info:shortcuts
 312         LatexType             command
 313         LatexName             shortcut
 314         Preamble
 315           \providecommand{\shortcut}[1]{\textsf{#1}}
 316         EndPreamble
 317         Decoration            conglomerate
 318         Font
 319           Family              sans
 320         EndFont
 321 End