[jira] [Commented] (JEXL-233) Documentation rewrite

["Dmitri Blinov (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/JEXL-233?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16071052#comment-16071052 ] 

Dmitri Blinov commented on JEXL-233:
------------------------------------

There are so many ways to tell a strory, indeed. So, first we need to agree what kind of documentation we need, or how it should be organized. From similar scripting language projects I see that every language comes with either a language reference or language specification. The documentation usualy contains a brief introduction, syntax overview, and then continues with more deep dive about operator behaviour, property resolution order, type casting, integration, customization etc. Examples are usually placed inside the sections they are to illustrate. I think we need the same language reference, with syntax overview for end-users being a chapter at the beginning. So we need to stop thinking about syntax.xml and start thinking about reference.xml to put everything in order

> Documentation rewrite
> ---------------------
>
>                 Key: JEXL-233
>                 URL: https://issues.apache.org/jira/browse/JEXL-233
>             Project: Commons JEXL
>          Issue Type: Improvement
>    Affects Versions: 3.1
>            Reporter: Dmitri Blinov
>            Priority: Minor
>         Attachments: syntax.xml
>
>
> I have reorganized the JEXL syntax doc, basically adjusted the document structure to be more logical in my view, and brushed up some descriptions.
> Comments are welcome! If it is ok, please promote the attachment to the source tree. 



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)