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