[kde-doc-english] [kate] doc/kate: document the scrollbar minimap

[T.C. Hollingsworth]

Git commit 02dfbb3a18026771ae523de71dba200f4eeff029 by T.C. Hollingsworth.
Committed on 05/02/2013 at 12:54.
Pushed by hollingsworth into branch 'master'.

document the scrollbar minimap

M  +3    -1    doc/kate/configuring-part.docbook
M  +2    -2    doc/kate/menus.docbook
A  +-    --    doc/kate/minimap.png
M  +22   -0    doc/kate/part.docbook

http://commits.kde.org/kate/02dfbb3a18026771ae523de71dba200f4eeff029

diff --git a/doc/kate/configuring-part.docbook b/doc/kate/configuring-part.docbook
index a53bfaf..5e34227 100644
--- a/doc/kate/configuring-part.docbook
+++ b/doc/kate/configuring-part.docbook
@@ -128,7 +128,9 @@ for instance show bookmarks.</para></listitem>
 <term><guilabel>Show scrollbar mini-map</guilabel></term>
 <listitem><para>If this option is checked, every new view will show a mini map of the 
 <!--FIXME remove when next option is enabled-->whole<!--FIXME--> 
-document on the vertical scrollbar.</para></listitem>
+document on the vertical scrollbar.</para>
+<para>For more information on the scrollbar minimap, see
+<xref linkend="kate-part-scrollbar-minimap"/></para></listitem>
 </varlistentry>
 <varlistentry>
 <term><guilabel>Minimap Width</guilabel></term>
diff --git a/doc/kate/menus.docbook b/doc/kate/menus.docbook
index dba41ed..f2a0346 100644
--- a/doc/kate/menus.docbook
+++ b/doc/kate/menus.docbook
@@ -957,8 +957,8 @@ to a position near the mark.</para></listitem>
 <term><menuchoice><guimenu>View</guimenu><guimenuitem>Show Scrollbar
 Minimap</guimenuitem></menuchoice></term>
 <listitem><para>This will replace the scrollbar with a visualization of the
-current document. <!--FIXME: describe this functionality in detail in on of the
-other sections and link to it here--></para></listitem>
+current document. For more information on the scrollbar minimap, see
+<xref linkend="kate-part-scrollbar-minimap"/></para></listitem>
 </varlistentry>
 
 <varlistentry>
diff --git a/doc/kate/minimap.png b/doc/kate/minimap.png
new file mode 100644
index 0000000..1d3974b
Binary files /dev/null and b/doc/kate/minimap.png differ
diff --git a/doc/kate/part.docbook b/doc/kate/part.docbook
index 6015284..c2280ae 100644
--- a/doc/kate/part.docbook
+++ b/doc/kate/part.docbook
@@ -621,4 +621,26 @@ panel</link>, or you can disable this feature completely in the
 
 </sect1>
 
+<sect1 id="kate-part-scrollbar-minimap">
+<title>The Scrollbar Minimap</title>
+
+<para>&kappname;'s Scrollbar Minimap displays a preview of documents in place of
+the scrollbar.  The currently visible portion of the document is highlighted.
+</para>
+
+<para>
+<mediaobject>
+<imageobject><imagedata format="PNG" fileref="&imgpath;minimap.png"/></imageobject>
+<caption><para>The Scrollbar Minimap shows a preview of the &kate; source code.
+</para></caption>
+</mediaobject>
+</para>
+
+<para>You can temporarily enable or disable the minimap by selecting
+<menuchoice><guimenu>View</guimenu><guimenuitem>View Scrollbar Minimap</guimenuitem></menuchoice>
+or permanently in <link linkend="appearance-borders">the Appearance section of
+&kappname;'s configuration</link>.</para>
+
+</sect1>
+
 </chapter>