Menu
▾
▴
Re: [Exist-development] A proposed addition to the XQDocs
|
From: Loren C. <lor...@gm...> - 2012-10-08 01:10:09
|
I have copied the documentation for xqDoc from http://xqdoc.org and have placed the article on my own server http://greatlinkup.com:8080/exist/apps/doc/xqdoc.xml. I am hoping for permission from Darin McBeath to copy the documentation into the eXist doc app. I am thinking that it should be enhanced with the changes that Wolfgang did to the XQuery parser. Any feedback would be appreciated. On Oct 6, 2012, at 11:34 PM, Loren Cahlander <lor...@gm...> wrote: > I am thinking that in the XQuery code that the entries in the XQDoc documents could be changed to > > > > > @param > > The @param tag identifies the parameters associated with a function. For each parameter in a function, there should be a @param tag. The @param tag should be followed by the parameter name (as indicated in the function signature) and then the parameter description. > > @param $name The username @schema URI to the schema > > > > @return > > The @return tag describes what is returned from a function. Zero or one @return tags can be specified. > > @return Sequence of names matching the search criteria @schema URI to the schema > > > > > If there is no schema, then there would be no @schema entry. One question would be that during the XQDoc scan, do we harvest the schema data and insert that into the XQDoc structure assuring that there is actually a schema there or do we just store the URI? > > > <2012-10-06_23-31-44.png> > > On Oct 6, 2012, at 10:30 PM, Casey Jordan <cas...@jo...> wrote: > >> I think this is a great idea. It would even be very useful to be able to design this so inputs (and outputs) could automatically be validated (but I digress) >> >> For the java part, I suppose a new function signature sequence type (FunctionParameterSequenceType) constructor could be created, which would include a reference to a schema, the nice thing about this is it would work for both parameters and return types. >> >> I don't know enough about the native XQuery part to really comment. >> >> On Sat, Oct 6, 2012 at 2:48 PM, Loren Cahlander <lor...@gm...> wrote: >> Hello folks, >> >> I am thinking that the functions docs could use an enhancement. I was looking at the function docs for scheduler:get-secheduled-jobs() >> >> >> get-scheduled-jobs >> >> scheduler:get-scheduled-jobs() node() >> Gets the details of all scheduled jobs in the form: <scheduler:jobs xmlns:scheduler="http://exist-db.org/xquery/scheduler" count="iJobs"> <scheduler:group name="group"> <scheduler:job name=""> <scheduler:trigger name=""> <expression></expression> <state></state> <start></start> <end></end> <previous></previous> <next></next> <final></final> </scheduler:trigger> </scheduler:job> </scheduler:group></scheduler:jobs> >> >> Parameters: >> $a $a >> Returns: >> the XML containing the list of jobs >> >> I am thinking that there should be an option to add an XSD or a Relax NG to a parameter or the return value and then display a graphic of the schema of the value. I will work on this, but would like some feedback from the group as to a proper mechanism to add this to the XQDocs in any XQuery code. The java implemented function modules should be pretty straight forward to implement after this decision. >> >> >> I am thinking that the description should be changed to 'Get the details of all scheduled jobs.' and the returns show something similar to the attached: >> >> <2012-10-06_13-45-47.png> >> >> What do you think? >> >> Cheers, >> Loren >> >> >> >> >> ------------------------------------------------------------------------------ >> Don't let slow site performance ruin your business. Deploy New Relic APM >> Deploy New Relic app performance management and know exactly >> what is happening inside your Ruby, Python, PHP, Java, and .NET app >> Try New Relic at no cost today and get our sweet Data Nerd shirt too! >> http://p.sf.net/sfu/newrelic-dev2dev >> _______________________________________________ >> Exist-development mailing list >> Exi...@li... >> https://lists.sourceforge.net/lists/listinfo/exist-development >> >> >> >> >> -- >> -- >> Casey Jordan >> easyDITA a product of Jorsek LLC >> "CaseyDJordan" on LinkedIn, Twitter & Facebook >> (585) 348 7399 >> easydita.com >> >> >> This message is intended only for the use of the Addressee(s) and may >> contain information that is privileged, confidential, and/or exempt from >> disclosure under applicable law. If you are not the intended recipient, >> please be advised that any disclosure copying, distribution, or use of >> the information contained herein is prohibited. If you have received >> this communication in error, please destroy all copies of the message, >> whether in electronic or hard copy format, as well as attachments, and >> immediately contact the sender by replying to this e-mail or by phone. >> Thank you. >> > |
