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