XQDoc for BaseX
Tuesday, 12 February 2013 · 4 messages
JS
John Snelson12 Feb 2013 11:40 #
Hi all,
The xquerydoc project is a 100% XQuery 1.0 project which can parse XQuery modules and extract XQDoc style documentation. I've recently extended it to be able to parse XQuery Update and XQuery Full Text, which I believe solves the majority of problems if you want to use it with modules written for BaseX. The project is available here:
https://github.com/xquery/xquerydoc
I'm happy to add any other syntax that BaseX supports as well, but I'll need help understanding what that is if there is anything.
Enjoy your XQuery documentation!
John
AB
Andy Bunce12 Feb 2013 12:17 #
Hi John,
Thanks very much for the fast response on this.
I will take for a spin and let you know. My guess the remaining issues will be:
1. The statically known namespaces. I cobbled together this list https://github.com/apb2006/xqwebdoc/blob/master/src/xqwebdoc/lib/parsers/xqueryparser-bx.xq#L261but maybe some sort of pluggable list as XML config file would be best?
2. the map extension http://dev.saxonica.com/blog/mike/2012/01/#000188
3. BaseX specific syntax. I believe the only one is fuzzy search https://github.com/micheee/xqwebdoc/commit/c6a65b0108ccd2d1f95c3d85ea9da940ec5b2e20
Separately and more generally it would be good to extend the xqdoc format to capture annotations. I have added this as an issue
https://github.com/xquery/xquerydoc/issues/24
Cheers
/Andy
On Tue, Feb 12, 2013 at 10:40 AM, John Snelson
<John.Snelson at marklogic.com>wrote:
Quoted text · John Snelson · 21 lines
> Hi all, > > The xquerydoc project is a 100% XQuery 1.0 project which can parse XQuery > modules and extract XQDoc style documentation. I've recently extended it to > be able to parse XQuery Update and XQuery Full Text, which I believe solves > the majority of problems if you want to use it with modules written for > BaseX. The project is available here: > > https://github.com/xquery/xquerydoc > > I'm happy to add any other syntax that BaseX supports as well, but I'll > need help understanding what that is if there is anything. > > Enjoy your XQuery documentation! > > John > _______________________________________________ > BaseX-Talk mailing list > BaseX-Talk at mailman.uni-konstanz.de > https://mailman.uni-konstanz.de/mailman/listinfo/basex-talk >
AB
Andy Bunce12 Feb 2013 12:28 #
On a related note: It would be great if BaseX shipped with xqdoc files for each of its built-in in modules. http://docs.basex.org/wiki/Module_Library. This information might one day feed into a IDE like William Candillon's http://www.xmlprague.cz/sessions/#xqincloud
/Andy
Quoted text · Andy Bunce · 52 lines
On Tue, Feb 12, 2013 at 11:17 AM, Andy Bunce <bunce.andy at gmail.com> wrote: > Hi John, > > Thanks very much for the fast response on this. > > I will take for a spin and let you know. My guess the remaining issues > will be: > > 1. The statically known namespaces. I cobbled together this list > > https://github.com/apb2006/xqwebdoc/blob/master/src/xqwebdoc/lib/parsers/xqueryparser-bx.xq#L261but maybe some sort of pluggable list as XML config file would be best? > > 2. the map extension http://dev.saxonica.com/blog/mike/2012/01/#000188 > > 3. BaseX specific syntax. I believe the only one is fuzzy search > > https://github.com/micheee/xqwebdoc/commit/c6a65b0108ccd2d1f95c3d85ea9da940ec5b2e20 > > Separately and more generally it would be good to extend the xqdoc format > to capture annotations. I have added this as an issue > https://github.com/xquery/xquerydoc/issues/24 > > Cheers > /Andy > > > On Tue, Feb 12, 2013 at 10:40 AM, John Snelson <John.Snelson at marklogic.com > > wrote: > >> Hi all, >> >> The xquerydoc project is a 100% XQuery 1.0 project which can parse XQuery >> modules and extract XQDoc style documentation. I've recently extended it to >> be able to parse XQuery Update and XQuery Full Text, which I believe solves >> the majority of problems if you want to use it with modules written for >> BaseX. The project is available here: >> >> https://github.com/xquery/xquerydoc >> >> I'm happy to add any other syntax that BaseX supports as well, but I'll >> need help understanding what that is if there is anything. >> >> Enjoy your XQuery documentation! >> >> John >> _______________________________________________ >> BaseX-Talk mailing list >> BaseX-Talk at mailman.uni-konstanz.de >> https://mailman.uni-konstanz.de/mailman/listinfo/basex-talk >> > >
CG
John,
thanks a lot for your contribution! Be sure I’ll soon have a look at it.
Christian
Quoted text · John Snelson · 17 lines
On Tue, Feb 12, 2013 at 11:40 AM, John Snelson <John.Snelson at marklogic.com> wrote: > Hi all, > > The xquerydoc project is a 100% XQuery 1.0 project which can parse XQuery modules and extract XQDoc style documentation. I've recently extended it to be able to parse XQuery Update and XQuery Full Text, which I believe solves the majority of problems if you want to use it with modules written for BaseX. The project is available here: > > https://github.com/xquery/xquerydoc > > I'm happy to add any other syntax that BaseX supports as well, but I'll need help understanding what that is if there is anything. > > Enjoy your XQuery documentation! > > John > _______________________________________________ > BaseX-Talk mailing list > BaseX-Talk at mailman.uni-konstanz.de > https://mailman.uni-konstanz.de/mailman/listinfo/basex-talk
Written for BaseX 7.6. BaseX may have changed since: please check the current documentation.
⚡Generated with XQuery