Custom anchor names for edit tabs?

zopyx · November 13, 2020, 6:41am

The tabs of the edit form have autogenerated IDs autotoc-item-autotoc-X.
Is there a way to provide a custom ID (e.g. as part of the fieldset configuration)?
The common usecase is that you want to open an edit form with a particular fieldset opened by default.
In our case we have a content sync behavior (that could possibly appear at any position) which I want to open directly from a control panel view.

jensens · November 13, 2020, 10:39am

Short: No.
Long:
fieldsets are form groups as defined here, no attribute for an explizit ID here.

github.com

plone/plone.z3cform/blob/master/src/plone/z3cform/fieldsets/group.py

# -*- coding: utf-8 -*-
from plone.z3cform.fieldsets.interfaces import IDescriptiveGroup
from plone.z3cform.fieldsets.interfaces import IGroupFactory
from z3c.form import group
from zope.interface import implementer


@implementer(IDescriptiveGroup)
class Group(group.Group):
    __name__ = u""
    label = u""
    description = u""
    order = 0

    def getContent(self):
        # Default to sharing content with parent
        return self.__parent__.getContent()


@implementer(IGroupFactory)

This file has been truncated. show original

the template rendering the fieldset is defined here, autogenerated id from label.

github.com

plone/plone.app.z3cform/blob/master/plone/app/z3cform/templates/macros.pt#L108


                <metal:field define-macro="field">
                    <tal:widget tal:replace="structure widget/@@ploneform-render-widget"/>
                </metal:field>
            </metal:field-slot>
        </tal:widgets>
    </metal:define>
</fieldset>

<!-- Secondary fieldsets -->
<tal:block tal:repeat="group groups" condition="has_groups">
    <fieldset
        tal:define="normalizeString nocall:context/@@plone/normalizeString;
                    fieldset_label group/label;
                    fieldset_name python:getattr(group, '__name__', False) or getattr(group.label, 'default', False) or fieldset_label;
                    fieldset_name python:normalizeString(fieldset_name);"
        tal:attributes="id string:fieldset-${fieldset_name};
                        class string:kssattr-fieldset-${fieldset_name};
                        data-fieldset fieldset_name">

            <legend tal:condition="fieldset_label"
                    tal:attributes="id string:fieldsetlegend-${fieldset_name}"

the pattern pat-autotoc then generates the tabs from the ids.

IIRC the label is translated and so the ID changes over languages. One (relatively easy) way to have an fixed ID is to modify the code in a way so the msgid is used as a label.

espenmn · November 13, 2020, 5:02pm

I can not see that the current ids can be 'used for anything', so in my opinion the default behaviour should be 'something-nameofthefildset'

jaroel · November 13, 2020, 5:07pm

I guess https://github.com/plone/plone.staticresources/blob/24e65c497e85e4888ac9879830c6224f13bb938f/src/plone/staticresources/static/components/mockup/mockup/patterns/autotoc/pattern.js#L119 is wrong?

A legend (level) has an id so, it would go into the if to generate a new id. Which is not what you want. You want something like https://demo.plone.org/en/frontpage/edit#fieldsetlegend-dates, not https://demo.plone.org/en/frontpage/edit#autotoc-item-autotoc-3

jaroel · November 13, 2020, 5:09pm

Anyhow, you can add a bit of jquery that after the page is loaded will check for an #anchor in the url and click on the right tab.