PageRenderTime 132ms CodeModel.GetById 123ms app.highlight 4ms RepoModel.GetById 1ms app.codeStats 0ms

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

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