/jEdit/tags/jedit-4-5-pre1/doc/FAQ/faq-plugins.xml

<?xml version="1.0" encoding="UTF-8"?>
<section id="plugins">
    <title>Plugin Questions</title>
    <!-- jEdit buffer-local properties:                      -->
    <!-- :indentSize=4:noTabs=false:maxLineLen=80:tabSize=4: -->
    <!-- :xml.root=faq.xml:                                  -->
    <!-- jEdit FAQ                                           -->
    <!-- Copyright (C) 2003 John Gellene, Kris Kopicki       -->
    <para>This section deals with questions concerning the use of jEdit's
    plugins. Plugins are applications that share jEdit's memory space and user
    interface and provide a wide variety of functions and services.</para>
    <qandaset defaultlabel="qanda">
        <qandadiv id="plugin-general">
            <title>General plugin questions</title>
            <qandaentry>
                <question id="plugins-latest-official">
                    <para>Where can I get information on the latest available
                    <quote>official</quote> plugins?</para>
                </question>
                <answer>
                    <para>To get a listing of the latest plugins available for
                    downloading from jEdit Plugin Central, use the
                    <guimenuitem>Plugin Manager</guimenuitem> feature on jEdit's
                    <guimenu>Plugin</guimenu> menu. You can also get more
                    detailed descriptions of the plugins from the <ulink
                    url="http://plugins.jedit.org">Plugin Central</ulink> web
                    site.</para>
                </answer>
            </qandaentry>
            <qandaentry>
                <question id="plugins-latest-beta">
                    <para>Where can I get information on new plugins under
                    development?</para>
                </question>
                <answer>
                    <para>We encourage plugin developers to join the
                    <email>jedit-devel@lists.sourceforge.net</email> mailing
                    list. There, you will find the greatest concentration of
                    people who are also familiar with the core and its
                    plugins.</para>
                </answer>
            </qandaentry>
            <qandaentry>
                <question id="plugin-install-manual">
                    <para>How do I install a plugin manually, without using the
                    Plugin Manager?</para>
                </question>
                <answer>
                    <para>Copy the plugin's jar archive file (or files, if there
                    are more than one) to the <filename>/jars</filename>
                    subdirectory of either (a) the directory in which jEdit is
                    installed, or (b) your user settings directory (which you
                    can find by evaluating the BeanShell expression
                    <userinput>jEdit.getSettingsDirectory()</userinput>.</para>
                </answer>
            </qandaentry>
            <qandaentry>
                <question id="plugins-developing">
                    <para>How do I write a plugin?</para>
                </question>
                <answer>
                    <para>Writing a plugin requires a working knowledge of Java
                    and some familiarity with jEdit's Plugin API. There is a
                    tutorial on plugin development in the jEdit User's Guide.
                    The source code distribution for jEdit also includes the
                    source for an example plugin, <application>Quick
                    Notepad</application>, which is discussed in the
                    tutorial.</para>
                    <para>To learn more about plugin development, take a look at
                    the source code for other plugins, particularly those whose
                    features or user interface you might use as a model. The
                    <ulink url="mailto:jedit-devel@lists.sourceforge.net">jedit-devel mailing
                    list</ulink> and the message boards at <ulink
                    url="http://community.jedit.org">jEdit Community</ulink> are
                    also available for specific questions.</para>
                </answer>
            </qandaentry>
            <qandaentry>
                <question id="plugin-irc">
                    <para>Is there an IRC (Internet Relay Chat) plugin for
                    jEdit?</para>
                </question>
                <answer>
                    <para>Yes. Open the Plugin Manager, then select
                    <guimenuitem>Install plugins</guimenuitem>. You will find
                    the IRC plugin which you can select for installation.</para>
                </answer>
            </qandaentry>
            <qandaentry>
                <question id="plugin-console-execute">
                    <para>Is it possible to execute my application from within
                    jEdit?</para>
                </question>
                <answer>
                    <para>Yes. You can use the System shell of the Console
                    plugin to run your application.</para>
                </answer>
            </qandaentry>
            <qandaentry>
                <question id="plugin-cvs">
                    <para>Can I work with cvs/svn/git/hg/bzr/Perforce
                    under jEdit? Is there a plugin for my favorite SCCS system?
                    How can I send a command from jEdit to cvs/svn without
                    leaving my editor?</para>
                </question>
                <answer>
                    <para>The SVNPlugin supports Subversion browsing, diffing
                    (via JDiff) and other common operations.</para>
                    <para>With *NIX (or cygwin), the Console plugin
                    documentation has some ideas on how to use jEdit as the
                    <literal>VISUAL</literal> editor when called from the
                    cvs/svn/hg command-line tools, all of which can be run from
                    the Console dockable.</para>
                    <para>The ProjectViewer plugin has some support for reading
                    the "entries" in your working directory, and will use that as a filter for importing. CVS/SVN support is built-in, and p4, bzr, git, and hg are also supported via plugins. </para>
                    <para>The P4Plugin adds Perforce support to ProjectViewer,
                    and has some other advanced features for working with
                    Perforce repositories.</para>
                    <para>You can use jEdit as your default editor from WinCVS:
                    specify <userinput>jedit.exe</userinput> as your default
                    viewer and editor to automate the opening of file.</para>
                    <para>GruntSpud and jEditCvs are not maintained, but do
                    offer CVS support on jEdit 4.2final.</para>
                </answer>
            </qandaentry>
            <qandaentry>
                <question id="plugin-debugger">
                    <para>Is there a debugger plugin?</para>
                </question>
                <answer>
					<para> The GdbPlugin provides gdb/mi support for C/C++
                    programs. Also, the Console BeanShell can be used to debug Java classes in the current running JVM. </para>
                    <para>A plugin based on the version 1.4 of the JSwat
                    debugger application is currently available for download
                    using jEdit's Plugin Manager feature. </para>
                    <para>The developers would like to come up with a common
                    debugger plugin that can be shared between java, gdb, and python, but such a thing does not exist at this time.
                    </para>
                </answer>
            </qandaentry>
            <qandaentry>
                <question id="plugins-xslt">
                    <para>Any development on integrating an XSL parser? It would
                    be great to have the possibility to do XSL + XSLT -&gt;
                    XHTML development in the same environment as other
                    development.</para>
                </question>
                <answer>
                    <para>There is currently one plugin available called XSLT.
                    The XSLT plugin provides features for: transforming XML
                    using XSL transformation stylesheets; evaluating XPath
                    expressions on XML and displaying results; and indenting
                    XML.</para>
                </answer>
            </qandaentry>
            <qandaentry>
                <question id="plugins-ssh">
                    <para>Is there a plugin to enable editing of remote files
                    over FTP or SSH?</para>
                </question>
                <answer>
                    <para>The FTP plugin allows remote editing of files over the
                    <literal>SFTP://</literal> and <literal>FTP://</literal>
                    protocols. <literal>HTTP://</literal> is supported natively
                    in jEdit. The <literal>FTPS://</literal> and
                    <literal>FISH://</literal> protocols are not supported
                    yet.</para>
                </answer>
            </qandaentry>
        </qandadiv>
    </qandaset>
</section>