PageRenderTime 58ms CodeModel.GetById 54ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 0ms

/jEdit/tags/jedit-4-2-pre14/doc/users-guide/users-guide.xml

#
XML | 170 lines | 136 code | 29 blank | 5 comment | 0 complexity | 96497df91ebac3ca8a0543ae23860a0b MD5 | raw file
  1<?xml version="1.0" ?>
  2
  3<!-- jEdit user's guide -->
  4<!-- (C) 1999, 2003 Slava Pestov -->
  5<!-- (C) 2001, 2002 John Gellene -->
  6
  7<!-- jEdit buffer-local properties: -->
  8<!-- :indentSize=1:noTabs=true: -->
  9
 10<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 11  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
 12
 13<!ENTITY conventions SYSTEM "conventions.xml">
 14<!ENTITY starting SYSTEM "starting.xml">
 15<!ENTITY basics SYSTEM "basics.xml">
 16<!ENTITY files SYSTEM "files.xml">
 17<!ENTITY text-edit SYSTEM "text-edit.xml">
 18<!ENTITY source-edit SYSTEM "source-edit.xml">
 19<!ENTITY customizing SYSTEM "customizing.xml">
 20<!ENTITY using-macros SYSTEM "using-macros.xml">
 21<!ENTITY using-plugins SYSTEM "using-plugins.xml">
 22<!ENTITY shortcuts SYSTEM "shortcuts.xml">
 23<!ENTITY activity-log SYSTEM "activity-log.xml">
 24<!ENTITY history SYSTEM "history.xml">
 25<!ENTITY globs SYSTEM "globs.xml">
 26<!ENTITY regexps SYSTEM "regexps.xml">
 27<!ENTITY macro-index SYSTEM "macro-index.xml">
 28<!ENTITY launcher-guide SYSTEM "launcher-guide.xml">
 29
 30<!ENTITY writing-modes SYSTEM "writing-modes.xml">
 31<!ENTITY installing-modes SYSTEM "installing-modes.xml">
 32<!ENTITY updating-modes SYSTEM "updating-modes.xml">
 33
 34<!ENTITY macro-basics SYSTEM "macro-basics.xml">
 35<!ENTITY dialog-macro SYSTEM "dialog-macro.xml">
 36<!ENTITY macro-tips SYSTEM "macro-tips.xml">
 37<!ENTITY bsh-commands SYSTEM "bsh-commands.xml">
 38
 39<!ENTITY plugin-intro SYSTEM "plugin-intro.xml">
 40<!ENTITY plugin-implement SYSTEM "plugin-implement.xml">
 41<!ENTITY plugin-tips SYSTEM "plugin-tips.xml">
 42
 43]>
 44
 45<book>
 46
 47<bookinfo>
 48 <title>jEdit 4.2 User's Guide</title>
 49
 50 <copyright><year>1999</year><year>2003</year><holder>Slava Pestov</holder></copyright>
 51 <copyright><year>2001</year><year>2002</year><holder>John Gellene</holder></copyright>
 52 <legalnotice><title>Legal Notice</title>
 53  <para>
 54   Permission is granted to copy, distribute and/or modify this document
 55   under the terms of the GNU Free Documentation License, Version 1.1 or
 56   any later version published by the Free Software Foundation; with no
 57   <quote>Invariant Sections</quote>, <quote>Front-Cover Texts</quote> or
 58   <quote>Back-Cover Texts</quote>, each as defined in the license. A copy of
 59   the license can be found in the file <filename>COPYING.DOC.txt</filename>
 60   included with jEdit.
 61  </para>
 62 </legalnotice>
 63</bookinfo>
 64
 65<part id="using-jedit-part"><title>Using jEdit</title>
 66 <partintro>
 67  <para>
 68   This part of the user's guide covers jEdit's text editing commands, along
 69   with basic usage of macros and plugins.
 70  </para>
 71
 72  <para>
 73   This part of the user's guide was written by Slava Pestov
 74   <email>slava@jedit.org</email>.
 75  </para>
 76 </partintro>
 77
 78 &conventions;
 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 &updating-modes;
118</part>
119
120<part id="writing-macros-part"><title>Writing Macros</title>
121 <partintro>
122
123 <para>
124  This part of the user's guide covers writing macros for jEdit.
125 </para>
126
127 <para>
128  First, we will tell you a little about BeanShell,
129  jEdit's macro scripting language. Next, we will walk through a few
130  simple macros. We then present and analyze a dialog-based macro to
131  illustrate additional macro writing techniques. Finally, we discuss
132  several tips and techniques for writing and debugging macros.
133 </para>
134
135 <para>This part of the user's guide was written by John Gellene
136 <email>jgellene@nyc.rr.com</email>.</para>
137
138 </partintro>
139
140 &macro-basics;
141 &dialog-macro;
142 &macro-tips;
143 &bsh-commands;
144</part>
145
146<part id="writing-plugins-part"><title>Writing Plugins</title>
147 <partintro>
148  <para>
149   This part of the user's guide covers writing plugins for jEdit.
150  </para>
151
152  <para>
153   Like jEdit itself, plugins are written primarily in Java. While this
154   guide assumes some working knowledge of the language, you are not
155   required to be a Java wizard. If you can write a useful application of
156   any size in Java, you can write a plugin.
157  </para>
158
159  <para>
160   This part of the user's guide was written by John Gellene
161   <email>jgellene@nyc.rr.com</email>.
162  </para>
163 </partintro>
164
165 &plugin-intro;
166 &plugin-implement;
167 &plugin-tips;
168</part>
169
170</book>