Updated developer guide doc-dc
authorDamien Correia
Thu, 13 Dec 2018 13:12:51 +0100
branchdoc-dc
changeset 114 8032f81fba95
parent 113 5108336d3a4c
child 115 bd11e4938409
Updated developer guide
src/source/admln_guide/app.rst
src/source/admln_guide/appextend.rst
src/source/admln_guide/manage.rst
src/source/dev_guide/adv-features.rst
src/source/dev_guide/appextend.rst
src/source/dev_guide/utilities.rst
src/source/glossary.rst
src/source/index.rst
src/source/ref_guide/packages.rst
src/source/ref_guide/tests.rst
src/source/user_guide/manager-guide.rst
--- a/src/source/admln_guide/app.rst	Thu Dec 13 11:34:10 2018 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,10 +0,0 @@
-.. _app:
-
-Configuring and Running PyAMS
-=============================
-
-.. toctree::
-   :maxdepth: 2
-
-   appconfig
-   appstart
--- a/src/source/admln_guide/appextend.rst	Thu Dec 13 11:34:10 2018 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,18 +0,0 @@
-.. _appextend:
-
-
-How to extend PyAMS ?
-=====================
-
-.. toctree::
-    :maxdepth: 1
-
-
-    howto-adapter
-    howto-form
-    howto-paragraph
-    howto-portlet
-    howto-renderer
-    howto-rename
-    howto-skin
-    howto-template
--- a/src/source/admln_guide/manage.rst	Thu Dec 13 11:34:10 2018 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,12 +0,0 @@
-.. _manage:
-
-Managing PyAMS environment
-==========================
-
-.. toctree::
-   :maxdepth: 2
-
-   appmanage
-   utilities
-
-
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/dev_guide/adv-features.rst	Thu Dec 13 13:12:51 2018 +0100
@@ -0,0 +1,22 @@
+.. _advfeatures:
+
+
+Advanced features
+=================
+
+
+Managing schema generations
+---------------------------
+
+Renaming persistent classes
+---------------------------
+
+Including SQLAlchemy
+--------------------
+
+Using GIS features
+------------------
+
+Internationalization
+--------------------
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/dev_guide/appextend.rst	Thu Dec 13 13:12:51 2018 +0100
@@ -0,0 +1,18 @@
+.. _appextend:
+
+
+How to extend PyAMS ?
+=====================
+
+.. toctree::
+    :maxdepth: 1
+
+
+    howto-adapter
+    howto-form
+    howto-paragraph
+    howto-portlet
+    howto-renderer
+    howto-rename
+    howto-skin
+    howto-template
--- a/src/source/dev_guide/utilities.rst	Thu Dec 13 11:34:10 2018 +0100
+++ b/src/source/dev_guide/utilities.rst	Thu Dec 13 13:12:51 2018 +0100
@@ -39,19 +39,3 @@
 That should require an update of :py:func:`tzinfo` adapter to get timezone info from session, request or user profile.
 
 
-ZEO connection
---------------
-
-Several PyAMS utilities (like the tasks scheduler or the medias converter) are working with dedicated processes,
-are connected to main PyAMS process through ØMQ, and use ZEO connections for their PyAMS database access.
-
-Clients of these processes have to send settings of the ZEO connections that they should use.
-
-The ZEOConnection utility can be created by the site manager through the web management interface (ZMI) from the
-*Control panel*:
-
-.. image:: _static/zeo-add-menu.png
-
-ZEO connection creation form allows you to define all settings of a ZEO connection:
-
-.. image:: _static/zeo-add-form.png
--- a/src/source/glossary.rst	Thu Dec 13 11:34:10 2018 +0100
+++ b/src/source/glossary.rst	Thu Dec 13 13:12:51 2018 +0100
@@ -1,11 +1,15 @@
 .. _glossary:
 
+Glossary
+========
+
+
 .. glossary::
 
 	Administrator
-		*
+
 	Back-officer
-		*
+
 	Blog
 
 	Component
--- a/src/source/index.rst	Thu Dec 13 11:34:10 2018 +0100
+++ b/src/source/index.rst	Thu Dec 13 13:12:51 2018 +0100
@@ -52,16 +52,16 @@
    :caption:  Developer Guide
 
    Understanding the Zope Component Architecture <dev_guide/zca>
-   Understanding PyAMS internals
-   Creating new PyAMS Packages
-   Overriding PyAMS features
-   Customizing site appearance
-   Understanding PyAMS forms
-   Creating new blocks
-   Creating new portlet
-   Creating new content type
-   Creating Custom workflows
-   Advanced features
+   Understanding PyAMS internals <dev_guide/internals>
+   Creating new PyAMS Packages <dev_guide/internals>
+   Overriding PyAMS features <dev_guide/overring>
+   Customizing site appearance <dev_guide/custom>
+   Understanding PyAMS forms <dev_guide/dev_form>
+   Creating new blocks <dev_guide/howto-block>
+   Creating new portlet <dev_guide/howto-portlet>
+   Creating new content type <dev_guide/howto-content>
+   Creating Custom workflows <dev_guide/howto-workflow>
+   Advanced features <dev_guide/adv-features>
 
 
 
--- a/src/source/ref_guide/packages.rst	Thu Dec 13 11:34:10 2018 +0100
+++ b/src/source/ref_guide/packages.rst	Thu Dec 13 13:12:51 2018 +0100
@@ -10,21 +10,21 @@
 .. toctree::
    :maxdepth: 1
 
-   PyAMS Template <_api-doc/pyams_template/pyams_template>
-   PyAMS Viewlet <_api-doc/pyams_viewlet/pyams_viewlet>
-   PyAMS Pagelet <_api-doc/pyams_pagelet/pyams_pagelet>
-   PyAMS Utils <_api-doc/pyams_utils/pyams_utils>
-   PyAMS Skin <_api-doc/pyams_skin/pyams_skin>
-   PyAMS Form <_api-doc/pyams_form/pyams_form>
-   PyAMS File <_api-doc/pyams_file/pyams_file>
-   PyAMS I18N <_api-doc/pyams_i18n/pyams_i18n>
-   PyAMS Security <_api-doc/pyams_security/pyams_security>
-   PyAMS Catalog <_api-doc/pyams_catalog/pyams_catalog>
-   PyAMS Mail <_api-doc/pyams_mail/pyams_mail>
-   PyAMS Cache <_api-doc/pyams_cache/pyams_cache>
-   PyAMS ZMQ <_api-doc/pyams_zmq/pyams_zmq>
-   PyAMS Scheduler <_api-doc/pyams_scheduler/pyams_scheduler>
-   PyAMS ZMI <_api-doc/pyams_zmi/pyams_zmi>
+   PyAMS Template <../_api-doc/pyams_template/pyams_template>
+   PyAMS Viewlet <../_api-doc/pyams_viewlet/pyams_viewlet>
+   PyAMS Pagelet <../_api-doc/pyams_pagelet/pyams_pagelet>
+   PyAMS Utils <../_api-doc/pyams_utils/pyams_utils>
+   PyAMS Skin <../_api-doc/pyams_skin/pyams_skin>
+   PyAMS Form <../_api-doc/pyams_form/pyams_form>
+   PyAMS File <../_api-doc/pyams_file/pyams_file>
+   PyAMS I18N <../_api-doc/pyams_i18n/pyams_i18n>
+   PyAMS Security <../_api-doc/pyams_security/pyams_security>
+   PyAMS Catalog <../_api-doc/pyams_catalog/pyams_catalog>
+   PyAMS Mail <../_api-doc/pyams_mail/pyams_mail>
+   PyAMS Cache <../_api-doc/pyams_cache/pyams_cache>
+   PyAMS ZMQ <../_api-doc/pyams_zmq/pyams_zmq>
+   PyAMS Scheduler <../_api-doc/pyams_scheduler/pyams_scheduler>
+   PyAMS ZMI <../_api-doc/pyams_zmi/pyams_zmi>
 
 
 CMS Packages
@@ -33,12 +33,12 @@
 .. toctree::
    :maxdepth: 1
 
-   PyAMS Sequence <_api-doc/pyams_sequence/pyams_sequence>
-   PyAMS Workflow <_api-doc/pyams_workflow/pyams_workflow>
-   PyAMS Thesaurus <_api-doc/pyams_thesaurus/pyams_thesaurus>
-   PyAMS Portal <_api-doc/pyams_portal/pyams_portal>
-   PyAMS Content <_api-doc/pyams_content/pyams_content>
-   PyAMS Default theme <_api-doc/pyams_default_theme/pyams_default_theme>
+   PyAMS Sequence <../_api-doc/pyams_sequence/pyams_sequence>
+   PyAMS Workflow <../_api-doc/pyams_workflow/pyams_workflow>
+   PyAMS Thesaurus <../_api-doc/pyams_thesaurus/pyams_thesaurus>
+   PyAMS Portal <../_api-doc/pyams_portal/pyams_portal>
+   PyAMS Content <../_api-doc/pyams_content/pyams_content>
+   PyAMS Default theme <../_api-doc/pyams_default_theme/pyams_default_theme>
 
 
 Optional packages
@@ -49,12 +49,12 @@
 .. toctree::
    :maxdepth: 1
 
-   PyAMS Content with ElasticSearch <_api-doc/pyams_content_es/pyams_content_es>
-   PyAMS APM  <_api-doc/pyams_alchemy/pyams_apm>
-   PyAMS ZODBbrowser <_api-doc/pyams_zodbbrowser/pyams_zodbbrowser>
-   PyAMS LDAP <_api-doc/pyams_ldap/pyams_ldap>
-   PyAMS GIS <_api-doc/pyams_gis/pyams_gis>
-   PyAMS Alchemy  <_api-doc/pyams_alchemy/pyams_alchemy>
-   PyAMS Media <_api-doc/pyams_media/pyams_media>
-   PyAMS Notify <_api-doc/pyams_notify/pyams_notify>
-   PyAMS Notify with WebSocket<_api-doc/pyams_notify_ws/pyams_notify_ws>
+   PyAMS Content with ElasticSearch <../_api-doc/pyams_content_es/pyams_content_es>
+   PyAMS APM  <../_api-doc/pyams_alchemy/pyams_apm>
+   PyAMS ZODBbrowser <../_api-doc/pyams_zodbbrowser/pyams_zodbbrowser>
+   PyAMS LDAP <../_api-doc/pyams_ldap/pyams_ldap>
+   PyAMS GIS <../_api-doc/pyams_gis/pyams_gis>
+   PyAMS Alchemy  <../_api-doc/pyams_alchemy/pyams_alchemy>
+   PyAMS Media <../_api-doc/pyams_media/pyams_media>
+   PyAMS Notify <../_api-doc/pyams_notify/pyams_notify>
+   PyAMS Notify with WebSocket<../_api-doc/pyams_notify_ws/pyams_notify_ws>
--- a/src/source/ref_guide/tests.rst	Thu Dec 13 11:34:10 2018 +0100
+++ b/src/source/ref_guide/tests.rst	Thu Dec 13 13:12:51 2018 +0100
@@ -6,29 +6,29 @@
 .. toctree::
    :maxdepth: 1
 
-   PyAMS Alchemy tests <_api-doc/pyams_alchemy/pyams_alchemy.tests>
-   PyAMS Cache tests <_api-doc/pyams_cache/pyams_cache.tests>
-   PyAMS Catalog tests <_api-doc/pyams_catalog/pyams_catalog.tests>
-   PyAMS Content tests <_api-doc/pyams_content/pyams_content.tests>
-   PyAMS Content_es tests <_api-doc/pyams_content_es/pyams_content_es.tests>
-   PyAMS File tests <_api-doc/pyams_file/pyams_file.tests>
-   PyAMS Form tests <_api-doc/pyams_form/pyams_form.tests>
-   PyAMS GIS tests <_api-doc/pyams_gis/pyams_gis.tests>
-   PyAMS LDAP tests <_api-doc/pyams_ldap/pyams_ldap.tests>
-   PyAMS Mail tests <_api-doc/pyams_mail/pyams_mail.tests>
-   PyAMS Media tests <_api-doc/pyams_media/pyams_media.tests>
-   PyAMS Notify tests <_api-doc/pyams_notify/pyams_notify.tests>
-   PyAMS Pagelet tests <_api-doc/pyams_pagelet/pyams_pagelet.tests>
-   PyAMS Portal tests <_api-doc/pyams_portal/pyams_portal.tests>
-   PyAMS Scheduler tests <_api-doc/pyams_scheduler/pyams_scheduler.tests>
-   PyAMS Security tests <_api-doc/pyams_security/pyams_security.tests>
-   PyAMS Sequence tests <_api-doc/pyams_sequence/pyams_sequence.tests>
-   PyAMS Skin tests <_api-doc/pyams_skin/pyams_skin.tests>
-   PyAMS Template tests <_api-doc/pyams_template/pyams_template.tests>
-   PyAMS Thesaurus tests <_api-doc/pyams_thesaurus/pyams_thesaurus.tests>
-   PyAMS Utils tests <_api-doc/pyams_utils/pyams_utils.tests>
-   PyAMS Viewlet tests <_api-doc/pyams_viewlet/pyams_viewlet.tests>
-   PyAMS Workflow tests <_api-doc/pyams_workflow/pyams_workflow.tests>
-   PyAMS ZMI tests <_api-doc/pyams_zmi/pyams_zmi.tests>
-   PyAMS ZMQ tests <_api-doc/pyams_zmq/pyams_zmq.tests>
-   PyAMS ZODBbrowser tests <_api-doc/pyams_zodbbrowser/pyams_zodbbrowser.tests>
+   PyAMS Alchemy tests <../_api-doc/pyams_alchemy/pyams_alchemy.tests>
+   PyAMS Cache tests <../_api-doc/pyams_cache/pyams_cache.tests>
+   PyAMS Catalog tests <../_api-doc/pyams_catalog/pyams_catalog.tests>
+   PyAMS Content tests <../_api-doc/pyams_content/pyams_content.tests>
+   PyAMS Content_es tests <../_api-doc/pyams_content_es/pyams_content_es.tests>
+   PyAMS File tests <../_api-doc/pyams_file/pyams_file.tests>
+   PyAMS Form tests <../_api-doc/pyams_form/pyams_form.tests>
+   PyAMS GIS tests <../_api-doc/pyams_gis/pyams_gis.tests>
+   PyAMS LDAP tests <../_api-doc/pyams_ldap/pyams_ldap.tests>
+   PyAMS Mail tests <../_api-doc/pyams_mail/pyams_mail.tests>
+   PyAMS Media tests <../_api-doc/pyams_media/pyams_media.tests>
+   PyAMS Notify tests <../_api-doc/pyams_notify/pyams_notify.tests>
+   PyAMS Pagelet tests <../_api-doc/pyams_pagelet/pyams_pagelet.tests>
+   PyAMS Portal tests <../_api-doc/pyams_portal/pyams_portal.tests>
+   PyAMS Scheduler tests <../_api-doc/pyams_scheduler/pyams_scheduler.tests>
+   PyAMS Security tests <../_api-doc/pyams_security/pyams_security.tests>
+   PyAMS Sequence tests <../_api-doc/pyams_sequence/pyams_sequence.tests>
+   PyAMS Skin tests <../_api-doc/pyams_skin/pyams_skin.tests>
+   PyAMS Template tests <../_api-doc/pyams_template/pyams_template.tests>
+   PyAMS Thesaurus tests <../_api-doc/pyams_thesaurus/pyams_thesaurus.tests>
+   PyAMS Utils tests <../_api-doc/pyams_utils/pyams_utils.tests>
+   PyAMS Viewlet tests <../_api-doc/pyams_viewlet/pyams_viewlet.tests>
+   PyAMS Workflow tests <../_api-doc/pyams_workflow/pyams_workflow.tests>
+   PyAMS ZMI tests <../_api-doc/pyams_zmi/pyams_zmi.tests>
+   PyAMS ZMQ tests <../_api-doc/pyams_zmq/pyams_zmq.tests>
+   PyAMS ZODBbrowser tests <../_api-doc/pyams_zodbbrowser/pyams_zodbbrowser.tests>
--- a/src/source/user_guide/manager-guide.rst	Thu Dec 13 11:34:10 2018 +0100
+++ b/src/source/user_guide/manager-guide.rst	Thu Dec 13 13:12:51 2018 +0100
@@ -94,6 +94,22 @@
 Creating ZEO connection
 ^^^^^^^^^^^^^^^^^^^^^^^
 
+
+Several PyAMS utilities (like the tasks scheduler or the medias converter) are working with dedicated processes,
+are connected to main PyAMS process through ØMQ, and use ZEO connections for their PyAMS database access.
+
+Clients of these processes have to send settings of the ZEO connections that they should use.
+
+The ZEOConnection utility can be created by the site manager through the web management interface (ZMI) from the
+*Control panel*:
+
+.. image:: ../_static/zeo-add-menu.png
+
+ZEO connection creation form allows you to define all settings of a ZEO connection:
+
+.. image:: ../_static/zeo-add-form.png
+
+
 Planning Tasks
 ^^^^^^^^^^^^^^