portletspec3
  1. portletspec3
  2. PORTLETSPEC3-14

Errata: Clarification about the Portlet Title

    Details

      Description

      The JSR 286 spec defines several ways for setting the portlet title:

      1) The title can be set in a resource bundle.
      2) The title can be set in the portlet-info section of the portlet descriptor.
      3) The title can be set by overriding the GenericPortlet.getTitle() method.
      4) The title can be set during the render headers part of the render phase

      However, these are all optional ways of setting the title. It is not defined
      what happens when none of them are used. In that case, WebSphere Portal, at least,
      uses the <portlet-name> value from the portlet descriptor, which is mandatory.

      I don't know how the RI treats this case.

      Do we need to specify something here?

        Activity

        Show
        Neil Griffin added a comment - Test Portlet: https://github.com/ngriffin7a/portletbox/tree/master/issues/PORTLETSPEC3-14-portlet
        Hide
        msnicklous added a comment -

        As mentioned previously, it seems that according to the deployment descriptor schema, the <portlet-info>, <portlet-title> and <resource-bundle> elements are all optional, even though the Pluto implementation does not treat them as being optional.

        My take is that Pluto has a bug in this area, and that the elements should be handled as being optional. As a clarification, I propose the following change in the spec.

        Referring to the [latest version of the working document] (https://java.net/projects/portletspec3/downloads/download/WorkingDocs/PortletSpec3-20130708.pdf):
        On page 52 after line 16 add the following paragraph:
        =====
        The <portlet-info> and <resource-bundle> elements are optional in the deployment descriptor. If neither are present, the portlet title will not be explicitly defined. In this case, the portlet container can draw on other information, for example on the <portlet-name> or <display-name> values from the portlet descriptor, to define the portlet title.
        =====

        Show
        msnicklous added a comment - As mentioned previously, it seems that according to the deployment descriptor schema, the <portlet-info>, <portlet-title> and <resource-bundle> elements are all optional, even though the Pluto implementation does not treat them as being optional. My take is that Pluto has a bug in this area, and that the elements should be handled as being optional. As a clarification, I propose the following change in the spec. Referring to the [latest version of the working document] ( https://java.net/projects/portletspec3/downloads/download/WorkingDocs/PortletSpec3-20130708.pdf): On page 52 after line 16 add the following paragraph: ===== The <portlet-info> and <resource-bundle> elements are optional in the deployment descriptor. If neither are present, the portlet title will not be explicitly defined. In this case, the portlet container can draw on other information, for example on the <portlet-name> or <display-name> values from the portlet descriptor, to define the portlet title. =====
        Hide
        Neil Griffin added a comment -

        @msnicklous: Just to clarify, if neither are present, then it is left as an implementation detail?

        Show
        Neil Griffin added a comment - @msnicklous: Just to clarify, if neither are present, then it is left as an implementation detail?
        Hide
        msnicklous added a comment -

        implemented fix in spec.

        Show
        msnicklous added a comment - implemented fix in spec.
        Hide
        msnicklous added a comment -

        reviewed on 20130730 and can be closed.

        Show
        msnicklous added a comment - reviewed on 20130730 and can be closed.

          People

          • Assignee:
            Unassigned
            Reporter:
            msnicklous
          • Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: