PageRenderTime 213ms CodeModel.GetById 209ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

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

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