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           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               div
  81         HTMLStyle
  82                 div.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               div
 111         HTMLLabel             \arabic{footnote}
 112         HTMLInnerTag          div
 113         HTMLStyle
 114                 span.foot_label {
 115                         vertical-align: super;
 116                         font-size: smaller;
 117                         font-weight: bold;
 118                         text-decoration: underline;
 119                 }
 120     div.foot { display: inline; }
 121                 div.foot_inner { display: none; }
 122                 div.foot:hover div.foot_inner {
 123                         display: block;
 124                         border: 1px double black;
 125                         margin: 0em 1em;
 126                         padding: 1em;
 127                 }
 128         EndHTMLStyle
 129 End
 130
 131 InsetLayout Note:Comment
 132         LabelString           comment
 133         LatexType             environment
 134         LatexName             comment
 135         BgColor               commentbg
 136         LabelFont
 137           Color               comment
 138           Size                Small
 139         EndFont
 140         MultiPar              true
 141         HTMLTag               !--
 142         HTMLIsBlock           false
 143 End
 144
 145
 146 InsetLayout Note:Note
 147         LabelString           note
 148         LatexType             command
 149         LatexName             note
 150         BgColor               notebg
 151         LabelFont
 152           Color               note
 153           Size                Small
 154         EndFont
 155         MultiPar              true
 156         HTMLTag               div
 157         HTMLIsBlock           false
 158 # FIXME HTML Need CSS
 159 End
 160
 161
 162 InsetLayout Note:Greyedout
 163         LabelString           greyedout
 164         LatexType             environment
 165         LatexName             lyxgreyedout
 166         BgColor               greyedoutbg
 167         LabelFont
 168           Color               greyedout
 169           Size                Small
 170         EndFont
 171         MultiPar              true
 172         HTMLStyle
 173                 span.note_greyedout {
 174                         background-color: #A0A0A0;
 175                         padding-left: 1ex;
 176                         padding-right: 1ex;
 177                 }
 178         EndHTMLStyle
 179         HTMLTag               div
 180         HTMLIsBlock           false
 181 End
 182
 183 InsetLayout ERT
 184         LabelString           ERT
 185         LatexType             none
 186         Decoration            minimalistic
 187         Font
 188           Color               latex
 189           Family              typewriter
 190         EndFont
 191         LabelFont
 192           Color               latex
 193           Size                Small
 194         EndFont
 195         MultiPar              true
 196         CustomPars            false
 197         ForcePlain            true
 198         PassThru              true
 199         KeepEmpty             true
 200         FreeSpacing           true
 201         ForceLTR              true
 202 End
 203
 204 InsetLayout Phantom
 205         Decoration            minimalistic
 206         Font
 207           Color               phantomtext
 208         EndFont
 209         CustomPars            false
 210         ForcePlain            true
 211 End
 212
 213 InsetLayout Listings
 214         LabelString           Listings
 215         LatexType             none
 216         Decoration            minimalistic
 217         Font
 218           Color               foreground
 219           Family              typewriter
 220         EndFont
 221         LabelFont
 222           Color               foreground
 223           Size                Small
 224         EndFont
 225         BgColor               listingsbg
 226         MultiPar              true
 227         PassThru              true
 228         KeepEmpty             true
 229         FreeSpacing           true
 230         ForceLTR              true
 231 End
 232
 233 InsetLayout Branch
 234         Decoration            classic
 235         LabelFont
 236           Color               branchlabel
 237           Size                Small
 238         EndFont
 239         MultiPar              true
 240         InToc                 true
 241         HTMLIsBlock           false
 242 End
 243
 244 InsetLayout Index
 245         LabelString           Idx
 246         Decoration            classic
 247         Font
 248           Color               foreground
 249           Size                Small
 250           Family              Roman
 251           Shape               Up
 252           Series              Medium
 253           Misc                No_Emph
 254           Misc                No_Noun
 255           Misc                No_Bar
 256         EndFont
 257         LabelFont
 258           Color               indexlabel
 259           Size                Small
 260         EndFont
 261         MultiPar              false
 262         CustomPars            false
 263         ForcePlain            true
 264 End
 265
 266 InsetLayout Box
 267         LabelFont
 268           Color               foreground
 269           Size                Small
 270         EndFont
 271         MultiPar              true
 272 End
 273
 274 InsetLayout Box:Shaded
 275         BgColor               shaded
 276         LabelFont
 277           Color               foreground
 278           Size                Small
 279         EndFont
 280         MultiPar              true
 281 End
 282
 283 InsetLayout Float
 284         LabelFont
 285           Color               collapsable
 286           Size                Small
 287         EndFont
 288         MultiPar              true
 289         HTMLTag               div
 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         HTMLIsBlock           false
 332 End
 333
 334 InsetLayout OptArg
 335         LabelString           opt
 336         LabelFont
 337           Color               collapsable
 338           Size                Small
 339         EndFont
 340         MultiPar              false
 341 End
 342
 343 InsetLayout Info
 344         Decoration            conglomerate
 345         HTMLStyle
 346                 span.info { font-family: sans-serif; }
 347         EndHTMLStyle
 348         MultiPar           false
 349 End
 350
 351 InsetLayout Info:menu
 352         CopyStyle             Info
 353         LatexType             command
 354         LatexName             menuitem
 355         Preamble
 356           \providecommand{\menuitem}[1]{\textsf{#1}}
 357         EndPreamble
 358         Decoration            conglomerate
 359         Font
 360           Family              sans
 361         EndFont
 362         HTMLTag           span
 363         HTMLAttr          "class='info menu'"
 364         HTMLStyle
 365                 span.menu { font-family: sans-serif; }
 366         EndHTMLStyle
 367 End
 368
 369 InsetLayout Info:shortcut
 370         CopyStyle             Info
 371         LatexType             command
 372         LatexName             shortcut
 373         Preamble
 374           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 375         EndPreamble
 376         Decoration            conglomerate
 377         Font
 378           Family              sans
 379         EndFont
 380         HTMLTag           span
 381         HTMLAttr          "class='info shortcut'"
 382         HTMLStyle
 383                 span.shortcut { font-family: sans-serif; }
 384         EndHTMLStyle
 385 End
 386
 387 InsetLayout Info:shortcuts
 388         CopyStyle             Info
 389         LatexType             command
 390         LatexName             shortcut
 391         Preamble
 392           \providecommand{\shortcut}[1]{\textsf{#1}}
 393         EndPreamble
 394         Decoration            conglomerate
 395         Font
 396           Family              sans
 397         EndFont
 398         HTMLTag           span
 399         HTMLAttr          "class='info shortcut'"
 400         HTMLStyle
 401                 span.shortcut { font-family: sans-serif; }
 402         EndHTMLStyle
 403 End
 404
 405 InsetLayout Box
 406         HTMLStyle
 407                 span.Frameless { font-family: sans-serif; }
 408         EndHTMLStyle
 409 End