[kphotoalbum/feature/remove-kipi] doc: Remove plugin system from handbook.

Johannes Zarl-Zierl null at kde.org
Mon May 4 00:36:21 BST 2020


Git commit b0f3f70194dc1eef0354d4dfc43871af7b510bb7 by Johannes Zarl-Zierl.
Committed on 03/05/2020 at 23:32.
Pushed by johanneszarl into branch 'feature/remove-kipi'.

Remove plugin system from handbook.

Note: the handbook is very seriously out of date anyways. At this point
it would probably be best to remove it and maybe start from scratch.

M  +3    -4    doc/generating-html.docbook
M  +0    -2    doc/index.docbook
M  +2    -3    doc/options.docbook
D  +0    -68   doc/plugins.docbook

https://commits.kde.org/kphotoalbum/b0f3f70194dc1eef0354d4dfc43871af7b510bb7

diff --git a/doc/generating-html.docbook b/doc/generating-html.docbook
index 4b257cc1..56838d53 100644
--- a/doc/generating-html.docbook
+++ b/doc/generating-html.docbook
@@ -1,9 +1,8 @@
   <chapter id="chp-generating-html">
     <title>Generating &HTML;</title>
-    <para>&kphotoalbum; offers two possibilities for generating &HTML; from your
-      photo album. One is the implementation build into &kphotoalbum;, the other is
-      available as an plugin (see <xref linkend="chp-plugins"/>). This section
-      will describe the build in version, which you may find in the menubar
+    <para>&kphotoalbum; offers the possibility for generating &HTML; from your
+      photo album.
+      You may find this in the menubar
       <menuchoice><guimenu>File</guimenu><guimenuitem>Generate 
       &HTML;</guimenuitem></menuchoice></para>
     
diff --git a/doc/index.docbook b/doc/index.docbook
index 523c9cf7..cf354200 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -16,7 +16,6 @@
   <!ENTITY workflows SYSTEM "workflows.docbook">
   <!ENTITY generating-html SYSTEM "generating-html.docbook">
   <!ENTITY importexport SYSTEM "importexport.docbook">
-  <!ENTITY plugins SYSTEM "plugins.docbook">
 ]>
 
 <book id="kphotoalbum" lang="&language;">
@@ -92,7 +91,6 @@ Homepage</ulink>.</para>
   &datebar;
   &generating-html;
   &importexport;
-  &plugins;
   &options;
   &workflows;
 
diff --git a/doc/options.docbook b/doc/options.docbook
index f0832616..2789960e 100644
--- a/doc/options.docbook
+++ b/doc/options.docbook
@@ -102,9 +102,8 @@ example_12.tif, example.PNG.
   <title>Viewer Settings</title>
   <para>Another rather simple configuration. Mainly you can select the
   preferred size of Viewer or SlideShow window or to display them in
-  full screen mode. Basic SlideShow interval can be set here but a more
-  feature rich Advanced SlideShow is available from KIPI plugins. The
-  scaling algorithm can be <emphasis>Best</emphasis> or
+  full screen mode. Basic SlideShow interval can be set here.
+  The scaling algorithm can be <emphasis>Best</emphasis> or
   <emphasis>Fastest</emphasis>. If your
   computer is fast enough for Best scaling use that otherwise go for the
   speed.
diff --git a/doc/plugins.docbook b/doc/plugins.docbook
deleted file mode 100644
index d963f3d6..00000000
--- a/doc/plugins.docbook
+++ /dev/null
@@ -1,68 +0,0 @@
-<chapter id="chp-plugins">
-  <title>Plugins</title>
-  <para>&kphotoalbum; shares a plugin system with a number of other image
-applications, among these <application>digiKam</application> and 
-<application>Gwenview</application>. The plugin system is named
-<application>Kipi</application>, which is short for &kde; Image Plugin
-Interface. See <ulink url="http://extragear.kde.org/apps/kipi/">Kipi Homepage</ulink></para>
-
-<para>The plugins are available from the menu bar, under the item
-<guimenu>Plugins</guimenu>. The plugins will and can not be described in
-this manual, as the plugins are not part of &kphotoalbum;, but shipped
-separately. Most plugins do, however have a help page available from the
-plugin itself.</para>
-
-<warning><para>As the plugins are shared between a
-number of applications, certain plugins might be very little tested with
-&kphotoalbum;, you should therefore always try out new plugins with the demo
-database before you try them on
-your own images<footnote><para>You start &kphotoalbum; with the demo setup either 
-from the shell by executing <userinput><command>kphotoalbum</command> 
-<option>-demo</option></userinput>, or from the <guimenu>Help</guimenu> menu.</para></footnote> 
-(Don't say I didn't warn you!).</para></warning>
-
-<para>The applications using KIPI are very different from each other, this means that some
-plugins are not always working the &kphotoalbum; way, but after all, this is the
-price for sharing the functionality between the applications.</para>
-
-<para>The most important difference between &kphotoalbum; and the other
-applications using KIPI, is that the other applications order the images in
-albums, where an album simply is a directory. &kphotoalbum; do not have this
-concept; nevertheless, for certain plugins to function, &kphotoalbum; behaves
-towards the plugin system as if it did.</para>
-
-<para>&kphotoalbum; does this by defining <emphasis>the current album</emphasis>
-to be the current view - that is, all the images the browser currently offers to display.</para>
-
-<para>In addition to the current album, &kphotoalbum; must also be able to give a list of all albums; 
-&kphotoalbum; defines this list in the following way:</para>
-
-<itemizedlist>
-  <listitem><para>When &kphotoalbum;'s browser displays the content of a
-    category, say people, then each item in this category will look like
-    an album to the plugin.</para></listitem> 
-  <listitem><para>Otherwise, the
-    category you specify for <guilabel>Category for virtual albums</guilabel>
-in the options dialog, will be used; e.g. if you specify
-    People with this option, then &kphotoalbum; will act as if you had just chosen
-    to display people and then invoke the plugin which needs to know about
-    all albums.</para></listitem>
-</itemizedlist>
-
-<para>Some plugins might be redundant to features implemented in &kphotoalbum;,
-and in that case you may not want to see them at all in the Plugin
-menu. For that, you may go to the options dialog, and specify which plugins
-should be shown at all.</para>
-  </chapter>
-
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: xml
-sgml-namecase-general:t
-sgml-general-insert-case:lower
-sgml-always-quote-attributes:t
-sgml-indent-step:2
-sgml-parent-document: "index.docbook"
-End:
--->


More information about the kde-doc-english mailing list