2013-03-05 02:57:42 +08:00
|
|
|
<TeXmacs|1.0.7.18>
|
2011-08-28 15:59:50 +08:00
|
|
|
|
|
|
|
|
<style|tmdoc>
|
|
|
|
|
|
|
|
|
|
<\body>
|
2012-02-16 19:59:22 +08:00
|
|
|
<tmdoc-title|Example of a plug-in with <scheme> code>
|
2011-08-28 15:59:50 +08:00
|
|
|
|
|
|
|
|
<paragraph*|The <verbatim|world> plug-in>
|
|
|
|
|
|
|
|
|
|
Consider the <verbatim|world> plug-in in the directory
|
|
|
|
|
|
|
|
|
|
<\verbatim>
|
|
|
|
|
\ \ \ \ $TEXMACS_PATH/examples/plugins
|
|
|
|
|
</verbatim>
|
|
|
|
|
|
2012-02-16 19:59:22 +08:00
|
|
|
This plug-in shows how to extend <TeXmacs> with some additional <scheme>
|
|
|
|
|
code in the file
|
2011-08-28 15:59:50 +08:00
|
|
|
|
|
|
|
|
<\verbatim>
|
|
|
|
|
\ \ \ \ <example-plugin-link|world/progs/init-world.scm>
|
|
|
|
|
</verbatim>
|
|
|
|
|
|
|
|
|
|
In order to test the <verbatim|world> plug-in, you should recursively copy
|
|
|
|
|
the directory
|
|
|
|
|
|
|
|
|
|
<\verbatim>
|
|
|
|
|
\ \ \ \ $TEXMACS_PATH/examples/plugins/world
|
|
|
|
|
</verbatim>
|
|
|
|
|
|
|
|
|
|
to <verbatim|$TEXMACS_PATH/plugins> or <verbatim|$TEXMACS_HOME_PATH/plugins>.
|
|
|
|
|
When relaunching <TeXmacs>, the plug-in should now be automatically
|
|
|
|
|
recognized (a <menu|World> menu should appear in the menu bar).
|
|
|
|
|
|
|
|
|
|
<paragraph*|How it works>
|
|
|
|
|
|
|
|
|
|
The file <verbatim|init-world.scm> essentially contains the following code:
|
|
|
|
|
|
2012-02-16 19:59:22 +08:00
|
|
|
<\scm-code>
|
2013-03-05 02:57:42 +08:00
|
|
|
(plugin-configure world
|
2011-08-28 15:59:50 +08:00
|
|
|
|
2013-03-05 02:57:42 +08:00
|
|
|
\ \ (:require #t))
|
2011-08-28 15:59:50 +08:00
|
|
|
|
|
|
|
|
\;
|
|
|
|
|
|
2013-03-05 02:57:42 +08:00
|
|
|
(when (supports-world?)
|
2011-08-28 15:59:50 +08:00
|
|
|
|
2013-03-05 02:57:42 +08:00
|
|
|
\ \ (display* "Using world plug-in!\\n"))
|
2012-02-16 19:59:22 +08:00
|
|
|
</scm-code>
|
2011-08-28 15:59:50 +08:00
|
|
|
|
2012-02-16 19:59:22 +08:00
|
|
|
The configuration option <scm|:require> specifies a condition which needs
|
|
|
|
|
to be satisfied for the plug-in to be detected by <TeXmacs> (later on, this
|
|
|
|
|
will for instance allow us to check whether certain programs exist on the
|
|
|
|
|
system). The configuration is aborted if the requirement is not fulfilled.
|
2011-08-28 15:59:50 +08:00
|
|
|
|
2013-03-05 02:57:42 +08:00
|
|
|
Assuming that the configuration succeeds, the <verbatim|supports-world?>
|
|
|
|
|
predicate will evaluate to <verbatim|#t>. In our example, the body of the
|
|
|
|
|
<scm|when> statement corresponds to some further initialization code, which
|
|
|
|
|
just sends a message to the standard output that we are using our plug-in.
|
|
|
|
|
In general, this kind of initialization code should be very short and
|
|
|
|
|
rather load a module which takes care of the real initialization. Indeed,
|
|
|
|
|
keeping the <verbatim|init-<em|myplugin>.scm> files simple will reduce the
|
|
|
|
|
startup time of<nbsp><TeXmacs>.
|
2011-08-28 15:59:50 +08:00
|
|
|
|
|
|
|
|
<tmdoc-copyright|1998--2002|Joris van der Hoeven>
|
|
|
|
|
|
|
|
|
|
<tmdoc-license|Permission is granted to copy, distribute and/or modify this
|
|
|
|
|
document under the terms of the GNU Free Documentation License, Version 1.1
|
|
|
|
|
or any later version published by the Free Software Foundation; with no
|
|
|
|
|
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
|
|
|
|
|
Texts. A copy of the license is included in the section entitled "GNU Free
|
|
|
|
|
Documentation License".>
|
|
|
|
|
</body>
|
|
|
|
|
|
|
|
|
|
<\initial>
|
|
|
|
|
<\collection>
|
|
|
|
|
<associate|language|english>
|
|
|
|
|
</collection>
|
|
|
|
|
</initial>
|
