PageRenderTime 167ms CodeModel.GetById 164ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 0ms

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

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