PageRenderTime 158ms CodeModel.GetById 150ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 1ms

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

#
XML | 196 lines | 160 code | 31 blank | 5 comment | 0 complexity | 66d865ee045f4f4fc252591e53fa53e5 MD5 | raw file
  1<?xml version="1.0" ?>
  2
  3<!-- jEdit user's guide -->
  4<!-- (C) 1999, 2000, 2001 Slava Pestov -->
  5<!-- (C) 2001 John Gellene -->
  6
  7<!-- jEdit buffer-local properties: -->
  8<!-- :indentSize=1:noTabs=true:folding=indent:collapseFolds=1: -->
  9
 10<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 11  "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 12
 13<!ENTITY starting SYSTEM "starting.xml">
 14<!ENTITY basics SYSTEM "basics.xml">
 15<!ENTITY files SYSTEM "files.xml">
 16<!ENTITY text-edit SYSTEM "text-edit.xml">
 17<!ENTITY source-edit SYSTEM "source-edit.xml">
 18<!ENTITY customizing SYSTEM "customizing.xml">
 19<!ENTITY using-macros SYSTEM "using-macros.xml">
 20<!ENTITY using-plugins SYSTEM "using-plugins.xml">
 21<!ENTITY shortcuts SYSTEM "shortcuts.xml">
 22<!ENTITY activity-log SYSTEM "activity-log.xml">
 23<!ENTITY history SYSTEM "history.xml">
 24<!ENTITY globs SYSTEM "globs.xml">
 25<!ENTITY regexps SYSTEM "regexps.xml">
 26<!ENTITY macro-index SYSTEM "macro-index.xml">
 27<!ENTITY launcher-guide SYSTEM "launcher-guide.xml">
 28
 29<!ENTITY writing-modes SYSTEM "writing-modes.xml">
 30<!ENTITY installing-modes SYSTEM "installing-modes.xml">
 31
 32<!ENTITY macro-basics SYSTEM "macro-basics.xml">
 33<!ENTITY simple-macros SYSTEM "simple-macros.xml">
 34<!ENTITY dialog-macro SYSTEM "dialog-macro.xml">
 35<!ENTITY macro-tips SYSTEM "macro-tips.xml">
 36
 37<!ENTITY plugin-intro SYSTEM "plugin-intro.xml">
 38<!ENTITY host-design SYSTEM "host-design.xml">
 39<!ENTITY plugin-api SYSTEM "plugin-api.xml">
 40<!ENTITY plugin-implement SYSTEM "plugin-implement.xml">
 41
 42<!ENTITY bsh-commands SYSTEM "bsh-commands.xml">
 43<!ENTITY api-guide SYSTEM "api-guide.xml">
 44<!ENTITY api-message SYSTEM "api-message.xml"> ]>
 45
 46<book>
 47
 48<bookinfo>
 49 <title>jEdit 4.0 User's Guide</title>
 50
 51 <copyright><year>1998</year><year>2001</year><holder>Slava Pestov</holder></copyright>
 52 <copyright><year>2001</year><holder>John Gellene</holder></copyright>
 53 <legalnotice><title>Legal Notice</title>
 54  <para>
 55   Permission is granted to copy, distribute and/or modify this document
 56   under the terms of the GNU Free Documentation License, Version 1.1 or
 57   any later version published by the Free Software Foundation; with no
 58   <quote>Invariant Sections</quote>, <quote>Front-Cover Texts</quote> or
 59   <quote>Back-Cover Texts</quote>, each as defined in the license. A copy of
 60   the license can be found in the file <filename>COPYING.DOC.txt</filename>
 61   included with jEdit.
 62  </para>
 63 </legalnotice>
 64</bookinfo>
 65
 66<part id="using-jedit-part"><title>Using jEdit</title>
 67 <partintro>
 68  <para>
 69   This part of the user's guide covers jEdit's text editing commands, along
 70   with basic usage of macros and plugins.
 71  </para>
 72
 73  <para>
 74   This part of the user's guide was written by Slava Pestov
 75   <email>slava@jedit.org</email>.
 76  </para>
 77 </partintro>
 78
 79 &starting;
 80 &basics;
 81 &files;
 82 &text-edit;
 83 &source-edit;
 84 &customizing;
 85 &using-macros;
 86 &using-plugins;
 87 &shortcuts;
 88 &activity-log;
 89 &history;
 90 &globs;
 91 &regexps;
 92 &macro-index;
 93 &launcher-guide;
 94</part>
 95
 96<part id="writing-modes-part"><title>Writing Edit Modes</title>
 97 <partintro>
 98  <para>
 99   This part of the user's guide covers writing edit modes for jEdit.
100  </para>
101
102  <para>
103   Edit modes
104   specify syntax highlighting rules, auto indent behavior, and various other
105   customizations for editing different file types.
106   For general information about edit modes, see <xref linkend="modes" />.
107  </para>
108
109  <para>
110   This part of the user's guide was written by Slava Pestov
111   <email>slava@jedit.org</email>.
112  </para>
113 </partintro>
114
115 &writing-modes;
116 &installing-modes;
117</part>
118
119<part id="writing-macros-part"><title>Writing Macros</title>
120 <partintro>
121
122 <para>
123  This part of the user's guide covers writing macros for jEdit.
124 </para>
125
126 <para>
127  First, we will tell you a little about BeanShell,
128  jEdit's macro scripting language. Next, we will walk through a few
129  simple macros. We then present and analyze a dialog-based macro to
130  illustrate additional macro writing techniques. Finally, we discuss
131  several tips and techniques for writing and debugging macros.
132 </para>
133
134 <para>This part of the user's guide was written by John Gellene
135 <email>jgellene@nyc.rr.com</email>.</para>
136
137 </partintro>
138
139 &macro-basics;
140 &simple-macros;
141 &dialog-macro;
142 &macro-tips;
143</part>
144
145<part id="writing-plugins-part"><title>Writing Plugins</title>
146 <partintro>
147  <para>
148   This part of the user's guide covers writing plugins for jEdit.
149  </para>
150
151  <para>
152   Like jEdit itself, plugins are written primarily in Java. While this
153   guide assumes some working knowledge of the language, you are not
154   required to be a Java wizard. If you can write a useful application of
155   any size in Java, you can write a plugin.
156  </para>
157
158  <para>
159   This part of the user's guide was written by John Gellene
160   <email>jgellene@nyc.rr.com</email>.
161  </para>
162 </partintro>
163
164 &plugin-intro;
165 &host-design;
166 &plugin-api;
167 &plugin-implement;
168</part>
169
170<part id="api-guide-part"><title>jEdit API Reference</title>
171 <partintro>
172  <para>
173   This part of the user's guide covers the jEdit <firstterm>application
174   programmer interface</firstterm>. The information in this part is only useful
175   to macro and plugin developers; you do not need to read it if you only want to
176   use jEdit.
177  </para>
178  <para>
179   The first two chapter covers BeanShell commands, which are can only
180   be used in macros. The second chapter covers APIs useful to both macros and
181   plugins.
182   The final chapter covers the EditBus message system, which is typically
183   only used by plugins.
184  </para>
185  <para>
186   This part of the user's guide was written by John Gellene
187   <email>jgellene@nyc.rr.com</email>.
188  </para>
189 </partintro>
190
191 &bsh-commands;
192 &api-guide;
193 &api-message;
194</part>
195
196</book>