pyams/pyams_user_guide: comparison src/source/dev

equal deleted inserted replaced

-:696f58cb5bdd
+:c8081c2ffe56
 .. _paragraphhowto:
+Creating new Paragraph (or blocks)
-How to create a Paragraph type?
+==================================
-===============================
 Paragraphs or Blocks are components that contain elements/fields and provide one or many renderer methods to compose
 the front office website
+How to create a Paragraph type?
-Create a Paragraph
+-------------------------------
-""""""""""""""""""
 In this example we will create a contact paragraph to display at the user, who to contact.
 1) Interface
-------------
+^^^^^^^^^^^^
 At first we create a new paragraph interface.
 .. code-block:: python
 2) Implement the interface
---------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 An implementation of the interface
 .. code-block:: python
 if IImage.providedBy(self._photo):
 alsoProvides(self._photo, IResponsiveImage)
 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
 :ref:`rendererhowto`
 Paragraph in the ZMI
-""""""""""""""""""""
+--------------------
 1) Container Paragraph
-----------------------
+^^^^^^^^^^^^^^^^^^^^^^
 For example :py:class:`IParagraphContainerTarget`, it's a marker interface for paragraph containers.
 To create a new element instance inside the zodb, we need a container to this object. PyAMS provide
 `IParagraphContainerTarget`, it's the default marker interface container for all paragraphs.
 To display and manage the new paragraph in the ZMI, you should create this associated forms
 2) Create 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
 paragraph_type = CONTACT_PARAGRAPH_TYPE
 3) Create Edit inner form
--------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: python
 @adapter_config(context=(IContactPhoneParagraph, IPyAMSLayer), provides=IParagraphInnerEditor)
 permission=MANAGE_CONTENT_PERMISSION)
 ContactParagraphInnerEditForm))
 return output
 4) Create an Edit modal form
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 This form is used inside modals popup
 .. code-block:: python
 .. image:: ../_static/select_paragraph.png
 5) Paragraph Factory
---------------------
+^^^^^^^^^^^^^^^^^^^^
 If you want to create automatically a paragraph object for a shared content you must define a factory
 Declaration of the **factory** of `ContactPhoneParagraph`
 When the contributors will create new shared content with predefined paragraphs,
 it's the container factory class that will be used to create the paragraph object.
 How to associate links or Illustrations to a Paragraph ?
-========================================================
+--------------------------------------------------------
 Adding the following marker interface, we add new behavior to the Paragraph `ContactPhoneParagraph` .
-Paragraph advanced
-""""""""""""""""""
 You can attach Associated files, links or illustration and manage them directly through the rubric `Links and Attachments`.
 .. image:: ../_static/select_links_n_attachment.png
 1) Paragraph with Links and Attachements
-----------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 To "activate" this features the paragrath object must to implement specific interface
 .. code-block:: python
 .. image:: ../_static/select_add_links.png
 2) Add link and association form
---------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 You can add form to manage links and attachments directly in paragraph form to do that your form must implement
 ``IPropertiesEditForm`` and/or  ``IAssociationParentForm``

branch	doc-dc
changeset 125	c8081c2ffe56
parent 122	7e69ecc9fd43
child 126	e0584f3de3fd