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