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

equal deleted inserted replaced

-:8eb1b401003a
+:82165875e66b
 To display and manage the new paragraph in the ZMI, you should create this associated forms
 1) Paragraph factory
 --------------------
-To create a new element inside the zodb, we need a container to this element. PyAMS provide
+To create a new element instance inside the zodb, we need a container to this object. PyAMS provide
 `IParagraphContainerTarget`, it's the default container for all paragraphs. We could use this container interface
 as context to create a new paragraph.
-We need to create two views
+Declaration of the **factory** of `ContactPhoneParagraph`
-- *HTML*
+.. code-block:: python
-.. code-block:: python
+@utility_config(name=CONTACT_PHONE_PARAGRAPH_TYPE, provides=IParagraphFactory)
+class ContactPhoneParagraphFactory(BaseParagraphFactory):
+"""Contact paragraph factory"""
+name = _("Contact Phone card")
+content_type = ContactPhoneParagraph
+secondary_menu = True
+Definition of a form to create a new ContactPhone instance
+.. code-block:: python
+from pyams_form.form import ajax_config
 @pagelet_config(name='add-contact-phone-paragraph.html', context=IParagraphContainerTarget, layer=IPyAMSLayer,
 permission=MANAGE_CONTENT_PERMISSION)
+@ajax_config(name='add-contact-phone-paragraph.json', context=IParagraphContainerTarget, layer=IPyAMSLayer,
+base=BaseParagraphAJAXAddForm)
 class ContactPhoneParagraphAddForm(AdminDialogAddForm):
 """Contact phone paragraph add form"""
 legend = _("Add new contact phone card")
 dialog_class = 'modal-large'
 icon_css_class = 'fa fa-fw fa-phone'
 fields = field.Fields(IContactPhoneParagraph).omit('__parent__', '__name__', 'visible')
-ajax_handler = 'add-contact-phone-paragraph.json' #(*)
 edit_permission = MANAGE_CONTENT_PERMISSION
 def create(self, data):
 return ContactPhoneParagraph()
 def add(self, object):
 IParagraphContainer(self.context).append(object)
-- *JSON*
+2) Create the Paragraph addform button in the menu
-.. code-block:: python
-#(*)
-@view_config(name='add-contact-phone-1paragraph.json', context=IParagraphContainerTarget, request_type=IPyAMSLayer,
-permission=MANAGE_CONTENT_PERMISSION, renderer='json', xhr=True)
-class ContactPhoneParagraphAJAXAddForm(BaseParagraphAJAXAddForm, ContactPhoneParagraphAddForm):
-"""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
 url = 'add-contact-paragraph.html'
 paragraph_type = CONTACT_PARAGRAPH_TYPE
-3) Create Edit form
+3) Create Edit inner form
--------------------
+-------------------------
 .. code-block:: python
 @adapter_config(context=(IContactPhoneParagraph, IPyAMSLayer), provides=IParagraphInnerEditor)
+permission=MANAGE_CONTENT_PERMISSION)
+@ajax_config(name='inner-properties.json', context=IContactPhoneParagraph, layer=IPyAMSLayer,
+base=BaseParagraphAJAXEditForm)
 @implementer(IInnerForm)
 class ContactPhoneParagraphInnerEditForm(ContactPhoneParagraphPropertiesEditForm):
 """Contact paragraph inner edit form"""
 legend = None
-ajax_handler = 'inner-properties.json'
 @property
 def buttons(self):
 if self.mode == INPUT_MODE:
 return button.Buttons(IParagraphEditFormButtons)
 else:
 return button.Buttons()
-.. code-block:: python
-@view_config(name='inner-properties.json', context=IContactPhoneParagraph, request_type=IPyAMSLayer,
-permission=MANAGE_CONTENT_PERMISSION, renderer='json', xhr=True)
-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, ())
 if 'title' in updated:
 -----------------------------
 This form is used inside modals popup
-- *HTML*
+.. code-block:: python
-.. code-block:: python
+@ajax_config(name='properties.json', context=IContactPhoneParagraph, request_type=IPyAMSLayer,
+permission=MANAGE_CONTENT_PERMISSION, renderer='json', xhr=True)
 @pagelet_config(name='properties.html', context=IContactParagraph, layer=IPyAMSLayer,
 permission=MANAGE_CONTENT_PERMISSION)
 class ContactPhoneParagraphPropertiesEditForm(BaseParagraphPropertiesEditForm):
 """Contact phone paragraph properties edit form"""
 icon_css_class = 'fa fa-fw fa-id-card-o'
 fields = field.Fields(IContactParagraph).omit('__parent__', '__name__', 'visible')
 fields['renderer'].widgetFactory = RendererFieldWidget
-ajax_handler = 'properties.json'
 edit_permission = MANAGE_CONTENT_PERMISSION
-- *JSON*
-.. code-block:: python
-@view_config(name='properties.json', context=IContactPhoneParagraph, request_type=IPyAMSLayer,
-permission=MANAGE_CONTENT_PERMISSION, renderer='json', xhr=True)
-class ContactPhoneParagraphPropertiesAJAXEditForm(BaseParagraphAJAXEditForm, ContactParagraphPropertiesEditForm):
-"""Contact phone paragraph properties edit form, JSON renderer"""
 .. note::
 Select the new content block types in ZMI to make it available in tools
 .. image:: _static/select_paragraph.png
+How to associate links or Illustrations to a Paragraph ?
+========================================================
+Adding the following marker interface, we add new behavior to the Paragraph `ContactPhoneParagraph` .
+1) Inner form
+-------------
+.. code-block:: python
+@adapter_config(context=(IContactPhoneParagraph, IPyAMSLayer), provides=IParagraphInnerEditor)
+@implementer(IInnerForm, IPropertiesEditForm, IAssociationParentForm)
+class ContactPhoneParagraphInnerEditForm(ContactPhoneParagraphPropertiesEditForm):
+"""Contact paragraph inner edit form"""
+legend = None
+ajax_handler = 'inner-properties.json'
+Marker interfaces:
+:py:class:`IPropertiesEditForm`
+:py:class:`IAssociationParentForm`
+.. image:: _static/associations_form.png
+2) Inside a dedicated menu
+--------------------------
+.. image:: _static/select_links_n_attachment.png
+.. code-block:: python
+@implementer(IContactPhoneParagraph, IIllustrationTarget,ILinkContainerTarget,IExtFileContainerTarget))
+@factory_config(provided=IContactPhoneParagraph)
+class ContactPhoneParagraph(BaseParagraph):
+"""Contact paragraph"""
+...
+Marker interfaces:
++--------------------------------+
+|:py:class:`IIllustrationTarget` |
++===================+============+
+|                   |            |
++-------------------+------------+
++---------------------------------+
+|:py:class:`ILinkContainerTarget` |
++==============+==================+
+|              | Add internal link|
+|              +------------------+
+|              | Add external link|
+|              +------------------+
+|              | Add mailto link  |
++--------------+------------------+
++------------------------------------+
+|:py:class:`IExtFileContainerTarget` |
++================+===================+
+|                | Add external file |
+|                +-------------------+
+|                | Add image         |
+|                +-------------------+
+|                | Add video         |
+|                +-------------------+
+|                | Add audio file    |
++----------------+-------------------+
+ZMI overview:
+.. image:: _static/select_add_links.png

branch	doc-dc
changeset 85	82165875e66b
parent 84	8eb1b401003a
child 87	a5c0ec15b437