Menu
▾
▴
[ jEdit-commits ] SF.net SVN: jedit:[21636] jEdit/trunk/doc/users-guide
|
From: <jar...@us...> - 2012-05-06 07:39:44
|
Revision: 21636
http://jedit.svn.sourceforge.net/jedit/?rev=21636&view=rev
Author: jarekczek
Date: 2012-05-06 07:39:38 +0000 (Sun, 06 May 2012)
Log Message:
-----------
Added extensive documentation on electric keys. Please correct language
errors directly or send me a note.
Modified Paths:
--------------
jEdit/trunk/doc/users-guide/customizing.xml
jEdit/trunk/doc/users-guide/source-edit.xml
jEdit/trunk/doc/users-guide/writing-modes.xml
Modified: jEdit/trunk/doc/users-guide/customizing.xml
===================================================================
--- jEdit/trunk/doc/users-guide/customizing.xml 2012-05-06 06:30:23 UTC (rev 21635)
+++ jEdit/trunk/doc/users-guide/customizing.xml 2012-05-06 07:39:38 UTC (rev 21636)
@@ -330,12 +330,37 @@
<para> The <literal>Deep Indent</literal> option instructs jEdit to indent subsequent lines so that they line up with the open bracket on the previous line. </para>
- <para><literal>Electric keys</literal> may be used in different
- operating modes. Most of them are self-explanatory.
- <literal>smart</literal> mode means that electric keys will
+ <para><literal>Electric keys</literal>
+ (see <xref linkend="electric-keys" />)
+ may be used in different operating modes:
+ <itemizedlist>
+ <listitem><literal>on</literal>:
+ Default mode of jEdit 4. Electric keys are active without
+ limitations.
+ </listitem>
+ <listitem><literal>smart</literal>:
+ Electric keys will
work only if the current line matches one of the
- rules affecting the current line. The rules are defined
- in mode files.</para>
+ rules affecting the current line, for example
+ <literal>unindentThisLine</literal> rule.
+ </listitem>
+ <listitem><literal>brackets only</literal>:
+ Only brackets are considered electric keys. This setting
+ may be used if more electric keys are defined, but
+ one wants to switch them off, leaving only brackets
+ as electric keys. Indenting brackets are implicit
+ electric keys.
+ </listitem>
+ <listitem><literal>off</literal>:
+ Electric keys are inactive. One needs to achieve
+ the correct indentation using <guimenu>Indent</guimenu>
+ command, preferrably assigned to a keyboard shortcut.
+ Another handy feature in this mode is macro indenting
+ both lines (not included), that could be assigned to the
+ <keycap>ENTER</keycap> key.
+ </listitem>
+ </itemizedlist>
+ </para>
</section>
Modified: jEdit/trunk/doc/users-guide/source-edit.xml
===================================================================
--- jEdit/trunk/doc/users-guide/source-edit.xml 2012-05-06 06:30:23 UTC (rev 21635)
+++ jEdit/trunk/doc/users-guide/source-edit.xml 2012-05-06 07:39:38 UTC (rev 21636)
@@ -262,6 +262,43 @@
Lines</guisubmenu> (shortcut: <keycap>C+i</keycap>) indents all
selected lines, or the current line if there is no selection, as
if in the <quote>full</quote> scheme.</para>
+
+ <section id="electric-keys">
+ <title>Electric keys</title>
+
+ Electric keys cause reapplying of the indentation rules to
+ the current line. Thanks to the electric keys the following
+ code fragments are indented properly on-line:
+ <itemizedlist>
+ <listitem>
+ Java, C: brackets. If indenting brackets are defined for
+ the language, they are implicitly considered electric keys.
+ Thus a closing bracket is placed in its correct position
+ immediately after being typed.
+ </listitem>
+ <listitem>
+ Java, C: labels. Labels end with a colon and the colon is
+ included in electric keys for these languages. With
+ pressing the colon, the line is reindented and the labels
+ are indented a level to the left.
+ </listitem>
+ <listitem>
+ Basic: <literal>endif</literal>. Here <keycap>f</keycap>
+ letter is an electric key, that makes the line indented
+ to the left.
+ </listitem>
+ </itemizedlist>
+ Despite all the benefits of the electric keys feature,
+ they cause a lot of problems when the indentation is done
+ manually in an unusual way. It happens frequently with
+ long lines. When an electric key is pressed, the indentation
+ gets back to the state which the editor finds best.
+ In such cases it can be reverted with <guimenu>Undo</guimenu>
+ command. To counteract negative effects of the electric keys,
+ their activity may be limited through
+ <guimenu>Editing Options</guimenu>
+ (see <xref linkend="editing-pane" />).
+ </section>
</section>
<section id="autoindent-simple">
Modified: jEdit/trunk/doc/users-guide/writing-modes.xml
===================================================================
--- jEdit/trunk/doc/users-guide/writing-modes.xml 2012-05-06 06:30:23 UTC (rev 21635)
+++ jEdit/trunk/doc/users-guide/writing-modes.xml 2012-05-06 07:39:38 UTC (rev 21636)
@@ -194,7 +194,8 @@
the new line. To get this behavior, add the newline character to
<literal>electricKeys</literal> in the xml-escaped form &#xA;
</para>
- <para>Electric keys may be turned <literal>on</literal> or
+ <para>Electric keys (see <xref linkend="electric-keys" />)
+ may be turned <literal>on</literal> or
<literal>off</literal> or put into other mode through
<guimenu>Editing Options</guimenu>
(see <xref linkend="editing-pane" />)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|