1.1 --- a/src/Tools/isac/jEditC/contrib/jEdit/jars/Isac/plugin/users-guide.xml Tue Aug 31 21:03:11 2010 +0200
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,277 +0,0 @@
1.4 -<?xml version="1.0" encoding="UTF-8"?>
1.5 -<!-- Isac .0 help documentation -->
1.6 -<!-- Copyright (C) 2001 John Gellene -->
1.7 -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
1.8 -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
1.9 -<article id="Isac">
1.10 - <articleinfo>
1.11 - <author>
1.12 - <firstname>John</firstname>
1.13 -
1.14 - <surname>Gellene</surname>
1.15 -
1.16 - <affiliation>
1.17 - <address><email>jgellene@nyc.rr.com</email></address>
1.18 - </affiliation>
1.19 - </author>
1.20 -
1.21 - <copyright>
1.22 - <year>2001</year>
1.23 -
1.24 - <holder>John Gellene</holder>
1.25 - </copyright>
1.26 -
1.27 - <legalnotice>
1.28 - <title>Legal Notice</title>
1.29 -
1.30 - <para>Permission is granted to copy, distribute and/or modify this
1.31 - document under the terms of the GNU Free Documentation License,
1.32 - Version 1.1 or any later version published by the Free Software
1.33 - Foundation; with no <quote>Invariant Sections</quote>,
1.34 - <quote>Front-Cover Texts</quote> or <quote>Back-Cover Texts</quote>,
1.35 - each as defined in the license. A copy of the license is included in
1.36 - the file <filename>COPYING.DOC.txt</filename> included with the
1.37 - jEdit distribution.</para>
1.38 - </legalnotice>
1.39 -
1.40 - <title>QuickNotepad 4.2</title>
1.41 - </articleinfo>
1.42 -
1.43 - <simplesect>
1.44 - <title>Introduction</title>
1.45 -
1.46 - <indexterm>
1.47 - <primary>QuickNotepad</primary>
1.48 - </indexterm>
1.49 -
1.50 - <para>This plugin provides a dockable <quote>scratch pad</quote> for
1.51 - writing and displaying notes, to do lists or similar items as
1.52 - unformatted text. The text is automatically saved upon closing the
1.53 - plugin or exiting jEdit. It can also be saved manually. The user can
1.54 - change the file to be displayed during the current editing session. The
1.55 - path of the default notepad file can be changed as a user option.
1.56 - Finally, the text file can be copied to a new, untitled jEdit buffer so
1.57 - that it can be edited by the main program.</para>
1.58 -
1.59 - <para>The <citetitle>jEdit Plugin Guide</citetitle> details the
1.60 - development and design of QuickNotepad. It is a simple but functional
1.61 - dockable plugin that incorporates the basic elements of the jEdit plugin
1.62 - architecture.</para>
1.63 -
1.64 - <para>The file <filename>changes42.txt</filename> in the plugin's source
1.65 - code details the changes that were made to the plugin to conform to the
1.66 - new plugin API for jEdit version 4.2.</para>
1.67 -
1.68 - <para>The file <filename>changes40.txt</filename> in the plugin's source
1.69 - code details the changes that were made to the plugin to conform to the
1.70 - new plugin API for jEdit version 4.0.</para>
1.71 - </simplesect>
1.72 -
1.73 - <simplesect>
1.74 - <title>Operation</title>
1.75 -
1.76 - <para><indexterm>
1.77 - <primary>QuickNotepad</primary>
1.78 -
1.79 - <secondary>shortcut keys</secondary>
1.80 - </indexterm> When QuickNotepad is activated, it loads and displays
1.81 - the file stored in its properties as unformatted text. The text can be
1.82 - edited using the keyboard and mouse. The text area component recognizes
1.83 - the following basic editing shortcuts:</para>
1.84 -
1.85 - <!-- Limitations on xsltproc's capabilities require a blank column between -->
1.86 -
1.87 - <!-- the two columns of data to provide spacing for the table. -->
1.88 -
1.89 - <informaltable frame="none">
1.90 - <tgroup align="left" cols="4">
1.91 - <colspec colnum="1" />
1.92 -
1.93 - <!-- blank column -->
1.94 -
1.95 - <colspec colnum="2" />
1.96 -
1.97 - <colspec colnum="3" />
1.98 -
1.99 - <!-- blank column -->
1.100 -
1.101 - <colspec colnum="4" />
1.102 -
1.103 - <tbody>
1.104 - <row>
1.105 - <entry></entry>
1.106 -
1.107 - <entry>Cut</entry>
1.108 -
1.109 - <entry></entry>
1.110 -
1.111 - <entry><keycombo action="simul">
1.112 - <keysym>Ctrl</keysym>
1.113 -
1.114 - <keysym>x</keysym>
1.115 - </keycombo></entry>
1.116 - </row>
1.117 -
1.118 - <row>
1.119 - <entry></entry>
1.120 -
1.121 - <entry>Copy</entry>
1.122 -
1.123 - <entry></entry>
1.124 -
1.125 - <entry><keycombo action="simul">
1.126 - <keysym>Ctrl</keysym>
1.127 -
1.128 - <keysym>c</keysym>
1.129 - </keycombo></entry>
1.130 - </row>
1.131 -
1.132 - <row>
1.133 - <entry></entry>
1.134 -
1.135 - <entry>Paste</entry>
1.136 -
1.137 - <entry></entry>
1.138 -
1.139 - <entry><keycombo action="simul">
1.140 - <keysym>Ctrl</keysym>
1.141 -
1.142 - <keysym>v</keysym>
1.143 - </keycombo></entry>
1.144 - </row>
1.145 -
1.146 - <row>
1.147 - <entry></entry>
1.148 -
1.149 - <entry>Select All</entry>
1.150 -
1.151 - <entry></entry>
1.152 -
1.153 - <entry><keycombo action="simul">
1.154 - <keysym>Ctrl</keysym>
1.155 -
1.156 - <keysym>a</keysym>
1.157 - </keycombo></entry>
1.158 - </row>
1.159 - </tbody>
1.160 - </tgroup>
1.161 - </informaltable>
1.162 -
1.163 - <para>QuickNotepad ignores function keys and other combination key
1.164 - presses.</para>
1.165 - </simplesect>
1.166 -
1.167 - <simplesect>
1.168 - <title>Toolbar buttons</title>
1.169 -
1.170 - <para>Three buttons above the text area provide file management
1.171 - operations:</para>
1.172 -
1.173 - <itemizedlist>
1.174 - <listitem>
1.175 - <para><guilabel>Choose notepad file</guilabel> - this button
1.176 - opens a file selection dialog permitting the user to select a
1.177 - different file to view in the text area. If a new file is
1.178 - selected, the old file is auomatically saved. The selection is
1.179 - valid only for the current editing session; to change the
1.180 - default QuickNotepad file for future sessions, use the <link
1.181 - linkend="options">options dialog</link>.</para>
1.182 - </listitem>
1.183 -
1.184 - <listitem>
1.185 - <para><guilabel>Save notepad file</guilabel> - this button
1.186 - causes QuickNotepad to write the contents of the text area to
1.187 - the designated notepad file. To save the text to another file
1.188 - name, use the <guilabel>Copy notepad to buffer</guilabel>
1.189 - operation.</para>
1.190 - </listitem>
1.191 -
1.192 - <listitem>
1.193 - <para><guilabel>Copy notepad to buffer</guilabel> - this button
1.194 - causes the contents of the text to be written to a newly
1.195 - created, untitled buffer in the main text editing area. This
1.196 - operation does not alter the QuickNotepad text area or write its
1.197 - text to storage. Further changes to either the QuickNotepad text
1.198 - area or the new buffer will not affect the other.</para>
1.199 - </listitem>
1.200 - </itemizedlist>
1.201 -
1.202 - <para>These operations are listed in the menu which appears for
1.203 - QuickNotepad under the <guimenu>Plugins</guimenu> heading. They can also
1.204 - be made the subject of keyboard shortcuts in the <guilabel>Plugin
1.205 - Shortcuts</guilabel> pane of jEdit's options dialog.</para>
1.206 -
1.207 - <para>One other operation is available as a keyboard shortcut.
1.208 - <guilabel>Bring QuickNotepad to front</guilabel> activates the plugin
1.209 - and makes visible if it is currently hidden in a docking window.</para>
1.210 - </simplesect>
1.211 -
1.212 - <simplesect id="options">
1.213 - <title>Options</title>
1.214 -
1.215 - <indexterm>
1.216 - <primary>QuickNotepad</primary>
1.217 -
1.218 - <secondary>options</secondary>
1.219 - </indexterm>
1.220 -
1.221 - <para>There are three options which can be set using the pane for
1.222 - QuickNotepad in the <guilabel>Plugin Shortcuts</guilabel> section of the
1.223 - general options dialog:</para>
1.224 -
1.225 - <itemizedlist>
1.226 - <listitem>
1.227 - <para>A checkbox governs whether the name of the notepad file
1.228 - will be displayed in the toolbar panel above the text area. Even
1.229 - if the file name display is enabled, if the plugin is displayed
1.230 - to the left or right of the main editing area, the notepad file
1.231 - name will likely be partially or completely hidden.</para>
1.232 - </listitem>
1.233 -
1.234 - <listitem>
1.235 - <para>A text field and adjacent button allow the user to choose
1.236 - the path of the default notepad file by typing its name or
1.237 - opening a file chooser dialog. This file will be loaded (and the
1.238 - old file saved) once the plugin's options settings are
1.239 - committed.</para>
1.240 - </listitem>
1.241 -
1.242 - <listitem>
1.243 - <para>A third button shows the name, size and style of the font
1.244 - used by the QuickNotepad text area. Pressing the button summons
1.245 - a font chooser dialog for making a new selection. The text area
1.246 - will be redrawn with the new font once the change is
1.247 - committed.</para>
1.248 - </listitem>
1.249 - </itemizedlist>
1.250 - </simplesect>
1.251 -
1.252 - <simplesect>
1.253 - <title>Legal notices</title>
1.254 -
1.255 - <para>The QuickNotepad plugin is released under the GNU General Public
1.256 - License (either version 2 or any later version, at the user's option). A
1.257 - copy of the GPL is available in the <filename>COPYING.txt</filename>
1.258 - file in the jEdit distribution.</para>
1.259 -
1.260 - <para>The QuickNotepad plugin comes with ABSOLUTELY NO WARRANTY OF ANY
1.261 - KIND; see section 11 and 12 of the GPL for details.</para>
1.262 -
1.263 - <para>Permission is granted to copy, distribute and/or modify this
1.264 - document under the terms of the GNU Free Documentation License, Version
1.265 - 1.1 or any later version published by the Free Software Foundation; with
1.266 - no <quote>Invariant Sections</quote>, <quote>Front-Cover Texts</quote>
1.267 - or <quote>Back-Cover Texts</quote>, each as defined in the license. A
1.268 - copy of the license is included in the file
1.269 - <filename>COPYING.DOC.txt</filename> included with the jEdit
1.270 - distribution.</para>
1.271 - </simplesect>
1.272 -
1.273 - <simplesect>
1.274 - <title>Feedback</title>
1.275 -
1.276 - <para>Comments, bug reports and other feedback may be sent to the <ulink
1.277 - url="mailto:jgellene@nyc.rr.com">author</ulink> or the jEdit-users
1.278 - mailing list.</para>
1.279 - </simplesect>
1.280 -</article>
1.281 \ No newline at end of file