Tapestry 5
  1. Tapestry 5
  2. TAP5-502

Improve the description of parameter passing and binding in the documentation

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 5.0.18
    • Fix Version/s: 5.1.0.1
    • Component/s: documentation
    • Labels:
      None

      Description

      It seem that the documentation for parameter is milseading.
      The way parameter are defined and passed between a parent component and its child use to be really well explained (I think it was in the "Parameter" page, but I'm not sure). It seems that the introduction text which use to deal with the concept is no more in the Parameter documentation, what leads to really big miscomprehension from user.

      It would be really great to add again something about that at the beginning of the parameter page (before the loop example).

      That is the text in the T5 refcard on that topic, which seems quite good:
      ===
      A page binds the parameters of its child components. For example, a TextField properties
      component's value parameter is bound to a property, or property expression, indicating what object property it will
      read (when rendering) or update (when the containing form is submitted).
      ===

      And there used to be something about parameter being a conduit, both read and write, between a component and it's container that was quite nice too.

        Activity

        Francois Armand created issue -
        Howard M. Lewis Ship made changes -
        Field Original Value New Value
        Assignee Howard M. Lewis Ship [ hlship ]
        Howard M. Lewis Ship made changes -
        Status Open [ 1 ] In Progress [ 3 ]
        Howard M. Lewis Ship made changes -
        Priority Major [ 3 ] Minor [ 4 ]
        Summary Parameter passing between components is not well explain Improve the description of parameter passing and binding in the documentation
        Issue Type Bug [ 1 ] Improvement [ 4 ]
        Howard M. Lewis Ship made changes -
        Fix Version/s 5.1.0.1 [ 12313660 ]
        Status In Progress [ 3 ] Closed [ 6 ]
        Resolution Fixed [ 1 ]

          People

          • Assignee:
            Howard M. Lewis Ship
            Reporter:
            Francois Armand
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development