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