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