ICEfaces
  1. ICEfaces
  2. ICE-9414

Refresh ACE Component Wiki Documentation

    Details

    • Assignee Priority:
      P1
    • Affects:
      Documentation (User Guide, Ref. Guide, etc.)

      Description

      The ACE Component Wiki documentation pages are in need of a general reformat/refresh to bring them up to a consistent level of higher quality.

      General issues:

      - Getting Started should show most basic use-case, with Examples section showing additional / more advanced use-cases
      - Need to add the default values to the client event TLD doc section for each execute/render value for each event?
      - Need to add images to the topic as relevant. At least one per topic to show the component, and more if feasible (charts, gmap, etc.)
      - Should add a link to the public showcase demo most appropriate for each wiki page under "Additional Resources" section (see ICE-6401).
      - Remove empty section headers if not application to a component (JavaScript API, Keyboard Support, Known Issues, etc.)
      - Add details for each component explaining what JS console logging options/features are available for the component.


      Per Component Issues:

      Missing topic and links for New Text Entry Component Features (Yip)
      - Integrated label rendering, including Inplace/InField labels and left/right/top/bottom label positions.
      - Integrated required/optional label indicators and positioning (ex. render a "*" or "(Required)" string next to the component or component label).
      - Required/optional CSS style classes for style-based required or optional status indication (ex. change background colour for required input components).
      - Built-in support for Theme-Roller based style classes for components in Error/Invalid validation status (ex. highlight invalid components with red borders).

      ace:autoCompleteEntry (Art)
      - Missing advanced examples
      - Missing client filtering mode
      - Missing TLD reference section
      - Missing label position example, required styling, etc.

      ace:checkboxButton (Mark)
      - Need complete revamp

      ace:delegate (Art)
      - should be discussed/example code shown in ace:tooltip wiki topic and linked to from there as well.

      ace:gMap (Art)
      - gMap event wiki missing
      - In the showcase gMap demo, the tlddoc link is wrong. Points to an invalid page (gMapBasic.html, should be gMap.html
      - The helper components should have their own child topic pages. Not enough explanation or examples are provided for these currently:
      • ace:gmapAutocomplete - An ACE component implementation of Google's Places autocomplete tool. The ace:gMapAutocomplete component will create a text box which will provide locations that match the currently typed string, then return information about the selected location such as the types Google has assigned to it, or the url to Google's information page on it.
      • ace:gMapControl - Modify the controls that appear on the map (overview, pan, rotate, scale, streetview, zoom).
      • ace:gMapInfoWindow - displays a pop-up window that can display either straight text information, or nested html code. If placed within a gMap, it will render at the locations given by its latitude and longitude attributes. If it is placed inside an ace:gMapMarker, it will bind to that marker and move to whatever location it occupies.
      • ace:gMapLayer - activates a layer on the parent gMap that's designed to provide an alternative visual, such as displaying bike paths, traffic, or third-party KML data.
      • ace:gMapMarker - places a marker upon the map in the desired coordinates to be used for designating points of interest or important locations.
      • ace:gMapOverlay - allows the user to create a shape of their choosing on the map.
      • ace:gMapServices - is an access point to the services portion of the api and will return information about the specified points, such as maximum zoom, or height. Directions are also specified through this subcomponent.

      ace:tree (Nils)
      - Missing explanations and examples for basically all functionality (beyond attribute descriptions):
      - explanation of client vs. server modes
      - single and multiple selection examples
      - lazy loading
      - expansion
      - reordering
      - styling modes (added in 3.3)

      ARIA support (Yip)
      - All components with ARIA support need to have that documented in their wiki pages. Can we list the specific roles that are used for each component?
      - In addition, a new ARIA Accessibility Topic needs to be created under the ACE section to document the nature and scope of our ARIA support in one place (overview).

      ace:ajax - Need to explain the submit merging aspect in the wiki page? (Nils)

      ace:chart (Nils)
      - missing simple examples
      - needs Gauge added
      - pictures

      ace:comboBox (Art)
      - missing TLD doc link / attributes section
      - Missing label pos, req. styling, etc. explanations and examples (maybe those should be explained in another dedicated topic page and linked to from each comp. that supports?)

      ace:dataTable (Nils)
      - Missing column pinning updates
      - Missing sort/filter cancel on invalid example

      ace:dateTimeEntry (Yip)
      - Missing lenientParsing example

      ace:dataExporter (Art)
      - Missing custom exporter + nested dataTable explanation and example
      - column order preservation missing
      - expandable rows (basically need to explain what scenarios are supported/not and provide examples for those that are)

      ace:listControl (Nils)
      - Needs own child topic (policy is now to always have a topic for each comp or sub comp.

      ace:message(s) (Yip)
      - Missing examples
      - ARIA role support?

      ace:selectMenu (Art)
      - missing tld link / attribute section
      - Missing advanced examples (effects?)

      ace:simpleSelectOneMenu (Art)
      - missing tld link, attributes section

      ace:sliderEntry (Art)
      - missing showLabels explanation and example

      ace:subMenu (Art)
      - missing new positionTop/Left, etc. attribute explanation

      ace:tableConfigPanel (Nils)
      - missing positioning explanation and examples ("modal", "offsetTop", "in-col-left", etc.)

      ace:textEntry (Yip)
      - no autotab section

      ace:textAreaEntry (Yip)
      - missing resizable behavior on newer browsers

      ace:themeSelect (Yip)
      - Needs a detailed explanation of the interaction between this comp. and the ace.theme config. parameter (wait for Mircea to finalize first) (Ken)
      - missing example(*s)

      ace:tooltip (Art)
      - missing examples
      - missing ace:delegate reference and example

      Basically, a few pages should be reviewed and updated first and then reviewed prior to the rest being updated to match, once the new format and contents are completed to our satisfaction.

       

        Issue Links

          Activity

          Hide
          Arturo Zambrano added a comment -

          Most of the tasks specified above, as well as other ones not listed have already been completed. The only tasks left to do at the moment are the following:

          ace:tree (Nils)

          • Missing explanations and examples for basically all functionality (beyond attribute descriptions):
          • explanation of client vs. server modes
          • single and multiple selection examples
          • lazy loading
          • expansion
          • reordering
          • styling modes (added in 3.3)

          ARIA support (Yip)

          • In addition, a new ARIA Accessibility Topic needs to be created under the ACE section to document the nature and scope of our ARIA support in one place (overview).

          ace:ajax - Need to explain the submit merging aspect in the wiki page? (Nils)

          ace:chart (Nils)

          • missing simple examples
          • needs Gauge added
          • pictures

          ace:dataTable (Nils)

          • Missing column pinning updates
          • Missing sort/filter cancel on invalid example

          ace:dateTimeEntry (Yip)

          • Missing lenientParsing example

          ace:tableConfigPanel (Nils)

          • missing positioning explanation and examples ("modal", "offsetTop", "in-col-left", etc.)

          ace:themeSelect (Yip)

          • Needs a detailed explanation of the interaction between this comp. and the ace.theme config. parameter (wait for Mircea to finalize first) (Ken)
          • missing example(*s)
          Show
          Arturo Zambrano added a comment - Most of the tasks specified above, as well as other ones not listed have already been completed. The only tasks left to do at the moment are the following: ace:tree (Nils) Missing explanations and examples for basically all functionality (beyond attribute descriptions): explanation of client vs. server modes single and multiple selection examples lazy loading expansion reordering styling modes (added in 3.3) ARIA support (Yip) In addition, a new ARIA Accessibility Topic needs to be created under the ACE section to document the nature and scope of our ARIA support in one place (overview). ace:ajax - Need to explain the submit merging aspect in the wiki page? (Nils) ace:chart (Nils) missing simple examples needs Gauge added pictures ace:dataTable (Nils) Missing column pinning updates Missing sort/filter cancel on invalid example ace:dateTimeEntry (Yip) Missing lenientParsing example ace:tableConfigPanel (Nils) missing positioning explanation and examples ("modal", "offsetTop", "in-col-left", etc.) ace:themeSelect (Yip) Needs a detailed explanation of the interaction between this comp. and the ace.theme config. parameter (wait for Mircea to finalize first) (Ken) missing example(*s)
          Hide
          Arturo Zambrano added a comment -

          The tasks above have now been completed as well.

          Show
          Arturo Zambrano added a comment - The tasks above have now been completed as well.
          Hide
          Ken Fyten added a comment -

          Re-opened as the ACE components topics "JavaScript API" sections all require updating for the changes in 4.0.

          I have completed the ace:dialog topic as a reference on how these changes can be presented for the other ACE components:
          http://www.icesoft.org/wiki/display/ICE/Dialog

          Show
          Ken Fyten added a comment - Re-opened as the ACE components topics "JavaScript API" sections all require updating for the changes in 4.0. I have completed the ace:dialog topic as a reference on how these changes can be presented for the other ACE components: http://www.icesoft.org/wiki/display/ICE/Dialog
          Hide
          Arturo Zambrano added a comment -

          The task above has now been completed.

          Show
          Arturo Zambrano added a comment - The task above has now been completed.

            People

            • Assignee:
              Arturo Zambrano
              Reporter:
              Ken Fyten
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: