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 22
  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                         display: inline;
 170                         background-color: #A0A0A0;
 171                         padding-left: 1ex;
 172                         padding-right: 1ex;
 173                 }
 174         EndHTMLStyle
 175         HTMLIsBlock           false
 176 End
 177
 178 InsetLayout ERT
 179         LabelString           ERT
 180         LatexType             none
 181         Decoration            minimalistic
 182         Font
 183           Color               latex
 184           Family              typewriter
 185         EndFont
 186         LabelFont
 187           Color               latex
 188           Size                Small
 189         EndFont
 190         MultiPar              true
 191         CustomPars            false
 192         ForcePlain            true
 193         PassThru              true
 194         KeepEmpty             true
 195         FreeSpacing           true
 196         ForceLTR              true
 197 End
 198
 199 InsetLayout Phantom
 200         Decoration            minimalistic
 201         Font
 202           Color               phantomtext
 203         EndFont
 204         CustomPars            false
 205         ForcePlain            true
 206 End
 207
 208 InsetLayout Listings
 209         LabelString           Listings
 210         LatexType             none
 211         Decoration            minimalistic
 212         Font
 213           Color               foreground
 214           Family              typewriter
 215         EndFont
 216         LabelFont
 217           Color               foreground
 218           Size                Small
 219         EndFont
 220         BgColor               listingsbg
 221         MultiPar              true
 222         PassThru              true
 223         KeepEmpty             true
 224         FreeSpacing           true
 225         ForceLTR              true
 226 End
 227
 228 InsetLayout Branch
 229         Decoration            classic
 230         LabelFont
 231           Color               branchlabel
 232           Size                Small
 233         EndFont
 234         MultiPar              true
 235         InToc                 true
 236         HTMLIsBlock           false
 237 End
 238
 239 InsetLayout Index
 240         LabelString           Idx
 241         Decoration            classic
 242         Font
 243           Size                Small
 244         EndFont
 245         LabelFont
 246           Color               indexlabel
 247           Size                Small
 248         EndFont
 249         MultiPar              false
 250         CustomPars            false
 251         ForcePlain            true
 252         ContentAsLabel        true
 253 End
 254
 255 InsetLayout Box
 256         LabelFont
 257           Color               foreground
 258           Size                Small
 259         EndFont
 260         MultiPar              true
 261         HTMLStyle
 262                 div.Frameless { font-family: sans-serif; }
 263         EndHTMLStyle
 264 End
 265
 266 InsetLayout Box:Shaded
 267         BgColor               shaded
 268         LabelFont
 269           Color               foreground
 270           Size                Small
 271         EndFont
 272         MultiPar              true
 273 End
 274
 275 InsetLayout Float
 276         LabelFont
 277           Color               collapsable
 278           Size                Small
 279         EndFont
 280         MultiPar              true
 281         HTMLStyle
 282                 div.float {
 283                         border: 2px solid black;
 284                         text-align: center;
 285                 }
 286         EndHTMLStyle
 287 End
 288
 289 InsetLayout Wrap
 290         LabelFont
 291           Color               collapsable
 292           Size                Small
 293         EndFont
 294         MultiPar              true
 295         HTMLStyle
 296                 div.wrap {
 297                         float: right;
 298                         border: 2px solid black;
 299                         padding: 1ex;
 300                         margin: 1ex;
 301                 }
 302         EndHTMLStyle
 303 End
 304
 305 InsetLayout URL
 306         LyXType               standard
 307         Decoration            classic
 308         LabelString           URL
 309         ContentAsLabel        true
 310         LatexName             url
 311         LatexType             command
 312         Requires              url
 313         MultiPar              false
 314         CustomPars            false
 315         ForcePlain            true
 316         PassThru              true
 317         FreeSpacing           true
 318         ForceLTR              true
 319         Font
 320           Family              Typewriter
 321           Color               urltext
 322         EndFont
 323         LabelFont
 324           Family              Typewriter
 325           Color               urllabel
 326           Size                Small
 327         EndFont
 328         HTMLIsBlock           false
 329 End
 330
 331 InsetLayout OptArg
 332         LabelString           opt
 333         LabelFont
 334           Color               collapsable
 335           Size                Small
 336         EndFont
 337         MultiPar              false
 338 End
 339
 340 InsetLayout Info
 341         Decoration            conglomerate
 342         HTMLStyle
 343                 span.info { font-family: sans-serif; }
 344         EndHTMLStyle
 345         HTMLTag            span
 346         MultiPar           false
 347 End
 348
 349 InsetLayout Info:menu
 350         CopyStyle             Info
 351         LatexType             command
 352         LatexName             menuitem
 353         Preamble
 354           \providecommand{\menuitem}[1]{\textsf{#1}}
 355         EndPreamble
 356         Decoration            conglomerate
 357         Font
 358           Family              sans
 359         EndFont
 360         HTMLAttr          "class='info menu'"
 361         HTMLStyle
 362                 span.menu { font-family: sans-serif; }
 363         EndHTMLStyle
 364 End
 365
 366 InsetLayout Info:shortcut
 367         CopyStyle             Info
 368         LatexType             command
 369         LatexName             shortcut
 370         Preamble
 371           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 372         EndPreamble
 373         Decoration            conglomerate
 374         Font
 375           Family              sans
 376         EndFont
 377         HTMLAttr          "class='info shortcut'"
 378         HTMLStyle
 379                 span.shortcut { font-family: sans-serif; }
 380         EndHTMLStyle
 381 End
 382
 383 InsetLayout Info:shortcuts
 384         CopyStyle             Info
 385         LatexType             command
 386         LatexName             shortcut
 387         Preamble
 388           \providecommand{\shortcut}[1]{\textsf{#1}}
 389         EndPreamble
 390         Decoration            conglomerate
 391         Font
 392           Family              sans
 393         EndFont
 394         HTMLAttr          "class='info shortcut'"
 395         HTMLStyle
 396                 span.shortcuts { font-family: sans-serif; }
 397         EndHTMLStyle
 398 End
 399
 400 InsetLayout Caption
 401         HTMLStyle
 402                 div.float-caption {
 403                         text-align: center;
 404                         border: 2px solid black;
 405                         padding: 1ex;
 406                         margin: 1ex;
 407                 }
 408         EndHTMLStyle
 409 End
 410