]> git.lyx.org Git - lyx.git/blobdiff - lib/external_templates
Reported by BH
[lyx.git] / lib / external_templates
index f7526e81f0cd0eed5128309c7916aa4ce751d3f1..4f4af8c92f7ebc8aacac73b811b9bb1dd1805d3b 100644 (file)
@@ -35,29 +35,49 @@ PreambleDefEnd
 
 
 Template RasterImage
+       # By default, InsetExternal is displayed as a grey button
+       # containing this text.
        GuiName "Bitmap: $$AbsOrRelPathParent$$Basename"
+       # 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.
-               This template uses Gimp for editing.
        HelpTextEnd
+       # ANY file type can be displayed as a RasterImage.
+       # Specifically, LyX will attempt to interrogate the file itself
+       # in order to deduce its format.
        InputFormat "*"
+       # Globbing pattern used when browsing for a Raster image file.
        FileFilter "*.{gif,png,jpg,bmp,pbm,ppm,tga,tif,xpm,xbm}"
-       EditCommand "gimp $$Absname"
+       # Set to "true" if the file represented by the template
+       # must be generated by LyX.
        AutomaticProduction true
+       # LyX has hard-coded support for these transformations
        Transform Rotate
        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
                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
@@ -69,6 +89,7 @@ Template RasterImage
                UpdateFormat png
                UpdateResult "$$AbsPath$$Basename.png"
                Requirement "graphicx"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.png"
        FormatEnd
        Format Ascii
                Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
@@ -79,34 +100,36 @@ Template RasterImage
                Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
                UpdateFormat eps
                UpdateResult "$$AbsPath$$Basename.eps"
-       FormatEnd
-       Format LinuxDoc
-               Product "[Bitmap: $$FName]"
+               ReferencedFile docbook     "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
        FormatEnd
 TemplateEnd
 
 
 Template XFig
-       GuiName "XFig: $$AbsOrRelPathParent$$Basename"
+       GuiName "Xfig: $$AbsOrRelPathParent$$Basename"
        HelpText
-               An XFig figure.
-               This template uses XFig for editing.
+               An Xfig figure.
        HelpTextEnd
        InputFormat fig
        FileFilter "*.fig"
-       EditCommand "xfig $$Absname"
        AutomaticProduction true
        Transform Rotate
        Transform Resize
+       Preview InstantPreview
        Format LaTeX
                TransformCommand Rotate RotationLatexCommand
                TransformCommand Resize ResizeLatexCommand
                Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pstex_t}$$ResizeBack$$RotateBack"
                UpdateFormat pstex
                UpdateResult "$$AbsPath$$Basename.pstex_t"
+               Requirement "color"
                Requirement "graphicx"
-               Preamble WarnNotFound
-               Preamble InputOrWarn
+               # Preamble WarnNotFound
+               # Preamble InputOrWarn
+               ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
+               ReferencedFile latex "$$AbsPath$$Basename.eps"
+               ReferencedFile dvi   "$$AbsPath$$Basename.eps"
        FormatEnd
        Format PDFLaTeX
                TransformCommand Rotate RotationLatexCommand
@@ -114,9 +137,12 @@ Template XFig
                Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pdftex_t}$$ResizeBack$$RotateBack"
                UpdateFormat pdftex
                UpdateResult "$$AbsPath$$Basename.pdftex_t"
+               Requirement "color"
                Requirement "graphicx"
-               Preamble WarnNotFound
-               Preamble InputOrWarn
+               # Preamble WarnNotFound
+               # Preamble InputOrWarn
+               ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
        FormatEnd
        Format Ascii
                Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
@@ -127,9 +153,8 @@ Template XFig
                Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
                UpdateFormat eps
                UpdateResult "$$AbsPath$$Basename.eps"
-       FormatEnd
-       Format LinuxDoc
-               Product "[XFig: $$FName]"
+               ReferencedFile docbook     "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
        FormatEnd
 TemplateEnd
 
@@ -157,11 +182,21 @@ Template ChessDiagram
        HelpTextEnd
        InputFormat fen
        FileFilter "*.fen"
-       EditCommand "xboard -lpf $$Absname -mode EditPosition"
        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
                Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
@@ -171,8 +206,94 @@ 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 pdf
+               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: $$AbsOrRelPathParent$$Basename"
+       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)
+               Read the documentation of the pdfpages package
+               for further options and details.
+       HelpTextEnd
+       InputFormat pdf
+       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 pdf
+               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
 
@@ -186,24 +307,80 @@ Template Date
        InputFormat date
        FileFilter "*"
        AutomaticProduction true
+       Preview Off
        Format LaTeX
                Product "$$Contents(\"$$Tempname\")"
                UpdateFormat dateout
                UpdateResult "$$Tempname"
        FormatEnd
-       Format Ascii
+       Format PDFLaTeX
                Product "$$Contents(\"$$Tempname\")"
                UpdateFormat dateout
                UpdateResult "$$Tempname"
        FormatEnd
-       Format DocBook
+       Format Ascii
                Product "$$Contents(\"$$Tempname\")"
                UpdateFormat dateout
                UpdateResult "$$Tempname"
        FormatEnd
-       Format LinuxDoc
+       Format DocBook
                Product "$$Contents(\"$$Tempname\")"
                UpdateFormat dateout
                UpdateResult "$$Tempname"
        FormatEnd
 TemplateEnd
+
+Template Dia
+       GuiName "Dia: $$AbsOrRelPathParent$$Basename"
+       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 pdf
+               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
+