Initial import of tastymenu 1.0.8

4 files changed, 299 insertions, 0 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..a7255a8
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,6 @@
+# the SUBDIRS is filled automatically by am_edit. If files are 
+# in this directory they are installed into the english dir
+
+KDE_LANG = en
+KDE_DOCS = tastymenu
+SUBDIRS = $(AUTODIRS)  
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am
new file mode 100644
index 0000000..9e59989
--- /dev/null
+++ b/doc/en/Makefile.am
@@ -0,0 +1,3 @@
+KDE_DOCS = tastymenu
+KDE_LANG = en
+kde_docs_KDEDOCS = screenshot.png
diff --git a/doc/en/index.docbook b/doc/en/index.docbook
new file mode 100644
index 0000000..5ff1df7
--- /dev/null
+++ b/doc/en/index.docbook
@@ -0,0 +1,290 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+  <!ENTITY tastymenu "<application>TastyMenu 1.0.6</application>">
+  <!ENTITY kappname "&tastymenu;"><!-- Do *not* replace kappname-->
+  <!ENTITY % addindex "IGNORE">
+  <!ENTITY % English "INCLUDE"><!-- change language only here -->
+  <!ENTITY homepage "http://kde-apps.org/content/show.php?content=41866">
+  
+  <!-- Do not define any other entities; instead, use the entities
+       from kde-genent.entities and $LANG/user.entities. -->
+]>
+<!-- kdoctemplate v0.8 October 1 1999 
+     Minor update to "Credits and Licenses" section on August 24, 2000
+     Removed "Revision history" section on 22 January 2001
+     Changed to Installation/Help menu entities 18 October 2001
+     Other minor cleanup and changes 18 October 2001 -->
+
+
+
+<!-- ................................................................ -->
+
+<!-- The language must NOT be changed here. -->
+
+<book lang="&language;">
+
+<!-- This header contains all of the meta-information for the document such
+as Authors, publish date, the abstract, and Keywords -->
+
+<bookinfo>
+<title>The &tastymenu; Handbook</title>
+
+<authorgroup>
+<author>
+<firstname>Marco</firstname>
+<othername></othername>
+<surname>Martin</surname>
+<affiliation>
+<address><email>notmart@gmail.com</email></address>
+</affiliation>
+</author>
+</authorgroup>
+
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+
+<copyright>
+<year>2006</year>
+<holder>Marco Martin</holder>
+</copyright>
+<!-- Translators: put here the copyright notice of the translation -->
+<!-- Put here the FDL notice.  Read the explanation in fdl-notice.docbook
+     and in the FDL itself on how to use it. -->
+<legalnotice>&FDLNotice;</legalnotice>
+
+<!-- Date and version information of the documentation
+Don't forget to include this last date and this last revision number, we
+need them for translation coordination !
+Please respect the format of the date (YYYY-MM-DD) and of the version
+(V.MM.LL), it could be used by automation scripts.
+Do NOT change these in the translation. -->
+
+<date>2006-07-09</date>
+<releaseinfo>0.1</releaseinfo>
+
+<!-- Abstract about this handbook -->
+
+<abstract>
+<para>
+&tastymenu; is a KMenu replacement
+</para>
+</abstract>
+
+<!-- This is a set of Keywords for indexing by search engines.
+Please at least include KDE, the KDE package it is in, the name
+ of your application, and a few relevant keywords. -->
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>TastyMenu</keyword>
+<keyword>start menu</keyword>
+<keyword>usability</keyword>
+</keywordset>
+
+</bookinfo>
+
+<!-- The contents of the documentation begin here.  Label
+each chapter so with the id attribute. This is necessary for two reasons: it
+allows you to easily reference the chapter from other chapters of your
+document, and if there is no ID, the name of the generated HTML files will vary
+from time to time making it hard to manage for maintainers and for the CVS
+system. Any chapter labelled (OPTIONAL) may be left out at the author's
+discretion. Other chapters should not be left out in order to maintain a
+consistent documentation style across all KDE apps. -->
+
+<chapter id="introduction">
+<title>Introduction</title>
+
+<!-- The introduction chapter contains a brief introduction for the
+application that explains what it does and where to report
+problems. Basically a long version of the abstract.  Don't include a
+revision history. (see installation appendix comment) -->
+
+<para>
+&tastymenu; is a KMenu replacement aiming to provide the maximum usability, or at least to be a testbed for usability concepts and ideas for a future kmenu replacement.
+</para>
+</chapter>
+
+<chapter id="using-tastymenu">
+<title>Using &tastymenu;</title>
+
+<!-- This chapter should tell the user how to use your app. You should use as
+many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
+your application. -->
+
+<para>
+
+<!-- Note that all graphics should be in .png format. Use no gifs because of
+patent issues. -->
+
+<screenshot>
+<screeninfo>Here's a screenshot of &tastymenu;</screeninfo>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="screenshot.png" format="PNG"/>
+	  </imageobject>
+	  <imageobject>
+	    <imagedata fileref="screenshot.eps" format="EPS"/>
+	  </imageobject>
+	  <textobject>
+	    <phrase>Screenshot</phrase>
+	  </textobject>
+	</mediaobject>
+</screenshot>
+</para>
+<para>
+ The left part of the menu is very similar to the Novell idea(<ulink url="http://www.novell.com/products/desktop/preview.html">http://www.novell.com/products/desktop/preview.html</ulink>): you have a search box that is always selected when the menu is opened (the search result are displayed in the leftmost listview), followed by a combobox that decides what the following listview: favourite applications (default), most used applications, recently used applications and recent documents.
+</para>
+<para>
+The right part contains the whole kmenu and takes the aspect from <ulink url="http://www.kbfx.org">KBFX</ulink>, the middle column contains the top level categorization (plus in the current kmenu arrangment there are also the control center, home folder and find files, but i think there should be present only categories). in the left-most listview there is the content of the category currently selected in the middle column. I think in this way even if it has the same number of items it <emphasis>appears</emphasis> less huge than with a popup menu/submenu structure.
+Every items have two row, for the name and for the description, in order to make a more it more informative. On each selected item appears an action icon on the right, at the moment they are "add bookmark" on application icons and &amp;remove bookmark &amp;on favourite apps list.
+</para>
+<para>
+The bottom buttons are the usual switch user, lock session and logout. In a first time I didn't want to put them, I tought that these function should be delegate to another applet like <ulink url="http://kde-apps.org/content/show.php?content=26150">http://kde-apps.org/content/show.php?content=26150</ulink> , but it seems that the multiple menus concept it's a thing that doesn't work very well in practice, it needs more real-world testing.
+</para>
+<para>
+The left-most btton contains the user name and icon, and clicking on it it opens the kcm used to edit the user's profile. I know it seems silly, but It's only an experiment, probably it will be merged with the switch user button.
+</para>
+
+
+<sect1 id="tastymenu-features">
+<title>More &tastymenu; features</title>
+
+<para>To do</para>
+<para>
+
+</para>
+
+</sect1>
+</chapter>
+
+<chapter id="commands">
+<title>Command Reference</title>
+
+<sect1 id="tastymenu-mainwindow">
+<title>The main &tastymenu; window</title>
+
+<sect2>
+<title>The search field</title>
+<para>
+  To do
+</para>
+
+</sect2>
+
+</sect1>
+</chapter>
+
+<chapter id="faq">
+<title>Questions and Answers</title>
+
+<qandaset id="faqlist">
+<qandaentry>
+<question>
+<para>To do</para>
+</question>
+<answer>
+<para></para>
+</answer>
+</qandaentry>
+</qandaset>
+</chapter>
+
+<chapter id="credits">
+
+<!-- Include credits for the programmers, documentation writers, and
+contributors here. The license for your software should then be included below
+the credits with a reference to the appropriate license file included in the KDE
+distribution. -->
+
+<title>Credits and License</title>
+
+<para>
+&tastymenu;
+</para>
+<para>
+Program copyright 2006 Marco Martin <email>notmart@gmail.com</email>
+</para>
+<para>
+Contributors:
+<itemizedlist>
+<listitem><para>some code from Kbfx Spinx (<ulink url="http://www.kbfx.org">http://www.kbfx.org</ulink>) copyright (c) 2006 Kbfx team.</para>
+</listitem>
+<listitem><para>dmctl.h and dmctl.c Copyright (c) 2004-2006 Oswald Buddenhagen and Stephan Kulow</para>
+</listitem>
+<listitem><para>some code of the TastyListView from the statistics list view of Amarok (c) 2005-2006 Seb Ruiz</para>
+</listitem>
+</itemizedlist>
+</para>
+
+<para>
+Documentation copyright 2006 Marco Martin <email>notmart@gmail.com</email>
+</para>
+
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+
+&underFDL;               <!-- FDL: do not remove -->
+
+<!-- Determine which license your application is licensed under, 
+     and delete all the remaining licenses below:
+
+     (NOTE:  All documentation are licensed under the FDL, 
+     regardless of what license the application uses) -->
+
+&underLGPL;        	 <!-- LGPL License -->
+
+
+</chapter>
+
+<appendix id="installation">
+<title>Installation</title>
+
+<sect1 id="getting-tastymenu">
+<title>How to obtain &tastymenu;</title>
+
+
+<para>
+ The latest &tastymenu; sources can be found at <ulink url="&homepage;">&homepage;</ulink>
+</para>
+
+</sect1>
+
+<sect1 id="requirements">
+<title>Requirements</title>
+
+<para>
+In order to successfully use &tastymenu;, you need at least &kde; 3.4 (didn't tested it under older &kde; versions, but it could compile anyway). it should suffice a stock &kde; found on most distributions, without special requirements
+</para>
+
+<para>
+You can find a list of changes at <ulink url="&homepage;">&homepage;</ulink>.
+</para>
+</sect1>
+
+<sect1 id="compilation">
+<title>Compilation and Installation</title>
+
+<!-- This entity contains the boilerplate text for standard -->
+<!-- compilation instructions.  If your application requires any -->
+<!-- special handling, remove it, and replace with your own text. -->
+
+&install.compile.documentation;
+
+</sect1>
+
+</appendix>
+
+&documentation.index;
+</book>
+
+<!--
+Local Variables:
+mode: sgml
+sgml-minimize-attributes:nil
+sgml-general-insert-case:lower
+sgml-indent-step:0
+sgml-indent-data:nil
+End:
+
+vim:tabstop=2:shiftwidth=2:expandtab 
+-->
+
diff --git a/doc/en/screenshot.png b/doc/en/screenshot.png
new file mode 100644
index 0000000..31d87c4
--- /dev/null
+++ b/doc/en/screenshot.png