PageRenderTime 223ms CodeModel.GetById 217ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 0ms

/jEdit/tags/jedit-4-1-pre5/jars/QuickNotepad/qpadhelp.xml

#
XML | 229 lines | 194 code | 27 blank | 8 comment | 0 complexity | 4fd5f4882f9de0fdcb1e44f22208f407 MD5 | raw file
  1<!-- QuickNotepad 2.0 help documentation		-->
  2<!-- Contains text of documentation;		-->
  3<!-- DocBook header contained in QuickNotepad.xml       -->
  4<!-- Copyright (C) 2001 John Gellene		-->
  5<!-- $Id: qpadhelp.xml 3892 2001-11-11 12:26:20Z jgellene $
  6-->
  7
  8<simplesect><title>Introduction</title>
  9<indexterm><primary>QuickNotepad</primary></indexterm>
 10<para>
 11	This plugin provides a dockable <quote>scratch pad</quote> for writing
 12	and displaying notes, to do lists or similar items as unformatted text.
 13	The text is automatically saved upon closing the plugin or exiting
 14	jEdit. It can also be saved manually. The user can change the file to be
 15	displayed during the current editing session. The path of the default
 16	notepad file can be changed as a user option. Finally, the text file can
 17	be copied to a new, untitled jEdit buffer so that it can be edited by the
 18	main program.
 19</para>
 20
 21<para>
 22	The <citetitle>jEdit Plugin Guide</citetitle> details the development
 23	and design of QuickNotepad. It is a simple but functional dockable plugin
 24	that incorporates the basic elements of the jEdit plugin architecture.
 25</para>
 26
 27<para>
 28	QuickNotepad 2.0 is designed to operate with JDK 1.2 or greater and
 29	jEdit 4.0 or greater.  The EditBus plugin is also required.
 30</para>
 31
 32<para>
 33	The file <filename>changes40.txt</filename> in the plugin's source
 34	code details the changes that were made to the plugin to conform to
 35	the new plugin API for jEdit version 4.0.
 36</para>
 37</simplesect>
 38
 39<simplesect><title>Operation</title>
 40
 41<para>
 42<indexterm>
 43	<primary>QuickNotepad</primary>
 44	<secondary>shortcut keys</secondary>
 45</indexterm>
 46	When QuickNotepad is activated, it loads and displays the file stored in
 47	its properties as unformatted text. The text can be edited using the
 48	keyboard and mouse. The text area component recognizes the following
 49	basic editing shortcuts:
 50</para>
 51<!-- Limitations on xsltproc's capabilities require a blank column between -->
 52<!-- the two columns of data to provide spacing for the table.       -->
 53<informaltable align="center" frame="none">
 54	<tgroup cols="4" align="left">
 55		<colspec colnum="1"/> <!-- blank column -->
 56		<colspec colnum="2"/>
 57		<colspec colnum="3"/> <!-- blank column -->
 58		<colspec colnum="4"/>
 59		<tbody>
 60			<row>
 61				<entry>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</entry>
 62				<entry>Cut</entry>
 63				<entry>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</entry>
 64				<entry><keycombo action="simul"><keysym>Ctrl</keysym><keysym>x</keysym></keycombo></entry>
 65			</row>
 66			<row>
 67				<entry>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</entry>
 68				<entry>Copy</entry>
 69				<entry>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</entry>
 70				<entry><keycombo action="simul"><keysym>Ctrl</keysym><keysym>c</keysym></keycombo></entry>
 71			</row>
 72			<row>
 73				<entry>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</entry>
 74				<entry>Paste</entry>
 75				<entry>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</entry>
 76				<entry><keycombo action="simul"><keysym>Ctrl</keysym><keysym>v</keysym></keycombo></entry>
 77			</row>
 78			<row>
 79				<entry>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</entry>
 80				<entry>Select All</entry>
 81				<entry>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</entry>
 82				<entry><keycombo action="simul"><keysym>Ctrl</keysym><keysym>a</keysym></keycombo></entry>
 83			</row>
 84		</tbody>
 85	</tgroup>
 86</informaltable>
 87
 88<para>
 89	QuickNotepad ignores function keys and other combination key presses.
 90</para>
 91
 92</simplesect>
 93
 94<simplesect><title>Toolbar buttons</title>
 95
 96<para>
 97	Three buttons above the text area provide file management operations:
 98</para>
 99
100<itemizedlist>
101	<listitem>
102		<para>
103			<guilabel>Choose notepad file</guilabel> - this button opens a file selection
104			dialog permitting the user to select a different file to view in the
105			text area. If a new file is selected, the old file is
106			auomatically saved. The selection is valid only for the current
107			editing session; to change the default QuickNotepad file for future
108			sessions, use the <link linkend="options">options dialog</link>.
109		</para>
110	</listitem>
111	<listitem>
112		<para>
113			<guilabel>Save notepad file</guilabel> - this button causes QuickNotepad to
114			write the contents of the text area to the designated notepad file. To
115			save the text to another file name, use the <guilabel>Copy notepad to
116			buffer</guilabel> operation.
117		</para>
118	</listitem>
119	<listitem>
120		<para>
121			<guilabel>Copy notepad to buffer</guilabel> - this button causes the
122			contents of the text to be written to a newly created,
123			untitled buffer in the main text editing area.  This operation
124			does not alter the QuickNotepad text area or write its text to
125			storage.  Further changes to either the QuickNotepad text area or
126			the new buffer will not affect the other.
127		</para>
128	</listitem>
129</itemizedlist>
130
131<para>
132	These operations are listed in the menu which appears for
133	QuickNotepad under the <guimenu>Plugins</guimenu> heading.  They can
134	also be made the subject of keyboard shortcuts in the
135	<guilabel>Plugin Shortcuts</guilabel> pane of jEdit's options dialog.
136</para>
137
138<para>
139	One other operation is available as a keyboard shortcut. <guilabel>Bring
140	QuickNotepad to front</guilabel> activates the plugin and makes visible
141	if it is currently hidden in a docking window.
142</para>
143
144</simplesect>
145
146<simplesect id="options"><title>Options</title>
147<indexterm>
148  <primary>QuickNotepad</primary>
149  <secondary>options</secondary>
150</indexterm>
151
152<para>
153	There are three options which can be set
154	using the pane for QuickNotepad in the <guilabel>Plugin
155	Shortcuts</guilabel> section of the general options dialog:
156</para>
157<itemizedlist>
158	<listitem>
159		<para>
160			A checkbox governs whether the name of the notepad file will be
161			displayed in the toolbar panel above the text area. Even if the file
162			name display is enabled, if the plugin is displayed to the left or right
163			of the main editing area, the notepad file name will likely be partially
164			or completely hidden.
165		</para>
166	</listitem>
167	<listitem>
168		<para>
169			A text field and adjacent button allow the user to choose the path of
170			the default notepad file by typing its name or opening a file chooser
171			dialog. This file will be loaded (and the old file saved) once the
172			plugin's options settings are committed.
173		</para>
174	</listitem>
175	<listitem>
176		<para>
177			A third button shows the name, size and style of the font used by the
178			QuickNotepad text area.  Pressing the button summons a font chooser
179			dialog for making a new selection.  The text area will be
180			redrawn with the new font once the change is committed.
181		</para>
182	</listitem>
183</itemizedlist>
184
185</simplesect>
186
187<simplesect><title>Legal notices</title>
188
189<para>
190	The toolbar button icons are taken from the Sun Java Look and Feel
191	icon collection. The license for these items may be found
192	in the <filename>ICONS.LICENSE.txt</filename> file in the jEdit
193	distribution.
194</para>
195
196<para>
197	The QuickNotepad plugin is released under the GNU General Public License
198	(either version 2 or any later version, at the user's option). A copy
199	of the GPL is available in the <filename>COPYING.txt</filename> file
200	in the jEdit distribution.
201</para>
202
203<para>
204	The QuickNotepad plugin comes with ABSOLUTELY NO WARRANTY OF ANY KIND;
205	see section 11 and 12 of the GPL for details.
206</para>
207
208<para>
209	Permission is granted to copy, distribute and/or modify this document
210	under the terms of the GNU Free Documentation License, Version 1.1 or
211	any later version published by the Free Software Foundation; with no
212	<quote>Invariant Sections</quote>, <quote>Front-Cover Texts</quote> or
213	<quote>Back-Cover Texts</quote>, each as defined in the license. A copy
214	of the license is included in the file
215	<filename>COPYING.DOC.txt</filename> included with the jEdit distribution.
216</para>
217
218</simplesect>
219
220<simplesect><title>Feedback</title>
221
222<para>
223	Comments, bug reports and other feedback may be sent to the
224	<ulink url="mailto:jgellene@nyc.rr.com">author</ulink> or the
225	jEdit-users mailing list.
226</para>
227
228</simplesect>
229