[seam-issues] [JBoss JIRA] Updated: (SEAMXML-33) Misc documentation issues

[Jozef Hartinger (JIRA)]

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

Jozef Hartinger updated SEAMXML-33:
-----------------------------------

    Description: 
* index.html says "Alternative metadata sources for defining and configuration beans". IMO it should be
** "Alternative metadata sources for defining and configuration of beans" or
** "Alternative metadata sources for bean definition and configuration"
* Section 1.1. talks about "Weld Extensions JAR"
* A warning in Section 1.1. says that one should not put the configuration file in the web context, however SEAMXML-10 seems to resolve the problem
* The warning in Section 1.1 says : "it is recommended that you define your beans in WEB-INF/classes/META-INF/seam-beans.xml" while the very next sentese in the following paragraph says: "The beans.xml file is the preferred way of configuring beans via XML"
It is unclear if one should use beans.xml or seam-beans.xml
* Section 1.2 "The princess rescue example is a sample web app that uses Seam XML" -> should be Seam Config
* Section 2.1 "The main namespace is urn:java:ee contains builtin tags and types from core packages."
** should be "The main namespace is urn:java:ee. This namespace contains built-in tags and types from core packages."
* section 2.1 contains typo "namspaces"
* Section 2.1 - sample "my" namespace is defined, later in the text, the configured bean is referenced as <ns:Report> - should be <my:Report>
* 2.9 
** Weld Extensions
** typo "exmaple"

  was:
* index.html says "Alternative metadata sources for defining and configuration beans". IMO it should be
** "Alternative metadata sources for defining and configuration of beans" or
** "Alternative metadata sources for bean definition and configuration"
* Section 1.1. talks about "Weld Extensions JAR"
* A warning in Section 1.1. says that one should not put the configuration file in the web context, however SEAMXML-10 seems to resolve the problem
* The warning in Section 1.1 says : "it is recommended that you define your beans in WEB-INF/classes/META-INF/seam-beans.xml" while the very next sentese in the following paragraph says: "The beans.xml file is the preferred way of configuring beans via XML"
It is unclear if one should use beans.xml or seam-beans.xml
* Section 1.2 "The princess rescue example is a sample web app that uses Seam XML" -> should be Seam Config
* Section 2.1 "The main namespace is urn:java:ee contains builtin tags and types from core packages."
** should be "The main namespace is urn:java:ee. This namespace contains built-in tags and types from core packages."
* section 2.1 contains typo "namspaces"
* Section 2.1 - sample "my" namespace is defined, later in the text, the configured bean is referenced as <ns:Report> - should be <my:Report>
* 2.9 
** Weld Extensions
** type "exmaple"



> Misc documentation issues
> -------------------------
>
>                 Key: SEAMXML-33
>                 URL: https://issues.jboss.org/browse/SEAMXML-33
>             Project: Seam Config
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 3.0.0.Beta2
>            Reporter: Jozef Hartinger
>            Assignee: Stuart Douglas
>            Priority: Minor
>             Fix For: 3.0.0.Beta3
>
>
> * index.html says "Alternative metadata sources for defining and configuration beans". IMO it should be
> ** "Alternative metadata sources for defining and configuration of beans" or
> ** "Alternative metadata sources for bean definition and configuration"
> * Section 1.1. talks about "Weld Extensions JAR"
> * A warning in Section 1.1. says that one should not put the configuration file in the web context, however SEAMXML-10 seems to resolve the problem
> * The warning in Section 1.1 says : "it is recommended that you define your beans in WEB-INF/classes/META-INF/seam-beans.xml" while the very next sentese in the following paragraph says: "The beans.xml file is the preferred way of configuring beans via XML"
> It is unclear if one should use beans.xml or seam-beans.xml
> * Section 1.2 "The princess rescue example is a sample web app that uses Seam XML" -> should be Seam Config
> * Section 2.1 "The main namespace is urn:java:ee contains builtin tags and types from core packages."
> ** should be "The main namespace is urn:java:ee. This namespace contains built-in tags and types from core packages."
> * section 2.1 contains typo "namspaces"
> * Section 2.1 - sample "my" namespace is defined, later in the text, the configured bean is referenced as <ns:Report> - should be <my:Report>
> * 2.9 
> ** Weld Extensions
> ** typo "exmaple"

-- 
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira