pyams/pyams_user_guide: comparison src/source/howto-paragraph.rst

equal deleted inserted replaced

-:ca63b1a69cbb
+:ae0e104800aa
 description=_("Use 'browse' button to select contact picture"),
 required=False)
 phone = TextLine(title=_("Phone Number"),
 description=_("Name of the contact", required=False))
-address = Text(title=_("Address"), required=False)
-contact_email = MailAddressField(title=_("Email address"),
-description=_("Contact email address"),
-required=False)
 renderer = Choice(title=_("Contact template"),
 description=_("Presentation template used for this contact"),
 vocabulary=CONTACT_PHONE_PARAGRAPH_RENDERERS,
 default='default')
 icon_class = 'fa-phone'
 icon_hint = _("Phone number card")
-address = FieldProperty(IContactParagraph['address'])
+name = FieldProperty(IContactPhoneParagraph['name'])
-contact_email = FieldProperty(IContactParagraph['contact_email'])
+_photo = FileProperty(IContactPhoneParagraph['photo'])
 renderer = FieldProperty(IContactParagraph['renderer'])
 @property
 def photo(self):
 return self._photo
 self._photo = value
 if IImage.providedBy(self._photo):
 alsoProvides(self._photo, IResponsiveImage)
-3) renderer Vocabulary
+3) renderers Vocabulary
 ----------------------
 The list of rendered available for a paragraph is build automatically and is based on adapters that provide this interface
 .. code-block:: python
 @vocabulary_config(name=CONTACT_PARAGRAPH_RENDERERS)
 class ContactParagraphRendererVocabulary(RenderersVocabulary):
-"""Contact paragraph renderers vocabulary"""
+"""Contact Phone paragraph renderers vocabulary"""
-content_interface = IContactParagraph
+content_interface = IContactPhoneParagraph
 .. seealso::
 :ref:`rendererhowto`
 How integrate a paragraph in the ZMI?
 =====================================
 To display and manage the new paragraph in the ZMI, you should create this associated forms
-1) paragraph factory
+1) Paragraph factory
 --------------------
 To create a new element inside the zodb, we need a container to this element. PyAMS provide
 `IParagraphContainerTarget`, it's the default container for all paragraphs. We could use this container interface
 as context to create a new paragraph.
 - *HTML*
 .. code-block:: python
-@pagelet_config(name='add-contact-paragraph.html', context=IParagraphContainerTarget, layer=IPyAMSLayer,
+@pagelet_config(name='add-contact-phone-paragraph.html', context=IParagraphContainerTarget, layer=IPyAMSLayer,
 permission=MANAGE_CONTENT_PERMISSION)
-class ContactParagraphAddForm(AdminDialogAddForm):
+class ContactPhoneParagraphAddForm(AdminDialogAddForm):
-"""Contact paragraph add form"""
+"""Contact phone paragraph add form"""
-legend = _("Add new contact card")
+legend = _("Add new contact phone card")
 dialog_class = 'modal-large'
-icon_css_class = 'fa fa-fw fa-id-card-o'
+icon_css_class = 'fa fa-fw fa-phone'
-fields = field.Fields(IContactParagraph).omit('__parent__', '__name__', 'visible')
+fields = field.Fields(IContactPhoneParagraph).omit('__parent__', '__name__', 'visible')
-ajax_handler = 'add-contact-paragraph.json'
+ajax_handler = 'add-contact-phone-paragraph.json' #(*)
 edit_permission = MANAGE_CONTENT_PERMISSION
-def updateWidgets(self, prefix=None):
+def create(self, data):
-super(ContactParagraphAddForm, self).updateWidgets(prefix)
+return ContactPhoneParagraph()
-if 'address' in self.widgets:
-self.widgets['address'].widget_css_class = 'textarea'
-def create(self, data):
-return ContactParagraph()
 def add(self, object):
 IParagraphContainer(self.context).append(object)
 - *JSON*
 .. code-block:: python
-@view_config(name='add-contact-paragraph.json', context=IParagraphContainerTarget, request_type=IPyAMSLayer,
+#(*)
+@view_config(name='add-contact-phone-1paragraph.json', context=IParagraphContainerTarget, request_type=IPyAMSLayer,
 permission=MANAGE_CONTENT_PERMISSION, renderer='json', xhr=True)
-class ContactParagraphAJAXAddForm(BaseParagraphAJAXAddForm, ContactParagraphAddForm):
+class ContactPhoneParagraphAJAXAddForm(BaseParagraphAJAXAddForm, ContactPhoneParagraphAddForm):
-"""Contact paragraph add form, JSON renderer"""
+"""Contact phone paragraph add form, JSON renderer"""
 2) Append the paragraph addform button in the menu
 --------------------------------------------------
 We have created a new form and we want add a quick access button to create a new paragraph
 .. code-block:: python
-@viewlet_config(name='add-contact-paragraph.menu', context=IParagraphContainerTarget, view=IParagraphContainerView,
+@viewlet_config(name='add-contact-phone-paragraph.menu', context=IParagraphContainerTarget, view=IParagraphContainerView,
 layer=IPyAMSLayer, manager=IToolbarAddingMenu, weight=600)
-class ContactParagraphAddMenu(BaseParagraphAddMenu):
+class ContactPhoneParagraphAddMenu(BaseParagraphAddMenu):
 """Contact paragraph add menu"""
 label = _("Contact card...")
 label_css_class = 'fa fa-fw fa-id-card-o'
 url = 'add-contact-paragraph.html'
 paragraph_type = CONTACT_PARAGRAPH_TYPE
-3)Edit form
+3) Create Edit form
------------
+-------------------
 - *HTML*
 .. code-block:: python
 @pagelet_config(name='properties.html', context=IContactParagraph, layer=IPyAMSLayer,
 permission=MANAGE_CONTENT_PERMISSION)
-class ContactParagraphPropertiesEditForm(BaseParagraphPropertiesEditForm):
+class ContactPhoneParagraphPropertiesEditForm(BaseParagraphPropertiesEditForm):
-"""Contact paragraph properties edit form"""
+"""Contact phone paragraph properties edit form"""
 prefix = 'contact_properties.'
 legend = _("Edit contact card properties")
 icon_css_class = 'fa fa-fw fa-id-card-o'
 fields['renderer'].widgetFactory = RendererFieldWidget
 ajax_handler = 'properties.json'
 edit_permission = MANAGE_CONTENT_PERMISSION
-def updateWidgets(self, prefix=None):
-super(ContactParagraphPropertiesEditForm, self).updateWidgets(prefix)
-if 'address' in self.widgets:
-self.widgets['address'].widget_css_class = 'textarea'
 - *JSON*
 .. code-block:: python
-@view_config(name='properties.json', context=IContactParagraph, request_type=IPyAMSLayer,
+@view_config(name='properties.json', context=IContactPhoneParagraph, request_type=IPyAMSLayer,
 permission=MANAGE_CONTENT_PERMISSION, renderer='json', xhr=True)
-class ContactParagraphPropertiesAJAXEditForm(BaseParagraphAJAXEditForm, ContactParagraphPropertiesEditForm):
+class ContactPhoneParagraphPropertiesAJAXEditForm(BaseParagraphAJAXEditForm, ContactParagraphPropertiesEditForm):
-"""Contact paragraph properties edit form, JSON renderer"""
+"""Contact phone paragraph properties edit form, JSON renderer"""
-@adapter_config(context=(IContactParagraph, IPyAMSLayer), provides=IParagraphInnerEditor)
+4) Create ZMI Edit form inner tab
+---------------------------------
+.. code-block:: python
+@adapter_config(context=(IContactPhoneParagraph, IPyAMSLayer), provides=IParagraphInnerEditor)
 @implementer(IInnerForm)
-class ContactParagraphInnerEditForm(ContactParagraphPropertiesEditForm):
+class ContactPhoneParagraphInnerEditForm(ContactPhoneParagraphPropertiesEditForm):
 """Contact paragraph inner edit form"""
 legend = None
 ajax_handler = 'inner-properties.json'
 return button.Buttons(IParagraphEditFormButtons)
 else:
 return button.Buttons()
-@view_config(name='inner-properties.json', context=IContactParagraph, request_type=IPyAMSLayer,
+.. code-block:: python
+@view_config(name='inner-properties.json', context=IContactPhoneParagraph, request_type=IPyAMSLayer,
 permission=MANAGE_CONTENT_PERMISSION, renderer='json', xhr=True)
-class ContactParagraphInnerAJAXEditForm(BaseParagraphAJAXEditForm, ContactParagraphInnerEditForm):
+class ContactPhoneParagraphInnerAJAXEditForm(BaseParagraphAJAXEditForm, ContactParagraphInnerEditForm):
 """Contact paragraph inner edit form, JSON renderer"""
 def get_ajax_output(self, changes):
 output = super(ContactParagraphInnerAJAXEditForm, self).get_ajax_output(changes)
 updated = changes.get(IBaseParagraph, ())

branch	doc-dc
changeset 77	ae0e104800aa
parent 76	ca63b1a69cbb
child 78	88a65b19d07d