Ok... see comments/questions below...

On Wednesday, January 8, 2003, at 10:10  AM, Geoff Hutchison wrote:


This seems like something I could do. Could you please provide more
detail on what exactly needs to be done? For example, do we want to have
each configure option in it's own html file a la php.net's documentation
I guess that's certainly a possibility--I think the original idea was that
we'd keep an attrs.html for backwards-URL compatibility, but we'd have a
few "category" pages. Certainly we could do both--have a "category" index
and then separate pages for each attribute.

But I think in some cases, it's useful to show examples in the
documentation of using multiple related attributes together.
I'll plan on doing both.


Also, what version of htdig et al are we preparing this documentation
for?
3.2.x. The defaults.cc file (or defaults.xml file, if you've
been following that) has a "category" field like "File Layout" or
"Indexing" that should be a separate page.
I've reviewed, briefly, both files mentioned. I'm not sure what they're purpose is in terms of the whole project (I've been following the discussion, but not closely - seems like these are default values for every attribute based on the name), but it seems that the smartest thing to do would be to write some php code that parses the defaults.xml document and extracts the documentation from there. I could set this up to be done on the fly (for each request) or as a php file that reads the defaults.xml file and outputs a series of html files that could then be uploaded to the web site (similar to a project I did for BBEdit: http://www.tedmasterweb.com/glossary/ )

How much control do we have on the htdig site (can we set options in .htaccess, or better yet, modify the httpd.conf file directly)? Is anyone opposed to moving the online documentation to php or to using php on htdig.org? Can we customize the 404 error page? Can we use .htaccess?

Finally, could someone provide a gloss on the doctype declaration in defaults.xml? I understand the basic structure of xml documents (and have written a few smil docs by hand) but I could use a little clarification on this one point. Oh, and, one last thing, why is there both a defaults.cc and defaults.xml document? I can understand the purpose of the .cc document, but what is the defaults.xml doc for? Is it just a pretty way of presenting the .cc doc?

One more thing... I tend to try and write XTHML 1.1 Strict copmliant html. Does anyone have a problem with this? For those who are unfamiliar with it, XHTML is an XML compliant version of HTML 4.

Ted

------------------------------------------------------------------------------------
Homepage: http://www.tedmasterweb.com/
My JavaScript Window Management Tool: http://www.tedmasterweb.com/wmo/



-------------------------------------------------------
This SF.NET email is sponsored by:
SourceForge Enterprise Edition + IBM + LinuxWorld = Something 2 See!
http://www.vasoftware.com
_______________________________________________
htdig-dev mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/htdig-dev

Reply via email to