Diff of /users-guide.xml [000000] .. [09549c] Maximize Restore

  Switch to side-by-side view

--- a
+++ b/users-guide.xml
@@ -0,0 +1,193 @@
+<?xml version="1.0"?>
+
+<!-- BufferTabs plugin user's guide -->
+<!-- (C) 2001 Andre Kaplan -->
+
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+  "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+
+<book>
+
+
+<bookinfo>
+    <title>BufferSelector plugin</title>
+
+    <authorgroup>
+        <author>
+            <firstname>Andr&eacute;</firstname>
+            <surname>Kaplan</surname>
+        </author>
+    </authorgroup>
+
+    <legalnotice>
+        <title>Legal Notice</title>
+
+        <para>
+        Permission is granted to copy, distribute and/or modify this
+        document under the terms of the GNU Free Documentation License,
+        Version 1.1 or any later version published by the
+        Free Software Foundation; with no
+        <quote>Invariant Sections</quote>,
+        <quote>Front-Cover Texts</quote> or
+        <quote>Back-Cover Texts</quote>,
+        each as defined in the license.
+        A copy of the license can be found in the file
+        <filename>COPYING.DOC.txt</filename> included with jEdit.
+        </para>
+    </legalnotice>
+</bookinfo>
+
+
+<chapter id="presentation">
+    <title>Presentation</title>
+
+    <para>
+    The Buffer Selector plugin provides a set of buttons at the bottom of a
+    jEdit view that allow you to change the current buffer.
+    </para>
+
+    <para>
+    Each button's appearance depends on the state of its buffer.
+    </para>
+
+    <itemizedlist>
+        <listitem>
+            A saved buffer appears with this
+            <imagedata fileref="normal.gif" format="gif"/> icon
+        </listitem>
+
+        <listitem>
+            A modified buffer appears with this
+            <imagedata fileref="dirty.gif" format="gif"/> icon
+        </listitem>
+
+        <listitem>
+            A new buffer appears with this
+            <imagedata fileref="new.gif" format="gif"/> icon
+        </listitem>
+
+        <listitem>
+            A read-only buffer appears with this
+            <imagedata fileref="readonly.gif" format="gif"/> icon
+            and in a grey font
+        </listitem>
+
+        <listitem>
+            The current buffer appears with a bold font
+        </listitem>
+    </itemizedlist>
+
+    <para>
+    The main concern of Buffer Selector is to
+    <emphasis>save screen real-estate</emphasis>, so that it should be
+    possible to work with split panes or a large number of buffers and
+    still conveniently switch between them.
+    </para>
+
+    <orderedlist>
+        <listitem>
+            Buffer Selector acts on the active text area, so there's only
+            one Buffer Selector per view even if the view is split into
+            several edit panes.
+        </listitem>
+
+        <listitem>
+            It is possible to control the miminum/maximum width and font
+            size of the Buffer Selector buttons.
+            The trade-off is that the longest buffer names might be
+            truncated.
+        </listitem>
+    </orderedlist>
+
+</chapter>
+
+
+<chapter id="customization">
+    <title>Customization</title>
+
+    <para>
+    It is possible to have some control over the display of Buffer Selector:
+    </para>
+
+    <itemizedlist>
+        <listitem>Buffer Selector can be enabled by default</listitem>
+
+        <listitem>
+            Buffer Selector can be at the top or at the bottom of the view
+        </listitem>
+
+        <listitem>
+            It is possible to specify the minimum and maximum widths
+            (in pixels, 100 and 150 by default) of the selector buttons.
+
+            If a buffer name is too long it will be truncated, so choose
+            a range of values for which an acceptable number of buffer
+            names will be truncated.
+        </listitem>
+
+        <listitem>
+            It is possible to choose the font size (10pt by default)
+            of the selector buttons.
+        </listitem>
+    </itemizedlist>
+
+</chapter>
+
+
+<chapter id="license">
+    <title>License</title>
+
+    <para>
+    The source code is distributed under the GPL.
+    Please see
+    <ulink url="http://www.fsf.org/copyleft/gpl.html">
+        http://www.fsf.org/copyleft/gpl.html
+    </ulink>
+    </para>
+</chapter>
+
+
+<chapter id="feedback">
+    <title>Feedback</title>
+
+    <para>
+    Bug reports should be sent using the Sourceforge Bug Tracker at
+    <ulink url="http://sourceforge.net/bugs/?group_id=588">
+        http://sourceforge.net/bugs/?group_id=588
+    </ulink>
+    </para>
+
+    <para>
+    Feature requests should be sent to the users mailing list
+    <email>users@jedit.org</email>.
+    </para>
+
+    <para>
+    Patches should be sent to the developers mailing list
+    <email>devel@jedit.org</email>.
+    </para>
+
+    <para>
+    In other cases you may contact the author Andr&eacute; Kaplan
+    <email>akaplan@jedit.org</email>.
+    </para>
+</chapter>
+
+
+<chapter id="credits">
+    <title>Credits</title>
+
+    <itemizedlist>
+        <listitem>
+            BufferSelector was originally developed by Chris Laird
+        </listitem>
+
+        <listitem>
+            It was maintained for some time by Slava Pestov
+            <email>slava@jedit.org</email>
+        </listitem>
+    </itemizedlist>
+</chapter>
+
+
+</book>