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