javaeetutorial
  1. javaeetutorial
  2. JAVAEETUTORIAL-114

create actual examples instead of inviting user to imagine

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Won't Fix
    • Affects Version/s: 6.0.7-5
    • Fix Version/s: None
    • Component/s: doc, examples
    • Labels:
      None

      Description

      This issue is in the "The immediate Attribute" section of the page entitled "Adding Components to a Page Using HTML Tags" at http://docs.oracle.com/javaee/6/tutorial/doc/bnarf.html. The third paragraph in this section starts with "Assume that you have a page with a button and a field for entering the quantity of a book in a shopping cart." Why are we assuming here? This is a tutorial, so have readers open an existing example of this scenario or code it up and see what happens. This also relates to other feedback on the sequencing of describing how immediate works without describing the ordinary request lifecycle. The user doesn't yet have the context to imagine what would happen.

        Activity

        Hide
        Kim Haase added a comment -

        This is a good suggestion, and we should do something with this section. We have been hoping to add some simpler examples along with the large case study. I'm not absolutely certain that the immediate attribute is the best candidate for such an example, but I'll certainly try.

        JAVAEETUTORIAL-88, when fixed, should help provide more lifecycle context at this point.

        There's also a subject-verb agreement typo ("occurs" in the 4th paragraph) that should be fixed.

        Show
        Kim Haase added a comment - This is a good suggestion, and we should do something with this section. We have been hoping to add some simpler examples along with the large case study. I'm not absolutely certain that the immediate attribute is the best candidate for such an example, but I'll certainly try. JAVAEETUTORIAL-88 , when fixed, should help provide more lifecycle context at this point. There's also a subject-verb agreement typo ("occurs" in the 4th paragraph) that should be fixed.
        Hide
        Kim Haase added a comment -

        Deferring to an update release later in the year.

        Show
        Kim Haase added a comment - Deferring to an update release later in the year.
        Hide
        Kim Haase added a comment -

        Since the lifecycle information is now provided before this chapter, users have the information needed to understand the hypothetical situation presented. The section does describe in detail an example from the case study that provides a more realistic use case.

        Show
        Kim Haase added a comment - Since the lifecycle information is now provided before this chapter, users have the information needed to understand the hypothetical situation presented. The section does describe in detail an example from the case study that provides a more realistic use case.

          People

          • Assignee:
            Kim Haase
            Reporter:
            Brant Gurganus
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: