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 16
  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         HTMLTag               span
 101         HTMLAttr              class='footnote'
 102 End
 103
 104 InsetLayout Note:Comment
 105         LabelString           comment
 106         LatexType             environment
 107         LatexName             comment
 108         BgColor               commentbg
 109         LabelFont
 110           Color               comment
 111           Size                Small
 112         EndFont
 113         MultiPar              true
 114 End
 115
 116
 117 InsetLayout Note:Note
 118         LabelString           note
 119         LatexType             command
 120         LatexName             note
 121         BgColor               notebg
 122         LabelFont
 123           Color               note
 124           Size                Small
 125         EndFont
 126         MultiPar              true
 127 End
 128
 129 InsetLayout Note:Greyedout
 130         LabelString           greyedout
 131         LatexType             environment
 132         LatexName             lyxgreyedout
 133         BgColor               greyedoutbg
 134         LabelFont
 135           Color               greyedout
 136           Size                Small
 137         EndFont
 138         MultiPar              true
 139 End
 140
 141 InsetLayout ERT
 142         LabelString           ERT
 143         LatexType             none
 144         Decoration            minimalistic
 145         Font
 146           Color               latex
 147           Family              typewriter
 148         EndFont
 149         LabelFont
 150           Color               latex
 151           Size                Small
 152         EndFont
 153         MultiPar              true
 154         CustomPars            false
 155         ForcePlain            true
 156         PassThru              true
 157         KeepEmpty             true
 158         FreeSpacing           true
 159         ForceLTR              true
 160 End
 161
 162 InsetLayout Phantom
 163         Decoration            minimalistic
 164         Font
 165           Color               phantomtext
 166         EndFont
 167         CustomPars            false
 168         ForcePlain            true
 169 End
 170
 171 InsetLayout Listings
 172         LabelString           Listings
 173         LatexType             none
 174         Decoration            minimalistic
 175         Font
 176           Color               foreground
 177           Family              typewriter
 178         EndFont
 179         LabelFont
 180           Color               foreground
 181           Size                Small
 182         EndFont
 183         BgColor               listingsbg
 184         MultiPar              true
 185         PassThru              true
 186         KeepEmpty             true
 187         FreeSpacing           true
 188         ForceLTR              true
 189 End
 190
 191 InsetLayout Branch
 192         Decoration            classic
 193         LabelFont
 194           Color               branchlabel
 195           Size                Small
 196         EndFont
 197         MultiPar              true
 198         InToc                 true
 199 End
 200
 201 InsetLayout Index
 202         LabelString           Idx
 203         LatexType             command
 204         LatexName             index
 205         Decoration            classic
 206         Font
 207           Color               foreground
 208           Size                Small
 209           Family              Roman
 210           Shape               Up
 211           Series              Medium
 212           Misc                No_Emph
 213           Misc                No_Noun
 214           Misc                No_Bar
 215         EndFont
 216         LabelFont
 217           Color               indexlabel
 218           Size                Small
 219         EndFont
 220         MultiPar              false
 221         CustomPars            false
 222         ForcePlain            true
 223         NeedProtect           true
 224 End
 225
 226 InsetLayout Box
 227         LabelFont
 228           Color               foreground
 229           Size                Small
 230         EndFont
 231         MultiPar              true
 232 End
 233
 234 InsetLayout Box:Shaded
 235         BgColor               shaded
 236         LabelFont
 237           Color               foreground
 238           Size                Small
 239         EndFont
 240         MultiPar              true
 241 End
 242
 243 InsetLayout Float
 244         LabelFont
 245           Color               collapsable
 246           Size                Small
 247         EndFont
 248         MultiPar              true
 249 End
 250
 251 InsetLayout Wrap
 252         LabelFont
 253           Color               collapsable
 254           Size                Small
 255         EndFont
 256         MultiPar              true
 257 End
 258
 259 InsetLayout URL
 260         LyXType               standard
 261         LatexName             url
 262         LatexType             command
 263         Decoration            classic
 264         LabelString           URL
 265         PassThru              true
 266         ForceLTR              true
 267         Font
 268           Family              Typewriter
 269           Color               urltext
 270         EndFont
 271         LabelFont
 272           Family              Typewriter
 273           Color               urllabel
 274           Size                Small
 275         EndFont
 276         Requires              url
 277 End
 278
 279 InsetLayout OptArg
 280         LabelString           opt
 281         LabelFont
 282           Color               collapsable
 283           Size                Small
 284         EndFont
 285         MultiPar              false
 286 End
 287
 288 InsetLayout Info
 289         Decoration            conglomerate
 290 End
 291
 292 InsetLayout Info:menu
 293         LatexType             command
 294         LatexName             menuitem
 295         Preamble
 296           \providecommand{\menuitem}[1]{\textsf{#1}}
 297         EndPreamble
 298         Decoration            conglomerate
 299         Font
 300           Family              sans
 301         EndFont
 302 End
 303
 304 InsetLayout Info:shortcut
 305         LatexType             command
 306         LatexName             shortcut
 307         Preamble
 308           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 309         EndPreamble
 310         Decoration            conglomerate
 311         Font
 312           Family              sans
 313         EndFont
 314 End
 315
 316 InsetLayout Info:shortcuts
 317         LatexType             command
 318         LatexName             shortcut
 319         Preamble
 320           \providecommand{\shortcut}[1]{\textsf{#1}}
 321         EndPreamble
 322         Decoration            conglomerate
 323         Font
 324           Family              sans
 325         EndFont
 326 End
 327
 328 InsetLayout Box
 329         HTMLStyle
 330                 span.Frameless { font-family: sans-serif; }
 331         EndHTMLStyle
 332 End