[Cdd-commits] r304 - in cdd/trunk/cdd/examples/menu: . task1
Andreas Tille
debian-custom@lists.debian.org
Sun, 19 Sep 2004 09:46:14 -0600
Author: tille
Date: Sun Sep 19 09:46:13 2004
New Revision: 304
Added:
cdd/trunk/cdd/examples/menu/task1/dep1.menu
- copied, changed from r303, cdd/trunk/cdd/examples/menu/task1/task1.menu
cdd/trunk/cdd/examples/menu/task1/dep2.txt
- copied, changed from r303, cdd/trunk/cdd/examples/menu/task1/dep1.txt
cdd/trunk/cdd/examples/menu/task1/dep3.html
Removed:
cdd/trunk/cdd/examples/menu/task1/dep1.txt
cdd/trunk/cdd/examples/menu/task1/task1.menu
Modified:
cdd/trunk/cdd/examples/menu/README
cdd/trunk/cdd/examples/menu/task1/README
Log:
Further adaptations to 0.3.9 in the examples section.
Modified: cdd/trunk/cdd/examples/menu/README
==============================================================================
--- cdd/trunk/cdd/examples/menu/README (original)
+++ cdd/trunk/cdd/examples/menu/README Sun Sep 19 09:46:13 2004
@@ -11,13 +11,14 @@
done via text files /usr/share/doc/_CDD_task1/deppkg1.txt (see Debian-Med).
The idea is to provide a special _CDD_ menu with the relevant parts for
-the users of the _CDD_
+the users of the _CDD_.
-Perhaps this approach could be even more automated this way:
-
- - cdd-update-menus checks existant menu entries of the deppkg1 package
- and append this entry to /etc/_CDD_/menu/_CDD_-task1
- - For those dependand packages deppkg3, which do not provide a menu entry (for
- whatever reason) a file docs/task1/deppkg3.txt should exist. At package build
- time the *.txt files in docs/task1 will be parsed and reasonable menu
- entries builded.
+At install time the existing dependencies are checked for their
+menu entries. These are tekan over into the user menu. If the
+meta package maintainer wants to override this entry he is able
+to provide menu/<task>/<dep>.menu files. If there is no reasonable
+menu entry for a package extra documentation can be provided which
+can be viewed via menu entries. This can either be given as plain
+text files menu/<task>/<dep>.txt or HTML files menu/<task>/<dep>.html.
+The created menu entry calls sensible-pager or sensible-browser,
+respectively.
Modified: cdd/trunk/cdd/examples/menu/task1/README
==============================================================================
--- cdd/trunk/cdd/examples/menu/task1/README (original)
+++ cdd/trunk/cdd/examples/menu/task1/README Sun Sep 19 09:46:13 2004
@@ -1,13 +1,16 @@
+Here you can place overrides for the package maintainer menu entries
+in normal menu syntax as files <dep>.menu .
+
Sometimes it is not possible to provide a useful menu entry for a
package and thus we would fail to create a menu entry for a dependency
inside a meta package. This sucks in term of user support and thus
it is strongly suggested to provide some information about each
dependant package which has no reasonable menu entry.
-This can easily done by creating a directory with the name of the
-meta package (i.e. task1) which contains the relevant package dependency.
-Then create a file named like the package which fails to provide a menu
-(i.e. dep1.txt). This simple text file should provide all information
-which is necessary to use this package, like man pages online documentation,
-usage examples, upstream URL, etc.
-
\ No newline at end of file
+This can easily done by creating a text file with the name of the
+dependency, i.e. dep2.txt. Alternatively you can provide HTML
+formated description as dep3.html.
+
+These files should provide all information which is necessary to use
+this package, like man pages online documentation, usage examples,
+upstream URL, etc.
Copied: cdd/trunk/cdd/examples/menu/task1/dep1.menu (from r303, cdd/trunk/cdd/examples/menu/task1/task1.menu)
==============================================================================
--- cdd/trunk/cdd/examples/menu/task1/task1.menu (original)
+++ cdd/trunk/cdd/examples/menu/task1/dep1.menu Sun Sep 19 09:46:13 2004
@@ -1,15 +1,5 @@
-?package(_CDD_-task1): needs = "X11" \
- section = "_CDD_/Task1" \
- title = "DepPkg1" \
- command = "/usr/bin/deppkg1" \
- hints = "Use of DepPkg1"
-?package(_CDD_-task1): needs = "X11" \
- section = "_CDD_/Task1" \
- title = "DepPkg2" \
- command = "/usr/bin/deppkg2" \
- hints = "Use of DepPkg2"
-?package(_CDD_-task1): needs = "text" \
- section = "_CDD_/Task1" \
- title = "DepPkg3" \
- command = "view /usr/share/doc/_CDD_-task1/deppkg3.txt" \
- hints = "Hints for usage of pkg3"
+?package(dep1): needs = "X11" \
+ section = "_CDD_/Task1" \
+ title = "DepPkg1" \
+ command = "/usr/bin/deppkg1" \
+ hints = "Use of DepPkg1"
Copied: cdd/trunk/cdd/examples/menu/task1/dep2.txt (from r303, cdd/trunk/cdd/examples/menu/task1/dep1.txt)
==============================================================================
--- cdd/trunk/cdd/examples/menu/task1/dep1.txt (original)
+++ cdd/trunk/cdd/examples/menu/task1/dep2.txt Sun Sep 19 09:46:13 2004
@@ -1,18 +1,18 @@
-dep1: Short description of package dep1
+dep2: Short description of package dep2
-Some information about dep1 from the Debian-_CDD_ project.
+Some information about dep2 from the Debian-_CDD_ project.
- long description of dep1
+ long description of dep2
- More infromation about the dep1 package can be obtained from the following
+ More infromation about the dep2 package can be obtained from the following
manpages:
- dep1_a.1 dep1_b.1 ...
+ dep2_a.1 dep2_b.1 ...
You can use this package in the following way:
...
- More information about dep1 can be obtained from the home page at
+ More information about dep2 can be obtained from the home page at
- http://www.dep1.org/
+ http://www.dep2.org/
Added: cdd/trunk/cdd/examples/menu/task1/dep3.html
==============================================================================
--- (empty file)
+++ cdd/trunk/cdd/examples/menu/task1/dep3.html Sun Sep 19 09:46:13 2004
@@ -0,0 +1,15 @@
+<html>
+<head>
+<title>Description of dep3</title>
+<meta name="author" content="<meta package author>" />
+</head>
+<body>
+<h2>dep3: Short description of package dep3</h2>
+<p>
+ long description of dep3
+</p>
+
+<h4>For more detailed information see:</h4>
+
+</body>
+</html>