/jEdit/tags/jedit-4-3-pre5/doc/users-guide/users-guide.xml

<?xml version="1.0" ?>

<!-- jEdit user's guide -->
<!-- (C) 1999, 2004 Slava Pestov -->
<!-- (C) 2001, 2002 John Gellene -->
<!-- (C) 2005, 2006 Alan Ezust -->

<!-- jEdit buffer-local properties: -->
<!-- :indentSize=1:noTabs=true: -->

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY conventions SYSTEM "conventions.xml">
<!ENTITY starting SYSTEM "starting.xml">
<!ENTITY basics SYSTEM "basics.xml">
<!ENTITY files SYSTEM "files.xml">
<!ENTITY text-edit SYSTEM "text-edit.xml">
<!ENTITY source-edit SYSTEM "source-edit.xml">
<!ENTITY customizing SYSTEM "customizing.xml">
<!ENTITY using-macros SYSTEM "using-macros.xml">
<!ENTITY using-plugins SYSTEM "using-plugins.xml">
<!ENTITY shortcuts SYSTEM "shortcuts.xml">
<!ENTITY activity-log SYSTEM "activity-log.xml">
<!ENTITY history SYSTEM "history.xml">
<!ENTITY globs SYSTEM "globs.xml">
<!ENTITY regexps SYSTEM "regexps.xml">
<!ENTITY macro-index SYSTEM "macro-index.xml">
<!ENTITY launcher-guide SYSTEM "launcher-guide.xml">

<!ENTITY writing-modes SYSTEM "writing-modes.xml">
<!ENTITY installing-modes SYSTEM "installing-modes.xml">
<!ENTITY updating-modes SYSTEM "updating-modes.xml">

<!ENTITY macro-basics SYSTEM "macro-basics.xml">
<!ENTITY dialog-macro SYSTEM "dialog-macro.xml">
<!ENTITY macro-tips SYSTEM "macro-tips.xml">
<!ENTITY bsh-commands SYSTEM "bsh-commands.xml">

<!ENTITY plugin-intro SYSTEM "plugin-intro.xml">
<!ENTITY plugin-implement SYSTEM "plugin-implement.xml">
<!ENTITY plugin-tips SYSTEM "plugin-tips.xml">

]>

<book>

<bookinfo>
 <title>jEdit 4.3 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>2006</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 written by Slava Pestov
   <email>slava@jedit.org</email>.
  </para>
 </partintro>

 &conventions;
 &starting;
 &basics;
 &files;
 &text-edit;
 &source-edit;
 &customizing;
 &using-macros;
 &using-plugins;
 &shortcuts;
 &activity-log;
 &history;
 &globs;
 &regexps;
 &macro-index;
<!--  &launcher-guide; -->
</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
   <email>slava@jedit.org</email>.
  </para>
 </partintro>

 &writing-modes;
 &installing-modes;
 &updating-modes;
</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>

 &macro-basics;
 &dialog-macro;
 &macro-tips;
 &bsh-commands;
</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 written by John Gellene
   <email>jgellene@nyc.rr.com</email>.
  </para>
 </partintro>

 &plugin-intro;
 &plugin-implement;
 &plugin-tips;
</part>

</book>