Started on comments for the LFUNs, and added note for LFUN_BUFFER_WRITE_AS

[lyx.git] / lib / doc / Customization.lyx

diff --git a/lib/doc/Customization.lyx b/lib/doc/Customization.lyx
index 37fe041a928fd39af1ddaf76f181454be6337a53..edf09186a7f51a7635c3d5c9c3d7a2772668d496 100644 (file)
--- a/lib/doc/Customization.lyx
+++ b/lib/doc/Customization.lyx
@@ -1,5 +1,5 @@
 #LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 271
+\lyxformat 276
 \begin_document
 \begin_header
 \textclass book
@@ -39,9 +39,10 @@
 \paperpagestyle headings
 \tracking_changes false
 \output_changes false
-\author "Richard Heck" 
-\author "Jean-Marc Lasgouttes" 
-\author "usti" 
+\author ""
+\author ""
+\author ""
+\author ""
 \end_header
 
 \begin_body
@@ -1699,6 +1700,11 @@ s.
 \end_layout
 
 \begin_layout Section
+\begin_inset LatexCommand label
+name "sec:converters-etc"
+
+\end_inset
+
 Converters, Formats, and Copiers
 \end_layout
 
@@ -1961,7 +1967,7 @@ P
 references:Copiers
 \family default
  dialog.
- Since all conversions from one Format to another take place in a temporary
+ Since all conversions from one Format to another take place in LyX's temporary
  directory, it is sometimes necessary to modify a file before copying it
  to the temporary directory in order that the conversion may be performed.
 \begin_inset Foot
@@ -1977,6 +1983,77 @@ For example, the file may refer to other files---images, for example---using
 
  This is done by the Copier: It copies a file to (or from) the temporary
  directory and may modify it in the process.
+ 
+\end_layout
+
+\begin_layout Standard
+Copiers may also be used for other purposes.
+ For example, if appropriate converters are found, LyX will automatically
+ install copiers for the html and wordhtml formats.
+ When these formats are exported, the copier sees to it that not just the
+ main HTML file but various associated files (style files, images, and the
+ like) are also copied, and all these files are written to a subdirectory
+ of the directory in which the original LyX file was found.
+ The copier may of course be customized.
+ The optional -e argument takes a comma-separated list of extensions to
+ be copied; if it is omitted, all files will be copied.
+ The -t argument determines the extension added to the generated directory.
+ By default, it is 
+\begin_inset Quotes eld
+\end_inset
+
+LyXconv
+\begin_inset Quotes erd
+\end_inset
+
+, so HTML generated from 
+\family typewriter
+/path/to/filename.lyx
+\family default
+ will end up in 
+\family typewriter
+/path/to/filename.html.LyXconv
+\family default
+.
+ 
+\end_layout
+
+\begin_layout Standard
+The definitions of the copiers may use four variables:
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$s The LyX system directory (e.g., 
+\family typewriter
+/usr/share/lyx
+\family default
+).
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$i The input file
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$o The output file
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$l The `LaTeX name'
+\end_layout
+
+\begin_layout Standard
+The latter is to be given in a form suitable for inclusion in a LaTeX 
+\family typewriter
+
+\backslash
+include
+\family default
+ command and is relevant only when exporting files suitable for such inclusion.
 \end_layout
 
 \begin_layout Subsection
@@ -5891,7 +5968,7 @@ DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
 
 \begin_layout Standard
 This indicates that your text class uses the foo.sty package.
- Finally, it is also possible to declare classes for SGML and DocBook code.
+ Finally, it is also possible to declare classes for DocBook code.
  Typical declarations will look like
 \end_layout
 
@@ -5906,20 +5983,6 @@ This indicates that your text class uses the foo.sty package.
 \size small
 # 
 \backslash
-DeclareSGMLClass{SGML (LinuxDoc)}
-\end_layout
-
-\begin_layout Standard
-or
-\end_layout
-
-\begin_layout LyX-Code
-#% Do not delete the line below; configure depends on this 
-\end_layout
-
-\begin_layout LyX-Code
-# 
-\backslash
 DeclareDocBookClass[article]{SGML (DocBook article)}
 \end_layout
 
@@ -9396,10 +9459,6 @@ ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
 FormatEnd
 \end_layout
 
-\begin_layout LyX-Code
-Format LinuxDoc
-\end_layout
-
 \begin_layout LyX-Code
 Product "[XFig: $$FName]"
 \end_layout
@@ -9590,7 +9649,7 @@ The Format section
 \family typewriter
 \series medium
 Format\InsetSpace ~
-LaTeX|PDFLaTeX|PlainText|DocBook|LinuxDoc
+LaTeX|PDFLaTeX|PlainText|DocBook
 \family default
 \series default
  The primary document file format that this format definition is for.
@@ -9600,8 +9659,7 @@ LaTeX|PDFLaTeX|PlainText|DocBook|LinuxDoc
 Format
 \family default
  section for all formats.
- Use a dummy text when no representation is available (see the LinuxDoc
- format in the example above).
+ Use a dummy text when no representation is available.
  Then you can at least see a reference to the external material in the exported
  document.
 \end_layout