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 18
  57
  58 Provides stdinsets 1
  59
  60 InsetLayout Marginal
  61         LabelString           margin
  62         LatexType             command
  63         LatexName             marginpar
  64         Font
  65           Size                Small
  66         EndFont
  67         LabelFont
  68           Color               marginlabel
  69           Size                Small
  70         EndFont
  71         MultiPar              true
  72         NeedProtect           true
  73         HTMLStyle
  74                 div.marginal {
  75                         border: 2px solid black;
  76                         padding: 1ex;
  77                         margin: 1ex;
  78                         background-color: #F0F0F0;
  79                         float:right;
  80                         font-size: small;
  81                         font-weight: medium;
  82                         font-family: serif;
  83                         font-variant: normal;
  84                         font-style: normal;
  85                 }
  86         EndHTMLStyle
  87 End
  88
  89 InsetLayout Foot
  90         LabelString           foot
  91         Counter               footnote
  92         Font
  93           Size                Small
  94         EndFont
  95         LabelFont
  96           Color               footlabel
  97           Size                Small
  98         EndFont
  99         MultiPar              true
 100         HTMLLabel             \arabic{footnote}
 101         HTMLInnerTag          div
 102         HTMLStyle
 103                 span.foot_label {
 104                         vertical-align: super;
 105                         font-size: smaller;
 106                         font-weight: bold;
 107                         text-decoration: underline;
 108                 }
 109                 div.foot {
 110                         display: inline;
 111                         font-size: small;
 112                         font-weight: medium;
 113                         font-family: serif;
 114                         font-variant: normal;
 115                         font-style: normal;
 116                 }
 117                 div.foot_inner { display: none; }
 118                 div.foot:hover div.foot_inner {
 119                         display: block;
 120                         border: 1px double black;
 121                         margin: 0em 1em;
 122                         padding: 1em;
 123                 }
 124         EndHTMLStyle
 125 End
 126
 127 InsetLayout Note:Comment
 128         LabelString           comment
 129         LatexType             environment
 130         LatexName             comment
 131         BgColor               commentbg
 132         LabelFont
 133           Color               comment
 134           Size                Small
 135         EndFont
 136         MultiPar              true
 137         HTMLTag               !--
 138         HTMLIsBlock           false
 139 End
 140
 141
 142 InsetLayout Note:Note
 143         LabelString           note
 144         LatexType             command
 145         LatexName             note
 146         BgColor               notebg
 147         LabelFont
 148           Color               note
 149           Size                Small
 150         EndFont
 151         MultiPar              true
 152         HTMLIsBlock           false
 153 # FIXME HTML Need CSS
 154 End
 155
 156
 157 InsetLayout Note:Greyedout
 158         LabelString           greyedout
 159         LatexType             environment
 160         LatexName             lyxgreyedout
 161         BgColor               greyedoutbg
 162         LabelFont
 163           Color               greyedout
 164           Size                Small
 165         EndFont
 166         MultiPar              true
 167         HTMLStyle
 168                 div.note_greyedout {
 169                         background-color: #A0A0A0;
 170                         padding-left: 1ex;
 171                         padding-right: 1ex;
 172                 }
 173         EndHTMLStyle
 174         HTMLIsBlock           false
 175 End
 176
 177 InsetLayout ERT
 178         LabelString           ERT
 179         LatexType             none
 180         Decoration            minimalistic
 181         Font
 182           Color               latex
 183           Family              typewriter
 184         EndFont
 185         LabelFont
 186           Color               latex
 187           Size                Small
 188         EndFont
 189         MultiPar              true
 190         CustomPars            false
 191         ForcePlain            true
 192         PassThru              true
 193         KeepEmpty             true
 194         FreeSpacing           true
 195         ForceLTR              true
 196 End
 197
 198 InsetLayout Phantom
 199         Decoration            minimalistic
 200         Font
 201           Color               phantomtext
 202         EndFont
 203         CustomPars            false
 204         ForcePlain            true
 205 End
 206
 207 InsetLayout Listings
 208         LabelString           Listings
 209         LatexType             none
 210         Decoration            minimalistic
 211         Font
 212           Color               foreground
 213           Family              typewriter
 214         EndFont
 215         LabelFont
 216           Color               foreground
 217           Size                Small
 218         EndFont
 219         BgColor               listingsbg
 220         MultiPar              true
 221         PassThru              true
 222         KeepEmpty             true
 223         FreeSpacing           true
 224         ForceLTR              true
 225 End
 226
 227 InsetLayout Branch
 228         Decoration            classic
 229         LabelFont
 230           Color               branchlabel
 231           Size                Small
 232         EndFont
 233         MultiPar              true
 234         InToc                 true
 235         HTMLIsBlock           false
 236 End
 237
 238 InsetLayout Index
 239         LabelString           Idx
 240         Decoration            classic
 241         Font
 242           Size                Small
 243         EndFont
 244         LabelFont
 245           Color               indexlabel
 246           Size                Small
 247         EndFont
 248         MultiPar              false
 249         CustomPars            false
 250         ForcePlain            true
 251 End
 252
 253 InsetLayout Box
 254         LabelFont
 255           Color               foreground
 256           Size                Small
 257         EndFont
 258         MultiPar              true
 259         HTMLStyle
 260                 div.Frameless { font-family: sans-serif; }
 261         EndHTMLStyle
 262 End
 263
 264 InsetLayout Box:Shaded
 265         BgColor               shaded
 266         LabelFont
 267           Color               foreground
 268           Size                Small
 269         EndFont
 270         MultiPar              true
 271 End
 272
 273 InsetLayout Float
 274         LabelFont
 275           Color               collapsable
 276           Size                Small
 277         EndFont
 278         MultiPar              true
 279 End
 280
 281 InsetLayout Wrap
 282         LabelFont
 283           Color               collapsable
 284           Size                Small
 285         EndFont
 286         MultiPar              true
 287         HTMLStyle
 288                 div.wrap {
 289                         float: right;
 290                         border: 2px solid black;
 291                         padding: 1ex;
 292                         margin: 1ex;
 293                 }
 294         EndHTMLStyle
 295 End
 296
 297 InsetLayout URL
 298         LyXType               standard
 299         Decoration            classic
 300         LabelString           URL
 301         LatexName             url
 302         LatexType             command
 303         Requires              url
 304         MultiPar              false
 305         CustomPars            false
 306         ForcePlain            true
 307         PassThru              true
 308         FreeSpacing           true
 309         ForceLTR              true
 310         Font
 311           Family              Typewriter
 312           Color               urltext
 313         EndFont
 314         LabelFont
 315           Family              Typewriter
 316           Color               urllabel
 317           Size                Small
 318         EndFont
 319         HTMLIsBlock           false
 320 End
 321
 322 InsetLayout OptArg
 323         LabelString           opt
 324         LabelFont
 325           Color               collapsable
 326           Size                Small
 327         EndFont
 328         MultiPar              false
 329 End
 330
 331 InsetLayout Info
 332         Decoration            conglomerate
 333         HTMLStyle
 334                 span.info { font-family: sans-serif; }
 335         EndHTMLStyle
 336         HTMLTag            span
 337         MultiPar           false
 338 End
 339
 340 InsetLayout Info:menu
 341         CopyStyle             Info
 342         LatexType             command
 343         LatexName             menuitem
 344         Preamble
 345           \providecommand{\menuitem}[1]{\textsf{#1}}
 346         EndPreamble
 347         Decoration            conglomerate
 348         Font
 349           Family              sans
 350         EndFont
 351         HTMLAttr          "class='info menu'"
 352         HTMLStyle
 353                 span.menu { font-family: sans-serif; }
 354         EndHTMLStyle
 355 End
 356
 357 InsetLayout Info:shortcut
 358         CopyStyle             Info
 359         LatexType             command
 360         LatexName             shortcut
 361         Preamble
 362           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 363         EndPreamble
 364         Decoration            conglomerate
 365         Font
 366           Family              sans
 367         EndFont
 368         HTMLAttr          "class='info shortcut'"
 369         HTMLStyle
 370                 span.shortcut { font-family: sans-serif; }
 371         EndHTMLStyle
 372 End
 373
 374 InsetLayout Info:shortcuts
 375         CopyStyle             Info
 376         LatexType             command
 377         LatexName             shortcut
 378         Preamble
 379           \providecommand{\shortcut}[1]{\textsf{#1}}
 380         EndPreamble
 381         Decoration            conglomerate
 382         Font
 383           Family              sans
 384         EndFont
 385         HTMLAttr          "class='info shortcut'"
 386         HTMLStyle
 387                 span.shortcuts { font-family: sans-serif; }
 388         EndHTMLStyle
 389 End