1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- jEdit buffer-local properties: -->
<!-- maxLineLen=90:wrap=soft:indentSize=2:noTabs=true: -->
<!-- jEdit user's guide -->
<book id="users-guide"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xi="http://www.w3.org/2001/XInclude" xsi:noNamespaceSchemaLocation='https://www.docbook.org/xsd/4.4/docbook.xsd'>
<bookinfo>
<title>jEdit 5.5 User's Guide</title>
<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>
<author>
<othername> The jEdit all-volunteer developer team </othername>
</author>
<revhistory>
<revision>
<revnumber>1.0 - 4.3</revnumber>
<date>1999-2004</date>
<author> <firstname>Slava</firstname> <surname>Pestov</surname> </author>
<revremark>Initial HTML document</revremark>
</revision>
<revision>
<revnumber>3.2 - 4.1</revnumber>
<date>2001-2002</date>
<author> <firstname>John</firstname><surname>Gellene</surname> </author>
<revremark> Initial DocBook version. Initial versions of Plugin Guide and Macro Guide. </revremark>
</revision>
<revision>
<revnumber>4.3 - 5.5</revnumber>
<date>2005-2017</date>
<author><firstname>Alan</firstname><surname>Ezust</surname></author>
<revremark> Maintainer. </revremark>
</revision>
</revhistory>
</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 originally written by Slava
Pestov and is maintained by the jEdit core development team.</para>
</partintro>
<xi:include href="conventions.xml" />
<xi:include href="starting.xml" />
<xi:include href="basics.xml" />
<xi:include href="files.xml" />
<xi:include href="text-edit.xml" />
<xi:include href="source-edit.xml" />
<xi:include href="customizing.xml" />
<xi:include href="using-macros.xml" />
<xi:include href="using-plugins.xml" />
<xi:include href="shortcuts.xml" />
<xi:include href="activity-log.xml" />
<xi:include href="history.xml" />
<xi:include href="globs.xml" />
<xi:include href="regexps.xml" />
<xi:include href="macro-index.xml" />
</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 and
is maintained by the jEdit core development team.</para>
</partintro>
<xi:include href="writing-modes.xml" />
<xi:include href="installing-modes.xml" />
<xi:include href="updating-modes.xml" />
</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>
</partintro>
<xi:include href="macro-basics.xml" />
<xi:include href="dialog-macro.xml" />
<xi:include href="macro-tips.xml" />
<xi:include href="bsh-commands.xml" />
</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>Where applicable, this section will also explain how jEdit's
source code is similar. Therefore, this is also a good introduction to
to jEdit development. </para>
</partintro>
<xi:include href="plugin-intro.xml" />
<xi:include href="plugin-implement.xml" />
<xi:include href="plugin-tips.xml" />
</part>
</book>
|