Perhaps, something like xqDoc ... http://xqdoc.org ?
The project has become a bit stale, but after attending the user conference this past week, I was a bit surprised as to how many people were actually using the tool. So, I plan on updating some of the functionality later this summer/fall. If there are some specific requirements/features that this group would like added, please let me know. Keep in mind, that the goal is to keep xqDoc vendor neutral ... one of the reasons why I never added a full-text search capability. With that said, we used to have XQuery scripts that we ran against the XPath F&O HTML documentation and the MarkLogic HTML documentation. These scripts generated xqDoc XML for the 'functions' which could then be hyperlinked (used by, what functions used, etc.) and became a great learning tool for XQuery (in my opinion). Of course, it would be easier if MarkLogic would provide xqDoc XML for their functions ... it got to be a pain updating the screen scraping scripts as the ML web site changed. Anyway, the site has some examples (http://xqdoc.org/enhanced/default.html). If others are interested in participating to help enhance xqDoc, your time would be greatly appreciated ... just drop me a note. Darin. -----Original Message----- From: [email protected] on behalf of Chris Maloney Sent: Tue 5/11/2010 6:18 PM To: General Mark Logic Developer Discussion Subject: [MarkLogic Dev General] Documentation suggestion: more hyperlinking! Danny, It would be nice if the documentation could have a lot more hyperlinking to the reference material. Both within the API reference documentation itself (linking from examples, for instance, when a function is used -- to it's reference doc) and from the PDFs to the reference document. I guess it's probably not trivial, but it's something to think about for the future, or maybe for an open source project. It would certainly make using the docs *much* easier, IMO. Chris _______________________________________________ General mailing list [email protected] http://developer.marklogic.com/mailman/listinfo/general
