[Cdd-commits] cdd/doc/common/en 06_technology.sgml,1.4,1.5

[Andreas Tille]

Update of /cvsroot/cdd/cdd/doc/common/en
In directory haydn:/tmp/cvs-serv7546/common/en

Modified Files:
	06_technology.sgml 
Log Message:
Increased version number for next release and finished quick meta package building howto.


Index: 06_technology.sgml
===================================================================
RCS file: /cvsroot/cdd/cdd/doc/common/en/06_technology.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- 06_technology.sgml	30 Jun 2004 19:35:04 -0000	1.4
+++ 06_technology.sgml	30 Jun 2004 21:53:56 -0000	1.5
@@ -1256,6 +1256,84 @@
 possibly other things which will be implementd in the future.
 </p>
    </sect1>
+   <sect1 id="meta-package-menus">
+   <heading>The meta package menus</heading>
+
+<p>
+As explained in <ref id="menu_tools"> the meta packages can contain
+user menus.  This optional feature can be implemented easily by using
+the template from the <package>cdd-dev</package> in the following way:
+
+<example>
+~> cp -a /usr/share/doc/cdd-dev/examples/menu .
+~> cat menu/README
+~> edit menu/task1
+ <var>Edit the example to legal menu entries of the
+ dependencies of this meta package</var>
+~> cp menu/task1 menu/<var>&lt;meta package name&gt;</var>
+</example>
+
+A menu file for each task should be created containing valid menu
+entries for each dependant package.  The easiest way to obtain those
+menu entries is to simply copy the original menu entry files which are
+contained in the packages which the meta package will depend from.
+The only thing which has to be changed in these menu entries is the
+<tt>package</tt> field which has to be changed from
+<package>&lt;dependant package&gt;</package> to
+<package><var>cdd</var>-<var>task</var></package>.  All other entries
+might remain unchanged.  This is a good point to check whether the
+menu entries of the packages you depend from are formated nicely and
+print the necessary information (for instance make use of "hints").
+Here the meta package maintainer has a good chance for quality
+assurance work which is also part of the Custom Debian Distributions
+issue.
+</p>
+<p>
+In principle these menu items could be created automatically either at
+meta package build time or even better in the <file>postinst</file>
+script of the meta package because it is granted that the needed menu
+files are installed on the system (which is not really necessary on
+the meta package build machine).  This might be implemented in later
+versions of <package>cdd-dev</package>.  Currently the policy is that
+we like to have a little bit of control about the menu entries for the
+quality assurance issue mentioned above.  Last but not least there are
+packages which do not provide a menu entry.  If this is the case
+because the package maintainer just forgot it a bug report should be
+filed.  On the other hand there are packages with programs which
+provide a command line interface which does not allow a reasonable
+menu entry.  A solution for this case is provided in the next
+paragraph.
+</p>
+
+   </sect1>
+   <sect1 id="any-dependency--menus">
+   <heading>Menu for any dependency</heading>
+
+<p>
+The idea of the meta package menu is to provide the user with easily
+viewable traces of any installed package which helps solving every day
+tasks.  So if there are packages which do not contain a menu a screen
+with relevant documentation should be provided in a viewer by the
+creator of the meta package.  Such documentation can be created using
+the following templates:
+
+<example>
+~> cp -a /usr/share/doc/cdd-dev/examples/docs .
+~> cat docs/README
+~> edit docs/task1/dep1
+ <var>Provide information about package &lt;dep1&gt; which
+ depends from meta package &lt;task1&gt; but does not
+ contain a useful menu entry</var>
+~> cp docs/task1/dep1 docs/task1/<var>&lt;dependent pkg&gt;</var>
+~> cp -a docs/task1 docs/<var>&lt;meta package name&gt;</var>
+</example>
+
+This ensures that our users become aware of all interesting packages
+on their system.  The documentation files should contain hints to man
+pages to read, URLs which should be visited to learn more about the
+package or some short introduction how to get started.
+</p>
+   </sect1>
    </sect>
 </chapt>