[dna-issues] [JBoss JIRA] Updated: (DNA-621) Document search/query languages in the Reference Guide

[Brian Carothers (JIRA)]

     [ https://jira.jboss.org/jira/browse/DNA-621?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Brian Carothers updated DNA-621:
--------------------------------

    Attachment: DNA-621_gs_review_bc.patch


Attached my feedback from proofing the Getting Started Guide.  A bit of minor grammatical clean-up and some refactoring of code examples to avoid horizontal scrollbars.  Overall, it looked great.  Nice job!

> Document search/query languages in the Reference Guide
> ------------------------------------------------------
>
>                 Key: DNA-621
>                 URL: https://jira.jboss.org/jira/browse/DNA-621
>             Project: DNA
>          Issue Type: Task
>          Components: Documentation, Query, Search
>    Affects Versions: 0.7
>            Reporter: Randall Hauch
>            Assignee: Randall Hauch
>            Priority: Blocker
>             Fix For: 0.7
>
>         Attachments: DNA-621_gs_review_bc.patch
>
>
> We probably want to have a section/chapter in the Reference Guide that presents the different languages.  We probably just need to have a bit of intro (list the different languages, maybe show how to use them via JCR API), and then describe the different languages in detail.  The SQL language and full-text search parsers have pretty good JavaDoc, and we can probably just lift it and reformat it for DocBook.  And for XPath, we should be able to just reference the appropriate sections in the JCR 1.0 specification (perhaps linking to the online versions hosted by Day).  

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira