]> git.lyx.org Git - lyx.git/blobdiff - lib/external_templates
example files: fixes and updates by Ignacio
[lyx.git] / lib / external_templates
index f6ad4cce230ad26f57c54de45514178f9c46261b..54b6dbde0b45ca61a4536f648e77eded07a2ad5d 100644 (file)
 # part of the official LyX distribution.
 # Feel free to create your own External Templates, storing them in
 # .lyx/external_templates
+# Note that a user-defined external_templates file would replace this
+# definition. Thus, if you would like to keep the external templates defined
+# in this file, please copy this file and add on futher external templates
+# to the end. For more information, see http://www.lyx.org/trac/ticket/3983.
 
 
 PreambleDef WarnNotFound
@@ -33,16 +37,56 @@ PreambleDef InputOrWarn
                \IfFileExists{#1}{\input{#1}}{\warnNotFound{#1}}}
 PreambleDefEnd
 
+Template GnumericSpreadsheet
+       GuiName "Spreadsheet"
+       HelpText
+               A spreadsheet made with Gnumeric, LibreOffice, OpenOffice or Excel.
+               It imports as a multi-page table, so any length
+               is ok. Excessive width could be a problem.
+               The gnumeric software is necessary for conversion,
+               both for gnumeric and excel files.
+       HelpTextEnd
+       InputFormat "gnumeric"
+       FileFilter "*.{gnumeric,ods,xls}"
+       AutomaticProduction true
+       Format LaTeX
+               Product "\\def\\inputGnumericTable{}\\input{$$AbsOrRelPathMaster$$Basename.tex}"
+               UpdateFormat latex
+               UpdateResult "$$AbsPath$$Basename.tex"
+               Requirement "color"
+               Requirement "array"
+               Requirement "longtable"
+               Requirement "calc"
+               Requirement "multirow"
+               Requirement "hhline"
+               Requirement "ifthen"
+               ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.tex"
+               FormatEnd
+       Format PDFLaTeX
+               Product "\\def\\inputGnumericTable{}\\input{$$AbsOrRelPathMaster$$Basename.tex}"
+               UpdateFormat latex
+               UpdateResult "$$AbsPath$$Basename.tex"
+               Requirement "color"
+               Requirement "array"
+               Requirement "longtable"
+               Requirement "calc"
+               Requirement "multirow"
+               Requirement "hhline"
+               Requirement "ifthen"
+               ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.tex"
+       FormatEnd
+TemplateEnd
 
 Template RasterImage
        # By default, InsetExternal is displayed as a grey button
        # containing this text.
-       GuiName "Bitmap: $$AbsOrRelPathParent$$Basename"
+       GuiName "Raster image"
        # This text is used in the External dialog.
        # Provide enough information to explain to the user just
        # what the template can provide him with.
        HelpText
                A bitmap file.
+               Use this template to include bitmap images of any kind.
        HelpTextEnd
        # ANY file type can be displayed as a RasterImage.
        # Specifically, LyX will attempt to interrogate the file itself
@@ -58,6 +102,13 @@ Template RasterImage
        Transform Resize
        Transform Clip
        Transform Extra
+       # LyX preview options:
+       # Off: LyX will not attempt to show this material on screen.
+       # Graphics: LyX will attempt to show this material as-is or via a
+       #           conversion to a showable format.
+       # InstantPreview: LyX will attempt to use the 'instant preview'
+       #                 mechanism in order to show this material.
+       Preview Graphics
        Format LaTeX
                TransformOption Rotate RotationLatexOption
                TransformOption Resize ResizeLatexOption
@@ -79,10 +130,10 @@ Template RasterImage
                TransformOption Extra  ExtraOption
                Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
                Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
-               UpdateFormat png
-               UpdateResult "$$AbsPath$$Basename.png"
+               UpdateFormat "$$pngOrjpg"
+               UpdateResult "$$AbsPath$$Basename.$$pngOrjpg"
                Requirement "graphicx"
-               ReferencedFile pdflatex "$$AbsPath$$Basename.png"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.$$pngOrjpg"
        FormatEnd
        Format Ascii
                Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
@@ -96,22 +147,84 @@ Template RasterImage
                ReferencedFile docbook     "$$AbsPath$$Basename.eps"
                ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
        FormatEnd
-       Format LinuxDoc
-               Product "[Bitmap: $$FName]"
-       FormatEnd
 TemplateEnd
 
+Template VectorGraphics
+       GuiName "Vector graphics"
+       HelpText
+               A vector graphics file.
+               Use this template to include vector graphics of any kind.
+               LyX will try to retain the vector properties of the image for
+               the final output.
+               Note that specialized templates exist for Xfig figures and Dia diagrams.
+               The specialized templates allow to automatically use the document font in
+               the figures, which is not possible with this general template.
+       HelpTextEnd
+       # ANY file type can be displayed as a VectorGraphics.
+       # Specifically, LyX will attempt to interrogate the file itself
+       # in order to deduce its format.
+       InputFormat "*"
+       # Globbing pattern used when browsing for a vector graphics file.
+       # xfig, dia, fen and ly are exlcuded, since we have specialized templates
+       FileFilter "*.{agr,dot,emf,eps,odg,obj,sxd,svg,svgz,tgo,pdf,wmf}"
+       AutomaticProduction true
+       # LyX has hard-coded support for these transformations
+       Transform Rotate
+       Transform Resize
+       Transform Clip
+       Transform Extra
+       Preview Graphics
+       Format LaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               # This string is what is output to the LaTeX file.
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat eps
+               UpdateResult "$$AbsPath$$Basename.eps"
+               Requirement "graphicx"
+               ReferencedFile latex "$$AbsPath$$Basename.eps"
+               ReferencedFile dvi   "$$AbsPath$$Basename.eps"
+       FormatEnd
+       Format PDFLaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat pdf6
+               UpdateResult "$$AbsPath$$Basename.pdf"
+               Requirement "graphicx"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
+       FormatEnd
+       Format Ascii
+               Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
+               UpdateFormat asciiimage
+               UpdateResult "$$AbsPath$$Basename.asc"
+       FormatEnd
+       Format DocBook
+               Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
+               UpdateFormat eps
+               UpdateResult "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook     "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
+       FormatEnd
+TemplateEnd
 
 Template XFig
-       GuiName "XFig: $$AbsOrRelPathParent$$Basename"
+       GuiName "Xfig figure"
        HelpText
-               An XFig figure.
+               An Xfig figure.
        HelpTextEnd
        InputFormat fig
        FileFilter "*.fig"
        AutomaticProduction true
        Transform Rotate
        Transform Resize
+       Preview InstantPreview
        Format LaTeX
                TransformCommand Rotate RotationLatexCommand
                TransformCommand Resize ResizeLatexCommand
@@ -151,14 +264,11 @@ Template XFig
                ReferencedFile docbook     "$$AbsPath$$Basename.eps"
                ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
        FormatEnd
-       Format LinuxDoc
-               Product "[XFig: $$FName]"
-       FormatEnd
 TemplateEnd
 
 
 Template ChessDiagram
-       GuiName "Chess: $$AbsOrRelPathParent$$Basename"
+       GuiName "Chess diagram"
        HelpText
                A chess position diagram.
                This template will use XBoard to edit the position.
@@ -181,14 +291,19 @@ Template ChessDiagram
        InputFormat fen
        FileFilter "*.fen"
        AutomaticProduction true
+       Preview InstantPreview
        Format LaTeX
                Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
                Requirement "chess"
+               UpdateFormat fen
+               UpdateResult "$$AbsPath$$Basename$$Extension"
                ReferencedFile latex "$$AbsPath$$Basename$$Extension"
        FormatEnd
        Format PDFLaTeX
                Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
                Requirement "chess"
+               UpdateFormat fen
+               UpdateResult "$$AbsPath$$Basename$$Extension"
                ReferencedFile pdflatex "$$AbsPath$$Basename$$Extension"
        FormatEnd
        Format Ascii
@@ -199,8 +314,97 @@ Template ChessDiagram
        Format DocBook
                Product "[Chess: $$AbsOrRelPathMaster$$Basename]"
        FormatEnd
-       Format LinuxDoc
-               Product "[Chess: $$FName]"
+TemplateEnd
+
+
+Template LilyPond
+       GuiName "Lilypond typeset music"
+       HelpText
+               Sheet music typeset by GNU LilyPond,
+               converted to .pdf or .eps for inclusion
+               Using .eps requires at least lilypond 2.6
+               Using .pdf requires at least lilypond 2.9
+       HelpTextEnd
+       InputFormat "lilypond"
+       FileFilter "*.ly"
+       AutomaticProduction true
+       Transform Rotate
+       Transform Resize
+       Transform Clip
+       Transform Extra
+       Preview InstantPreview
+       Format LaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat eps
+               UpdateResult "$$AbsPath$$Basename.eps"
+               Requirement "graphicx"
+               ReferencedFile latex "$$AbsPath$$Basename.eps"
+               ReferencedFile dvi   "$$AbsPath$$Basename.eps"
+       FormatEnd
+       Format PDFLaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat pdf6
+               UpdateResult "$$AbsPath$$Basename.pdf"
+               Requirement "graphicx"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
+       FormatEnd
+       Format Ascii
+               Product "[LilyPond: $$FName]"
+       FormatEnd
+       Format DocBook
+               Product "[LilyPond: $$FName]"
+       FormatEnd
+TemplateEnd
+
+Template PDFPages
+       GuiName "PDF pages"
+       HelpText
+               Includes PDF documents, using the 'pdfpages' package.
+               To include multiple pages, use the 'pages'-option,
+               which must be inserted to 'Options'.
+               Examples:
+               * pages={x-y} (for a range of pages)
+               * pages={x,y,z} (for specific pages)
+               * pages=- (to include all pages)
+               * pages=last-1 (to include all pages in reverse order)
+               With the option 'noautoscale' the PDF pages are
+               inserted in their original size.
+               Read the documentation of the pdfpages package
+               for further options and details.
+       HelpTextEnd
+       InputFormat pdf6
+       FileFilter "*.pdf"
+       AutomaticProduction true
+       Transform Rotate
+       Transform Resize
+       Transform Extra
+       Preview Graphics
+       Format LaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize]"
+               Product "\\includepdf$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat pdf6
+               UpdateResult "$$AbsPath$$Basename.pdf"
+               Requirement "pdfpages"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
+       FormatEnd
+       Format Ascii
+               Product "[PDFPages: $$FName]"
+       FormatEnd
+       Format DocBook
+               Product "[PDFPages: $$FName]"
        FormatEnd
 TemplateEnd
 
@@ -214,6 +418,7 @@ Template Date
        InputFormat date
        FileFilter "*"
        AutomaticProduction true
+       Preview Off
        Format LaTeX
                Product "$$Contents(\"$$Tempname\")"
                UpdateFormat dateout
@@ -234,9 +439,59 @@ Template Date
                UpdateFormat dateout
                UpdateResult "$$Tempname"
        FormatEnd
-       Format LinuxDoc
-               Product "$$Contents(\"$$Tempname\")"
-               UpdateFormat dateout
-               UpdateResult "$$Tempname"
+TemplateEnd
+
+Template Dia
+       GuiName "Dia diagram"
+       HelpText
+               Dia diagram.
+       HelpTextEnd
+       InputFormat dia
+       FileFilter "*.dia"
+       AutomaticProduction true
+       # LyX has hard-coded support for these transformations
+       Transform Rotate
+       Transform Resize
+       Transform Clip
+       Transform Extra
+       Preview InstantPreview
+       Format LaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               # This string is what is output to the LaTeX file.
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat eps
+               UpdateResult "$$AbsPath$$Basename.eps"
+               Requirement "graphicx"
+               ReferencedFile latex "$$AbsPath$$Basename.eps"
+               ReferencedFile dvi   "$$AbsPath$$Basename.eps"
+       FormatEnd
+       Format PDFLaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat pdf6
+               UpdateResult "$$AbsPath$$Basename.pdf"
+               Requirement "graphicx"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
+       FormatEnd
+       Format Ascii
+               Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
+               UpdateFormat asciiimage
+               UpdateResult "$$AbsPath$$Basename.asc"
+       FormatEnd
+       Format DocBook
+               Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
+               UpdateFormat eps
+               UpdateResult "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook     "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
        FormatEnd
 TemplateEnd
+