diff -r 000000000000 -r b2be9a32f3fc src/source/userguide.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/userguide.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,274 @@ +.. _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. + + +