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