[prev in list] [next in list] [prev in thread] [next in thread]
List: jedit-cvs
Subject: [ jEdit-commits ] SF.net SVN: jedit:[23102] jEdit/trunk/doc/users-guide
From: ezust () users ! sourceforge ! net
Date: 2013-07-31 20:13:53
Message-ID: E1V4cmP-0008FP-G6 () sfp-svn-4 ! v30 ! ch3 ! sourceforge ! com
[Download RAW message or body]
Revision: 23102
http://jedit.svn.sourceforge.net/jedit/?rev=23102&view=rev
Author: ezust
Date: 2013-07-31 20:13:45 +0000 (Wed, 31 Jul 2013)
Log Message:
-----------
docs.
Modified Paths:
--------------
jEdit/trunk/doc/users-guide/plugin-implement.xml
jEdit/trunk/doc/users-guide/starting.xml
jEdit/trunk/doc/users-guide/users-guide.xml
Modified: jEdit/trunk/doc/users-guide/plugin-implement.xml
===================================================================
--- jEdit/trunk/doc/users-guide/plugin-implement.xml 2013-07-30 21:20:11 UTC (rev \
23101)
+++ jEdit/trunk/doc/users-guide/plugin-implement.xml 2013-07-31 20:13:45 UTC (rev \
23102) @@ -4,9 +4,9 @@
<!-- :xml.root=users-guide.xml: -->
<!-- :maxLineLen=80:wrap=soft: -->
<title>Implementing a Simple Plugin</title>
- <!-- jEdit 4 Plugin Guide, (C) 2001, 2002 John Gellene -->
- <!-- jEdit 4.5 Plugin Guide, (C) 2005, 2011 Alan Ezust -->
+ <!-- jEdit Plugin Guide, (C) 2001-2013 John Gellene, Alan Ezust -->
+
<para>There are many applications for the leading operating systems that
provide a <quote>scratch-pad</quote> or <quote>sticky note</quote> facility
for the desktop display. A similar type of facility operating within the
@@ -315,7 +315,7 @@
</section>
<section id="plugin-implement-properties">
- <title>The Property File</title>
+ <title>The Property Files</title>
<para>jEdit maintains a list of <quote>properties</quote>, which are
name/value pairs used to store human-readable strings, user settings,
@@ -453,8 +453,17 @@
of property files.</para>
</tip>
+
+ <section id="localizationfiles">
+ <title> Localization Files </title>
+
+ <para> In addition to property files ending in <literal>.props</literal>,
+ you will find property files with the names like \
<literal>lang_de.properties</literal>. Each of these files provides + localized \
strings for a particular locale. In the example above, it is for the German locale. \
These files are loaded by jEdit automatically when that locale is in use. They need \
to have a different filename extension from the other property files so they can be \
treated differently from + the regular properties. </para>
+ </section>
+
</section>
-
<section id="plugin-implement-editbus">
<title>The EditBus</title>
@@ -542,9 +551,9 @@
</section>
<section id="plugin-implement-actions">
- <title>The Actions Catalog</title>
+ <title>The Actions.xml Catalog</title>
- <para>Actions define procedures that can be bound to a menu item, a
+ <para>In jEdit as well as in Plugins, actions define procedures that can be \
bound to a menu item, a
toolbar button or a keyboard shortcut. Most plugin Actions <footnote>
<para>Some plugins, such as Sidekick, Console, and
ProjectViewer, create pure Java EditAction-derived Actions,
@@ -591,6 +600,11 @@
</ACTIONS></programlisting>
</informalexample>
+ <tip> <title> Actions in jEdit core </title>
+ <para> You can see how each action in jEdit core is implemented by
+ inspecting the <literal>actions.xml</literal> file that is there. </para>
+ </tip>
+
<para>This file defines three actions. They each use a built-in variable
<literal>wm</literal>, which refers to the current view's <ulink
url="../api/org/gjt/sp/jedit/gui/DockableWindowManager.html">
@@ -636,7 +650,7 @@
and on small buttons) and a title (for display in the floating window's
title bar).</para>
- <para>The jEdit plugin API uses BeanShell to create the top-level
+ <para>The jEdit API uses BeanShell to create the top-level
visible container of a plugin's interface. The BeanShell code is
contained in a file named <filename>dockables.xml</filename>. It usually
is quite short, providing only a single BeanShell expression used to
@@ -684,6 +698,12 @@
also contains the public interface you should use for getting, showing,
hiding, and other interactions with the plugin's top-level
windows.</para>
+
+
+ <tip> <title> jEdit's dockables </title> <para> jEdit has its own
+ <literal>dockables.xml</literal> file that you can inspect to see how
+ jEdit creates its own dockables. </para> </tip>
+
</section>
<section id="plugin-implement-services">
@@ -696,11 +716,11 @@
defined in the XML plugin. In a way, the dependency is
bidirectional.</para>
- <para>Similarly, the AntFarm plugin defines but does not instantiate a
- <literal>Shell</literal> object. It is the Console plugin which creates
- a specific shell for each available service. SideKick and Console use
- the ServiceManager to search for services offered by other
- plugins.</para>
+ <para>Similarly, the SshConsole plugin defines but does not instantiate
+ a <literal>Shell</literal> object. It is the Console plugin which
+ creates a specific shell for each available service. SideKick and
+ Console use the <literal>ServiceManager</literal> to search for services
+ offered by other plugins.</para>
<para>Here is an example of a service from the XML plugin, which extends
Sidekick:</para>
@@ -733,7 +753,10 @@
<para>For more information about services, refer to the <ulink
url="../api/org/gjt/sp/jedit/ServiceManager.html">ServiceManager</ulink>
class API documentation. There, you can find out what the tags and
- attributes mean, as well as how to register and use services.</para>
+ attributes mean, as well as how to register and use services.
+ You can also inspect the <literal>services.xml</literal> file of jEdit
+ core to see what services are offered by jEdit itself. </para>
+
</section>
<section id="plugin-implement-quicknotepad">
Modified: jEdit/trunk/doc/users-guide/starting.xml
===================================================================
--- jEdit/trunk/doc/users-guide/starting.xml 2013-07-30 21:20:11 UTC (rev 23101)
+++ jEdit/trunk/doc/users-guide/starting.xml 2013-07-31 20:13:45 UTC (rev 23102)
@@ -426,7 +426,7 @@
<entry>Antialias the text in Swing components. </entry>
</row>
<row>
- <entry><userinput>"-Djedit.home=/path/to/jedit" </userinput>
+ <entry><userinput>-Djedit.home=/path/to/jedit</userinput>
</entry>
<entry> Sets/overrides the java System property
<literal>jedit.home</literal> to be the path to the jEdit
Modified: jEdit/trunk/doc/users-guide/users-guide.xml
===================================================================
--- jEdit/trunk/doc/users-guide/users-guide.xml 2013-07-30 21:20:11 UTC (rev 23101)
+++ jEdit/trunk/doc/users-guide/users-guide.xml 2013-07-31 20:13:45 UTC (rev 23102)
@@ -129,7 +129,11 @@
<para>Like jEdit itself, plugins are written primarily in Java.
While this guide assumes some working knowledge of the language, you
are not required to be a Java wizard. If you can write a useful
- application of any size in Java, you can write a plugin.</para>
+ application of any size in Java, you can write a plugin. </para>
+
+ <para>Where applicable, this section will also explain how jEdit's
+ source code is similar. Therefore, this is also a good introduction to
+ to jEdit development. </para>
</partintro>
This was sent by the SourceForge.net collaborative development platform, the world's \
largest Open Source development site.
------------------------------------------------------------------------------
Get your SQL database under version control now!
Version control is standard for application code, but databases havent
caught up. So what steps can you take to put your SQL databases under
version control? Why should you start doing it? Read more to find out.
http://pubads.g.doubleclick.net/gampad/clk?id=49501711&iu=/4140/ostg.clktrk
_______________________________________________
jEdit-CVS mailing list
jEdit-CVS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/jedit-cvs
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic