[dev] Docs Module (was: Horde Summary Layout options, in HEAD maybe?)

[Eric Rostetter]

Quoting Ryan Gallagher <ryan@studiesabroad.com>:

> Quoting Chuck Hagenbuch <chuck@horde.org>:
> 
> > > Other "considered" additions:
> > > 1) A documentation/faq module
> >
> > This is on my list, too, to integrate with Whups. The Category:: code is
> > _perfect_ for storing FAQ-type data, imho. I just haven't had the time to
> > devote to it yet...

Interesting idea.  I'll keep that in mind... :)  One of the biggest problems
with maintaining the faq list is trying to figure out where an FAQ should
go within the FAQ structure...

> area.  In my personal brainstorming I was considering playing with an XML
> based document manager type thingy.

I'm not sure what the "document manager type thingy" is, but I think all
docs should go to XML.  Then use XSLT to translate to text, pdf, html, etc.

> I was intrigued by the use of XMLSchema to define possible document types,

I'd rather see us use an existing XML format than create new ones, if possible.

> The viewer engine would rely on a the XSL->html style definitions.  Other
> output
> formats could later be added given the right processing tools and presence of
> an appropriate stylesheet.

Not sure about the viewer (could the help viewer be expanded to handle more
stuff like this?).  But I'm definately in favor of XML docs -> XSLT
stylesheets to multiple output formats.

> The web-editable requirement is "gray area".

I'm not sure it has to be web-editable.  Just web accessible, or cvs 
accessible, or both (since chora *does* both, I'd be happy with current
setup).

> I suppose that an
> upload/download tool plus the viewer engine would be useful enough by
> themselves to start with.

Chora/CVS is an upload/download tool, and any XSLT engine (or browser 
supporting XSLT) could be the viewer... Or maybe I totally misunderstand
you..

> I mentioned the mild interest in a structure document diff tool for Chora a
> while back in chora@.  I suppose this would be the ideal backend.  Then

I'm also still interested in that, but I see no real relationship to this 
project, and I've had no time to pursue chora work.

> despite
> the web-centric nature of the docs, they could be fully versioned and easily
> associated with a "make" process to facilitate building of offline formats
> for all or parts of the document catalog.

I think it would be XML nature, not web-centric nature.  And CVS would give
you versioning.  Make would be simple if you have an XSLT engine (like that
php provides via sablotron).  I think we might have to provide already 
converted versions for those who don't have access to, or simply don't know
anything about, and XSLT engine.

> Sorry for the length, you know how ideas tend to branch wildly before you get
> realistic and start pruning. ;-)  It also doesn't help that I used to work
> for a digital book retailer DOT-com before it busted.

Sounds like you are very well qualified to help out with this project.
I'll also agree to help of course ;)

> --
> Ryan T. Gallagher
> ryan@studiesabroad.com
> 
> 
> 
> --
> Horde developers mailing list
> Frequently Asked Questions: http://horde.org/faq/
> To unsubscribe, mail: dev-unsubscribe@lists.horde.org


-- 
Eric Rostetter
The Department of Physics
The University of Texas at Austin

"Can you hear me now? ... Good!"
"Can you hear me now? ... Good!"