Thanks anyway, but I'm planning to adopt the style conventions outlined for xqDoc and perhaps later write a parser to extract that documentation and convert it to other formats (html, text, man, etc.). It should be an easy project. For me, the value lies in having a standard format and keeping the documentation with the source code. An xqDoc filter for source files would offer a lot of flexibility while still keeping things simple.
Karl On Thu, Mar 4, 2010 at 9:27 AM, Geert Josten <[email protected]> wrote: > Hi Karl, > > If you are willing to give it a try with MLJAM, then all you will need to do > is: > - Setup MLJAM service in Jetty or Tomcat > - Drop xqdoc_conf-v1.6.jar in WEB-INF/lib > - Deploy the xqdoc distribution in a Mark Logic App server > - Replace ml-xqdoc-ws-lib.xqy with mljam-xqdoc-lib.xqy in the xqdoc > distribution (e.g. in imports and in install.xqy) > - Run install.xqy of xqdoc > > I can send you a copy of mljam-xqdoc-lib.xqy if you like. The > mljam-xqdoc-lib.xqy script contains special logic to determine proper xpath > and controller namespace.. > > Kind regards, > Geert > >> > > > drs. G.P.H. (Geert) Josten > Consultant > > > Daidalos BV > Hoekeindsehof 1-4 > 2665 JZ Bleiswijk > > T +31 (0)10 850 1200 > F +31 (0)10 850 1199 > > mailto:[email protected] > http://www.daidalos.nl/ > > KvK 27164984 > > P Please consider the environment before printing this mail. > De informatie - verzonden in of met dit e-mailbericht - is afkomstig van > Daidalos BV en is uitsluitend bestemd voor de geadresseerde. Indien u dit > bericht onbedoeld hebt ontvangen, verzoeken wij u het te verwijderen. Aan dit > bericht kunnen geen rechten worden ontleend. > >> From: [email protected] >> [mailto:[email protected]] On Behalf Of >> Karl Erisman >> Sent: donderdag 4 maart 2010 15:44 >> To: General Mark Logic Developer Discussion >> Subject: Re: [MarkLogic Dev General] XQDoc in ML version 4? >> >> Thanks, all, for the input, but I'm still getting the same error. >> >> The setup page (http://xqdoc.org/qs_marklogic.html) mentions >> and links to older versions of the scripts but yes, I did >> find the Jan 2007 1.3 versions and am using those. >> >> Yes, I'm using v1.6 of the binary. >> >> Again, I'm using the packages mentioned on the marklogic >> setup page (including xqdoc_conv.jar v1.6 and the latest >> scripts for verifying proper install. >> >> Are there any other tools to produce documentation from xqDoc >> embedded in a file? I'm actually more interested in simple >> text or manpage output than HTML anyway. It might be nice to >> get this working, though... >> >> On Thu, Mar 4, 2010 at 7:57 AM, Darin McBeath >> <[email protected]> wrote: >> > I assume when you mention xqDoc demo code, you are >> referencing the 'scripts' >> > from Jan 2007 v1.3 (http://xqdoc.org/source.html) >> > >> > What version of the binary are you using? Are you using >> version 1.6 >> > (http://xqdoc.org/binaries.html)? >> > >> > Based on the error message below, it sounds like there is a >> mismatch >> > between the version of the code/grammars parsing the XQuery >> file and >> > the XQuery specification syntax version used in the XQuery >> file. In >> > other words, if the syntax is 1.0 in the XQuery files, then >> only xqdoc >> > version 1.6 will work. Hope this helps. If not, let m >> know and I will investigate further. >> > >> > Darin. >> > >> > ________________________________ >> > From: Karl Erisman <[email protected]> >> > To: General Mark Logic Developer Discussion >> > <[email protected]> >> > Sent: Wed, March 3, 2010 11:08:47 PM >> > Subject: Re: [MarkLogic Dev General] XQDoc in ML version 4? >> > >> > $ java org.xqdoc.drivers.marklogic.MarkLogicFileDriver >> > /opt/MarkLogic/xqdoc localhost 8005 username password >> > >> > ... fails with: >> > >> > org.xqdoc.conversion.XQDocException: line 1:24: unexpected token: ; >> > at >> > org.xqdoc.conversion.XQDocController.parse(XQDocController.java:309) >> > at >> > >> org.xqdoc.conversion.XQDocController.process(XQDocController.java:229) >> > at >> > >> org.xqdoc.drivers.marklogic.MarkLogicFileDriver.main(MarkLogicFileDriv >> > er.java:84) Caused by: line 1:24: unexpected token: ; >> > at >> > >> org.xqdoc.xquery.parser.may2003.XQueryParser.exprSingle(XQueryParser.j >> > ava:2023) >> > at >> > >> org.xqdoc.xquery.parser.may2003.XQueryParser.expr(XQueryParser.java:13 >> > 99) >> > at >> > >> org.xqdoc.xquery.parser.may2003.XQueryParser.queryBody(XQueryParser.ja >> > va:700) >> > at >> > >> org.xqdoc.xquery.parser.may2003.XQueryParser.mainModule(XQueryParser.j >> > ava:392) >> > at >> > >> org.xqdoc.xquery.parser.may2003.XQueryParser.module(XQueryParser.java: >> > 290) >> > at >> > >> org.xqdoc.xquery.parser.may2003.XQueryParser.xpath(XQueryParser.java:2 >> > 31) >> > at >> > org.xqdoc.conversion.XQDocController.parse(XQDocController.java:302) >> > ... 2 more >> > >> > Note that this is the output when running xqDoc against the >> demo code >> > provided for verifying that things are working correctly. >> I get the >> > same result when running xqDoc against my own code. >> > >> > Any ideas? >> > >> > Thanks, >> > Karl >> > >> > On Wed, Mar 3, 2010 at 2:56 PM, Darin McBeath >> <[email protected]> wrote: >> >> What specific problem are you encountering? There is nothing >> >> specific to version 4 of ML that would prevent xqDoc from >> working. I >> >> use xqDoc on 4.1 and it works fine. >> >> >> >> However, there are some other xqDoc limitations ... but, >> it really >> >> depends on the xquery code which you are trying to xqDoc. >> >> >> >> Let me know the specific error and if possible provide the XQuery >> >> code that is causing the problem. >> >> >> >> Darin. >> >> >> >> ________________________________ >> >> From: Karl Erisman <[email protected]> >> >> To: General Mark Logic Developer Discussion >> >> <[email protected]> >> >> Sent: Wed, March 3, 2010 3:42:30 PM >> >> Subject: [MarkLogic Dev General] XQDoc in ML version 4? >> >> >> >> What is the status of xqDoc support for MarkLogic? Does >> XQDoc work >> >> with ML version 4? It appears to me that it does not. Can anyone >> >> suggest any alternatives to xqDoc? I prefer keeping >> certain types of >> >> documentation inline with the source code for >> maintainability reasons. >> >> >> >> Thanks, >> >> Karl >> >> _______________________________________________ >> >> General mailing list >> >> [email protected] >> >> http://xqzone.com/mailman/listinfo/general >> >> >> >> _______________________________________________ >> >> General mailing list >> >> [email protected] >> >> http://xqzone.com/mailman/listinfo/general >> >> >> >> >> > _______________________________________________ >> > General mailing list >> > [email protected] >> > http://xqzone.com/mailman/listinfo/general >> > >> > _______________________________________________ >> > General mailing list >> > [email protected] >> > http://xqzone.com/mailman/listinfo/general >> > >> > >> _______________________________________________ >> General mailing list >> [email protected] >> http://xqzone.com/mailman/listinfo/general >> > _______________________________________________ > General mailing list > [email protected] > http://xqzone.com/mailman/listinfo/general > _______________________________________________ General mailing list [email protected] http://xqzone.com/mailman/listinfo/general
