PageRenderTime 41ms CodeModel.GetById 36ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 0ms

/jEdit/tags/jedit-4-5-pre1/doc/users-guide/users-guide.xml

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