Binary file src/source/_static/tool_management.png has changed
--- a/src/source/conf.py Tue Dec 18 11:48:01 2018 +0100
+++ b/src/source/conf.py Tue Dec 18 18:31:17 2018 +0100
@@ -26,6 +26,7 @@
sys.path[0:0] = list(map(lambda x: prefix_path + x,
[
'pyams_alchemy/src',
+ 'pyams_apm/src',
'pyams_cache/src',
'pyams_catalog/src',
'pyams_content/src',
--- a/src/source/dev_guide/adv-features.rst Tue Dec 18 11:48:01 2018 +0100
+++ b/src/source/dev_guide/adv-features.rst Tue Dec 18 18:31:17 2018 +0100
@@ -81,4 +81,12 @@
Internationalization
--------------------
+.. _howto-i18n:
+pot-create -o ref.pot scr/
+msgmerge -U def.po ref.pot
+msgfmt def.po
+
+#bin/pot-create -o src/onf_website/locales/onf_website.pot src/
+#msgmerge -U --previous --sort-by-file src/onf_website/locales/fr/LC_MESSAGES/onf_website.po src/onf_website/locales/onf_website.pot
+#msgfmt src/onf_website/locales/fr/LC_MESSAGES/onf_website.po -o src/onf_website/locales/fr/LC_MESSAGES/onf_website.mo
--- a/src/source/dev_guide/appextend.rst Tue Dec 18 11:48:01 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/dev_guide/developerguide.rst Tue Dec 18 11:48:01 2018 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,54 +0,0 @@
-.. _developerguide:
-
-
-Developer's Guide
-=================
-
-Introduction
-++++++++++++
-
-Pyams packages are...
-
-
-What is Pyramid?
-++++++++++++++++
-
-Pyramid is an open source Python web application framework. It is designed to make creating web applications easier.
-
-
-What is Zope?
-+++++++++++++
-
-Zope 2 is a free and open-source, object-oriented web application server written in the Python programming language. The term ZOPE is an acronym for “Z Object Publishing Environment” (the Z doesn’t really mean anything in particular). However, nowadays ZOPE is simply written as Zope. It has three distinct audiences.
-
-
-This guide is intended to document Zope for the second audience, Developers, as defined above. If you fit more into the “user” audience defined above, you’ll probably want to start by reading The Zope Book .
-
-Throughout this guide, it is assumed that you know how to program in the Python programming language. Most of the examples in this guide will be in Python. There are a number of great resources and books for learning Python; the best online resource is the python.org web site and many books can be found on the shelves of your local bookstore.
-1.2. Organization of the book
-
-This book describes Zope’s services to the developer from a hands on, example-oriented standpoint. This book is not a complete reference to the Zope API, but rather a practical guide to applying Zope’s services to develop and deploy your own web applications. This book covers the following topics:
-
-Components and Interfaces
- Zope use a component-centric development model. This chapter describes the component model in Zope and how Zope components are described through interfaces.
-Object Publishing
- Developing applications for Zope involves more than just creating a component, that component must be publishable on the web. This chapter describes publication, and how your components need to be designed to be published.
-Zope Products
- New Zope components are distributed and installed in packages called “Products”. This chapter explains Products in detail.
-Persistent Components
- Zope provides a built-in, transparent Python object database called ZODB. This chapter describes how to create persistent components, and how they work in conjunction with the ZODB.
-Acquisition
- Zope relies heavily on a dynamic technique called acquisition. This chapter explores acquisition thoroughly.
-Security
- When your component is used by many different people through the web, security becomes a big concern. This chapter describes Zope’s security API and how you can use it to make security assertions about your object.
-Debugging and Testing
- Zope has built in debugging and testing support. This chapter describes these facilities and how you can debug and test your components.
-
-
-.. toctree::
- :maxdepth: 2
-
- Package directory layout <package_layout>
- appextend
- traverser
- tales
--- a/src/source/dev_guide/howto-paragraph.rst Tue Dec 18 11:48:01 2018 +0100
+++ b/src/source/dev_guide/howto-paragraph.rst Tue Dec 18 18:31:17 2018 +0100
@@ -222,9 +222,9 @@
.. note::
- Select the new content block types in ZMI to make it available in tools
+ Add the new paragraph in "content block types" to make it available in tools
- .. image:: ../_static/select_paragraph.png
+ .. image:: ../_static/tool_management.png
5) Paragraph Factory
--- a/src/source/dev_guide/internals.rst Tue Dec 18 11:48:01 2018 +0100
+++ b/src/source/dev_guide/internals.rst Tue Dec 18 18:31:17 2018 +0100
@@ -3,3 +3,36 @@
Understanding PyAMS internals
=============================
+Annotations
+-----------
+
+Traversal
+---------
+
+Namespaces
+----------
+
+TALES Extensions
+----------------
+
+Renderers
+---------
+
+Sequences
+---------
+
+Internal references
+-------------------
+
+Versioning
+----------
+
+Catalog
+-------
+
+Views
+-----
+
+Search engines
+--------------
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/dev_guide/intro-dev.rst Tue Dec 18 18:31:17 2018 +0100
@@ -0,0 +1,50 @@
+.. _introdev:
+
+Introduction
+============
+
+PyAMS application used the Pyramid framework and Zope architecture, most of functionality of PyAMS
+are build on this base.
+
+What is Pyramid?
+----------------
+
+Pyramid is an open source Python web application framework. It is designed to make creating web applications easier.
+
+
+What is Zope?
+-------------
+
+Zope is a free and open-source, object-oriented web application server written in the Python programming language. The term ZOPE is an acronym for “Z Object Publishing Environment” (the Z doesn’t really mean anything in particular). However, nowadays ZOPE is simply written as Zope. It has three distinct audiences.
+
+
+This guide is intended to document Zope for the second audience, Developers, as defined above. If you fit more into the “user” audience defined above, you’ll probably want to start by reading The Zope Book .
+
+Throughout this guide, it is assumed that you know how to program in the Python programming language. Most of the examples in this guide will be in Python. There are a number of great resources and books for learning Python; the best online resource is the python.org web site and many books can be found on the shelves of your local bookstore.
+1.2. Organization of the book
+
+This book describes Zope’s services to the developer from a hands on, example-oriented standpoint. This book is not a complete reference to the Zope API, but rather a practical guide to applying Zope’s services to develop and deploy your own web applications. This book covers the following topics:
+
+.. glossary::
+
+ Components and Interfaces
+ Zope use a component-centric development model. This chapter describes the component model in Zope and how Zope components are described through interfaces.
+
+ Object Publishing
+ Developing applications for Zope involves more than just creating a component, that component must be publishable on the web. This chapter describes publication, and how your components need to be designed to be published.
+
+ Zope Products
+ New Zope components are distributed and installed in packages called “Products”. This chapter explains Products in detail.
+
+ Persistent Components
+ Zope provides a built-in, transparent Python object database called ZODB. This chapter describes how to create persistent components, and how they work in conjunction with the ZODB.
+
+ Acquisition
+ Zope relies heavily on a dynamic technique called acquisition. This chapter explores acquisition thoroughly.
+
+ Security
+ When your component is used by many different people through the web, security becomes a big concern. This chapter describes Zope’s security API and how you can use it to make security assertions about your object.
+
+ Debugging and Testing
+ Zope has built in debugging and testing support. This chapter describes these facilities and how you can debug and test your components.
+
--- a/src/source/dev_guide/introduction.rst Tue Dec 18 11:48:01 2018 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,36 +0,0 @@
-.. _introduction:
-
-Why should i use PyAMS?
------------------------
-
-Based on the python langage, **PyAMS** supply powerfull tools like *PyAMS_content*, this package
-providing content management features, which can be easily extended to manage your own content types.
-But PyAMS can also be used to manage any kind of application.
-
-In addition **PyAMS** is built on top of **MyAMS** (**My** **\A**\pplication **\M**\anagement **\S**\kin), a small web client framework built on top of JQuery
-and Bootstrap, which was developed by the french national forestry office (ONF -- Office national des forêts --
-http://www.onf.fr) to build web applications in several languages (actually java, Python and PHP). The new ONF website
-is now completely handled with PyAMS framework.
-
-PyAMS is a multipurpose set of packages, providing tools including:
-
- * custom interfaces
- * custom registry annotations
- * custom security policy
- * local registry support
- * network protocols utilities (for HTTP and XML-RPC)
- * command line scripts
- * custom utilities.
-
-
-.. tip::
- Some screenshots of the admin interface are available at :ref:`screenshots`!
-
-
-How to install PyAMS?
----------------------
-
-If you want to create a PyAMS application instance easily, just follow the :ref:`quickstart` guide!
-If you want learn more about a custom installation follow :ref:`install` procedure.
-
-
--- a/src/source/glossary.rst Tue Dec 18 11:48:01 2018 +0100
+++ b/src/source/glossary.rst Tue Dec 18 18:31:17 2018 +0100
@@ -7,6 +7,9 @@
.. glossary::
Administrator
+ A web administrator maintains web server services (such as Apache or IIS) that allow for internal or external access to
+ web sites. Tasks include managing multiple sites, administering security, and configuring necessary components
+ and software. Responsibilities may also include software change management. (source:wiki)
Back-office
The back end is what your contributor see and interact with to add and manage they come to your website.
@@ -14,6 +17,7 @@
Blog
Component
+ A component can be any Python object and has a particular purpose associated with it.
Content
content consists of text, images, or other information shared in posts. This is separate from the structural
@@ -22,6 +26,11 @@
content, rather than the structural or graphic design of a web sit
Content block or "paragraph"
+ The block or paragraph is a component who can be include inside shared tools to build an editorial content.
+ PyAMS provides several block like "Key Number, enriched text or Galery
+
+ Default theme
+ PyAMS comes with a default theme to display the front-end of the website.
Developer
A developer, or dev, is a computer programmer who be able to create,
--- a/src/source/index.rst Tue Dec 18 11:48:01 2018 +0100
+++ b/src/source/index.rst Tue Dec 18 18:31:17 2018 +0100
@@ -19,6 +19,7 @@
:maxdepth: 2
Overview <overview>
+ Introduction <introduction>
Quickstart <quickstart>
Glossary <glossary>
@@ -51,12 +52,13 @@
:maxdepth: 2
:caption: Developer Guide
+ Introduction <dev_guide/intro-dev>
Understanding the Zope Component Architecture <dev_guide/zca>
Understanding PyAMS internals <dev_guide/internals>
Creating new PyAMS Packages <dev_guide/new-package>
Overriding PyAMS features <dev_guide/overring-feature>
Customizing site appearance <dev_guide/custom-skin>
- Understanding PyAMS forms <dev_guide/new_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>
@@ -71,7 +73,7 @@
PyAMS packages layout <ref_guide/package_layout>
PyAMS packages references <ref_guide/packages>
- PyAMs Test <ref_guide/test>
+ PyAMs Test <ref_guide/tests>
.. toctree::
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/introduction.rst Tue Dec 18 18:31:17 2018 +0100
@@ -0,0 +1,36 @@
+.. _introduction:
+
+Why should i use PyAMS?
+-----------------------
+
+Based on the python langage, **PyAMS** supply powerfull tools like *PyAMS_content*, this package
+providing content management features, which can be easily extended to manage your own content types.
+But PyAMS can also be used to manage any kind of application.
+
+In addition **PyAMS** is built on top of **MyAMS** (**My** **\A**\pplication **\M**\anagement **\S**\kin), a small web client framework built on top of JQuery
+and Bootstrap, which was developed by the french national forestry office (ONF -- Office national des forêts --
+http://www.onf.fr) to build web applications in several languages (actually java, Python and PHP). The new ONF website
+is now completely handled with PyAMS framework.
+
+PyAMS is a multipurpose set of packages, providing tools including:
+
+ * custom interfaces
+ * custom registry annotations
+ * custom security policy
+ * local registry support
+ * network protocols utilities (for HTTP and XML-RPC)
+ * command line scripts
+ * custom utilities.
+
+
+.. tip::
+ Some screenshots of the admin interface are available at :ref:`screenshots`!
+
+
+How to install PyAMS?
+---------------------
+
+If you want to create a PyAMS application instance easily, just follow the :ref:`quickstart` guide!
+If you want learn more about a custom installation follow :ref:`install` procedure.
+
+
--- a/src/source/quickstart.rst Tue Dec 18 11:48:01 2018 +0100
+++ b/src/source/quickstart.rst Tue Dec 18 18:31:17 2018 +0100
@@ -281,7 +281,7 @@
Launch a browser and open URL http://127.0.0.1:6543/admin to get access to PyAMS management interface.
-.. image:: ../_static/pyams-login.png
+.. image:: _static/pyams-login.png
.. warning::
--- a/src/source/ref_guide/packages.rst Tue Dec 18 11:48:01 2018 +0100
+++ b/src/source/ref_guide/packages.rst Tue Dec 18 18:31:17 2018 +0100
@@ -50,7 +50,7 @@
:maxdepth: 1
PyAMS Content with ElasticSearch <../_api-doc/pyams_content_es/pyams_content_es>
- PyAMS APM <../_api-doc/pyams_alchemy/pyams_apm>
+ PyAMS APM <../_api-doc/pyams_apm/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>
--- a/src/source/screenshots.rst Tue Dec 18 11:48:01 2018 +0100
+++ b/src/source/screenshots.rst Tue Dec 18 18:31:17 2018 +0100
@@ -11,16 +11,16 @@
* PyAMS dashboard:
-.. image:: ../_static/pyams-dashboard.png
+.. image:: _static/pyams-dashboard.png
* PyAMS site properties:
-.. image:: ../_static/pyams-properties.png
+.. image:: _static/pyams-properties.png
* PyAMS control panel showing registered utilities:
-.. image:: ../_static/pyams-control-panel.png
+.. image:: _static/pyams-control-panel.png
* PyAMS paragraphs of a sample 'news' content, also displaying access to workflow transitions:
-.. image:: ../_static/pyams-paragraphs.png
+.. image:: _static/pyams-paragraphs.png
--- a/src/source/user_guide/contributor-guide.rst Tue Dec 18 11:48:01 2018 +0100
+++ b/src/source/user_guide/contributor-guide.rst Tue Dec 18 18:31:17 2018 +0100
@@ -80,7 +80,7 @@
PyAMS offers a user-friendly interface for editing the content of an article, to do that, move on the side bar
and the section **Composition** and click on **Contents...**
- .. image:: ../_static/select_paragraph.png
+ .. image:: ../_static/tool_management.png
An article is composed of many paragraphs or blocks. Depending on the configuration of the shared tool,
one or more paragraphs may already be present when creating a new article to help the author structure his document.
