Updated index doc-dc
authorDamien Correia
Tue, 18 Dec 2018 11:48:01 +0100
branchdoc-dc
changeset 125 c8081c2ffe56
parent 124 696f58cb5bdd
child 126 e0584f3de3fd
Updated index
src/source/dev_guide/howto-paragraph.rst
src/source/dev_guide/workflow.rst
src/source/index.rst
src/source/user_guide/cms-interface.rst
src/source/user_guide/contributor-guide.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``
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/dev_guide/workflow.rst	Tue Dec 18 11:48:01 2018 +0100
@@ -0,0 +1,4 @@
+.. _workflow:
+
+Creating Custom workflows
+=========================
--- a/src/source/index.rst	Mon Dec 17 18:07:56 2018 +0100
+++ b/src/source/index.rst	Tue Dec 18 11:48:01 2018 +0100
@@ -54,13 +54,13 @@
    Understanding the Zope Component Architecture <dev_guide/zca>
    Understanding PyAMS internals <dev_guide/internals>
    Creating new PyAMS Packages <dev_guide/new-package>
-   Creating new PyAMS Packages<dev_guide/overring-feature>
+   Overriding PyAMS features <dev_guide/overring-feature>
    Customizing site appearance <dev_guide/custom-skin>
-   Understanding PyAMS forms <dev_guide/dev-form>
+   Understanding PyAMS forms <dev_guide/new_form>
    Creating new Paragraph (or blocks) <dev_guide/howto-paragraph>
    Creating new Portlet <dev_guide/howto-portlet>
    Creating new Content type <dev_guide/howto-content>
-   Creating Custom workflows <dev_guide/howto-workflowk>
+   Creating Custom workflows <dev_guide/workflow>
    Advanced features <dev_guide/adv-features>
 
 
--- a/src/source/user_guide/cms-interface.rst	Mon Dec 17 18:07:56 2018 +0100
+++ b/src/source/user_guide/cms-interface.rst	Tue Dec 18 11:48:01 2018 +0100
@@ -2,3 +2,10 @@
 
 Management interface
 ====================
+
+Screenshoot
+-----------
+
+PyAMS management interface
+--------------------------
+
--- a/src/source/user_guide/contributor-guide.rst	Mon Dec 17 18:07:56 2018 +0100
+++ b/src/source/user_guide/contributor-guide.rst	Tue Dec 18 11:48:01 2018 +0100
@@ -7,11 +7,9 @@
 	Individuals who use PyAMS features to create a custom application or website.
 
 
-To Begin
---------
+First login
+-----------
 
-Login
-^^^^^
 
 Begin by logging into the “administration area” or the back end of your website.
 Now log into PyAMS using your username and password.
@@ -19,8 +17,7 @@
 	.. image:: ../_static/pyams-login.png
 
 
-Dashboard
-^^^^^^^^^
+**Dashboard**
 
 After logging in you are on the main Administration Screen called the Dashboard. This is the starting point to create page and article
 also settings your workspace. If you are lost click on "Home" to come back on the Dashboard.
@@ -33,19 +30,23 @@
 On the left side of the screen is the main navigation menu detailing each of the administrative functions you can perform.
 
 
+
+Creating your first content
+---------------------------
+
 Article - The shared contents
------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Articles are sorted by category news, topic, long read... Each category have different attributes,
+like available paragraphs , publication workflows or contributors.
 
 
-Articles are sorted by category news, topic or long read, each category have different attributes, and they can quickly
-identify the type of content.
+
+Example : create a News
+^^^^^^^^^^^^^^^^^^^^^^^
 
 The News are a short article to spotlight an information. This is typically the type of content used for blog posts or news feeds
 
-
-Create a News
-^^^^^^^^^^^^^
-
 To create a News, click on the "Shared contents" on the top bar and select "News" then click on **+ Add news topic**
 
 	.. image:: ../_static/add_newtopic.png
@@ -152,9 +153,6 @@
 Raw HTML
 ^^^^^^^^
 
-Verify the content
-------------------
-
 Audit
 ^^^^^
 
@@ -162,8 +160,24 @@
 ^^^^^^^
 
 
+
+Managing Picture
+----------------
+
+
+Translating content
+-------------------
+
+Checking content
+----------------
+
+
+Publication workflow
+--------------------
+
+
 Publishing an Article
----------------------
+^^^^^^^^^^^^^^^^^^^^^
 
 When you are writing an article, it's not already visible for the visitors, but when the content is ready the editor
 has the possibility to make a request by clicking on the button **Change status**.
@@ -272,3 +286,6 @@
 
 
 
+
+Managing version
+----------------