Please find, for review, the debconf templates and packages descriptions for the htdig source package.
This review will last from Tuesday, January 01, 2008 to Friday, January 11, 2008.
Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.
Your review should be sent as an answer to this mail.
When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.
When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.
Finally, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.
Rationale:
--- ../htdig.old/debian/templates 2007-12-16 21:28:48.040573261 +0100
+++ debian/templates 2007-12-18 07:22:01.766510198 +0100
@@ -1,22 +1,22 @@
Template: htdig/generate-databases
Type: boolean
Default: true
-_Description: Generate endings database now?
+_Description: Generate ht://Dig endings database now?
Explain what database we're talking about. Useful when the package is
installed along with other packages
The ht://Dig search engine requires an endings database which has to be
generated before the first start. Generating the database will take a
short while. It can be done either now or later by calling the
- '/usr/sbin/htdigconfig' script. Should the database be generated now
- rather than later on?
+ '/usr/sbin/htdigconfig' script.
Drop extra question. See Developer's Reference
Template: htdig/run-rundig
Type: boolean
Default: false
-_Description: Execute the rundig script daily?
- rundig is a program that obtains on-line content and creates a searchable
- database for the ht://Dig search engine. It downloads and indexes HTML
- from the web, as defined in /etc/htdig/htdig.conf. Say Yes if you wish to
- run this program daily. Say No if you don't plan to use htdig in this
- way (perhaps htdig is being used by a third party, for instance KDE, to
- perform local indexing). If in doubt, say No. It is the safest choice
- unless you know what you're doing.
+_Description: Schedule a daily execution of the 'rundig' script?
More accurate question
+ On-line content must be indexed by the 'rundig' script before
+ ht://Dig can be used to search data. That script indexes the
+ web content defined in /etc/htdig/htdig.conf.
Rephrase to avoid a leading lowercase letter.
+ .
+ If you choose this option, a daily run of the script will be scheduled.
+ You may choose to not use this option if ht://Dig is used another
+ way (for instance by KDE, to
+ perform local indexing). If in doubt, do not choose this option.
Avoid "Say Yes/no". Split as a separate paragraph to make things clearer.
--- ../htdig.old/debian/control 2007-12-16 21:28:48.040573261 +0100
+++ debian/control 2007-12-18 07:27:00.251611468 +0100
@@ -10,55 +10,39 @@
Depends: ${shlibs:Depends}, perl, lockfile-progs, debconf (>= 1.2.9) | debconf-2.0
Suggests: htdig-doc, wwwoffle | httpd
Conflicts: libmifluz0
-Description: WWW search system for an intranet or small internet
+Description: web search and indexation system - binaries
Whatever is indexed is not really relevant
Use standard 'general - specific' style....
The ht://Dig system is a complete World Wide Web indexing and searching
system for a small domain or intranet. This system is not meant to
- replace the need for powerful internet-wide search systems like Lycos,
- Google, or Yahoo!. Instead it is meant to cover the search needs of a
+ replace the need for powerful internet-wide search systems.
+ It is meant to cover the search needs of a
single company, campus, or even a particular subsection of a website.
No mention of specific systems (some of which being outdated)
.
- As opposed to some WAIS-based or web-server based search engines,
- ht://Dig can span several web servers at a site. The type of these
- different web servers doesn't matter as long as they understand the
- HTTP 1.0 protocol.
+ The ht://Dig search engine can span several web servers at a site.
We're in the 21st century, now..:-)
.
Features:
- * Intranet searching
- * It is free
- * Robot exclusion is supported
- * Boolean expression searching
- * Configurable search results
- * Fuzzy searching (different algorithms supported)
- * Searching of HTML and text files
- * Keywords can be added to HTML documents
- * Email notification of expired documents
- * A Protected server can be indexed
- * Searches on subsections of the database
- * Full source code included
- * The depth of the search can be limited
- * Full support for the ISO-Latin-1 character set
- .
- Please note that ht://Dig is a resource-hog, with respect to processor usage,
- when indexing.
- .
- Disk space requirements:
- .
- 13.000 documents indexed: 150MB disk space with a 'wordlist database'
- 93MB disk space without a 'wordlist'
- .
- Multiplying the number of documents to index by 12.000 comes pretty close
- to the real disk space used.
+ - intranet searching;
+ - robot exclusion;
+ - boolean expression searches;
+ - configurable search results;
+ - fuzzy searching (various algorithms supported);
+ - indexation of HTML and text files;
+ - HTML documents keywords support;
+ - email notification of expired documents;
+ - indexation of protected servers;
+ - searches on subsections of the database;
+ - limitation of search depth;
+ - ISO-Latin-1 character set support.
Just list features. The resource stuff is not relevant for packages'
descriptions.
Package: htdig-doc
Architecture: all
Depends: perl5
Suggests: htdig
Section: doc
-Description: Documentation for the htdig package
+Description: web search and indexation system - documentation
The ht://Dig system is a complete World Wide Web indexing and searching
system for a small domain or intranet. This system is not meant to
- replace the need for powerful internet-wide search systems like Lycos,
- Google, or Yahoo!. Instead it is meant to cover the search needs of a
- single company, campus, or even a particular subsection of a website.
+ replace the need for powerful internet-wide search systems.
+ It is meant to cover the search needs of a
+ single company, campus, or even a particular subsection of a website.
.
- This package contains HTML documentation and examples.
+ This package provides the HTML documentation and examples.
Same modifications than the binary package.
--
Template: htdig/generate-databases Type: boolean Default: true _Description: Generate ht://Dig endings database now? The ht://Dig search engine requires an endings database which has to be generated before the first start. Generating the database will take a short while. It can be done either now or later by calling the '/usr/sbin/htdigconfig' script. Template: htdig/run-rundig Type: boolean Default: false _Description: Schedule a daily execution of the 'rundig' script? On-line content must be indexed by the 'rundig' script before ht://Dig can be used to search data. That script indexes the web content defined in /etc/htdig/htdig.conf. . If you choose this option, a daily run of the script will be scheduled. You may choose to not use this option if ht://Dig is used another way (for instance by KDE, to perform local indexing). If in doubt, do not choose this option.
--- ../htdig.old/debian/templates 2007-12-16 21:28:48.040573261 +0100
+++ debian/templates 2007-12-18 07:22:01.766510198 +0100
@@ -1,22 +1,22 @@
Template: htdig/generate-databases
Type: boolean
Default: true
-_Description: Generate endings database now?
+_Description: Generate ht://Dig endings database now?
The ht://Dig search engine requires an endings database which has to be
generated before the first start. Generating the database will take a
short while. It can be done either now or later by calling the
- '/usr/sbin/htdigconfig' script. Should the database be generated now
- rather than later on?
+ '/usr/sbin/htdigconfig' script.
Template: htdig/run-rundig
Type: boolean
Default: false
-_Description: Execute the rundig script daily?
- rundig is a program that obtains on-line content and creates a searchable
- database for the ht://Dig search engine. It downloads and indexes HTML
- from the web, as defined in /etc/htdig/htdig.conf. Say Yes if you wish to
- run this program daily. Say No if you don't plan to use htdig in this
- way (perhaps htdig is being used by a third party, for instance KDE, to
- perform local indexing). If in doubt, say No. It is the safest choice
- unless you know what you're doing.
+_Description: Schedule a daily execution of the 'rundig' script?
+ On-line content must be indexed by the 'rundig' script before
+ ht://Dig can be used to search data. That script indexes the
+ web content defined in /etc/htdig/htdig.conf.
+ .
+ If you choose this option, a daily run of the script will be scheduled.
+ You may choose to not use this option if ht://Dig is used another
+ way (for instance by KDE, to
+ perform local indexing). If in doubt, do not choose this option.
--- ../htdig.old/debian/control 2007-12-16 21:28:48.040573261 +0100
+++ debian/control 2007-12-18 07:27:00.251611468 +0100
@@ -10,55 +10,39 @@
Depends: ${shlibs:Depends}, perl, lockfile-progs, debconf (>= 1.2.9) | debconf-2.0
Suggests: htdig-doc, wwwoffle | httpd
Conflicts: libmifluz0
-Description: WWW search system for an intranet or small internet
+Description: web search and indexation system - binaries
The ht://Dig system is a complete World Wide Web indexing and searching
system for a small domain or intranet. This system is not meant to
- replace the need for powerful internet-wide search systems like Lycos,
- Google, or Yahoo!. Instead it is meant to cover the search needs of a
+ replace the need for powerful internet-wide search systems.
+ It is meant to cover the search needs of a
single company, campus, or even a particular subsection of a website.
.
- As opposed to some WAIS-based or web-server based search engines,
- ht://Dig can span several web servers at a site. The type of these
- different web servers doesn't matter as long as they understand the
- HTTP 1.0 protocol.
+ The ht://Dig search engine can span several web servers at a site.
.
Features:
- * Intranet searching
- * It is free
- * Robot exclusion is supported
- * Boolean expression searching
- * Configurable search results
- * Fuzzy searching (different algorithms supported)
- * Searching of HTML and text files
- * Keywords can be added to HTML documents
- * Email notification of expired documents
- * A Protected server can be indexed
- * Searches on subsections of the database
- * Full source code included
- * The depth of the search can be limited
- * Full support for the ISO-Latin-1 character set
- .
- Please note that ht://Dig is a resource-hog, with respect to processor usage,
- when indexing.
- .
- Disk space requirements:
- .
- 13.000 documents indexed: 150MB disk space with a 'wordlist database'
- 93MB disk space without a 'wordlist'
- .
- Multiplying the number of documents to index by 12.000 comes pretty close
- to the real disk space used.
+ - intranet searching;
+ - robot exclusion;
+ - boolean expression searches;
+ - configurable search results;
+ - fuzzy searching (various algorithms supported);
+ - indexation of HTML and text files;
+ - HTML documents keywords support;
+ - email notification of expired documents;
+ - indexation of protected servers;
+ - searches on subsections of the database;
+ - limitation of search depth;
+ - ISO-Latin-1 character set support.
Package: htdig-doc
Architecture: all
Depends: perl5
Suggests: htdig
Section: doc
-Description: Documentation for the htdig package
+Description: web search and indexation system - documentation
The ht://Dig system is a complete World Wide Web indexing and searching
system for a small domain or intranet. This system is not meant to
- replace the need for powerful internet-wide search systems like Lycos,
- Google, or Yahoo!. Instead it is meant to cover the search needs of a
- single company, campus, or even a particular subsection of a website.
+ replace the need for powerful internet-wide search systems.
+ It is meant to cover the search needs of a
+ single company, campus, or even a particular subsection of a website.
.
- This package contains HTML documentation and examples.
+ This package provides the HTML documentation and examples.
Source: htdig
Section: web
Priority: optional
Maintainer: Debian QA Group <packages@qa.debian.org>
Build-Depends: debhelper (>= 5), zlib1g-dev, flex, bison
Standards-Version: 3.7.2
Package: htdig
Architecture: any
Depends: ${shlibs:Depends}, perl, lockfile-progs, debconf (>= 1.2.9) | debconf-2.0
Suggests: htdig-doc, wwwoffle | httpd
Conflicts: libmifluz0
Description: web search and indexation system - binaries
The ht://Dig system is a complete World Wide Web indexing and searching
system for a small domain or intranet. This system is not meant to
replace the need for powerful internet-wide search systems.
It is meant to cover the search needs of a
single company, campus, or even a particular subsection of a website.
.
The ht://Dig search engine can span several web servers at a site.
.
Features:
- intranet searching;
- robot exclusion;
- boolean expression searches;
- configurable search results;
- fuzzy searching (various algorithms supported);
- indexation of HTML and text files;
- HTML documents keywords support;
- email notification of expired documents;
- indexation of protected servers;
- searches on subsections of the database;
- limitation of search depth;
- ISO-Latin-1 character set support.
Package: htdig-doc
Architecture: all
Depends: perl5
Suggests: htdig
Section: doc
Description: web search and indexation system - documentation
The ht://Dig system is a complete World Wide Web indexing and searching
system for a small domain or intranet. This system is not meant to
replace the need for powerful internet-wide search systems.
It is meant to cover the search needs of a
single company, campus, or even a particular subsection of a website.
.
This package provides the HTML documentation and examples.
Attachment:
signature.asc
Description: Digital signature