exist-development — eXist Developer's List

Re: [Exist-development] Function documentation app (fundocs, xqfdocs)

[Loren C. <lor...@gm...>]

Wolfgang,

Please take a look at the xqdoc.xml and see if has an accurate introduction section.  I had taken the checkin comments you had on the XQuery parser code where the xqDoc data was extracted when the XQuery code was being parsed.

Thanks,
Loren

Re: [Exist-development] Function documentation app (fundocs, xqfdocs)

[Jens Ø. P. <oe...@gm...>]

Hi,

I have remodelled the function documentation a bit. Please have a look. I am not sure if the @-notation I use in the dropdown is good. More could be still be done with sorting.

Jens

On Oct 10, 2012, at 6:16 PM, Wolfgang Meier <wol...@ex...> wrote:

>>> Oh, I see - now you mention it, I guess this was mentioned on a list …. So before libraries like this were kept in webapp or inside the app using it, now they are kept in eXide? This can't be the ideal solution.
>> 
> 
> Sure not. It's a temporary solution. The plan is to move those shared resources into separate .xar packages, but - as Joe said - we need a working dependency management for this. I had a look at it recently and I think I can get it to work without too much effort - maybe before 2.0.
> 
>> My other idea is to merge the former "RESTful" function documentation
>> browser into this one, so that we retain the ability to cite modules
>> with clean URLs, like:
>> 
>> http://exist-db.org/apps/functions/xmldb/store
> This would be great. The current page is fast for searching, but bad for browsing and referencing.
> 
> Wolfgang

[Exist-development] Netedit - Draft documentation

[Joe W. <jo...@gm...>]

Hi Evgeny,

I need your help to add information about your Netedit extension to
the eXist-db 2.0 documentation.  I remember that you created Netedit
to make editing eXist documents user-friendly.  The only way users can
benefit from the user-friendly features of Netedit is if they can read
a description in the eXist documentation.  So if you can help me, I
think this will really help users.

I tried creating a description from the information in your source
code and the mailing list records (remember when it was called
"Gate"?).  Here is what I have so far:

"Netedit is an eXist-db extension that enables users to edit documents
stored in eXist-db using their desktop applications.  Once Netedit is
enabled in your build of eXist-db, users can download and start the
Netedit java applet (http://localhost:8080/exist/netedit).  From the
applet, users can select and download any document (XML or binary) in
the eXist-db database.  Once a file is downloaded, the Netedit applet
will watch the local hard disk for any changes to the file, such as
when the user saves a change to the document.  When Netedit detects a
change in the file, it uploads the new version of the file to
eXist-db.  Thus, Netedit serves as a transparent bridge between
eXist-db and the user's applications.  It gives users the ability to
uses eXist-db as remote storage, while simplifying the task of
finding, editing, and saving XML documents or binary files on the
desktop.  To enable Netedit, change include.feature.netedit from false
to true in extensions/local.build.properties, then rebuild eXist-db,
then start eXist-db, then start the Netedit java applet via
http://localhost:8080/exist/netedit."

I *know* this is not all correct, so I need you to help me make it
correct.  Please!

Thank you very much!

Joe

Re: [Exist-development] Function documentation app (fundocs, xqfdocs)

[Wolfgang M. <wol...@ex...>]

> > Oh, I see - now you mention it, I guess this was mentioned on a list …. So before libraries like this were kept in webapp or inside the app using it, now they are kept in eXide? This can't be the ideal solution.
>  

Sure not. It's a temporary solution. The plan is to move those shared resources into separate .xar packages, but - as Joe said - we need a working dependency management for this. I had a look at it recently and I think I can get it to work without too much effort - maybe before 2.0.

> My other idea is to merge the former "RESTful" function documentation
> browser into this one, so that we retain the ability to cite modules
> with clean URLs, like:
>  
> http://exist-db.org/apps/functions/xmldb/store
This would be great. The current page is fast for searching, but bad for browsing and referencing.

Wolfgang

[Exist-development] Function documentation app (fundocs, xqfdocs)

[Joe W. <jo...@gm...>]

Hi Jens,

(Moving this thread from exist-commits over to exist-development.)

> Oh, I see - now you mention it, I guess this was mentioned on a list …. So before libraries like this were kept in webapp or inside the app using it, now they are kept in eXide? This can't be the ideal solution.

Right, the ace javascript library (used for syntax highlighting) is a
dependency of eXide, Atomicwiki, the regular documentation app, and
the function documentation app, so the question is how to handle
dependencies.  We don't have a clear mechanism for declaring or
resolving dependencies with EXPath packages, so I guess for now we're
left with verbal instructions.  We could always just reference copies
of Ace hosted on CDNs, but if we want to retain the ability to run
these apps offline, we have to store the libraries somewhere.  An
unresolved issue, I'd say - but you're right, the current situation
isn't ideal.

> There are a few things that need to be fixed in the function docs app.
>
> 1) The dropdown has to note the location of the module. There are many version of modules with the same uri.
>
> 2) When you choose to browse one of these, you are always shown the same one.

Yes, I find this a little quirky too.  Right now modules are
identified only by namespace URI, leading to the phenomenon you
mentioned in #1.  I think the solution is to add an additional
identifier - full database URI - to the function documentation UI and
logic.  That would be a unique identifier that would let users see the
distinction between different modules with the same URI, and would let
the app display only the desired module.

As the list of modules grows (now that Wolfgang's module scanner finds
all modules so effectively), I imagine it will be easy for users to be
overwhelmed with the list of modules.  I think it would help to add a
distinction between "core" modules and "app" modules.  Core modules
would be fn, util, xmldb, etc. - perhaps simply those declared in
conf.xml.  These should appear at the top of the module dropdown list.
 The "app" modules would be all other modules found in the database.
Between the core and app modules we could have a horizontal rule - to
distinguish between the two groups.

> 3) The installed name "xqfdocs" and the repo name "fundocs" should be the same.

I agree - consistency is always good.  I personally would prefer a
more readily understandable app name like "functions" or "modules".

My other idea is to merge the former "RESTful" function documentation
browser into this one, so that we retain the ability to cite modules
with clean URLs, like:

  http://exist-db.org/apps/functions/xmldb/store

The module namespace URI collisions make such clean URLs tricky, but
still a desired end.

> I got some of 1) fixed, but I don't think I can finish it.

Cool.

Joe


> On Oct 10, 2012, at 4:28 PM, Joe Wicentowski <jo...@gm...> wrote:
>
>> Hi Jens,
>>
>> You're right that the function signature problem has to do with Ace.
>> The solution is to uninstall eXide and reinstall it from the public
>> repo.  It has an updated version of ace that works.
>>
>> Joe
>>
>> On Wed, Oct 10, 2012 at 9:20 AM, Jens Østergaard Petersen
>> <oe...@gm...> wrote:
>>> With me, with latest versions of just about everything, the function signatures do not show up in the function doc - there is a thickish black bar instead. The text is clipped away by some late-running js, probably ace, and the text appears to be black on dark gray early in its short life.
>>>
>>> .function .signature should probably have
>>>    height:1.25em;
>>>
>>> in style.css (which is not linked in page.html).
>>>
>>> I don't know how to deal with ace.
>>>
>>> Jens
>>>
>>> On Oct 6, 2012, at 12:45 AM, Joe Wicentowski <jo...@gm...> wrote:
>>>
>>>> Hi Wolfgang,
>>>>
>>>> I can confirm you have gotten it working!  Many thanks!
>>>>
>>>> Joe
>>>>
>>>> On Fri, Oct 5, 2012 at 5:19 PM,  <wol...@us...> wrote:
>>>>> Revision: 17239
>>>>>         http://sourceforge.net/p/exist/code/17239
>>>>> Author:   wolfgang_m
>>>>> Date:     2012-10-05 21:19:28 +0000 (Fri, 05 Oct 2012)
>>>>> Log Message:
>>>>> -----------
>>>>> [ignore] Fixed ace import path for code highlighting. Requires latest version of ace - and thus eXide - to be installed though.
>>>>
>>>> ------------------------------------------------------------------------------
>>>> 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-commits mailing list
>>>> Exi...@li...
>>>> https://lists.sourceforge.net/lists/listinfo/exist-commits
>>>
>

[Exist-development] Documentation app function and style

[Joe W. <jo...@gm...>]

Hi Loren,

> I like the look of the table in the editorial-view.  I am wonder how we would want to indicate the use of this style in the tables generated by our DocBook to HTML 5 conversion?
>
> <table class="table table-striped table-bordered table-hover">

I'm no DocBook expert, but I think @role is the generic attribute for
indicating style on DocBook elements, so, for example, one could take
the DocBook <table role="the-works"> and render it as your HTML <table
class="table table-striped table-bordered table-hover">.

But in this case, shall we just make it the default?

(For others, what we're talking about is a new table view in the doc
app I committed yesterday.  If you update your doc app to trunk,
package up your .xar, and deploy it, you'll see the page in question
at http://localhost:8080/exist/apps/doc/editorial-view.html.  I
applied the bootstrap css styles to the tables, which you can also see
at http://twitter.github.com/bootstrap/base-css.html#tables.)

Joe

Re: [Exist-development] Outstanding issues in the documentation

[Loren C. <lor...@gm...>]

I like the look of the table in the editorial-view.  I am wonder how we would want to indicate the use of this style in the tables generated by our DocBook to HTML 5 conversion?


<table class="table table-striped table-bordered table-hover">

Re: [Exist-development] prepare-extensions ANT target gone/replaced?

[Leif-Jöran O. <lj...@ex...>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Den 2012-10-09 22:21, Andrzej Jan Taramina skrev:
> Just noticed the prepare-extensions ant target is gone.
> 
> Was this replaced with a different target perhaps?
> 
> Thanks!

Thanks. I will check this as a step in my documentation review of the
ant tasks article.

> Yeah...I'm still around..just been super busy with work things.

Great to hear!


-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.18 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://www.enigmail.net/

iD8DBQFQdU1bhcIn5aVXOPIRAi2DAJ0Ziwvz3uMOWk2QpbOq13VfkHCLXwCfYnPi
v8uLVLo3kRzvGen4yupmjhk=
=+6p2
-----END PGP SIGNATURE-----

[Exist-development] prepare-extensions ANT target gone/replaced?

[Andrzej J. T. <an...@ch...>]

Just noticed the prepare-extensions ant target is gone.

Was this replaced with a different target perhaps?

Thanks!

Yeah...I'm still around..just been super busy with work things.

-- 
Andrzej Taramina
Chaeron Corporation: Enterprise System Solutions
http://www.chaeron.com

Re: [Exist-development] Outstanding issues in the documentation

[Joe W. <jo...@gm...>]

Thanks, Dmitriy and Wolfgang.  I've incorporated this info in to the
updated draft of apps/doc/data/xquery.xml.

Joe

Re: [Exist-development] Outstanding issues in the documentation

[Wolfgang M. <wol...@ex...>]

> * The xqts.exist-db.org (http://xqts.exist-db.org) site is unreachable. Is this temporary, or
> should I remove the link?

Better remove it. We have too many server addresses to maintain.
> * Is the "99%" figure unchanged?

It applies to XQuery 1.0 and is still true in that respect (99.4%). For XQuery 3.0, Dmitriy just started to integrate the tests, so we cannot say anything there yet.

Wolfgang

Re: [Exist-development] Outstanding issues in the documentation

[Wolfgang M. <wol...@ex...>]

> * Could you please confirm if XQuery Caching is still activated? I
> thought it was disabled several years ago.

We still do XQuery caching as described in that section.

Wolfgang

Re: [Exist-development] Outstanding issues in the documentation

[Joe W. <jo...@gm...>]

The XQuery article also references "XQuery Caching":

"XQuery modules executed via the REST interface, the XQueryServlet or
                XQueryGenerator are <emphasis>automatically</emphasis>
cached: the compiled
                expression will be added to an internal pool of
prepared queries. The next time a
                query or module is loaded from the same location, it
will not be compiled again.
                Instead, the already compiled code is reused. The code
will only be recompiled if
                eXist-db decides that the source was modified or it
wasn't used for a longer period of
                time."

* Could you please confirm if XQuery Caching is still activated?  I
thought it was disabled several years ago.

Re: [Exist-development] Outstanding issues in the documentation

[Joe W. <jo...@gm...>]

Hi Dmitriy,

> I did prepare QT3 test suite runner (at trunk). Maybe better to reference to
> results for QT3?

By "QT3", you're referring to http://dev.w3.org/2011/QT3-test-suite/?

If the test is up to date and accurate, I would happily replace the
references to XQTS with QT3, and change the 99% number to whatever the
current results are.  What are the results?

Joe

Re: [Exist-development] Outstanding issues in the documentation

[Dmitriy S. <sha...@gm...>]

On Tue, Oct 9, 2012 at 8:03 PM, Joe Wicentowski <jo...@gm...> wrote:

>
> The Status of XQuery Support document states, "As of November 2007,
> eXist-db passes more than 99% of the test suite, but we are
> continuously trying to improve these results. Current test results are
> reported on the <ulink url="http://xqts.exist-db.org/">web
> site</ulink>."
>
> Action issues:
>
> * The xqts.exist-db.org site is unreachable.  Is this temporary, or
> should I remove the link?
>
> * Is the "99%" figure unchanged?
>
>
I did prepare QT3 test suite runner (at trunk). Maybe better to reference
to results for QT3?

-- 
Dmitriy Shabanov

[Exist-development] Outstanding issues in the documentation

[Joe W. <jo...@gm...>]

Hi all,

I'm going to use this thread to discuss outstanding issues in the
documentation that I would consider "blockers" on the 2.0 release.
I'd greatly appreciate everyone's help in resolving these.  To start:

The Status of XQuery Support document states, "As of November 2007,
eXist-db passes more than 99% of the test suite, but we are
continuously trying to improve these results. Current test results are
reported on the <ulink url="http://xqts.exist-db.org/">web
site</ulink>."

Action issues:

* The xqts.exist-db.org site is unreachable.  Is this temporary, or
should I remove the link?

* Is the "99%" figure unchanged?

Thanks,
Joe

Re: [Exist-development] Dashboard app source

[Joe W. <jo...@gm...>]

Hi Wolfgang,

> Right now the source code is in our internal git, but I will move it to a public repository when I have time. In the meantime, please just send me your fix and I will integrate it.

Okay, here's the fix:

Change login.xql line 70 from:

    empty($entry("expires")) or util:system-dateTime() < $entry("expires")

to:

    empty($entry("expires")) or util:system-dateTime() <
xs:dateTime($entry("expires"))

The error message that led me to this fix was:

09 Oct 2012 08:39:27,607 [eXistThread-38] WARN  (ServletHandler.java
[doHandle]:553) - /exist/apps/dashboard/plugins/backup/images/icon.png
org.exist.xquery.XPathException: exerr:ERROR Type error: cannot
compare xs:dateTime to xs:string [at line 85, column 32]
In function:
	login:is-valid(map*) [85:32:/db/dashboard/modules/login.xql]
	login:get-credentials(xs:string*, xs:string*, xs:boolean*)
[47:35:/db/dashboard/modules/login.xql]
	login:set-user(xs:string*, xs:dayTimeDuration?, xs:boolean*)
[101:15:/db/dashboard/modules/login.xql]
	at org.exist.xquery.value.AbstractDateTimeValue.compareTo(AbstractDateTimeValue.java:271)
	at org.exist.xquery.value.AbstractDateTimeValue.compareTo(AbstractDateTimeValue.java:251)

Joe

Re: [Exist-development] Dashboard app source

[Wolfgang M. <wol...@ex...>]

Hi Joe,
> Is the dashboard app in a source code repository? I just encountered
> a bug in the login.xql module and have a fix I could commit. Or, if
> the source code is closed, I can post the fix - here, I assume?

Right now the source code is in our internal git, but I will move it to a public repository when I have time. In the meantime, please just send me your fix and I will integrate it.

Wolfgang

Re: [Exist-development] A proposed addition to the XQDocs

[McBeath, D. W (ELS-STL) <D.M...@el...>]

Loren.

This sounds like a good idea.  Please proceed.  You may also want to discuss this with James Fuller as well and his implementation of 'xquerydoc' available on github (https://github.com/xquery/xquerydoc).

Darin.

From: Loren Cahlander <lor...@gm...<mailto:lor...@gm...>>
Date: Sunday, October 7, 2012 9:09 PM
To: Casey Jordan <cas...@jo...<mailto:cas...@jo...>>
Cc: "exi...@li...<mailto:exi...@li...>" <exi...@li...<mailto:exi...@li...>>, Darin McBeath <d.m...@el...<mailto:d.m...@el...>>
Subject: Re: [Exist-development] A proposed addition to the XQDocs

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...<mailto: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...<mailto: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...<mailto: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...<mailto: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<http://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.

[Exist-development] Dashboard app source

[Joe W. <jo...@gm...>]

Hi all,

Is the dashboard app in a source code repository?  I just encountered
a bug in the login.xql module and have a fix I could commit.  Or, if
the source code is closed, I can post the fix - here, I assume?

Joe

Re: [Exist-development] Requesting the addition of exist-development to markmail

[ron.vandenbranden <ron...@ka...>]

Thanks Adam,

It was just a matter of minutes before Jason had loaded the archives:
     <http://exist-development.markmail.org/>
     <http://exist-teixml.markmail.org/>

Wonderfully smooth, many thanks again to Jason!

Best,

Ron

On 8/10/2012 21:24, Adam Retter wrote:
> I managed to export these from SourceForge, they should be in mbox
> format, you can these here -
>
> http://dl.dropbox.com/u/35135948/exist-development.eml.bz2
> http://dl.dropbox.com/u/35135948/exist-teixml.eml.bz2
>
> Thanks Adam.
>

Re: [Exist-development] Requesting the addition of exist-development to markmail

[Adam R. <ad...@ex...>]

I managed to export these from SourceForge, they should be in mbox
format, you can these here -

http://dl.dropbox.com/u/35135948/exist-development.eml.bz2
http://dl.dropbox.com/u/35135948/exist-teixml.eml.bz2

Thanks Adam.

On 8 October 2012 08:50, ron.vandenbranden <ron...@ka...> wrote:
> Hi Joe,
>
> On 7/10/2012 0:56, Joe Wicentowski wrote:
>> Does anyone have the archive of exist-development in mbox format?
>>
>
> Supposedly, the list admins can get it out of sourceforge. If you (Joe)
> don't administer the exist-teixml list, it's probably Dannes who can
> provide this for exist-development and exist-teixml?
>
> Best,
>
> Ron
>
> ------------------------------------------------------------------------------
> 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



-- 
Adam Retter

eXist Developer
{ United Kingdom }
ad...@ex...
irc://irc.freenode.net/existdb

Re: [Exist-development] Requesting the addition of exist-development to markmail

[ron.vandenbranden <ron...@ka...>]

Hi Joe,

On 7/10/2012 0:56, Joe Wicentowski wrote:
> Does anyone have the archive of exist-development in mbox format?
>

Supposedly, the list admins can get it out of sourceforge. If you (Joe) 
don't administer the exist-teixml list, it's probably Dannes who can 
provide this for exist-development and exist-teixml?

Best,

Ron

Re: [Exist-development] A proposed addition to the XQDocs

[Loren C. <lor...@gm...>]

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.
>> 
> 

Re: [Exist-development] Request for feedback about certain documentation articles

[Wolfgang M. <wol...@ex...>]

Hi Joe, 
> 1. I think I might have made an error by importing the following files
> into the "doc" app:
> 
> - acknowledge.xml
> - community.xml
> - credits.xml
> - facts.xml
> - index.xml
> - roadmap.xml

We still need to prepare a new homepage for exist-db.org where those documents will appear. Compared to the current homepage, we planned to have a very reduced, clean design, so just a few key points which link into the appropriate articles in documentation. 
> 
> 3. One article, xinclude.xml, has several associated files, including
> an .xq file. Such files can't be in the doc app anymore, but rather
> need to have their own demo app. Is anyone an avid enough XInclude
> user that they could volunteer to clean up this article and create a
> demo app?
> 
Right, this should go into the general demo app.

Wolfgang