# HG changeset patch # User Damien Correia # Date 1544697250 -3600 # Node ID 5108336d3a4c527163fcec742a1a90e13849ea65 # Parent 49e4432c0a1dcea39547d8772ea296affd66cf78 Updated users guide diff -r 49e4432c0a1d -r 5108336d3a4c src/source/admln_guide/appmanage.rst --- a/src/source/admln_guide/appmanage.rst Thu Dec 13 10:51:53 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,79 +0,0 @@ -.. _appmanage: - -.. _site: - - -PyAMS admin site -================ - -PyAMS admin site (called also **ZMI**, in memory of old **\Z**\ope **\M**\anagement **\I**\nterface) is based on the ZODB. - -When the PyAMS is initialized, it create and register several utilities into the *local registry* and saved into ZODB. -These utilities are created with default values which can be modified through **management interface** when -the application is started by default (http://localhost:6543/admin). - - -Local registry utilities -'''''''''''''''''''''''' - -One of PyAMS pre-requisites is to use the ZODB, at least to store the site root application, -it's configuration and a set of local utilities. - -Some important utilities include: - -**Catalog**: - The catalog has the responsibility to index every content properties which are required to make quick - and efficient searches. Catalog indexes are automatically created on database upgrade; management interface - allows administrator to get indexes properties, to get the number of indexed objects and values for a given index, and - to delete an index before recreating it by running the database upgrade script another time (see :ref:`scripts`). - -**Internal IDs** utility: - The catalog object doesn't store direct references to objects, but their internal IDs which are generated by this - utility. - -**Language negotiator**: - As a web site or application can be localized, this utility allows you to define priorities between language - definition options (between *user session*, *browser* end *server*), and to define which languages are available - to your users (which is particularly important when managing potentially multi-lingual contents). - - .. tip:: - Static texts like those displayed into PyAMS management interface are always translated to the language defined - into browser language, if available. - -**Portal templates** container: - Portal templates are used to define *presentation templates* based on *portlets* (see :ref:`pyams_portal`). You can - create *local* templates, or create *shared templates* into this utility which can then be reused into several - places in your web site. - -**Security manager**: - This utility is used to define authentication sources which will be available to authenticate your users. - :ref:`pyams_security` package provides several authentication modules (like local users, or via OAuth/OAuth2 - providers); :ref:`pyams_ldap` add authentication plug-in via an LDAP directory. - -**Sequential IDs** utility: - This utility is used to assign simple sequential IDs to site contents (like sites, news, topics and more); these - IDs are simple to identify a given content; several versions of a given content handle by workflow share the same - sequential ID. - -**Server timezone** utility: - Define the timezone server to display date and time accordingly. - -**User profiles** container: - This utility is used to store information associated to principals through their user profile. - - -Optional utilities can also include: - -**Elasticearch content indexer**: - -Verifier la connection entre le server ElasticSearch et la l'application PyAMS - -**Maps manager**: -Systeme de cartografie, avec OpenStreeMaps, WMS, GeoPortable, ESRI ou encore Google Maps -permet de créer des zones catographique² - -**Medias converter**: - - -**Tasks scheduler**: - diff -r 49e4432c0a1d -r 5108336d3a4c src/source/index.rst --- a/src/source/index.rst Thu Dec 13 10:51:53 2018 +0100 +++ b/src/source/index.rst Thu Dec 13 11:34:10 2018 +0100 @@ -37,23 +37,15 @@ Application tuning Troubleshooting - Configuring and Running PyAMS - Managing PyAMS environment - Additional Plugins - .. toctree:: :maxdepth: 2 - :caption: User Guide + :caption: Users Guide - Management interface - Site Manager Guide - Webmaster Guide - Contributor Guide - - PyAMS CMS User’s Guide - screenshots - + Management interface + Site Manager Guide + Webmaster Guide + Contributor Guide .. toctree:: :maxdepth: 2 diff -r 49e4432c0a1d -r 5108336d3a4c src/source/user_guide/cms-interface.rst diff -r 49e4432c0a1d -r 5108336d3a4c src/source/user_guide/contributor-guide.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/user_guide/contributor-guide.rst Thu Dec 13 11:34:10 2018 +0100 @@ -0,0 +1,274 @@ +.. _userguide: + +PyAMS Contributor's Guide +========================= + +Users or Site Managers + Individuals who use PyAMS features to create a custom application or website. + + +To Begin +-------- + +Login +^^^^^ + +Begin by logging into the “administration area” or the back end of your website. +Now log into PyAMS using your username and password. + + .. image:: _static/pyams-login.png + + +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. + + .. image:: _static/pyams-dashboard.png + + + +At the top of the screen is the “toolbar”, this navigation menu is to create new publication content (site , article, view...) +On the left side of the screen is the main navigation menu detailing each of the administrative functions you can perform. + + +Article - The shared contents +----------------------------- + + +Articles are sorted by category news, topic or long read, each category have different attributes, and they can quickly +identify the type of content. + +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 + +(*) The progress bar below the title is an indicator to optimize for indexation by search engines. + +When you are completed the form you will be redirected and invited to complete the properties of the article + + +Manage a News +^^^^^^^^^^^^^ + + .. image:: _static/content_properties.png + + +On this page you can modify the title and the url display, content description and write an unpublish note + +In Addition you can wrapped the articles with custom feature like: + +- A header or main illustration placed on the top of your article +- An illustration for the links that targets the article. + + +The interface also allows you to perform additional actions such as publishing and versioning but, we will come back to it later + + + +Edit the content of an article +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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 + +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. + +Each paragraph corresponds to a type of media and will facilitate the modification the articulation of an article. +To add a new block, click **Add ..** + + .. image:: _static/content_paragraph.png + +(*) The list of available paragraph varies depending on the nature of the article and the configuration of the shared tools + + +Paragraph +--------- + +Header +^^^^^^ + +Rich Text +^^^^^^^^^ + +Illustration +^^^^^^^^^^^^ + +Media Gallery +^^^^^^^^^^^^^ + +Video +^^^^^ + +External video +^^^^^^^^^^^^^^ + +Audio +^^^^^ + +Associations +^^^^^^^^^^^^ + +Contact +^^^^^^^ + +Framed Text +^^^^^^^^^^^ + +Image Maps +^^^^^^^^^^ + +Key number +^^^^^^^^^^ + +Key point +^^^^^^^^^ + +Location number +^^^^^^^^^^^^^^^ + +Logos +^^^^^ + +Milestones +^^^^^^^^^^ + +Pictogram +^^^^^^^^^ + +Verbatim +^^^^^^^^ + +Raw HTML +^^^^^^^^ + +Verify the content +------------------ + +Audit +^^^^^ + +Preview +^^^^^^^ + + +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**. + + + .. image:: _static/content_publish_toolbar.png + + +You will be asked to validate the date of publication and check if the content corresponds to your expectations, + + .. image:: _static/content_publication_form.png + + +If you work alone the validated content will be put online. + + +If you have collaborators, you have the possibility to used a publication workflow that include reviewers. The editor +make a **Request of publication** to the review for the validation of the request. Then, the reviewer receives a +notification inviting him to consult the article in question. + +The reviewer has the choice to accept or refuse the publication or also create a new version of the article. + + +.. warning:: + + **Important**: Once published the content can not be erased, + However you can always unpublish it to remove the access to visitors. + + +Web site Page / Blog +-------------------- + +To create a new page for your website click on `Site tree` + + + .. image:: _static/select_sitetree.png + + +A blog or weblog is a simple editorial structure where news and topics are stacked in a chronological order. + +Click on **+ Add...** and choose the to create a `blog` or a `site manager` + + + .. image:: _static/select_website_content.png + + + +How to link a shared content in the site ? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +Once the article is created, you will need to appear in your site or blog + +To link an article to a site or blog. + +- Click on "Rent content" + + .. image:: _static/site_add_content.png + +- Fill in the article internal reference. + + .. image:: _static/site_link_content.png + +- Article linked + + .. image:: _static/site_linked_content.png + + +Website Design - Portal Templates +--------------------------------- + +You can create a generic template shared for all users, to do that you need to have some webdesign privilege. + + +On the `Control panel`, click on `Portal Templates` + + .. image:: _static/select_portlet.png + +For example In the Portal Templates menu + + .. image:: _static/user_create_template.png + +1) Click on **+add template** +2) Name your new template +3) Add a new **slot** +4) Drag and drop a new portlet **image**. + +5) Click right on the portlet to **edit properties** or **delete** this elements. + + + +Apply a Template +^^^^^^^^^^^^^^^^ + +When you have defined a shared template, you can use it for your website + + .. image:: _static/nav_site_management.png + + +If you choose to inherit from a template, select the template that you want to apply + + + .. image:: _static/template_edit_config.png + +If you won't inherit from a shared template, you can create a local template. + + + diff -r 49e4432c0a1d -r 5108336d3a4c src/source/user_guide/manager-guide.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/user_guide/manager-guide.rst Thu Dec 13 11:34:10 2018 +0100 @@ -0,0 +1,125 @@ +.. _appmanage: + +.. _site: + + +Site Manager guide +================== + + +PyAMS admin site (called also **ZMI**, in memory of old **\Z**\ope **\M**\anagement **\I**\nterface) is based on the ZODB. + +When the PyAMS is initialized, it create and register several utilities into the *local registry* and saved into ZODB. +These utilities are created with default values which can be modified through **management interface** when +the application is started by default (http://localhost:6543/admin). + + +Local registry utilities +'''''''''''''''''''''''' + +One of PyAMS pre-requisites is to use the ZODB, at least to store the site root application, +it's configuration and a set of local utilities. + +Some important utilities include: + +**Catalog**: + The catalog has the responsibility to index every content properties which are required to make quick + and efficient searches. Catalog indexes are automatically created on database upgrade; management interface + allows administrator to get indexes properties, to get the number of indexed objects and values for a given index, and + to delete an index before recreating it by running the database upgrade script another time (see :ref:`scripts`). + +**Internal IDs** utility: + The catalog object doesn't store direct references to objects, but their internal IDs which are generated by this + utility. + +**Language negotiator**: + As a web site or application can be localized, this utility allows you to define priorities between language + definition options (between *user session*, *browser* end *server*), and to define which languages are available + to your users (which is particularly important when managing potentially multi-lingual contents). + + .. tip:: + Static texts like those displayed into PyAMS management interface are always translated to the language defined + into browser language, if available. + +**Portal templates** container: + Portal templates are used to define *presentation templates* based on *portlets* (see :ref:`pyams_portal`). You can + create *local* templates, or create *shared templates* into this utility which can then be reused into several + places in your web site. + +**Security manager**: + This utility is used to define authentication sources which will be available to authenticate your users. + :ref:`pyams_security` package provides several authentication modules (like local users, or via OAuth/OAuth2 + providers); :ref:`pyams_ldap` add authentication plug-in via an LDAP directory. + +**Sequential IDs** utility: + This utility is used to assign simple sequential IDs to site contents (like sites, news, topics and more); these + IDs are simple to identify a given content; several versions of a given content handle by workflow share the same + sequential ID. + +**Server timezone** utility: + Define the timezone server to display date and time accordingly. + +**User profiles** container: + This utility is used to store information associated to principals through their user profile. + + +Optional utilities can also include: + +**Elasticearch content indexer**: + +Verifier la connection entre le server ElasticSearch et la l'application PyAMS + +**Maps manager**: +Systeme de cartografie, avec OpenStreeMaps, WMS, GeoPortable, ESRI ou encore Google Maps +permet de créer des zones catographique² + +**Medias converter**: + + +**Tasks scheduler**: + +After install... +---------------- + + +Settings administrator's password +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Setting server timezone +^^^^^^^^^^^^^^^^^^^^^^^ + +Setting site's language +^^^^^^^^^^^^^^^^^^^^^^^ + +Creating ZEO connection +^^^^^^^^^^^^^^^^^^^^^^^ + +Planning Tasks +^^^^^^^^^^^^^^ + + +.... + + +Custom utilities +---------------- + +Defining security +----------------- + +Assigning roles +--------------- + +Medias conversions +------------------ + +Google tools integration +------------------------ + +Generating sitemap +------------------ + +Managing redirections +--------------------- + + diff -r 49e4432c0a1d -r 5108336d3a4c src/source/user_guide/userguide.rst --- a/src/source/user_guide/userguide.rst Thu Dec 13 10:51:53 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,274 +0,0 @@ -.. _userguide: - -PyAMS User's Guide -================== - -Users or Site Managers - Individuals who use PyAMS features to create a custom application or website. - - -To Begin --------- - -Login -^^^^^ - -Begin by logging into the “administration area” or the back end of your website. -Now log into PyAMS using your username and password. - - .. image:: _static/pyams-login.png - - -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. - - .. image:: _static/pyams-dashboard.png - - - -At the top of the screen is the “toolbar”, this navigation menu is to create new publication content (site , article, view...) -On the left side of the screen is the main navigation menu detailing each of the administrative functions you can perform. - - -Article - The shared contents ------------------------------ - - -Articles are sorted by category news, topic or long read, each category have different attributes, and they can quickly -identify the type of content. - -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 - -(*) The progress bar below the title is an indicator to optimize for indexation by search engines. - -When you are completed the form you will be redirected and invited to complete the properties of the article - - -Manage a News -^^^^^^^^^^^^^ - - .. image:: _static/content_properties.png - - -On this page you can modify the title and the url display, content description and write an unpublish note - -In Addition you can wrapped the articles with custom feature like: - -- A header or main illustration placed on the top of your article -- An illustration for the links that targets the article. - - -The interface also allows you to perform additional actions such as publishing and versioning but, we will come back to it later - - - -Edit the content of an article -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -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 - -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. - -Each paragraph corresponds to a type of media and will facilitate the modification the articulation of an article. -To add a new block, click **Add ..** - - .. image:: _static/content_paragraph.png - -(*) The list of available paragraph varies depending on the nature of the article and the configuration of the shared tools - - -Paragraph ---------- - -Header -^^^^^^ - -Rich Text -^^^^^^^^^ - -Illustration -^^^^^^^^^^^^ - -Media Gallery -^^^^^^^^^^^^^ - -Video -^^^^^ - -External video -^^^^^^^^^^^^^^ - -Audio -^^^^^ - -Associations -^^^^^^^^^^^^ - -Contact -^^^^^^^ - -Framed Text -^^^^^^^^^^^ - -Image Maps -^^^^^^^^^^ - -Key number -^^^^^^^^^^ - -Key point -^^^^^^^^^ - -Location number -^^^^^^^^^^^^^^^ - -Logos -^^^^^ - -Milestones -^^^^^^^^^^ - -Pictogram -^^^^^^^^^ - -Verbatim -^^^^^^^^ - -Raw HTML -^^^^^^^^ - -Verify the content ------------------- - -Audit -^^^^^ - -Preview -^^^^^^^ - - -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**. - - - .. image:: _static/content_publish_toolbar.png - - -You will be asked to validate the date of publication and check if the content corresponds to your expectations, - - .. image:: _static/content_publication_form.png - - -If you work alone the validated content will be put online. - - -If you have collaborators, you have the possibility to used a publication workflow that include reviewers. The editor -make a **Request of publication** to the review for the validation of the request. Then, the reviewer receives a -notification inviting him to consult the article in question. - -The reviewer has the choice to accept or refuse the publication or also create a new version of the article. - - -.. warning:: - - **Important**: Once published the content can not be erased, - However you can always unpublish it to remove the access to visitors. - - -Web site Page / Blog --------------------- - -To create a new page for your website click on `Site tree` - - - .. image:: _static/select_sitetree.png - - -A blog or weblog is a simple editorial structure where news and topics are stacked in a chronological order. - -Click on **+ Add...** and choose the to create a `blog` or a `site manager` - - - .. image:: _static/select_website_content.png - - - -How to link a shared content in the site ? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - -Once the article is created, you will need to appear in your site or blog - -To link an article to a site or blog. - -- Click on "Rent content" - - .. image:: _static/site_add_content.png - -- Fill in the article internal reference. - - .. image:: _static/site_link_content.png - -- Article linked - - .. image:: _static/site_linked_content.png - - -Website Design - Portal Templates ---------------------------------- - -You can create a generic template shared for all users, to do that you need to have some webdesign privilege. - - -On the `Control panel`, click on `Portal Templates` - - .. image:: _static/select_portlet.png - -For example In the Portal Templates menu - - .. image:: _static/user_create_template.png - -1) Click on **+add template** -2) Name your new template -3) Add a new **slot** -4) Drag and drop a new portlet **image**. - -5) Click right on the portlet to **edit properties** or **delete** this elements. - - - -Apply a Template -^^^^^^^^^^^^^^^^ - -When you have defined a shared template, you can use it for your website - - .. image:: _static/nav_site_management.png - - -If you choose to inherit from a template, select the template that you want to apply - - - .. image:: _static/template_edit_config.png - -If you won't inherit from a shared template, you can create a local template. - - - diff -r 49e4432c0a1d -r 5108336d3a4c src/source/user_guide/webmaster-guide.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/user_guide/webmaster-guide.rst Thu Dec 13 11:34:10 2018 +0100 @@ -0,0 +1,23 @@ +.. _webmasterguide: + +Webmaster guide +=============== + +Organizing your site +--------------------- + +Assigning users roles +--------------------- + +Using views +----------- + +Using Thesaurus +--------------- + +Creation presentation templates +------------------------------- + +Defining Header and footer +-------------------------- +