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 8
  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         BgColor               listingsbg
 165         MultiPar              true
 166         PassThru              true
 167         KeepEmpty             true
 168         FreeSpacing           true
 169         ForceLTR              true
 170 End
 171
 172 InsetLayout Branch
 173         Decoration            classic
 174         LabelFont
 175           Color               branchlabel
 176           Size                Small
 177         EndFont
 178         MultiPar              true
 179 End
 180
 181 InsetLayout Index
 182         LabelString           Idx
 183         LatexType             command
 184         LatexName             index
 185         Decoration            classic
 186         Font
 187           Color               foreground
 188           Size                Small
 189           Family              Roman
 190           Shape               Up
 191           Series              Medium
 192           Misc                No_Emph
 193           Misc                No_Noun
 194           Misc                No_Bar
 195         EndFont
 196         LabelFont
 197           Color               indexlabel
 198           Size                Small
 199         EndFont
 200         MultiPar              false
 201         NeedProtect           true
 202 End
 203
 204 InsetLayout Box
 205         LabelFont
 206           Color               foreground
 207           Size                Small
 208         EndFont
 209         MultiPar              true
 210 End
 211
 212 InsetLayout Box:Shaded
 213         BgColor               shaded
 214         LabelFont
 215           Color               foreground
 216           Size                Small
 217         EndFont
 218         MultiPar              true
 219 End
 220
 221 InsetLayout figure
 222         LabelString           Figure
 223         LabelFont
 224           Color               collapsable
 225           Size                Small
 226         EndFont
 227         MultiPar              true
 228 End
 229
 230 InsetLayout table
 231         LabelString           Table
 232         LabelFont
 233           Color               collapsable
 234           Size                Small
 235         EndFont
 236         MultiPar              true
 237 End
 238
 239 InsetLayout algorithm
 240         LabelString           Algorithm
 241         LabelFont
 242           Color               collapsable
 243           Size                Small
 244         EndFont
 245         MultiPar              true
 246 End
 247
 248 InsetLayout URL
 249         LyXType               standard
 250         LatexName             url
 251         LatexType             command
 252         Decoration            classic
 253         LabelString           URL
 254         PassThru              true
 255         ForceLTR              true
 256         Font
 257           Family              Typewriter
 258           Color               urltext
 259         EndFont
 260         LabelFont
 261           Family              Typewriter
 262           Color               urllabel
 263           Size                Small
 264         EndFont
 265         Requires              url
 266 End
 267
 268 InsetLayout OptArg
 269         LabelString           opt
 270         LabelFont
 271           Color               collapsable
 272           Size                Small
 273         EndFont
 274         MultiPar              false
 275 End