Upon discovering on Wednesday that there was a chunk of documentation
missing from the external_parsers entry in attrs.html, I decided to
do a "diff -bu" of it against an older copy (dated Aug 26). I found
numerous errors were introduced as a result of the move to the new
cf_generate.pl script. Here's my summary of the problems:
- string list now simply identified as string, which doesn't destinguish
attributes that allow more than one string
- quoted string list simply identified as "quoted"
- hrefs to htdig.html now set target='_top' (should be just for
htsearch.html, which is the only one that opens a new frameset)
- same for links to htnotify.html, htfuzzy.html, htmerge.html
- cf_byprog.html links to htsearch.html without setting target frame
- no commas or ands in "used by" lists
- default values of "0" are listed as "No default"
- <, > and & in default not changed to <, > and &
- can't give multiple examples anymore, e.g. url_part_aliases
- no more multi-line examples for external_parsers, common_url_parts,
sort_names
- space after \ in no_page_number_text's multi-line example (bad for
cut'n'paste of examples)
- same for server_aliases, star_patterns, template_map, template_patterns,
url_part_aliases
- example of setting to empty doesn't get through for "no_excerpt_text:",
"no_next_page_text:", "no_prev_page_text:"
- example from no_page_list_header deleted
- description of include directive has been deleted (an entry for
"include" in defaults.cc shouldn't do any harm)
- external_parsers missing a big chunk of its description
- logging missing a small chunk of its description
- search_algorithm missing a big chunk of its description
- same for search_results_footer and search_results_header
- maximum_word_length missing its default (was 32)
- value of -1 for server_max_docs no longer explained
- descriptions add BIG strings to programs, which aren't even used by them
(should maybe be done as comments instead?)
Many of these problems should be fairly easy to fix, especially by
someone who knows the Perl script, while some may take a bit more work.
To be fair, the new script did solve some problems too, by fixing up
several inconsistencies that were there, and it should be a big help
in preventing further inconsistencies from creeping in.
In addition, I discovered a number of entries that need to be completed
or corrected to keep up with the many changes in 3.2:
- example for modification_time_is_now should complement default
- doc_excerpt has no documentation entries
- same for heading_factor, img_alt_factor, max_descriptions,
minimum_speling_length, noindex_end, regex_max_words, url_factor,
use_doc_date, valid_extensions
- still some references to heading_factor_[1-6] (are these gone for good?)
- *_factor entries still listed as used by htdig, not htsearch
- translate_* entries now used by more than just htdig
(unfortunately, I can't think of any way of automatically determining
which programs actually make use of which attributes)
I think these problems should be addressed before 3.2.0b1 goes out the
door.
--
Gilles R. Detillieux E-mail: <[EMAIL PROTECTED]>
Spinal Cord Research Centre WWW: http://www.scrc.umanitoba.ca/~grdetil
Dept. Physiology, U. of Manitoba Phone: (204)789-3766
Winnipeg, MB R3E 3J7 (Canada) Fax: (204)789-3930
------------------------------------
To unsubscribe from the htdig3-dev mailing list, send a message to
[EMAIL PROTECTED] containing the single word "unsubscribe" in
the SUBJECT of the message.
