exist-db / function-documentation Goto Github PK

View Code? Open in Web Editor NEW

5.0 16.0 14.0 540 KB

XQuery Function Documentation and Browser App

License: GNU Lesser General Public License v2.1

HTML 23.37% XQuery 43.75% CSS 24.34% JavaScript 8.54%

exist-db xquery documentation xar

function-documentation's Introduction

eXist-db Function Documentation Browser App

This repository contains the function documentation borwser app for the eXist-db native XML database.

Dependencies

Maven: 3.5.2
eXist-db: 4.0.0

Installation

Just go to your eXist server's Dashboard and select Function Documentation.
Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at http://exist-db.org/exist/apps/public-repo/.

Building from source

Clone the repository to your system:

$ git clone https://github.com/exist-db/function-documentation.git

Build the function documentation application:
```
$ cd function-documentation
$ mvn clean package
```
The compiled .xar file is located in the /target directory
Install this file via the Dashboard > Package Manager.

License

LGPLv2.1 eXist-db.org

function-documentation's People

Contributors

Stargazers

Watchers

Forkers

dizzzz jensopetersen ljo joewiz duncdrum adamretter line-o wolfgangmm agh2342 existsolutions tohuuuuu isabella232 evolvedbinary bryanchance

function-documentation's Issues

fix broken links

Links

in http://localhost:8085/exist/apps/doc/util.xml the link to 'Function Documentation Library' is broken (points to /exist/apps/xqfdocs)

all functions from http://exist-db.org/xquery/app are missing documentation

see exist-db.org

How to add the "Read More"-button to an entry in the function documentation?

@duncdrum Could you refresh my memory how to add the "read more" button to an entry in the function documentation?

Originally posted by @line-o in eXist-db/documentation#411 (comment)

EXpath and EXQuery Modules are Missing in the Function Browser

See: http://exist-db.org/exist/apps/fundocs/browse.html?extensions=true

Line https://github.com/eXist-db/function-documentation/blob/master/modules/app.xql#L395 seems to be the problem since modules starting with "http://expath.org/ns/" and "http://exquery.org/ns/" are filtered out by the predicate.

I'm happy to provide a patch if you like! In this case, please let me know if you like an extra filter button for the EXPath and the EXQuery module or if you like those modules appear under "Extension functions" as well.

Jochen

fundoc not working in eXist v5

Scenario: Plain eXist-db v5, install fundoc via app manager. access fundoc app:

HTTP ERROR 500
Problem accessing /exist/apps/fundocs/. Reason:

    Server Error
Caused by:
javax.servlet.ServletException: javax.servlet.ServletException: An error occurred while processing request to /exist/apps/fundocs/: err:XPST0017 Function xmldb:is-admin-user()  is not defined in module namespace: http://exist-db.org/xquery/xmldb [at line 30, column 48]
	at org.eclipse.jetty.server.handler.HandlerCollection.handle(HandlerCollection.java:146)
	at org.eclipse.jetty.server.handler.gzip.GzipHandler.handle(GzipHandler.java:753)
	at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:132)
	at org.eclipse.jetty.server.Server.handle(Server.java:502)
	at org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:364)
	at org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:260)
	at org.eclipse.jetty.io.AbstractConnection$ReadCallback.succeeded(AbstractConnection.java:305)
	at org.eclipse.jetty.io.FillInterest.fillable(FillInterest.java:103)
	at org.eclipse.jetty.io.ChannelEndPoint$2.run(ChannelEndPoint.java:118)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.runTask(EatWhatYouKill.java:333)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.doProduce(EatWhatYouKill.java:310)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.tryProduce(EatWhatYouKill.java:168)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.run(EatWhatYouKill.java:126)
	at org.eclipse.jetty.util.thread.ReservedThreadExecutor$ReservedThread.run(ReservedThreadExecutor.java:366)
	at org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:765)
	at org.eclipse.jetty.util.thread.QueuedThreadPool$2.run(QueuedThreadPool.java:683)
	at java.lang.Thread.run(Thread.java:748)
Caused by: javax.servlet.ServletException: An error occurred while processing request to /exist/apps/fundocs/: err:XPST0017 Function xmldb:is-admin-user()  is not defined in module namespace: http://exist-db.org/xquery/xmldb [at line 30, column 48]
	at org.exist.http.urlrewrite.XQueryURLRewrite.service(XQueryURLRewrite.java:371)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:790)
	at org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:859)
	at org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:542)
	at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:146)
	at org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:524)
	at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:132)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:257)
	at org.eclipse.jetty.server.session.SessionHandler.doHandle(SessionHandler.java:1588)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:255)
	at org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1345)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:203)
	at org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:480)
	at org.eclipse.jetty.server.session.SessionHandler.doScope(SessionHandler.java:1557)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:201)
	at org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1247)
	at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:144)
	at org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:220)
	at org.eclipse.jetty.server.handler.HandlerCollection.handle(HandlerCollection.java:126)
	... 16 more
Caused by: org.exist.xquery.XPathException: err:XPST0017 Function xmldb:is-admin-user()  is not defined in module namespace: http://exist-db.org/xquery/xmldb [at line 30, column 48]
	at org.exist.xquery.FunctionFactory.getInternalModuleFunction(FunctionFactory.java:294)
	at org.exist.xquery.FunctionFactory.functionCall(FunctionFactory.java:261)
	at org.exist.xquery.FunctionFactory.createFunction(FunctionFactory.java:94)
	at org.exist.xquery.FunctionFactory.createFunction(FunctionFactory.java:55)
	at org.exist.xquery.FunctionFactory.createFunction(FunctionFactory.java:51)
	at org.exist.xquery.parser.XQueryTreeParser.functionCall(XQueryTreeParser.java:11190)
	at org.exist.xquery.parser.XQueryTreeParser.primaryExpr(XQueryTreeParser.java:7776)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:3561)
	at org.exist.xquery.parser.XQueryTreeParser.constructor(XQueryTreeParser.java:10695)
	at org.exist.xquery.parser.XQueryTreeParser.constructor(XQueryTreeParser.java:10554)
	at org.exist.xquery.parser.XQueryTreeParser.constructor(XQueryTreeParser.java:10554)
	at org.exist.xquery.parser.XQueryTreeParser.primaryExpr(XQueryTreeParser.java:7564)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:3561)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:330)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:833)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:2620)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:423)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:426)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:426)
	at org.exist.xquery.parser.XQueryTreeParser.mainModule(XQueryTreeParser.java:4044)
	at org.exist.xquery.parser.XQueryTreeParser.module(XQueryTreeParser.java:3987)
	at org.exist.xquery.parser.XQueryTreeParser.xpath(XQueryTreeParser.java:3642)
	at org.exist.xquery.XQuery.compile(XQuery.java:128)
	at org.exist.xquery.XQuery.compile(XQuery.java:79)
	at org.exist.xquery.XQuery.compile(XQuery.java:71)
	at org.exist.http.urlrewrite.XQueryURLRewrite.runQuery(XQueryURLRewrite.java:669)
	at org.exist.http.urlrewrite.XQueryURLRewrite.service(XQueryURLRewrite.java:243)
	... 34 more
Caused by:
javax.servlet.ServletException: An error occurred while processing request to /exist/apps/fundocs/: err:XPST0017 Function xmldb:is-admin-user()  is not defined in module namespace: http://exist-db.org/xquery/xmldb [at line 30, column 48]
	at org.exist.http.urlrewrite.XQueryURLRewrite.service(XQueryURLRewrite.java:371)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:790)
	at org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:859)
	at org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:542)
	at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:146)
	at org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:524)
	at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:132)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:257)
	at org.eclipse.jetty.server.session.SessionHandler.doHandle(SessionHandler.java:1588)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:255)
	at org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1345)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:203)
	at org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:480)
	at org.eclipse.jetty.server.session.SessionHandler.doScope(SessionHandler.java:1557)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:201)
	at org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1247)
	at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:144)
	at org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:220)
	at org.eclipse.jetty.server.handler.HandlerCollection.handle(HandlerCollection.java:126)
	at org.eclipse.jetty.server.handler.gzip.GzipHandler.handle(GzipHandler.java:753)
	at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:132)
	at org.eclipse.jetty.server.Server.handle(Server.java:502)
	at org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:364)
	at org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:260)
	at org.eclipse.jetty.io.AbstractConnection$ReadCallback.succeeded(AbstractConnection.java:305)
	at org.eclipse.jetty.io.FillInterest.fillable(FillInterest.java:103)
	at org.eclipse.jetty.io.ChannelEndPoint$2.run(ChannelEndPoint.java:118)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.runTask(EatWhatYouKill.java:333)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.doProduce(EatWhatYouKill.java:310)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.tryProduce(EatWhatYouKill.java:168)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.run(EatWhatYouKill.java:126)
	at org.eclipse.jetty.util.thread.ReservedThreadExecutor$ReservedThread.run(ReservedThreadExecutor.java:366)
	at org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:765)
	at org.eclipse.jetty.util.thread.QueuedThreadPool$2.run(QueuedThreadPool.java:683)
	at java.lang.Thread.run(Thread.java:748)
Caused by: org.exist.xquery.XPathException: err:XPST0017 Function xmldb:is-admin-user()  is not defined in module namespace: http://exist-db.org/xquery/xmldb [at line 30, column 48]
	at org.exist.xquery.FunctionFactory.getInternalModuleFunction(FunctionFactory.java:294)
	at org.exist.xquery.FunctionFactory.functionCall(FunctionFactory.java:261)
	at org.exist.xquery.FunctionFactory.createFunction(FunctionFactory.java:94)
	at org.exist.xquery.FunctionFactory.createFunction(FunctionFactory.java:55)
	at org.exist.xquery.FunctionFactory.createFunction(FunctionFactory.java:51)
	at org.exist.xquery.parser.XQueryTreeParser.functionCall(XQueryTreeParser.java:11190)
	at org.exist.xquery.parser.XQueryTreeParser.primaryExpr(XQueryTreeParser.java:7776)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:3561)
	at org.exist.xquery.parser.XQueryTreeParser.constructor(XQueryTreeParser.java:10695)
	at org.exist.xquery.parser.XQueryTreeParser.constructor(XQueryTreeParser.java:10554)
	at org.exist.xquery.parser.XQueryTreeParser.constructor(XQueryTreeParser.java:10554)
	at org.exist.xquery.parser.XQueryTreeParser.primaryExpr(XQueryTreeParser.java:7564)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:3561)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:330)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:833)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:2620)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:423)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:426)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:426)
	at org.exist.xquery.parser.XQueryTreeParser.mainModule(XQueryTreeParser.java:4044)
	at org.exist.xquery.parser.XQueryTreeParser.module(XQueryTreeParser.java:3987)
	at org.exist.xquery.parser.XQueryTreeParser.xpath(XQueryTreeParser.java:3642)
	at org.exist.xquery.XQuery.compile(XQuery.java:128)
	at org.exist.xquery.XQuery.compile(XQuery.java:79)
	at org.exist.xquery.XQuery.compile(XQuery.java:71)
	at org.exist.http.urlrewrite.XQueryURLRewrite.runQuery(XQueryURLRewrite.java:669)
	at org.exist.http.urlrewrite.XQueryURLRewrite.service(XQueryURLRewrite.java:243)
	... 34 more
Caused by:
org.exist.xquery.XPathException: err:XPST0017 Function xmldb:is-admin-user()  is not defined in module namespace: http://exist-db.org/xquery/xmldb [at line 30, column 48]
	at org.exist.xquery.FunctionFactory.getInternalModuleFunction(FunctionFactory.java:294)
	at org.exist.xquery.FunctionFactory.functionCall(FunctionFactory.java:261)
	at org.exist.xquery.FunctionFactory.createFunction(FunctionFactory.java:94)
	at org.exist.xquery.FunctionFactory.createFunction(FunctionFactory.java:55)
	at org.exist.xquery.FunctionFactory.createFunction(FunctionFactory.java:51)
	at org.exist.xquery.parser.XQueryTreeParser.functionCall(XQueryTreeParser.java:11190)
	at org.exist.xquery.parser.XQueryTreeParser.primaryExpr(XQueryTreeParser.java:7776)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:3561)
	at org.exist.xquery.parser.XQueryTreeParser.constructor(XQueryTreeParser.java:10695)
	at org.exist.xquery.parser.XQueryTreeParser.constructor(XQueryTreeParser.java:10554)
	at org.exist.xquery.parser.XQueryTreeParser.constructor(XQueryTreeParser.java:10554)
	at org.exist.xquery.parser.XQueryTreeParser.primaryExpr(XQueryTreeParser.java:7564)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:3561)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:330)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:833)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:2620)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:423)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:426)
	at org.exist.xquery.parser.XQueryTreeParser.expr(XQueryTreeParser.java:426)
	at org.exist.xquery.parser.XQueryTreeParser.mainModule(XQueryTreeParser.java:4044)
	at org.exist.xquery.parser.XQueryTreeParser.module(XQueryTreeParser.java:3987)
	at org.exist.xquery.parser.XQueryTreeParser.xpath(XQueryTreeParser.java:3642)
	at org.exist.xquery.XQuery.compile(XQuery.java:128)
	at org.exist.xquery.XQuery.compile(XQuery.java:79)
	at org.exist.xquery.XQuery.compile(XQuery.java:71)
	at org.exist.http.urlrewrite.XQueryURLRewrite.runQuery(XQueryURLRewrite.java:669)
	at org.exist.http.urlrewrite.XQueryURLRewrite.service(XQueryURLRewrite.java:243)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:790)
	at org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:859)
	at org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:542)
	at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:146)
	at org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:524)
	at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:132)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:257)
	at org.eclipse.jetty.server.session.SessionHandler.doHandle(SessionHandler.java:1588)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:255)
	at org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1345)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:203)
	at org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:480)
	at org.eclipse.jetty.server.session.SessionHandler.doScope(SessionHandler.java:1557)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:201)
	at org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1247)
	at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:144)
	at org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:220)
	at org.eclipse.jetty.server.handler.HandlerCollection.handle(HandlerCollection.java:126)
	at org.eclipse.jetty.server.handler.gzip.GzipHandler.handle(GzipHandler.java:753)
	at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:132)
	at org.eclipse.jetty.server.Server.handle(Server.java:502)
	at org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:364)
	at org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:260)
	at org.eclipse.jetty.io.AbstractConnection$ReadCallback.succeeded(AbstractConnection.java:305)
	at org.eclipse.jetty.io.FillInterest.fillable(FillInterest.java:103)
	at org.eclipse.jetty.io.ChannelEndPoint$2.run(ChannelEndPoint.java:118)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.runTask(EatWhatYouKill.java:333)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.doProduce(EatWhatYouKill.java:310)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.tryProduce(EatWhatYouKill.java:168)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.run(EatWhatYouKill.java:126)
	at org.eclipse.jetty.util.thread.ReservedThreadExecutor$ReservedThread.run(ReservedThreadExecutor.java:366)
	at org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:765)
	at org.eclipse.jetty.util.thread.QueuedThreadPool$2.run(QueuedThreadPool.java:683)
	at java.lang.Thread.run(Thread.java:748)

noise.png

The image noise.png is referred to in fundocs.css, but it does not exist, causing errors when searching. For some reason, the error only happens in Firefox on Mac OS, whereas the bad reference to url(http://exist-db.org/exist/apps/fundocs/resources/images/noise.png) is passed over in Chrome and Safari.

[feature-request] linking to search results

When responding to user question it would be helpful to not have to Rest-style URL for a set of search results.

eg.: search the docs for export -> url stays http://www.exist-db.org/exist/apps/fundocs/index.html

to point users to the results i have to it would be easier if we could http://www.exist-db.org/exist/apps/fundocs/index.html?q=exports

Move Travis CI (inactive) to GitHub Actions

We have lots of dependabot PRs but no CI running to test them.

This repo is still configured to use Travis CI, which is inactive for our repo. See https://github.com/eXist-db/function-documentation/blob/master/.travis.yml.

We need a similar PR here as eXist-db/documentation#597.

Errors in exist.log when opening app

exist.log reports many lines of:

2018-02-14 18:50:50,030 [qtp1616515493-80] ERROR (FunError.java [eval]:139) - Not found: (http://exist-db.org/apps/site-utils#NOT_FOUND):Not found

exist 4.0.0
fundocs 0.9
java 8
macOS 10.13.3

Cache Module Documentation Is Missing

Where is the problem

eXist-db's XQuery Function Library documentation does not include the Cache module's functions.

What is the problem

The following Cache module functions are missing from the documentation.
cache:cleanup($cache-name as xs:string)
cache:clear($cache-name as xs:string)
cache:clear()
cache:create($cache-name as xs:string, $config as map())
cache:destroy($cache-name as xs:string)
cache:get($cache-name as xs:string, $key as xs:anyType+)
cache:keys($cache-name as xs:string)
cache:list($cache-name as xs:string, $keys as xs:anyType)
cache:names()
cache:put($cache-name as xs:string, $key as xs:anyType+, $value as item()*)
cache:remove($cache-name as xs:string, $key as xs:anyType+)

missing sem-ver declaration produces errors in expath-repo.log

2017-07-05 12:08:34,909 [Thread-3] WARN  (ClasspathHelper.java [scanPackages]:90) - Package http://exist-db.org/apps/fundocs is not compatible with this version of eXist. To avoid conflicts, Java libraries shipping with this package are not loaded.

The fix seems straight-forward PR will follow

[BUG] Typo when you've not yet generated function docs

eXist db 5.2

When you go your function documentation and you've never generated that before, you will see a message with a typo (double 'the')

The function documentation has not been generated yet. Please contact the database administrator in order to have the the function documentation generated.

The source of that message seems to be here:

https://github.com/eXist-db/function-documentation/blob/master/src/main/xar-resources/index.html

search for deprecated functions

It would be useful to be able to search for functions which are deprecated

xqDoc annotations

In the master branch, commit 7ba4f551eedf82ed75357992bf6bd1aecf638839, some xqDoc annotation functionality seems to be broken:
In the code below, @see is not working as I expect. The following code produces the attached documentation, where @see is omitted.

(:~
 : This module …
 : 
 : @see http://www.example.org/
 : @author Christian Forster
 : @version 0.1
 :)

Other issues occur in the functx documentation. The comment in its source code contains an email address and everything from the "@" part on does not appear in the generated documentation.
Also, within that module @author, @version, and @see annotations in function comments are ignored.

Generate documentation never stops

when pressing the 'update documentation' button, the button never indicates the process is finished.

cross links to documentation apps are broken

for some strange reason links containing {doc} no longer work.
Go to fundocs on exist-db.org (also tested on local). Now select any of the footer or navbar links to the documentation app example Legal in the footer

let's keep the discussion at eXist-db/documentation#154

add app permissions

in light of our last community call fundocs would be a use case for app-specific permissions, it doesn't have them right now.

Function documentation shows old information

@eriksiegel commented on Oct 8, 2018, 2:28 PM UTC:

What is the problem

If you create an XQuery module yourself with XQdoc comments, in some cases you see old information which does not go away on a regenerate.

What did you expect

Consistent information displayed by the fundocs app

Describe how to reproduce or add a test

Add a module with XQdoc in it to the database (anywhere). Here is an example: testmod.zip
Go to fundocs (as admin) and regenerate.
Search for "blah". The new module and function should show up.
Click on the namespace (http://www.xatapult.com/ns/testmod) in the grey-background header. You get the module's information.
Now change something in the XQdoc of the module and save
Regenerate the fundocs
Re-search on "blah". You should see the applied changes to the XQdoc
Click on the namespace again. The information there is old, it shows the previous XQdoc version.

Context information

eXist version: 4.4.0 (Build 201809211803)
Java version 1.8.0_181
Operating system W10 (source) and Unix (dest)
64 bit
JAR installed
Any custom changes in e.g. conf.xml?
- Data and Journal directory moved to outside eXist installation directory
- Global cache module enables
- RestXQ and expath auto deploy trigger disabled

This issue was moved by duncdrum from eXist-db/exist#2199.

Significant difference between 'repo' and software archive

During preparation of the XAR for the upcoming release, I see a significant difference in the file templates/page.html , between the XAR in the public repo (labeled 0.7) and the code in GitHub (labeled 0.6).

any idea? @wolfgangmm ?

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.