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