ERP5JS,xhtml_style: display form groups legends (!1949) · Merge requests · nexedi / erp5

ERP5JS,xhtml_style: display form groups legends

For erp5_web it is possible to define form groups following a naming rule "group_id (Group Title)" and "Group Title" is displayed in a legend, according to this comment in form_render.zpt:

It is possible to specify a group id and a group title by naming a group following the "group id (Group Title)" pattern. In this case the group id will be used as fieldset css class and as tag id. The group title will be used as a legend for the fieldset. If no group title is found, we use group id as title.

For historical reasons, the legend was hidden, this feature was only used in erp5_web, but this does not seem bad to enable it in erp5_xhtml_style as well.

At the moment, this is not used much, this script

for sf in context.getPortalObject().portal_skins.objectValues():
  for f in sf.objectValues():
    if not hasattr(f, 'get_groups'):
      continue
    for group in f.get_groups():
      if '(' in group:
        print('/'.join(f.getPhysicalPath()[1:]), group)

return printed

when running on a site with many business template installed yields

erp5/portal_skins/erp5_base/EmbeddedFile_view left (Document Reference)
erp5/portal_skins/erp5_base/EmbeddedFile_view right (Publication Information)
erp5/portal_skins/erp5_base/NotificationMessage_viewEditor left (Page Properties)
erp5/portal_skins/erp5_knowledge_pad/Base_viewKnowledgePadFieldLibrary right column (Toolbox)
erp5/portal_skins/erp5_web/StaticWebSite_viewRedirectAssistConfiguration left (Style)
erp5/portal_skins/erp5_web/WebPage_view left (Page Properties)
erp5/portal_skins/erp5_web/WebPage_view right (Publication)
erp5/portal_skins/erp5_web/WebPage_view bottom (Content)
erp5/portal_skins/erp5_web/WebPage_viewEditor left (Page Properties)
erp5/portal_skins/erp5_web/WebPage_viewFieldLibrary left (Page Properties)
erp5/portal_skins/erp5_web/WebPage_viewFieldLibrary right (Publication)
erp5/portal_skins/erp5_web/WebPage_viewFieldLibrary bottom (Content)
erp5/portal_skins/erp5_web/WebSection_view left (Content)
erp5/portal_skins/erp5_web/WebSection_view right (Layout)
erp5/portal_skins/erp5_web/WebSection_view center (Description)
erp5/portal_skins/erp5_web/WebSection_view bottom (Subsections)
erp5/portal_skins/erp5_web/WebSection_viewDefaultThemeConfiguration left (Style)
erp5/portal_skins/erp5_web/WebSection_viewDefaultThemeConfiguration right (Widgets)
erp5/portal_skins/erp5_web/WebSite_view left (Content)
erp5/portal_skins/erp5_web/WebSite_view right (Layout)
erp5/portal_skins/erp5_web/WebSite_view center (Description)
erp5/portal_skins/erp5_web/WebSite_view bottom (Subsections)
erp5/portal_skins/erp5_web/WebSite_viewRegistrationDialog left (User Login)
erp5/portal_skins/erp5_web/WebSite_viewRegistrationDialog right (User Identity)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_content_layout left column transparent (Logo)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_content_layout left column (Navigation)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_content_layout left column (Sections)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_content_layout left column (Contents)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_content_layout left column (Search)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_content_layout left column (Debug)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_content_layout right column (News)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_content_layout right column (Toolbox)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_content_layout right column (Highlight)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_layout left column transparent (Logo)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_layout left column (Navigation)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_layout left column (Sections)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_layout left column (Contents)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_layout left column (Search)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_layout left column (Debug)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_layout right column (News)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_layout right column (Toolbox)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_layout right column (Highlight)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_layout right column (Action)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_section_layout left column transparent (Logo)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_section_layout left column (Navigation)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_section_layout left column (Sections)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_section_layout left column (Contents)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_section_layout left column (Search)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_section_layout left column (Debug)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_section_layout right column (News)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_section_layout right column (Toolbox)
erp5/portal_skins/erp5_web_minimal_theme/erp5_web_section_layout right column (Highlight)
erp5/portal_skins/erp5_dms/Document_viewFieldLibrary left (Document Reference)
erp5/portal_skins/erp5_dms/Document_viewFieldLibrary right (Publication Information)
erp5/portal_skins/erp5_dms/ExternalSource_view left (Document Reference)
erp5/portal_skins/erp5_dms/ExternalSource_view right (Publication Information)
erp5/portal_skins/erp5_dms/OOoDocument_view left (Document Reference)
erp5/portal_skins/erp5_dms/OOoDocument_view right (Publication Information)
erp5/portal_skins/erp5_dms_base/File_view left (Document Reference)
erp5/portal_skins/erp5_dms_base/File_view right (Publication Information)
erp5/portal_skins/erp5_dms_base/Image_view left (Document Reference)
erp5/portal_skins/erp5_dms_base/Image_view right (Publication Information)
erp5/portal_skins/erp5_dms_web/WebIllustration_view left (Document Reference)
erp5/portal_skins/erp5_dms_web/WebIllustration_view right (Publication Information)
erp5/portal_skins/erp5_dms_web/WebIllustration_view bottom (Preview)
erp5/portal_skins/erp5_dms_web/WebPage_view left (Document Reference)
erp5/portal_skins/erp5_dms_web/WebPage_view right (Publication Information)
erp5/portal_skins/erp5_dms_web/WebPage_view bottom (Preview)
erp5/portal_skins/erp5_multimedia/Sound_view left (Document Reference)
erp5/portal_skins/erp5_multimedia/Sound_view right (Publication Information)
erp5/portal_skins/erp5_run_my_doc/Review_view left (Document Reference)
erp5/portal_skins/erp5_run_my_doc/Review_view right (Publication Information)
erp5/portal_skins/erp5_run_my_doc/TestPage_view left (Document Reference)
erp5/portal_skins/erp5_run_my_doc/TestPage_view right (Publication Information)
erp5/portal_skins/erp5_run_my_doc/TestPage_view bottom (Preview)
erp5/portal_skins/erp5_run_my_doc/TestPage_viewFieldLibrary left (Page Properties)
erp5/portal_skins/erp5_run_my_doc/TestPage_viewFieldLibrary right (Publication)
erp5/portal_skins/erp5_run_my_doc/TestPage_viewFieldLibrary bottom (Content)
erp5/portal_skins/erp5_run_my_doc/TestPage_viewTestReport bottom (Content)
erp5/portal_skins/erp5_officejs_slideshow_editor/WebPage_viewForSlideshowEditor bottom (Preview)
erp5/portal_skins/erp5_credential/CredentialRequest_view left (Personal Information)
erp5/portal_skins/erp5_credential/CredentialRequest_view left (Organisation Information)
erp5/portal_skins/erp5_credential/CredentialRequest_view right (Login Information)
erp5/portal_skins/erp5_credential/CredentialUpdate_view left (Personal Information)
erp5/portal_skins/erp5_credential/CredentialUpdate_view left (Organisation Information)
erp5/portal_skins/erp5_credential/CredentialUpdate_view right (Login Information)
erp5/portal_skins/erp5_km/WebSection_viewKMMinimalThemeConfiguration left (Colors)
erp5/portal_skins/erp5_km/WebSection_viewKMMinimalThemeConfiguration right (Static Content)
erp5/portal_skins/erp5_km/WebSection_viewKMMinimalThemeConfiguration left (Navigation)
erp5/portal_skins/erp5_km/WebSection_viewKMMinimalThemeConfiguration right (Gadgets)
erp5/portal_skins/erp5_km_theme/Base_viewKMFieldLibrary right column (Toolbox)
erp5/portal_skins/erp5_km_theme/WebSection_viewMinimalKMWidgetFieldLibrary bottom gadget (Bottom Gadget)
erp5/portal_skins/erp5_km_theme/WebSection_viewMinimalKMWidgetFieldLibrary right column gadget (Right Gadget)
erp5/portal_skins/erp5_km_theme/erp5_km_minimal_content_layout bottom gadget (Bottom Gadget)
erp5/portal_skins/erp5_km_theme/erp5_km_minimal_content_layout right column gadget (Right Gadget)
erp5/portal_skins/erp5_km_theme/erp5_km_minimal_layout bottom gadget (Bottom Gadget)
erp5/portal_skins/erp5_km_theme/erp5_km_minimal_layout right column gadget (Right Gadget)
erp5/portal_skins/erp5_km_theme/login_form left registration (Login)
erp5/portal_skins/erp5_km_theme/login_form right registration (New User Registration)

and this does not look bad when viewing the forms.

Edited 10 months ago by Jérome Perrin

Jérome Perrin @jerome · 10 months ago

Owner
Example of some forms where the feature was used

before after

if we like this, I'll make the same change for ERP5JS, the group labels are not used at the moment, but it could look like this:

the markup would also be a legend, something like:

before

<div class="right"> <div data-gadget-scope="field_my_classification"

after

<div class="right"> <legend>Publication Information</legend> <div data-gadget-scope="field_my_classification"
Kazuhiko Shiozaki @kazuhiko · 10 months ago

Owner

I like the idea but...

The group title will be used as a legend for the fieldset. If no group title is found, we use group id as title.

I prefer having no fallback, i.e. legend will be added only when explicit '(Title)' exists.
Jérome Perrin @jerome · 10 months ago

Owner

Ah I see, you are worried that it will display ugly "left" or "right" legends when no "(title)" is used, it's not the case:

This was the case when the feature was introducedd in a44ba813 but this changed in d8c8e865 and the comment was not updated. I'll update the comment while looking at the ERP5JS version.

Thanks for feedback
Jérome Perrin @jerome added 2 commits 10 months ago
added 2 commits

32409998 - ERP5JS: display form groups legends

ca24a5be - */form_render: update an outdated comment

Compare with previous version
Jérome Perrin @jerome · 10 months ago

Owner

I have updated the comment and implemented the same for ERP5JS.

It's something that already existed for years, this is just enabling it more. @tb said he likes the idea but reminded that this is not a feature that we expected to use a lot. The background context here is that we have a form used as "Layout Properties" on a customer project with almost 50 fields that we are organizing in semantic groups and showing the names of the groups would really make things easier to understand for this kind of forms.
Jérome Perrin @jerome added 2 commits 10 months ago
added 2 commits

e78a57a1 - ERP5JS: display form groups legends

3c64c1d3 - */form_render: update an outdated comment

Compare with previous version
Jérome Perrin @jerome changed title from xhtml_style: display form groups legends to ERP5JS,xhtml_style: display form groups legends 10 months ago

changed title from xhtml_style: display form groups legends to ERP5JS,xhtml_style: display form groups legends
Jérome Perrin @jerome changed the description 10 months ago

changed the description
Jérome Perrin @jerome added 1 commit 10 months ago
added 1 commit

4f84f243 - xhtml_style: fix form_dialog using a different condition for <legend>

Compare with previous version
Jérome Perrin @jerome enabled an automatic merge when the pipeline for 4f84f243 succeeds 10 months ago

enabled an automatic merge when the pipeline for 4f84f243 succeeds
Jérome Perrin @jerome canceled the automatic merge 10 months ago

canceled the automatic merge
Jérome Perrin @jerome merged 10 months ago

merged
Jérome Perrin @jerome mentioned in commit 9817d24f 10 months ago

mentioned in commit 9817d24f
You're only seeing other activity in the feed. To add a comment, switch to one of the following options.

Please register or sign in to reply

before	after

ERP5JS,xhtml_style: display form groups legends

before

after