Inaccuracies in Getting started with HTML5 tutorial

— Additional comment from trepel@redhat.com on 2012-06-05 10:08:30 EDT —

I've read the document, here are my observations. Hopefully at least some of them are relevant:

1.2.1. Using the Command Line

• currently latest version of archetype available in maven central is 1.0.0.M4
• at the very end of page there is a note about QUnit. What I miss is to tell the reader that the application server has to be up and running and the example should be deployed for QUnit tests to pass

1.2.2. Using JBoss Developer Studio

• in Procedure 1.3. Deploying the Project with JBoss Developer Studio, after step 3.,Figure 1.2 Management tab picture is redundant, can be deleted

2.1. Client Source Code

• the file index.html has a bit different content than the one shown in source code border, e.g. the title text and the paths to *.js files have changed

2.1.1. HTML5 Semantic Tags and Structure

• in generated example in index.html, footer element is outside the the section element, not inside as shown in source code border

2.1.2. HTML5 Form API

• in source code border, 'Register a user' should by replaced by 'Register a member'
• typo in paragraph Input Validation: 'Safari,a nd' should be 'Safari, and'

2.1.4. CSS Files

• it is said that there are two css files: screen.css and m.screen.css, but in the generated example there is third css file: d.screen.css

2.1.6.1. Member.java (and a few further sections too)

• the package 'org/jboss/as/quickstarts/html5_mobile' used in the document does not correspond to the default package value 'org.jboss.tools.example.html5'

2.1.6.2. MemberService.java, the text between 2nd and 3rd source code border

• It starts with 'The methods above...', but I think it is related to the methods in the source code border below, not above
• I can't see the way how to access the members in XML format in the example, but the last sentence claims that it is possible
• there is neither createMemberGet nor createMemberPost method in MemberService.java, only one createMember method. The 3rd and 4th source code border show code that is not in the example at all
• only the last comment and last command from the code in the last (7th) source code border remain in MemberServce.java, the rest of code is shifted to the MemberRegistration's register method
  [reply] [-] Private Comment 1 Karel Piwko 2012-09-24 09:46:08 EDT
  Tomas Repel:
  I've read the document, here are my observations. Hopefully at least some of them are relevant:

1.2.1. Using the Command Line

• currently latest version of archetype available in maven central is 1.0.0.M4
• at the very end of page there is a note about QUnit. What I miss is to tell the reader that the application server has to be up and running and the example should be deployed for QUnit tests to pass

1.2.2. Using JBoss Developer Studio

• in Procedure 1.3. Deploying the Project with JBoss Developer Studio, after step 3.,Figure 1.2 Management tab picture is redundant, can be deleted

2.1. Client Source Code

• the file index.html has a bit different content than the one shown in source code border, e.g. the title text and the paths to *.js files have changed

2.1.1. HTML5 Semantic Tags and Structure

• in generated example in index.html, footer element is outside the the section element, not inside as shown in source code border

2.1.2. HTML5 Form API

• in source code border, 'Register a user' should by replaced by 'Register a member'
• typo in paragraph Input Validation: 'Safari,a nd' should be 'Safari, and'

2.1.4. CSS Files

• it is said that there are two css files: screen.css and m.screen.css, but in the generated example there is third css file: d.screen.css

2.1.6.1. Member.java (and a few further sections too)

• the package 'org/jboss/as/quickstarts/html5_mobile' used in the document does not correspond to the default package value 'org.jboss.tools.example.html5'

2.1.6.2. MemberService.java, the text between 2nd and 3rd source code border

• It starts with 'The methods above...', but I think it is related to the methods in the source code border below, not above
• I can't see the way how to access the members in XML format in the example, but the last sentence claims that it is possible
• there is neither createMemberGet nor createMemberPost method in MemberService.java, only one createMember method. The 3rd and 4th source code border show code that is not in the example at all
• only the last comment and last command from the code in the last (7th) source code border remain in MemberServce.java, the rest of code is shifted to the MemberRegistration's register method