diff -r 696f58cb5bdd -r c8081c2ffe56 src/source/dev_guide/howto-paragraph.rst --- a/src/source/dev_guide/howto-paragraph.rst Mon Dec 17 18:07:56 2018 +0100 +++ b/src/source/dev_guide/howto-paragraph.rst Tue Dec 18 11:48:01 2018 +0100 @@ -1,20 +1,19 @@ .. _paragraphhowto: - -How to create a Paragraph type? -=============================== +Creating new Paragraph (or blocks) +================================== 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. @@ -47,7 +46,7 @@ 2) Implement the interface --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ An implementation of the interface @@ -79,7 +78,7 @@ 3) Renderers Vocabulary ------------------------ +^^^^^^^^^^^^^^^^^^^^^^^ The list of rendered available for a paragraph is build automatically and is based on adapters that provide this interface @@ -98,10 +97,10 @@ Paragraph in the ZMI -"""""""""""""""""""" +-------------------- 1) Container Paragraph ----------------------- +^^^^^^^^^^^^^^^^^^^^^^ For example :py:class:`IParagraphContainerTarget`, it's a marker interface for paragraph containers. @@ -140,7 +139,7 @@ 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 @@ -159,7 +158,7 @@ 3) Create Edit inner form -------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: python @@ -196,7 +195,7 @@ 4) Create an Edit modal form ----------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This form is used inside modals popup @@ -229,7 +228,7 @@ 5) Paragraph Factory --------------------- +^^^^^^^^^^^^^^^^^^^^ If you want to create automatically a paragraph object for a shared content you must define a factory @@ -250,21 +249,16 @@ 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 @@ -318,7 +312,7 @@ 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``