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 "$$Contents(\"$$AbsPath$$Basename.asc\")"
 140                 UpdateFormat asciiimage
 141                 UpdateResult "$$AbsPath$$Basename.asc"
 142         FormatEnd
 143         Format DocBook
 144                 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
 145                 UpdateFormat eps
 146                 UpdateResult "$$AbsPath$$Basename.eps"
 147                 ReferencedFile docbook     "$$AbsPath$$Basename.eps"
 148                 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
 149         FormatEnd
 150 TemplateEnd
 151
 152 Template VectorGraphics
 153         GuiName "Vector graphics"
 154         HelpText
 155                 A vector graphics file.
 156                 Use this template to include vector graphics of any kind.
 157                 LyX will try to retain the vector properties of the image for
 158                 the final output.
 159                 Note that specialized templates exist for Xfig figures and Dia diagrams.
 160                 The specialized templates allow to automatically use the document font in
 161                 the figures, which is not possible with this general template.
 162         HelpTextEnd
 163         # ANY file type can be displayed as a VectorGraphics.
 164         # Specifically, LyX will attempt to interrogate the file itself
 165         # in order to deduce its format.
 166         InputFormat "*"
 167         # Globbing pattern used when browsing for a vector graphics file.
 168         # xfig, dia, fen and ly are exlcuded, since we have specialized templates
 169         FileFilter "*.{agr,dot,emf,eps,odg,obj,sxd,svg,svgz,tgo,pdf,wmf}"
 170         AutomaticProduction true
 171         # LyX has hard-coded support for these transformations
 172         Transform Rotate
 173         Transform Resize
 174         Transform Clip
 175         Transform Extra
 176         Preview Graphics
 177         Format LaTeX
 178                 TransformOption Rotate RotationLatexOption
 179                 TransformOption Resize ResizeLatexOption
 180                 TransformOption Clip   ClipLatexOption
 181                 TransformOption Extra  ExtraOption
 182                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 183                 # This string is what is output to the LaTeX file.
 184                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 185                 UpdateFormat eps
 186                 UpdateResult "$$AbsPath$$Basename.eps"
 187                 Requirement "graphicx"
 188                 ReferencedFile latex "$$AbsPath$$Basename.eps"
 189                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
 190         FormatEnd
 191         Format PDFLaTeX
 192                 TransformOption Rotate RotationLatexOption
 193                 TransformOption Resize ResizeLatexOption
 194                 TransformOption Clip   ClipLatexOption
 195                 TransformOption Extra  ExtraOption
 196                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 197                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 198                 UpdateFormat pdf6
 199                 UpdateResult "$$AbsPath$$Basename.pdf"
 200                 Requirement "graphicx"
 201                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 202         FormatEnd
 203         Format Ascii
 204                 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
 205                 UpdateFormat asciiimage
 206                 UpdateResult "$$AbsPath$$Basename.asc"
 207         FormatEnd
 208         Format DocBook
 209                 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
 210                 UpdateFormat eps
 211                 UpdateResult "$$AbsPath$$Basename.eps"
 212                 ReferencedFile docbook     "$$AbsPath$$Basename.eps"
 213                 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
 214         FormatEnd
 215 TemplateEnd
 216
 217 Template XFig
 218         GuiName "Xfig figure"
 219         HelpText
 220                 An Xfig figure.
 221         HelpTextEnd
 222         InputFormat fig
 223         FileFilter "*.fig"
 224         AutomaticProduction true
 225         Transform Rotate
 226         Transform Resize
 227         Preview InstantPreview
 228         Format LaTeX
 229                 TransformCommand Rotate RotationLatexCommand
 230                 TransformCommand Resize ResizeLatexCommand
 231                 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pstex_t}$$ResizeBack$$RotateBack"
 232                 UpdateFormat pstex
 233                 UpdateResult "$$AbsPath$$Basename.pstex_t"
 234                 Requirement "color"
 235                 Requirement "graphicx"
 236                 # Preamble WarnNotFound
 237                 # Preamble InputOrWarn
 238                 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
 239                 ReferencedFile latex "$$AbsPath$$Basename.eps"
 240                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
 241         FormatEnd
 242         Format PDFLaTeX
 243                 TransformCommand Rotate RotationLatexCommand
 244                 TransformCommand Resize ResizeLatexCommand
 245                 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pdftex_t}$$ResizeBack$$RotateBack"
 246                 UpdateFormat pdftex
 247                 UpdateResult "$$AbsPath$$Basename.pdftex_t"
 248                 Requirement "color"
 249                 Requirement "graphicx"
 250                 # Preamble WarnNotFound
 251                 # Preamble InputOrWarn
 252                 ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
 253                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 254         FormatEnd
 255         Format Ascii
 256                 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
 257                 UpdateFormat asciixfig
 258                 UpdateResult "$$AbsPath$$Basename.asc"
 259         FormatEnd
 260         Format DocBook
 261                 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
 262                 UpdateFormat eps
 263                 UpdateResult "$$AbsPath$$Basename.eps"
 264                 ReferencedFile docbook     "$$AbsPath$$Basename.eps"
 265                 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
 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 TemplateEnd
 318
 319
 320 Template LilyPond
 321         GuiName "Lilypond typeset music"
 322         HelpText
 323                 Sheet music typeset by GNU LilyPond,
 324                 converted to .pdf or .eps for inclusion
 325                 Using .eps requires at least lilypond 2.6
 326                 Using .pdf requires at least lilypond 2.9
 327         HelpTextEnd
 328         InputFormat "lilypond"
 329         FileFilter "*.ly"
 330         AutomaticProduction true
 331         Transform Rotate
 332         Transform Resize
 333         Transform Clip
 334         Transform Extra
 335         Preview InstantPreview
 336         Format LaTeX
 337                 TransformOption Rotate RotationLatexOption
 338                 TransformOption Resize ResizeLatexOption
 339                 TransformOption Clip   ClipLatexOption
 340                 TransformOption Extra  ExtraOption
 341                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 342                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 343                 UpdateFormat eps
 344                 UpdateResult "$$AbsPath$$Basename.eps"
 345                 Requirement "graphicx"
 346                 ReferencedFile latex "$$AbsPath$$Basename.eps"
 347                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
 348         FormatEnd
 349         Format PDFLaTeX
 350                 TransformOption Rotate RotationLatexOption
 351                 TransformOption Resize ResizeLatexOption
 352                 TransformOption Clip   ClipLatexOption
 353                 TransformOption Extra  ExtraOption
 354                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 355                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 356                 UpdateFormat pdf6
 357                 UpdateResult "$$AbsPath$$Basename.pdf"
 358                 Requirement "graphicx"
 359                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 360         FormatEnd
 361         Format Ascii
 362                 Product "[LilyPond: $$FName]"
 363         FormatEnd
 364         Format DocBook
 365                 Product "[LilyPond: $$FName]"
 366         FormatEnd
 367 TemplateEnd
 368
 369 Template PDFPages
 370         GuiName "PDF pages"
 371         HelpText
 372                 Includes PDF documents, using the 'pdfpages' package.
 373                 To include multiple pages, use the 'pages'-option,
 374                 which must be inserted to 'Options'.
 375                 Examples:
 376                 * pages={x-y} (for a range of pages)
 377                 * pages={x,y,z} (for specific pages)
 378                 * pages=- (to include all pages)
 379                 * pages=last-1 (to include all pages in reverse order)
 380                 With the option 'noautoscale' the PDF pages are
 381                 inserted in their original size.
 382                 Read the documentation of the pdfpages package
 383                 for further options and details.
 384         HelpTextEnd
 385         InputFormat pdf6
 386         FileFilter "*.pdf"
 387         AutomaticProduction true
 388         Transform Rotate
 389         Transform Resize
 390         Transform Extra
 391         Preview Graphics
 392         Format LaTeX
 393                 TransformOption Rotate RotationLatexOption
 394                 TransformOption Resize ResizeLatexOption
 395                 TransformOption Extra  ExtraOption
 396                 Option Arg "[$$Extra,$$Rotate,$$Resize]"
 397                 Product "\\includepdf$$Arg{$$AbsOrRelPathMaster$$Basename}"
 398                 UpdateFormat pdf6
 399                 UpdateResult "$$AbsPath$$Basename.pdf"
 400                 Requirement "pdfpages"
 401                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 402         FormatEnd
 403         Format Ascii
 404                 Product "[PDFPages: $$FName]"
 405         FormatEnd
 406         Format DocBook
 407                 Product "[PDFPages: $$FName]"
 408         FormatEnd
 409 TemplateEnd
 410
 411
 412 Template Date
 413         GuiName "Date"
 414         HelpText
 415                 Today's date.
 416                 Read 'info date' for more information.
 417         HelpTextEnd
 418         InputFormat date
 419         FileFilter "*"
 420         AutomaticProduction true
 421         Preview Off
 422         Format LaTeX
 423                 Product "$$Contents(\"$$Tempname\")"
 424                 UpdateFormat dateout
 425                 UpdateResult "$$Tempname"
 426         FormatEnd
 427         Format PDFLaTeX
 428                 Product "$$Contents(\"$$Tempname\")"
 429                 UpdateFormat dateout
 430                 UpdateResult "$$Tempname"
 431         FormatEnd
 432         Format Ascii
 433                 Product "$$Contents(\"$$Tempname\")"
 434                 UpdateFormat dateout
 435                 UpdateResult "$$Tempname"
 436         FormatEnd
 437         Format DocBook
 438                 Product "$$Contents(\"$$Tempname\")"
 439                 UpdateFormat dateout
 440                 UpdateResult "$$Tempname"
 441         FormatEnd
 442 TemplateEnd
 443
 444 Template Dia
 445         GuiName "Dia diagram"
 446         HelpText
 447                 Dia diagram.
 448         HelpTextEnd
 449         InputFormat dia
 450         FileFilter "*.dia"
 451         AutomaticProduction true
 452         # LyX has hard-coded support for these transformations
 453         Transform Rotate
 454         Transform Resize
 455         Transform Clip
 456         Transform Extra
 457         Preview InstantPreview
 458         Format LaTeX
 459                 TransformOption Rotate RotationLatexOption
 460                 TransformOption Resize ResizeLatexOption
 461                 TransformOption Clip   ClipLatexOption
 462                 TransformOption Extra  ExtraOption
 463                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 464                 # This string is what is output to the LaTeX file.
 465                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 466                 UpdateFormat eps
 467                 UpdateResult "$$AbsPath$$Basename.eps"
 468                 Requirement "graphicx"
 469                 ReferencedFile latex "$$AbsPath$$Basename.eps"
 470                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
 471         FormatEnd
 472         Format PDFLaTeX
 473                 TransformOption Rotate RotationLatexOption
 474                 TransformOption Resize ResizeLatexOption
 475                 TransformOption Clip   ClipLatexOption
 476                 TransformOption Extra  ExtraOption
 477                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
 478                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
 479                 UpdateFormat pdf6
 480                 UpdateResult "$$AbsPath$$Basename.pdf"
 481                 Requirement "graphicx"
 482                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 483         FormatEnd
 484         Format Ascii
 485                 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
 486                 UpdateFormat asciiimage
 487                 UpdateResult "$$AbsPath$$Basename.asc"
 488         FormatEnd
 489         Format DocBook
 490                 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
 491                 UpdateFormat eps
 492                 UpdateResult "$$AbsPath$$Basename.eps"
 493                 ReferencedFile docbook     "$$AbsPath$$Basename.eps"
 494                 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
 495         FormatEnd
 496 TemplateEnd
 497