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. 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 Provides stdinsets 1
  53
  54 InsetLayout Marginal
  55         LabelString           margin
  56         LatexType             command
  57         LatexName             marginpar
  58         Font
  59           Color               foreground
  60           Size                Small
  61           Family              Roman
  62           Shape               Up
  63           Series              Medium
  64           Misc                No_Emph
  65           Misc                No_Noun
  66           Misc                No_Bar
  67         EndFont
  68         LabelFont
  69           Color               marginlabel
  70           Size                Small
  71         EndFont
  72         MultiPar              true
  73 End
  74
  75 InsetLayout Foot
  76         LabelString           foot
  77         LatexType             command
  78         LatexName             footnote
  79         Font
  80           Color               foreground
  81           Size                Small
  82           Family              Roman
  83           Shape               Up
  84           Series              Medium
  85           Misc                No_Emph
  86           Misc                No_Noun
  87           Misc                No_Bar
  88         EndFont
  89         LabelFont
  90           Color               footlabel
  91           Size                Small
  92         EndFont
  93         MultiPar              true
  94 End
  95
  96 InsetLayout Note:Comment
  97         LabelString           comment
  98         LatexType             environment
  99         LatexName             comment
 100         BgColor               commentbg
 101         LabelFont
 102           Color               comment
 103           Size                Small
 104         EndFont
 105         MultiPar              true
 106 End
 107
 108
 109 InsetLayout Note:Note
 110         LabelString           note
 111         LatexType             command
 112         LatexName             note
 113         BgColor               notebg
 114         LabelFont
 115           Color               note
 116           Size                Small
 117         EndFont
 118         MultiPar              true
 119 End
 120
 121 InsetLayout Note:Greyedout
 122         LabelString           greyedout
 123         LatexType             environment
 124         LatexName             lyxgreyedout
 125         BgColor               greyedoutbg
 126         LabelFont
 127           Color               greyedout
 128           Size                Small
 129         EndFont
 130         MultiPar              true
 131 End
 132
 133 InsetLayout ERT
 134         LabelString           ERT
 135         LatexType             none
 136         Decoration            minimalistic
 137         Font
 138           Color               latex
 139           Family              typewriter
 140         EndFont
 141         LabelFont
 142           Color               latex
 143           Size                Small
 144         EndFont
 145         MultiPar              true
 146         PassThru              true
 147         KeepEmpty             true
 148         FreeSpacing           true
 149         ForceLTR              true
 150 End
 151
 152 InsetLayout Listings
 153         LabelString           Listings
 154         LatexType             none
 155         Decoration            minimalistic
 156         Font
 157           Color               foreground
 158           Family              typewriter
 159         EndFont
 160         LabelFont
 161           Color               foreground
 162           Size                Small
 163         EndFont
 164         MultiPar              true
 165         PassThru              true
 166         KeepEmpty             true
 167         FreeSpacing           true
 168 End
 169
 170 InsetLayout Branch
 171         Decoration            classic
 172         LabelFont
 173           Color               branchlabel
 174           Size                Small
 175         EndFont
 176         MultiPar              true
 177 End
 178
 179 InsetLayout Index
 180         LabelString           Idx
 181         LatexType             command
 182         LatexName             index
 183         Decoration            classic
 184         Font
 185           Color               latex
 186           Size                Small
 187           Family              Roman
 188           Shape               Up
 189           Series              Medium
 190           Misc                No_Emph
 191           Misc                No_Noun
 192           Misc                No_Bar
 193         EndFont
 194         LabelFont
 195           Color               indexlabel
 196           Size                Small
 197         EndFont
 198         MultiPar              false
 199         NeedProtect           true
 200 End
 201
 202 InsetLayout Box
 203         LabelFont
 204           Color               foreground
 205           Size                Small
 206         EndFont
 207         MultiPar              true
 208 End
 209
 210 InsetLayout Box:Shaded
 211         BgColor               shaded
 212         LabelFont
 213           Color               foreground
 214           Size                Small
 215         EndFont
 216         MultiPar              true
 217 End
 218
 219 InsetLayout figure
 220         LabelString           Figure
 221         LabelFont
 222           Color               collapsable
 223           Size                Small
 224         EndFont
 225         MultiPar              true
 226 End
 227
 228 InsetLayout table
 229         LabelString           Table
 230         LabelFont
 231           Color               collapsable
 232           Size                Small
 233         EndFont
 234         MultiPar              true
 235 End
 236
 237 InsetLayout algorithm
 238         LabelString           Algorithm
 239         LabelFont
 240           Color               collapsable
 241           Size                Small
 242         EndFont
 243         MultiPar              true
 244 End
 245
 246 InsetLayout URL
 247         LyXType               standard
 248         LatexName             url
 249         LatexType             command
 250         Decoration            classic
 251         LabelString           URL
 252         PassThru              true
 253         ForceLTR              true
 254         Font
 255           Family              Typewriter
 256           Color               urltext
 257         EndFont
 258         LabelFont
 259           Family              Typewriter
 260           Color               urllabel
 261           Size                Small
 262         EndFont
 263         Requires              url
 264 End
 265
 266 InsetLayout OptArg
 267         LabelString           opt
 268         LabelFont
 269           Color               collapsable
 270           Size                Small
 271         EndFont
 272         MultiPar              false
 273 End