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         Counter               footnote
  96         Font
  97           Color               foreground
  98           Size                Small
  99           Family              Roman
 100           Shape               Up
 101           Series              Medium
 102           Misc                No_Emph
 103           Misc                No_Noun
 104           Misc                No_Bar
 105         EndFont
 106         LabelFont
 107           Color               footlabel
 108           Size                Small
 109         EndFont
 110         MultiPar              true
 111         HTMLTag               span
 112         HTMLAttr              class='footwrapper'
 113         HTMLLabel             "<span class='notenum'>\arabic{footnote}</span>"
 114         HTMLInnerTag          span
 115         HTMLInnerAttr         class='footnote'
 116         HTMLStyle
 117                 span.notenum {
 118                         vertical-align: super;
 119                         font-size: smaller;
 120                 }
 121                 span.footnote {
 122                         display: none;
 123                         font-size: medium;
 124                         font-weight: normal;
 125                         font-style: normal;
 126                         font-variant: normal;
 127                 }
 128                 span.footwrapper:hover span.footnote {
 129                         display: block;
 130                         border: 1px double black;
 131                         margin: 0em 1em;
 132                         padding: 1em;
 133                 }
 134         EndHTMLStyle
 135 End
 136
 137 InsetLayout Note:Comment
 138         LabelString           comment
 139         LatexType             environment
 140         LatexName             comment
 141         BgColor               commentbg
 142         LabelFont
 143           Color               comment
 144           Size                Small
 145         EndFont
 146         MultiPar              true
 147         HTMLTag               !--
 148         HTMLIsBlock           false
 149 End
 150
 151
 152 InsetLayout Note:Note
 153         LabelString           note
 154         LatexType             command
 155         LatexName             note
 156         BgColor               notebg
 157         LabelFont
 158           Color               note
 159           Size                Small
 160         EndFont
 161         MultiPar              true
 162         HTMLIsBlock           false
 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         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 End
 290
 291 InsetLayout Wrap
 292         LabelFont
 293           Color               collapsable
 294           Size                Small
 295         EndFont
 296         MultiPar              true
 297         HTMLStyle
 298                 span.wrap {
 299                         float: right;
 300                         width: 40%;
 301                         border: 2px solid black;
 302                         padding: 1ex;
 303                         margin: 1ex;
 304                 }
 305         EndHTMLStyle
 306 End
 307
 308 InsetLayout URL
 309         LyXType               standard
 310         Decoration            classic
 311         LabelString           URL
 312         LatexName             url
 313         LatexType             command
 314         Requires              url
 315         MultiPar              false
 316         CustomPars            false
 317         ForcePlain            true
 318         PassThru              true
 319         FreeSpacing           true
 320         ForceLTR              true
 321         Font
 322           Family              Typewriter
 323           Color               urltext
 324         EndFont
 325         LabelFont
 326           Family              Typewriter
 327           Color               urllabel
 328           Size                Small
 329         EndFont
 330 End
 331
 332 InsetLayout OptArg
 333         LabelString           opt
 334         LabelFont
 335           Color               collapsable
 336           Size                Small
 337         EndFont
 338         MultiPar              false
 339 End
 340
 341 InsetLayout Info
 342         Decoration            conglomerate
 343         HTMLTag           span
 344         HTMLAttr          class='info'
 345         HTMLStyle
 346                 span.info { font-family: sans-serif; }
 347         EndHTMLStyle
 348 End
 349
 350 InsetLayout Info:menu
 351         LatexType             command
 352         LatexName             menuitem
 353         Preamble
 354           \providecommand{\menuitem}[1]{\textsf{#1}}
 355         EndPreamble
 356         Decoration            conglomerate
 357         Font
 358           Family              sans
 359         EndFont
 360         HTMLTag           span
 361         HTMLAttr          "class='info menu'"
 362         HTMLStyle
 363                 span.menu { font-family: sans-serif; }
 364         EndHTMLStyle
 365 End
 366
 367 InsetLayout Info:shortcut
 368         LatexType             command
 369         LatexName             shortcut
 370         Preamble
 371           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 372         EndPreamble
 373         Decoration            conglomerate
 374         Font
 375           Family              sans
 376         EndFont
 377         HTMLTag           span
 378         HTMLAttr          "class='info shortcut'"
 379         HTMLStyle
 380                 span.shortcut { font-family: sans-serif; }
 381         EndHTMLStyle
 382 End
 383
 384 InsetLayout Info:shortcuts
 385         LatexType             command
 386         LatexName             shortcut
 387         Preamble
 388           \providecommand{\shortcut}[1]{\textsf{#1}}
 389         EndPreamble
 390         Decoration            conglomerate
 391         Font
 392           Family              sans
 393         EndFont
 394         HTMLTag           span
 395         HTMLAttr          "class='info shortcut'"
 396         HTMLStyle
 397                 span.shortcut { font-family: sans-serif; }
 398         EndHTMLStyle
 399 End
 400
 401 InsetLayout Box
 402         HTMLStyle
 403                 span.Frameless { font-family: sans-serif; }
 404         EndHTMLStyle
 405 End