[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [RFR] templates://htdig/{templates}



Christian Perrier wrote:
> Your review should be sent as an answer to this mail.

> -Description: WWW search system for an intranet or small internet
> +Description: web search and indexation system - binaries

Annoyingly, "indexation" exists only as a technical term in
accounting.  And the indexing has to happen first.  So:

   Description: web indexing and searching system - binaries

>   The ht://Dig system is a complete World Wide Web indexing and searching
                                      ^^^^^^^^^^
Take out the misleading WW part.  But that means it's repeating "web
search and indexing system" in both synopsis and long description
("system" in particular occurs far too often); one or the other
should perhaps say "web search engine".

>   system for a small domain or intranet. This system is not meant to
> + replace the need for powerful internet-wide search systems.

Come to think of it, we wouldn't want to "replace the need" for
Google (we would satisfy the need by replacing Google).  Say:

    The ht://Dig system is a complete web search engine for a small domain
    or intranet. It is not meant to replace the major Internet-wide search
    engines; instead it is meant [...]

(It's strangely hard to phrase this without giving an example!)

> + The ht://Dig search engine can span several web servers at a site.
> 
> We're in the 21st century, now..:-)

Even further, today.  But I'd merge this into the first Feature:

     - intranet searching, spanning multiple local web servers;

> -    * Keywords can be added to HTML documents
> +  - HTML documents keywords support;

That doesn't quite work, and it's a bit obscure anyway.  It's
talking about <META NAME="htdig-keywords" CONTENT="foo"> and other
specially added tags.  I was thinking:

     - keyword tagging of HTML documents;
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- ../htdig.old/debian/templates	2007-12-18 08:53:28.000000000 +0000
+++ debian/templates	2008-01-01 16:05:32.000000000 +0000
@@ -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-18 08:53:28.000000000 +0000
+++ debian/control	2008-01-01 16:14:58.000000000 +0000
@@ -10,55 +10,35 @@
 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
- 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.
- .
- 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.
+Description: web indexing and searching system - binaries
+ The ht://Dig system is a complete web search engine for a small domain
+ or intranet. It is not meant to replace the major Internet-wide search
+ engines; instead it is meant to cover the search needs of a single
+ company, campus, or even a particular subsection of a website.
  .
  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, spanning multiple local web servers;
+  - robot exclusion;
+  - boolean expression searches;
+  - configurable search results;
+  - fuzzy searching (various algorithms supported);
+  - indexing of HTML and text files;
+  - keyword tagging of HTML documents;
+  - email notification of expired documents;
+  - indexing 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
- 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. 
+Description: web indexing and searching system - documentation
+ The ht://Dig system is a complete web search engine for a small domain
+ or intranet. It is not meant to replace the major Internet-wide search
+ engines; instead 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.
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.
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 indexing and searching system - binaries
 The ht://Dig system is a complete web search engine for a small domain
 or intranet. It is not meant to replace the major Internet-wide search
 engines; instead it is meant to cover the search needs of a single
 company, campus, or even a particular subsection of a website.
 .
 Features:
  - intranet searching, spanning multiple local web servers;
  - robot exclusion;
  - boolean expression searches;
  - configurable search results;
  - fuzzy searching (various algorithms supported);
  - indexing of HTML and text files;
  - keyword tagging of HTML documents;
  - email notification of expired documents;
  - indexing 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 indexing and searching system - documentation
 The ht://Dig system is a complete web search engine for a small domain
 or intranet. It is not meant to replace the major Internet-wide search
 engines; instead 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.

Reply to: