lib/external_templates

   1 #
   2 # file external_templates
   3 # This file is part of LyX, the document processor.
   4 # Licence details can be found in the file COPYING.
   5 #
   6 # author Asger Alstrup Nielsen
   7 # author Angus Leeming
   8 # author Johnathan Burchill
   9 #
  10 # Full author contact details are available in file CREDITS.
  11
  12 # This file contains the definitions of those External Templates that are
  13 # part of the official LyX distribution.
  14 # Feel free to create your own External Templates, storing them in
  15 # .lyx/external_templates
  16 # Note that a user-defined external_templates file would replace this
  17 # definition. Thus, if you would like to keep the external templates defined
  18 # in this file, please copy this file and add on futher external templates
  19 # to the end. For more information, see http://www.lyx.org/trac/ticket/3983.
  20
  21
  22 PreambleDef WarnNotFound
  23         %% Print a warning encased in an fbox.
  24         \def\lyxstripprefix#1>{}
  25         \newcommand{\warnNotFound}[1]{%
  26                 \def\lyxtempfilename{#1}%
  27                 \fbox{Could not find
  28                         \ttfamily\expandafter\lyxstripprefix\meaning\lyxtempfilename!}%
  29                 \typeout{Could not find \lyxtempfilename!}%
  30         }
  31 PreambleDefEnd
  32
  33
  34 PreambleDef InputOrWarn
  35         %% Input the file if it exists, using \input, else print a warning
  36         \newcommand{\inputOrWarn}[1]{%
  37                 \IfFileExists{#1}{\input{#1}}{\warnNotFound{#1}}}
  38 PreambleDefEnd
  39
  40 Template GnumericSpreadsheet
  41         GuiName "Spreadsheet"
  42         HelpText
  43                 A spreadsheet made with Gnumeric, LibreOffice, OpenOffice or Excel.
  44                 It imports as a multi-page table, so any length
  45                 is ok. Excessive width could be a problem.
  46                 The gnumeric software is necessary for conversion,
  47                 both for gnumeric and excel files.
  48         HelpTextEnd
  49         InputFormat "gnumeric"
  50         FileFilter "*.{gnumeric,ods,xls}"
  51         AutomaticProduction true
  52         Format LaTeX
  53                 Product "\\def\\inputGnumericTable{}\\input{$$AbsOrRelPathMaster$$Basename.tex}"
  54                 UpdateFormat latex
  55                 UpdateResult "$$AbsPath$$Basename.tex"
  56                 Requirement "color"
  57                 Requirement "array"
  58                 Requirement "longtable"
  59                 Requirement "calc"
  60                 Requirement "multirow"
  61                 Requirement "hhline"
  62                 Requirement "ifthen"
  63                 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.tex"
  64                 FormatEnd
  65         Format PDFLaTeX
  66                 Product "\\def\\inputGnumericTable{}\\input{$$AbsOrRelPathMaster$$Basename.tex}"
  67                 UpdateFormat latex
  68                 UpdateResult "$$AbsPath$$Basename.tex"
  69                 Requirement "color"
  70                 Requirement "array"
  71                 Requirement "longtable"
  72                 Requirement "calc"
  73                 Requirement "multirow"
  74                 Requirement "hhline"
  75                 Requirement "ifthen"
  76                 ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.tex"
  77         FormatEnd
  78 TemplateEnd
  79
  80 Template RasterImage
  81         # By default, InsetExternal is displayed as a grey button
  82         # containing this text.
  83         GuiName "Raster image"
  84         # This text is used in the External dialog.
  85         # Provide enough information to explain to the user just
  86         # what the template can provide him with.
  87         HelpText
  88                 A bitmap file.
  89                 Use this template to include bitmap images of any kind.
  90         HelpTextEnd
  91         # ANY file type can be displayed as a RasterImage.
  92         # Specifically, LyX will attempt to interrogate the file itself
  93         # in order to deduce its format.
  94         InputFormat "*"
  95         # Globbing pattern used when browsing for a Raster image file.
  96         FileFilter "*.{gif,png,jpg,bmp,pbm,ppm,tga,tif,xpm,xbm}"
  97         # Set to "true" if the file represented by the template
  98         # must be generated by LyX.
  99         AutomaticProduction true
 100         # LyX has hard-coded support for these transformations
 101         Transform Rotate
 102         Transform Resize
 103         Transform Clip
 104         Transform Extra
 105         # LyX preview options:
 106         # Off: LyX will not attempt to show this material on screen.
 107         # Graphics: LyX will attempt to show this material as-is or via a
 108         #           conversion to a showable format.
 109         # InstantPreview: LyX will attempt to use the 'instant preview'
 110         #                 mechanism in order to show this material.
 111         Preview Graphics
 112         Format LaTeX
 113                 TransformOption Rotate RotationLatexOption
 114                 TransformOption Resize ResizeLatexOption
 115                 TransformOption Clip   ClipLatexOption
 116                 TransformOption Extra  ExtraOption
 117                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 118                 # This string is what is output to the LaTeX file.
 119                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 120                 UpdateFormat eps
 121                 UpdateResult "$$AbsPath$$Basename.eps"
 122                 Requirement "graphicx"
 123                 ReferencedFile latex "$$AbsPath$$Basename.eps"
 124                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
 125         FormatEnd
 126         Format PDFLaTeX
 127                 TransformOption Rotate RotationLatexOption
 128                 TransformOption Resize ResizeLatexOption
 129                 TransformOption Clip   ClipLatexOption
 130                 TransformOption Extra  ExtraOption
 131                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 132                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 133                 UpdateFormat "$$pngOrjpg"
 134                 UpdateResult "$$AbsPath$$Basename.$$pngOrjpg"
 135                 Requirement "graphicx"
 136                 ReferencedFile pdflatex "$$AbsPath$$Basename.$$pngOrjpg"
 137         FormatEnd
 138         Format Ascii
 139                 Product "[RasterImage: $$FName]"
 140         FormatEnd
 141         Format DocBook
 142                 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
 143                 UpdateFormat eps
 144                 UpdateResult "$$AbsPath$$Basename.eps"
 145                 ReferencedFile docbook     "$$AbsPath$$Basename.eps"
 146                 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
 147         FormatEnd
 148 TemplateEnd
 149
 150 Template VectorGraphics
 151         GuiName "Vector graphics"
 152         HelpText
 153                 A vector graphics file.
 154                 Use this template to include vector graphics of any kind.
 155                 LyX will try to retain the vector properties of the image for
 156                 the final output.
 157                 Note that specialized templates exist for Xfig figures and Dia diagrams.
 158                 The specialized templates allow to automatically use the document font in
 159                 the figures, which is not possible with this general template.
 160         HelpTextEnd
 161         # ANY file type can be displayed as a VectorGraphics.
 162         # Specifically, LyX will attempt to interrogate the file itself
 163         # in order to deduce its format.
 164         InputFormat "*"
 165         # Globbing pattern used when browsing for a vector graphics file.
 166         # xfig, dia, fen and ly are exlcuded, since we have specialized templates
 167         FileFilter "*.{agr,dot,emf,eps,odg,obj,sxd,svg,svgz,tgo,pdf,wmf}"
 168         AutomaticProduction true
 169         # LyX has hard-coded support for these transformations
 170         Transform Rotate
 171         Transform Resize
 172         Transform Clip
 173         Transform Extra
 174         Preview Graphics
 175         Format LaTeX
 176                 TransformOption Rotate RotationLatexOption
 177                 TransformOption Resize ResizeLatexOption
 178                 TransformOption Clip   ClipLatexOption
 179                 TransformOption Extra  ExtraOption
 180                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 181                 # This string is what is output to the LaTeX file.
 182                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 183                 UpdateFormat eps
 184                 UpdateResult "$$AbsPath$$Basename.eps"
 185                 Requirement "graphicx"
 186                 ReferencedFile latex "$$AbsPath$$Basename.eps"
 187                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
 188         FormatEnd
 189         Format PDFLaTeX
 190                 TransformOption Rotate RotationLatexOption
 191                 TransformOption Resize ResizeLatexOption
 192                 TransformOption Clip   ClipLatexOption
 193                 TransformOption Extra  ExtraOption
 194                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 195                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 196                 UpdateFormat pdf6
 197                 UpdateResult "$$AbsPath$$Basename.pdf"
 198                 Requirement "graphicx"
 199                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 200         FormatEnd
 201         Format Ascii
 202                 Product "[VectorGraphics: $$FName]"
 203         FormatEnd
 204         Format DocBook
 205                 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
 206                 UpdateFormat eps
 207                 UpdateResult "$$AbsPath$$Basename.eps"
 208                 ReferencedFile docbook     "$$AbsPath$$Basename.eps"
 209                 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
 210         FormatEnd
 211 TemplateEnd
 212
 213 Template XFig
 214         GuiName "Xfig figure"
 215         HelpText
 216                 An Xfig figure.
 217         HelpTextEnd
 218         InputFormat fig
 219         FileFilter "*.fig"
 220         AutomaticProduction true
 221         Transform Rotate
 222         Transform Resize
 223         Preview InstantPreview
 224         Format LaTeX
 225                 TransformCommand Rotate RotationLatexCommand
 226                 TransformCommand Resize ResizeLatexCommand
 227                 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pstex_t}$$ResizeBack$$RotateBack"
 228                 UpdateFormat pstex
 229                 UpdateResult "$$AbsPath$$Basename.pstex_t"
 230                 Requirement "color"
 231                 Requirement "graphicx"
 232                 # Preamble WarnNotFound
 233                 # Preamble InputOrWarn
 234                 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
 235                 ReferencedFile latex "$$AbsPath$$Basename.eps"
 236                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
 237         FormatEnd
 238         Format PDFLaTeX
 239                 TransformCommand Rotate RotationLatexCommand
 240                 TransformCommand Resize ResizeLatexCommand
 241                 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pdftex_t}$$ResizeBack$$RotateBack"
 242                 UpdateFormat pdftex
 243                 UpdateResult "$$AbsPath$$Basename.pdftex_t"
 244                 Requirement "color"
 245                 Requirement "graphicx"
 246                 # Preamble WarnNotFound
 247                 # Preamble InputOrWarn
 248                 ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
 249                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 250         FormatEnd
 251         Format Ascii
 252                 Product "[XFig: $$FName]"
 253         FormatEnd
 254         Format DocBook
 255                 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
 256                 UpdateFormat eps
 257                 UpdateResult "$$AbsPath$$Basename.eps"
 258                 ReferencedFile docbook     "$$AbsPath$$Basename.eps"
 259                 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
 260         FormatEnd
 261         Format XHTML
 262                 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
 263                 UpdateFormat svg
 264                 UpdateResult "$$AbsPath$$Basename.svg"
 265                 ReferencedFile xhtml "$$AbsPath$$Basename.svg"
 266         FormatEnd
 267 TemplateEnd
 268
 269
 270 Template ChessDiagram
 271         GuiName "Chess diagram"
 272         HelpText
 273                 A chess position diagram.
 274                 This template will use XBoard to edit the position.
 275                 Use the 'File->Save Position' in XBoard to save
 276                 the position that you want to display.
 277                 Make sure to give it a '.fen' extension
 278                 and remember to type in a relative path
 279                 to the LyX document location.
 280                 Within XBoard, use 'Edit->Edit Position'
 281                 to enable general editing of the board.
 282                 You might also check out the
 283                 'Options->Test legality' option, and
 284                 remember to middle and right click to
 285                 insert new material in the board.
 286                 In order for this to work, you have to
 287                 put the bundled lyxskak.sty in a place
 288                 that TeX will find it, and you will need
 289                 to install the skak package from CTAN.
 290         HelpTextEnd
 291         InputFormat fen
 292         FileFilter "*.fen"
 293         AutomaticProduction true
 294         Preview InstantPreview
 295         Format LaTeX
 296                 Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
 297                 Requirement "chess"
 298                 UpdateFormat fen
 299                 UpdateResult "$$AbsPath$$Basename$$Extension"
 300                 ReferencedFile latex "$$AbsPath$$Basename$$Extension"
 301         FormatEnd
 302         Format PDFLaTeX
 303                 Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
 304                 Requirement "chess"
 305                 UpdateFormat fen
 306                 UpdateResult "$$AbsPath$$Basename$$Extension"
 307                 ReferencedFile pdflatex "$$AbsPath$$Basename$$Extension"
 308         FormatEnd
 309         Format Ascii
 310                 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
 311                 UpdateFormat asciichess
 312                 UpdateResult "$$AbsPath$$Basename.asc"
 313         FormatEnd
 314         Format DocBook
 315                 Product "[Chess: $$AbsOrRelPathMaster$$Basename]"
 316         FormatEnd
 317         Format XHTML
 318                 Product "<pre>$$Contents(\"$$AbsPath$$Basename.asc\")</pre>"
 319                 UpdateFormat asciichess
 320                 UpdateResult "$$AbsPath$$Basename.asc"
 321         FormatEnd
 322 TemplateEnd
 323
 324
 325 Template LilyPond
 326         GuiName "Lilypond typeset music"
 327         HelpText
 328                 Sheet music typeset by GNU LilyPond,
 329                 converted to .pdf or .eps for inclusion
 330                 Using .eps requires at least lilypond 2.6
 331                 Using .pdf requires at least lilypond 2.9
 332         HelpTextEnd
 333         InputFormat "lilypond"
 334         FileFilter "*.ly"
 335         AutomaticProduction true
 336         Transform Rotate
 337         Transform Resize
 338         Transform Clip
 339         Transform Extra
 340         Preview InstantPreview
 341         Format LaTeX
 342                 TransformOption Rotate RotationLatexOption
 343                 TransformOption Resize ResizeLatexOption
 344                 TransformOption Clip   ClipLatexOption
 345                 TransformOption Extra  ExtraOption
 346                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 347                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 348                 UpdateFormat eps
 349                 UpdateResult "$$AbsPath$$Basename.eps"
 350                 Requirement "graphicx"
 351                 ReferencedFile latex "$$AbsPath$$Basename.eps"
 352                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
 353         FormatEnd
 354         Format PDFLaTeX
 355                 TransformOption Rotate RotationLatexOption
 356                 TransformOption Resize ResizeLatexOption
 357                 TransformOption Clip   ClipLatexOption
 358                 TransformOption Extra  ExtraOption
 359                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 360                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 361                 UpdateFormat pdf6
 362                 UpdateResult "$$AbsPath$$Basename.pdf"
 363                 Requirement "graphicx"
 364                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 365         FormatEnd
 366         Format Ascii
 367                 Product "[LilyPond: $$FName]"
 368         FormatEnd
 369         Format DocBook
 370                 Product "[LilyPond: $$FName]"
 371         FormatEnd
 372         Format XHTML
 373                 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.png\" />"
 374                 UpdateFormat png
 375                 UpdateResult "$$AbsPath$$Basename.png"
 376                 ReferencedFile xhtml "$$AbsPath$$Basename.png"
 377         FormatEnd
 378 TemplateEnd
 379
 380 Template PDFPages
 381         GuiName "PDF pages"
 382         HelpText
 383                 Includes PDF documents, using the 'pdfpages' package.
 384                 To include multiple pages, use the 'pages'-option,
 385                 which must be inserted to 'Options'.
 386                 Examples:
 387                 * pages={x-y} (for a range of pages)
 388                 * pages={x,y,z} (for specific pages)
 389                 * pages=- (to include all pages)
 390                 * pages=last-1 (to include all pages in reverse order)
 391                 With the option 'noautoscale' the PDF pages are
 392                 inserted in their original size.
 393                 Read the documentation of the pdfpages package
 394                 for further options and details.
 395         HelpTextEnd
 396         InputFormat pdf6
 397         FileFilter "*.pdf"
 398         AutomaticProduction true
 399         Transform Rotate
 400         Transform Resize
 401         Transform Extra
 402         Preview Graphics
 403         Format LaTeX
 404                 TransformOption Rotate RotationLatexOption
 405                 TransformOption Resize ResizeLatexOption
 406                 TransformOption Extra  ExtraOption
 407                 Option Arg "[$$Extra,$$Rotate,$$Resize]"
 408                 Product "\\includepdf$$Arg{$$AbsOrRelPathMaster$$Basename}"
 409                 UpdateFormat pdf6
 410                 UpdateResult "$$AbsPath$$Basename.pdf"
 411                 Requirement "pdfpages"
 412                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 413         FormatEnd
 414         Format Ascii
 415                 Product "[PDFPages: $$FName]"
 416         FormatEnd
 417         Format DocBook
 418                 Product "[PDFPages: $$FName]"
 419         FormatEnd
 420         Format XHTML
 421                 Product "[PDFPages: $$FName]"
 422         FormatEnd
 423 TemplateEnd
 424
 425
 426 Template Dia
 427         GuiName "Dia diagram"
 428         HelpText
 429                 Dia diagram.
 430         HelpTextEnd
 431         InputFormat dia
 432         FileFilter "*.dia"
 433         AutomaticProduction true
 434         # LyX has hard-coded support for these transformations
 435         Transform Rotate
 436         Transform Resize
 437         Transform Clip
 438         Transform Extra
 439         Preview InstantPreview
 440         Format LaTeX
 441                 TransformOption Rotate RotationLatexOption
 442                 TransformOption Resize ResizeLatexOption
 443                 TransformOption Clip   ClipLatexOption
 444                 TransformOption Extra  ExtraOption
 445                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 446                 # This string is what is output to the LaTeX file.
 447                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 448                 UpdateFormat eps
 449                 UpdateResult "$$AbsPath$$Basename.eps"
 450                 Requirement "graphicx"
 451                 ReferencedFile latex "$$AbsPath$$Basename.eps"
 452                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
 453         FormatEnd
 454         Format PDFLaTeX
 455                 TransformOption Rotate RotationLatexOption
 456                 TransformOption Resize ResizeLatexOption
 457                 TransformOption Clip   ClipLatexOption
 458                 TransformOption Extra  ExtraOption
 459                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 460                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 461                 UpdateFormat pdf6
 462                 UpdateResult "$$AbsPath$$Basename.pdf"
 463                 Requirement "graphicx"
 464                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 465         FormatEnd
 466         Format Ascii
 467                 Product "[Dia: $$FName]"
 468         FormatEnd
 469         Format DocBook
 470                 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
 471                 UpdateFormat eps
 472                 UpdateResult "$$AbsPath$$Basename.eps"
 473                 ReferencedFile docbook     "$$AbsPath$$Basename.eps"
 474                 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
 475         FormatEnd
 476         Format XHTML
 477                 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
 478                 UpdateFormat svg
 479                 UpdateResult "$$AbsPath$$Basename.svg"
 480                 ReferencedFile xhtml "$$AbsPath$$Basename.svg"
 481         FormatEnd
 482 TemplateEnd
 483