From 627edd9f9bec544ba063a1ccc65f9db335108b0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Poulain?= Date: Thu, 22 May 2014 15:46:32 +0000 Subject: [PATCH] Documentation update --- main/convert/new/man-newconv.en.tm | 101 +++++++++++------------------ 1 file changed, 37 insertions(+), 64 deletions(-) diff --git a/main/convert/new/man-newconv.en.tm b/main/convert/new/man-newconv.en.tm index 3f240b0..378543c 100644 --- a/main/convert/new/man-newconv.en.tm +++ b/main/convert/new/man-newconv.en.tm @@ -1,9 +1,10 @@ - + - +> <\body> - + Using the / extension language, it is possible to add new data formats and converters to in a modular way. Usually, @@ -17,13 +18,13 @@ A new format is declared using the command - <\expand|scheme-fragment> + <\scm-code> (define-format \ \ (:name ) \ \ ) - + Here > is a symbol which stands for the format and > a string which can be used in menus. In fact, a @@ -41,44 +42,50 @@ formats by their file suffix and contents. The possible suffixes for a format, with the default one listed first, may be specified using - <\expand|scheme-fragment> + <\scm-code> (:suffix ... ) - + A (heuristic) routine for recognizing whether a given document matches the format can be specified using either one of the following: - <\expand|scheme-fragment> + <\scm-code> (:recognize ) (:must-recognize ) - + In the first case, suffix recognition takes precedence over document recognition and in the second case, the heuristic recognition is entirely determined by the document recognition predicate. + A format can be removed from menus using the following: + + <\scm-code> + (:hidden) + + New converters are declared using - <\expand|scheme-fragment> + <\scm-code> (converter \ \ ) - + The actual converter is specified using either one of the following options: - <\expand|scheme-fragment> + <\scm-code> (:function ) (:function-with-options ) (:shell from to ) - + In the first case, the > is a routine which takes an object of the > format and returns a routine of the @@ -92,22 +99,22 @@ automatically computes the transitive closure of all converters using a shortest path algorithm. In other words, if you have a converter - from to and a converter from - to , then you will automatically have - a converter from to . A ``distance - between two formats via a given converter'' may be specified using + from to and a converter from to , then + you will automatically have a converter from to . A + ``distance between two formats via a given converter'' may be specified + using - <\expand|scheme-fragment> + <\scm-code> (:penalty ) - + Further options for converters are: - <\expand|scheme-fragment> + <\scm-code> (:require ) (:option ) - + The first option specifies a condition which must be satisfied for this converter to be used. This option should be specified as the first or @@ -116,49 +123,15 @@ default value. This option automatically become a user preference and it will be passed to all converters with options. - + - + -<\initial> - <\collection> - - - - - - - - - - - - - - - - -<\references> - <\collection> - |?>> - |?>> - - - -<\auxiliary> - <\collection> - <\associate|toc> - |font size||Declaring new - formats> - - |font size||Declaring new - converters> - - - \ No newline at end of file + +> \ No newline at end of file