/jEdit/tags/jedit-4-5-pre1/doc/users-guide/users-guide.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- jEdit buffer-local properties: -->
<!-- maxLineLen=0:wrap=soft:indentSize=1:noTabs=true: -->
<!-- jEdit user's guide -->
<!-- (C) 1999, 2004 Slava Pestov -->
<!-- (C) 2001, 2002 John Gellene -->
<!-- (C) 2005, 2011 Alan Ezust -->
<book id="users-guide"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xi="http://www.w3.org/2001/XInclude"  xsi:noNamespaceSchemaLocation='http://www.docbook.org/xsd/4.4/docbook.xsd'>
    <bookinfo>
        <title>jEdit 4.5 User's Guide</title>

        <copyright>
            <year>1999</year>
            <year>2004</year>

            <holder>Slava Pestov</holder>
        </copyright>

        <copyright>
            <year>2001</year>
            <year>2002</year>

            <holder>John Gellene</holder>
        </copyright>

        <copyright>
            <year>2005</year>
            <year>2011</year>

            <holder>Alan Ezust</holder>
        </copyright>

        <legalnotice>
            <title>Legal Notice</title>

            <para>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 <quote>Invariant Sections</quote>,
            <quote>Front-Cover Texts</quote> or <quote>Back-Cover Texts</quote>,
            each as defined in the license. A copy of the license can be found
            in the file <filename>COPYING.DOC.txt</filename> included with
            jEdit.</para>
        </legalnotice>
    </bookinfo>

    <part id="using-jedit-part">
        <title>Using jEdit</title>

        <partintro>
            <para>This part of the user's guide covers jEdit's text editing
            commands, along with basic usage of macros and plugins.</para>

            <para>This part of the user's guide was originally written by Slava
            Pestov and is maintained by the jEdit core development team.</para>
        </partintro>

        <xi:include href="conventions.xml" />
        <xi:include href="starting.xml" />
        <xi:include href="basics.xml" />
        <xi:include href="files.xml" />
        <xi:include href="text-edit.xml" />
        <xi:include href="source-edit.xml" />
        <xi:include href="customizing.xml" />
        <xi:include href="using-macros.xml" />
        <xi:include href="using-plugins.xml" />
        <xi:include href="shortcuts.xml" />
        <xi:include href="activity-log.xml" />
        <xi:include href="history.xml" />
        <xi:include href="globs.xml" />
        <xi:include href="regexps.xml" />
        <xi:include href="macro-index.xml" />

    </part>

    <part id="writing-modes-part">
        <title>Writing Edit Modes</title>

        <partintro>
            <para>This part of the user's guide covers writing edit modes for
            jEdit.</para>

            <para>Edit modes specify syntax highlighting rules, auto indent
            behavior, and various other customizations for editing different
            file types. For general information about edit modes, see <xref
            linkend="modes" />.</para>

            <para>This part of the user's guide was written by Slava Pestov and
            is maintained by the jEdit core development team.</para>
        </partintro>

        <xi:include href="writing-modes.xml" />
        <xi:include href="installing-modes.xml" />
        <xi:include href="updating-modes.xml" />
    </part>

    <part id="writing-macros-part">
        <title>Writing Macros</title>

        <partintro>
            <para>This part of the user's guide covers writing macros for
            jEdit.</para>

            <para>First, we will tell you a little about BeanShell, jEdit's
            macro scripting language. Next, we will walk through a few simple
            macros. We then present and analyze a dialog-based macro to
            illustrate additional macro writing techniques. Finally, we discuss
            several tips and techniques for writing and debugging macros.</para>

            <para>This part of the user's guide was written by John Gellene
            <email>jgellene@nyc.rr.com</email>.</para>
        </partintro>

        <xi:include href="macro-basics.xml" />

        <xi:include href="dialog-macro.xml" />
        <xi:include href="macro-tips.xml" />
        <xi:include href="bsh-commands.xml" />
    </part>

    <part id="writing-plugins-part">
        <title>Writing Plugins</title>

        <partintro>
            <para>This part of the user's guide covers writing plugins for
            jEdit.</para>

            <para>Like jEdit itself, plugins are written primarily in Java.
            While this guide assumes some working knowledge of the language, you
            are not required to be a Java wizard. If you can write a useful
            application of any size in Java, you can write a plugin.</para>

            <para>This part of the user's guide was originally written by John
            Gellene. As of jEdit 4.3, it is maintained by Alan Ezust with help
            from others in the jEdit core development team.</para>
        </partintro>

        <xi:include href="plugin-intro.xml" />
        <xi:include href="plugin-implement.xml" />
        <xi:include href="plugin-tips.xml" />

    </part>
</book>