]> git.lyx.org Git - lyx.git/blobdiff - lib/external_templates
pre2
[lyx.git] / lib / external_templates
index 6f11c71fe3bd5d9e33fc4e0693c957c4abf44b6d..c552511a4618d16392e67af3c946440cd78b4bd0 100644 (file)
@@ -35,44 +35,66 @@ PreambleDefEnd
 
 
 Template RasterImage
-       GuiName "Bitmap: $$Basename"
+       # 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.
-               In the parameters box, you can provide optional
-               parameters for the ImageMagick convert program.
-               E.g., use `-border 10x10 -bordercolor black'
-               to surround the picture with a black border
-               when you export to LaTeX.
-               When you export to Ascii, you can provide a
-               number describing how many columns the picture
-               should expand to.
-               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 "*"
-       FileFilter "*.(gif|png|jpg|bmp|pbm|ppm|tga|tif|xpm|xbm)"
-       EditCommand "gimp $$FName"
+       # Globbing pattern used when browsing for a Raster image file.
+       FileFilter "*.{gif,png,jpg,bmp,pbm,ppm,tga,tif,xpm,xbm}"
+       # 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
        Format LaTeX
-               Product "\\includegraphics{$$Basename}"
+               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 "$$Basename.eps"
+               UpdateResult "$$AbsPath$$Basename.eps"
                Requirement "graphicx"
+               ReferencedFile latex "$$AbsPath$$Basename.eps"
+               ReferencedFile dvi   "$$AbsPath$$Basename.eps"
        FormatEnd
        Format PDFLaTeX
-               Product "\\includegraphics{$$Basename}"
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
                UpdateFormat png
-               UpdateResult "$$Basename.png"
+               UpdateResult "$$AbsPath$$Basename.png"
                Requirement "graphicx"
+               ReferencedFile latex "$$AbsPath$$Basename.png"
        FormatEnd
        Format Ascii
-               Product "$$Contents(\"$$Basename.asc\")"
+               Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
                UpdateFormat asciiimage
-               UpdateResult "$$Basename.asc"
+               UpdateResult "$$AbsPath$$Basename.asc"
        FormatEnd
        Format DocBook
-               Product "<graphic fileref=\"$$Basename.eps\"></graphic>"
+               Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
                UpdateFormat eps
-               UpdateResult "$$Basename.eps"
+               UpdateResult "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook     "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
        FormatEnd
        Format LinuxDoc
                Product "[Bitmap: $$FName]"
@@ -81,40 +103,51 @@ TemplateEnd
 
 
 Template XFig
-       GuiName "XFig: $$Basename"
+       GuiName "XFig: $$AbsOrRelPathParent$$Basename"
        HelpText
                An XFig figure.
-               This template uses XFig for editing.
        HelpTextEnd
        InputFormat fig
        FileFilter "*.fig"
-       EditCommand "xfig $$FName"
        AutomaticProduction true
+       Transform Rotate
+       Transform Resize
        Format LaTeX
-               Product "\\inputOrWarn{$$Basename.pstex_t}"
+               TransformCommand Rotate RotationLatexCommand
+               TransformCommand Resize ResizeLatexCommand
+               Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pstex_t}$$ResizeBack$$RotateBack"
                UpdateFormat pstex
-               UpdateResult "$$Basename.pstex_t"
+               UpdateResult "$$AbsPath$$Basename.pstex_t"
                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
-               Product "\\inputOrWarn{$$Basename.pdftex_t}"
+               TransformCommand Rotate RotationLatexCommand
+               TransformCommand Resize ResizeLatexCommand
+               Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pdftex_t}$$ResizeBack$$RotateBack"
                UpdateFormat pdftex
-               UpdateResult "$$Basename.pdftex_t"
+               UpdateResult "$$AbsPath$$Basename.pdftex_t"
                Requirement "graphicx"
-               Preamble WarnNotFound
-               Preamble InputOrWarn
+               # Preamble WarnNotFound
+               # Preamble InputOrWarn
+               ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
+               ReferencedFile latex "$$AbsPath$$Basename.pdf"
        FormatEnd
        Format Ascii
-               Product "$$Contents(\"$$Basename.asc\")"
+               Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
                UpdateFormat asciixfig
-               UpdateResult "$$Basename.asc"
+               UpdateResult "$$AbsPath$$Basename.asc"
        FormatEnd
        Format DocBook
-               Product "<graphic fileref=\"$$Basename.eps\"></graphic>"
+               Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
                UpdateFormat eps
-               UpdateResult "$$Basename.eps"
+               UpdateResult "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook     "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
        FormatEnd
        Format LinuxDoc
                Product "[XFig: $$FName]"
@@ -123,7 +156,7 @@ TemplateEnd
 
 
 Template ChessDiagram
-       GuiName "Chess: $$Basename"
+       GuiName "Chess: $$AbsOrRelPathParent$$Basename"
        HelpText
                A chess position diagram.
                This template will use XBoard to edit the position.
@@ -145,19 +178,19 @@ Template ChessDiagram
        HelpTextEnd
        InputFormat fen
        FileFilter "*.fen"
-       EditCommand "xboard -lpf $$FName -mode EditPosition"
        AutomaticProduction true
        Format LaTeX
-               Product "\\loadgame{$$FPath$$Basename}\\showboard"
+               Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
                Requirement "chess"
+               ReferencedFile latex "$$AbsPath$$Basename$$Extension"
        FormatEnd
        Format Ascii
-               Product "$$Contents(\"$$Basename.asc\")"
+               Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
                UpdateFormat asciichess
-               UpdateResult "$$Basename.asc"
+               UpdateResult "$$AbsPath$$Basename.asc"
        FormatEnd
        Format DocBook
-               Product "[Chess: $$Basename]"
+               Product "[Chess: $$AbsOrRelPathMaster$$Basename]"
        FormatEnd
        Format LinuxDoc
                Product "[Chess: $$FName]"
@@ -168,7 +201,7 @@ TemplateEnd
 Template Date
        GuiName "Date"
        HelpText
-               Todays date.
+               Today's date.
                Read 'info date' for more information.
        HelpTextEnd
        InputFormat date