2 # file external_templates
3 # This file is part of LyX, the document processor.
4 # Licence details can be found in the file COPYING.
6 # author Asger Alstrup Nielsen
8 # author Johnathan Burchill
10 # Full author contact details are available in file CREDITS.
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.
22 PreambleDef WarnNotFound
23 %% Print a warning encased in an fbox.
24 \def\lyxstripprefix#1>{}
25 \newcommand{\warnNotFound}[1]{%
26 \def\lyxtempfilename{#1}%
28 \ttfamily\expandafter\lyxstripprefix\meaning\lyxtempfilename!}%
29 \typeout{Could not find \lyxtempfilename!}%
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}}}
40 Template GnumericSpreadsheet
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.
49 InputFormat "gnumeric"
50 FileFilter "*.{gnumeric,ods,xls}"
51 AutomaticProduction true
53 Product "\\def\\inputGnumericTable{}\\input{$$AbsOrRelPathMaster$$Basename.tex}"
55 UpdateResult "$$AbsPath$$Basename.tex"
58 Requirement "longtable"
60 Requirement "multirow"
63 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.tex"
66 Product "\\def\\inputGnumericTable{}\\input{$$AbsOrRelPathMaster$$Basename.tex}"
68 UpdateResult "$$AbsPath$$Basename.tex"
71 Requirement "longtable"
73 Requirement "multirow"
76 ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.tex"
79 Product "[Spreadsheet: $$FName]"
82 Product "[Spreadsheet: $$FName]"
85 Product "$$Contents(\"$$AbsPath$$Basename.html\")</p>"
86 UpdateFormat html_table
87 UpdateResult "$$AbsPath$$Basename.html"
92 # By default, InsetExternal is displayed as a grey button
93 # containing this text.
94 GuiName "Raster image"
95 # This text is used in the External dialog.
96 # Provide enough information to explain to the user just
97 # what the template can provide him with.
100 Use this template to include bitmap images of any kind.
102 # ANY file type can be displayed as a RasterImage.
103 # Specifically, LyX will attempt to interrogate the file itself
104 # in order to deduce its format.
106 # Globbing pattern used when browsing for a Raster image file.
107 FileFilter "*.{gif,png,jpg,bmp,pbm,ppm,tga,tif,xpm,xbm}"
108 # Set to "true" if the file represented by the template
109 # must be generated by LyX.
110 AutomaticProduction true
111 # LyX has hard-coded support for these transformations
116 # LyX preview options:
117 # Off: LyX will not attempt to show this material on screen.
118 # Graphics: LyX will attempt to show this material as-is or via a
119 # conversion to a showable format.
120 # InstantPreview: LyX will attempt to use the 'instant preview'
121 # mechanism in order to show this material.
124 TransformOption Rotate RotationLatexOption
125 TransformOption Resize ResizeLatexOption
126 TransformOption Clip ClipLatexOption
127 TransformOption Extra ExtraOption
128 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
129 # This string is what is output to the LaTeX file.
130 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
132 UpdateResult "$$AbsPath$$Basename.eps"
133 Requirement "graphicx"
134 ReferencedFile latex "$$AbsPath$$Basename.eps"
135 ReferencedFile dvi "$$AbsPath$$Basename.eps"
138 TransformOption Rotate RotationLatexOption
139 TransformOption Resize ResizeLatexOption
140 TransformOption Clip ClipLatexOption
141 TransformOption Extra ExtraOption
142 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
143 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
144 UpdateFormat "$$pngOrjpg"
145 UpdateResult "$$AbsPath$$Basename.$$pngOrjpg"
146 Requirement "graphicx"
147 ReferencedFile pdflatex "$$AbsPath$$Basename.$$pngOrjpg"
150 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
151 UpdateFormat asciiimage
152 UpdateResult "$$AbsPath$$Basename.asc"
155 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
157 UpdateResult "$$AbsPath$$Basename.eps"
158 ReferencedFile docbook "$$AbsPath$$Basename.eps"
159 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
162 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.png\" />"
164 UpdateResult "$$AbsPath$$Basename.png"
165 ReferencedFile xhtml "$$AbsPath$$Basename.png"
169 Template VectorGraphics
170 GuiName "Vector graphics"
172 A vector graphics file.
173 Use this template to include vector graphics of any kind.
174 LyX will try to retain the vector properties of the image for
176 Note that specialized templates exist for Xfig figures and Dia diagrams.
177 The specialized templates allow to automatically use the document font in
178 the figures, which is not possible with this general template.
180 # ANY file type can be displayed as a VectorGraphics.
181 # Specifically, LyX will attempt to interrogate the file itself
182 # in order to deduce its format.
184 # Globbing pattern used when browsing for a vector graphics file.
185 # xfig, dia, fen and ly are exlcuded, since we have specialized templates
186 FileFilter "*.{agr,dot,emf,eps,odg,obj,sxd,svg,svgz,tgo,pdf,wmf}"
187 AutomaticProduction true
188 # LyX has hard-coded support for these transformations
195 TransformOption Rotate RotationLatexOption
196 TransformOption Resize ResizeLatexOption
197 TransformOption Clip ClipLatexOption
198 TransformOption Extra ExtraOption
199 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
200 # This string is what is output to the LaTeX file.
201 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
203 UpdateResult "$$AbsPath$$Basename.eps"
204 Requirement "graphicx"
205 ReferencedFile latex "$$AbsPath$$Basename.eps"
206 ReferencedFile dvi "$$AbsPath$$Basename.eps"
209 TransformOption Rotate RotationLatexOption
210 TransformOption Resize ResizeLatexOption
211 TransformOption Clip ClipLatexOption
212 TransformOption Extra ExtraOption
213 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
214 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
216 UpdateResult "$$AbsPath$$Basename.pdf"
217 Requirement "graphicx"
218 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
221 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
222 UpdateFormat asciiimage
223 UpdateResult "$$AbsPath$$Basename.asc"
226 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
228 UpdateResult "$$AbsPath$$Basename.eps"
229 ReferencedFile docbook "$$AbsPath$$Basename.eps"
230 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
233 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
235 UpdateResult "$$AbsPath$$Basename.svg"
236 ReferencedFile xhtml "$$AbsPath$$Basename.svg"
241 GuiName "Xfig figure"
247 AutomaticProduction true
250 Preview InstantPreview
252 TransformCommand Rotate RotationLatexCommand
253 TransformCommand Resize ResizeLatexCommand
254 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pstex_t}$$ResizeBack$$RotateBack"
256 UpdateResult "$$AbsPath$$Basename.pstex_t"
258 Requirement "graphicx"
259 # Preamble WarnNotFound
260 # Preamble InputOrWarn
261 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
262 ReferencedFile latex "$$AbsPath$$Basename.eps"
263 ReferencedFile dvi "$$AbsPath$$Basename.eps"
266 TransformCommand Rotate RotationLatexCommand
267 TransformCommand Resize ResizeLatexCommand
268 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pdftex_t}$$ResizeBack$$RotateBack"
270 UpdateResult "$$AbsPath$$Basename.pdftex_t"
272 Requirement "graphicx"
273 # Preamble WarnNotFound
274 # Preamble InputOrWarn
275 ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
276 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
279 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
280 UpdateFormat asciixfig
281 UpdateResult "$$AbsPath$$Basename.asc"
284 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
286 UpdateResult "$$AbsPath$$Basename.eps"
287 ReferencedFile docbook "$$AbsPath$$Basename.eps"
288 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
291 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
293 UpdateResult "$$AbsPath$$Basename.svg"
294 ReferencedFile xhtml "$$AbsPath$$Basename.svg"
299 Template ChessDiagram
300 GuiName "Chess diagram"
302 A chess position diagram.
303 This template will use XBoard to edit the position.
304 Use the 'File->Save Position' in XBoard to save
305 the position that you want to display.
306 Make sure to give it a '.fen' extension
307 and remember to type in a relative path
308 to the LyX document location.
309 Within XBoard, use 'Edit->Edit Position'
310 to enable general editing of the board.
311 You might also check out the
312 'Options->Test legality' option, and
313 remember to middle and right click to
314 insert new material in the board.
315 In order for this to work, you have to
316 put the bundled lyxskak.sty in a place
317 that TeX will find it, and you will need
318 to install the skak package from CTAN.
322 AutomaticProduction true
323 Preview InstantPreview
325 Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
328 UpdateResult "$$AbsPath$$Basename$$Extension"
329 ReferencedFile latex "$$AbsPath$$Basename$$Extension"
332 Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
335 UpdateResult "$$AbsPath$$Basename$$Extension"
336 ReferencedFile pdflatex "$$AbsPath$$Basename$$Extension"
339 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
340 UpdateFormat asciichess
341 UpdateResult "$$AbsPath$$Basename.asc"
344 Product "[Chess: $$AbsOrRelPathMaster$$Basename]"
347 Product "<pre>$$Contents(\"$$AbsPath$$Basename.asc\")</pre>"
348 UpdateFormat asciichess
349 UpdateResult "$$AbsPath$$Basename.asc"
355 GuiName "Lilypond typeset music"
357 Sheet music typeset by GNU LilyPond,
358 converted to .pdf or .eps for inclusion
359 Using .eps requires at least lilypond 2.6
360 Using .pdf requires at least lilypond 2.9
362 InputFormat "lilypond"
364 AutomaticProduction true
369 Preview InstantPreview
371 TransformOption Rotate RotationLatexOption
372 TransformOption Resize ResizeLatexOption
373 TransformOption Clip ClipLatexOption
374 TransformOption Extra ExtraOption
375 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
376 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
378 UpdateResult "$$AbsPath$$Basename.eps"
379 Requirement "graphicx"
380 ReferencedFile latex "$$AbsPath$$Basename.eps"
381 ReferencedFile dvi "$$AbsPath$$Basename.eps"
384 TransformOption Rotate RotationLatexOption
385 TransformOption Resize ResizeLatexOption
386 TransformOption Clip ClipLatexOption
387 TransformOption Extra ExtraOption
388 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
389 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
391 UpdateResult "$$AbsPath$$Basename.pdf"
392 Requirement "graphicx"
393 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
396 Product "[LilyPond: $$FName]"
399 Product "[LilyPond: $$FName]"
402 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.png\" />"
404 UpdateResult "$$AbsPath$$Basename.png"
405 ReferencedFile xhtml "$$AbsPath$$Basename.png"
412 Includes PDF documents, using the 'pdfpages' package.
413 To include multiple pages, use the 'pages'-option,
414 which must be inserted to 'Options'.
416 * pages={x-y} (for a range of pages)
417 * pages={x,y,z} (for specific pages)
418 * pages=- (to include all pages)
419 * pages=last-1 (to include all pages in reverse order)
420 With the option 'noautoscale' the PDF pages are
421 inserted in their original size.
422 Read the documentation of the pdfpages package
423 for further options and details.
427 AutomaticProduction true
433 TransformOption Rotate RotationLatexOption
434 TransformOption Resize ResizeLatexOption
435 TransformOption Extra ExtraOption
436 Option Arg "[$$Extra,$$Rotate,$$Resize]"
437 Product "\\includepdf$$Arg{$$AbsOrRelPathMaster$$Basename}"
439 UpdateResult "$$AbsPath$$Basename.pdf"
440 Requirement "pdfpages"
441 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
444 Product "[PDFPages: $$FName]"
447 Product "[PDFPages: $$FName]"
450 Product "[PDFPages: $$FName]"
459 Read 'info date' for more information.
463 AutomaticProduction true
466 Product "$$Contents(\"$$Tempname\")"
468 UpdateResult "$$Tempname"
471 Product "$$Contents(\"$$Tempname\")"
473 UpdateResult "$$Tempname"
476 Product "$$Contents(\"$$Tempname\")"
478 UpdateResult "$$Tempname"
481 Product "$$Contents(\"$$Tempname\")"
483 UpdateResult "$$Tempname"
488 GuiName "Dia diagram"
494 AutomaticProduction true
495 # LyX has hard-coded support for these transformations
500 Preview InstantPreview
502 TransformOption Rotate RotationLatexOption
503 TransformOption Resize ResizeLatexOption
504 TransformOption Clip ClipLatexOption
505 TransformOption Extra ExtraOption
506 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
507 # This string is what is output to the LaTeX file.
508 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
510 UpdateResult "$$AbsPath$$Basename.eps"
511 Requirement "graphicx"
512 ReferencedFile latex "$$AbsPath$$Basename.eps"
513 ReferencedFile dvi "$$AbsPath$$Basename.eps"
516 TransformOption Rotate RotationLatexOption
517 TransformOption Resize ResizeLatexOption
518 TransformOption Clip ClipLatexOption
519 TransformOption Extra ExtraOption
520 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
521 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
523 UpdateResult "$$AbsPath$$Basename.pdf"
524 Requirement "graphicx"
525 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
528 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
529 UpdateFormat asciiimage
530 UpdateResult "$$AbsPath$$Basename.asc"
533 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
535 UpdateResult "$$AbsPath$$Basename.eps"
536 ReferencedFile docbook "$$AbsPath$$Basename.eps"
537 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
540 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
542 UpdateResult "$$AbsPath$$Basename.svg"
543 ReferencedFile xhtml "$$AbsPath$$Basename.svg"