[htdig3-dev] Documentation--Categories


Subject: [htdig3-dev] Documentation--Categories
From: Geoff Hutchison (ghutchis@wso.williams.edu)
Date: Sun Feb 06 2000 - 14:25:10 PST


Hi,

Some of you probably remember the discussion last year about this
time about reorganizing the documentation from one monster file into
several files of "categories." I slipped in an empty category field
into htcommon/defaults.cc before releasing 3.2.0b1.

I'm in the process of adding this field to the attributes in
defaults.cc based on the outline from
<http://www.htdig.org/htdig3-dev/1999/02/0087.html> by Marjolein.

Here's my updated version, borrowing heavily and ignoring the
examples already given.

URLs (URLS matching and pattern replacement)
Extra Output (optional extra output to be produced)
File Layout (databases used and their location)
Indexing
        Where (determines which files are going to be indexed)
        What (determines which parts of a file are indexed)
        How (determines how the files are stored in the database)
        Connection (determines how the connections are handled)
        Out (information sent to the outside world)
External
        Parsers (including pdf_parser)
        Protocols (self-explanatory)
Searching
        UI (user interface to the searching process)
        Method (algorithms and methods to be used)
        Ranking (scoring factors)
Presentation
        How (algorithms and decisions for presenting the results)
        Text (literal texts used in variables for the templates)
        Templates (files to be used as templates)

These are a bit subjective, so after a year of meditating (and some
new people), how do these sound?

My current format for the field in defaults.cc is simply
"Category:Subcategory" as a comma-separated list if the attribute
falls into two categories.
e.g. bad_word_list ... "Indexing:What,Searching Method"

How does this sound?

-Geoff

------------------------------------
To unsubscribe from the htdig3-dev mailing list, send a message to
htdig3-dev-unsubscribe@htdig.org
You will receive a message to confirm this.



This archive was generated by hypermail 2b28 : Sun Feb 06 2000 - 14:30:37 PST