jackrabbit-oak-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Vikas Saurabh (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (OAK-5051) Document XPath (and SQL-2) syntax as supported by Oak
Date Sun, 04 Feb 2018 17:54:00 GMT

    [ https://issues.apache.org/jira/browse/OAK-5051?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16351851#comment-16351851

Vikas Saurabh commented on OAK-5051:

Btw, on [~chetanm]'s (offline) request, here's published page - https://catholicon.github.io/railroad-output/query/grammar-xpath.html.

[~tmueller], btw, once you get around to check it out, I would like to mention a few things:
* the macro loads the grammar csv, but renders only what's requested (it doesn't load the
csv every time as one site plugin activation instantiates one instance of the macro)
* renamed {{grammar-xpath.md}} to {{grammar-xpath.md.vm}} as that allowed me to put grammar
csv in {{oak-doc}} project instead of an embedded resource in {{oak-doc-railroad-macro}} project
** it has a minor downside though - since velocity reserves {{#}} for its own macro language,
so I had to utilize a small hack to bring up Markdown's headings (which are {{#}}, or {{##}},
* while, I'm pretty happy with the current impl of macro and how it's reading grammar csv
(from consuming project), we still need to review:
** grammar
** nomenclature of new class and packages

> Document XPath (and SQL-2) syntax as supported by Oak
> -----------------------------------------------------
>                 Key: OAK-5051
>                 URL: https://issues.apache.org/jira/browse/OAK-5051
>             Project: Jackrabbit Oak
>          Issue Type: Documentation
>          Components: query
>            Reporter: Thomas Mueller
>            Assignee: Thomas Mueller
>            Priority: Major
> The JCR 2.0 SQL-2 language is documented at http://h2database.com/jcr/grammar.html
> But extensions to that are not documented. And XPath (as supported by Oak) is not documented
at all.
> It would be good to have such a documentation, with examples.

This message was sent by Atlassian JIRA

View raw message