8. The Features of Plone

8.1. Starting and Stopping Plone

We control Plone with a small script called "instance":

$ ./bin/instance fg

This starts Plone in foreground mode so that we can see what it is doing by monitoring console messages. This is an important development method. Note that when Plone is started in foreground mode, it is also automatically in development mode. Development mode gives better feedback, but is much slower, particularly on Windows.

You can stop it by pressing ctrl + c.

Apart from the fg command, the instance script offers several more commands. ./bin/instance help shows the list of available commands, bin/instance help <command> will give a short help for each command. Some commands you will use rather often are:

$ ./bin/instance fg
$ ./bin/instance start
$ ./bin/instance stop
$ ./bin/instance debug
$ ./bin/instance run myscript.py
$ ./bin/instance adduser name password

Depending on your computer, it might take up to a minute until Zope will tell you that it's ready to serve requests.

On a decent laptop it should be running in under 10 seconds. A standard installation listens on port 8080, so lets have a look at our Zope site by visiting http://localhost:8080

../_images/features_plone_running1.png

As you can see, there is no Plone site yet!

8.2. Creating a Plone Site

We now have a running Zope with a database but no content. But luckily there is a button to create a Plone site.

Warning

Because Plone 6 is not released yet we need to enable some features of Plone that are not there by default. In Plone 6 this will be done automatically for you.

Until then you need to select ploneconf.site as a add-on when creating the site!

ploneconf.site makes the following changes to ease working with Volto:

  • Make Document, News Items and Events folderish by installing collective.folderishtypes.

  • Install plone.restapi to be able to communicate with the frontend.

  • Enable the blocks-behavior for Documents.

  • Allow editing the Siteroot like a Document.

In Plone 6 this (and more) will be done automatically for you.

Click on the link Advanced next to the button Create a Plone site. If the site asks you to login, use login admin and password admin. This opens a form to create a Plone site and select additional features. Use Plone as the site id. Select ploneconf.site as a add-on that should be installed with your new site.

../_images/features_create_site_form1.png

You will be automatically redirected to the new site.

This is how the frontpage should look like:

../_images/frontpage_plone.png

Note

Plone has many message boxes. They contain important information. Read them and make sure you understand them!

8.3. Starting and Stopping the frontend

To start the frontend that will use your new plone site go to the folder volto and enter:

$ yarn start

If you open http://localhost:3000 you will see the front page of the Plone site in Volto.

../_images/frontpage_volto.png

You can stop the frontend anytime using ctrl + c.

While developing it is not necessary to restart the frontend unless you are adding a new file.

8.3.1. Exercises

8.3.1.1. Exercise 1

Open the bin/instance script in your favorite editor. Now let's say you want Plone to listen on port 9080 instead of the default 8080. Looking at the script. How could you do this?

Solution

At the end of the bin/instance script, you'll see the following code:

if __name__ == '__main__':
    sys.exit(plone.recipe.zope2instance.ctl.main(
        ['-C', '/Users/pbauer/workspace/training_buildout/parts/instance/etc/zope.conf', '-p', '/Users/pbauer/workspace/training_buildout/parts/instance/bin/interpreter', '--wsgi']
        + sys.argv[1:]))

The second to last line points to the configuration file your Plone instance is using. An absolute path is used so it might differ depending on the installation method. Open the wsgi.ini that lives in the same folder in your editor and look for the section:

[server:main]
use = egg:waitress#main
listen = 0.0.0.0:8080
threads = 4

Change the address to 0.0.0.0:9080 and restart your instance.

You will also have to tell the frontend that the backend is now running on a different port.

You need to change the environment variable RAZZLE_API_PATH to the base-url of the backend:

$ RAZZLE_API_PATH=http://localhost:9080/Plone yarn start

8.3.1.2. Exercise 2

Knowing that bin/instance debug basically offers you a Python prompt, how would you start to explore Plone?

Solution

Use locals() or locals().keys() to see Python objects available in Plone

You will get notified that app is automatically bound to your Zope application, so you can use dictionary-access or attribute-access as explained in What is Plone? to inspect the application:

8.3.1.3. Exercise 3

The app object you encountered in the previous exercise can be seen as the root of Plone. Once again using Python, can you find your newly created Plone site?

Solution

app.__dict__.keys() will show app's attribute names - there is one called Plone, this is your Plone site object. Use app.Plone to access and further explore it.

>>> app
<Application at >
>>> app.keys()
['browser_id_manager', 'session_data_manager', 'error_log', 'temp_folder', 'virtual_hosting', 'index_html', 'Plone', 'acl_users']
>>> app['Plone']
<PloneSite at /Plone>
>>> app.Plone.keys()
['portal_setup', 'MailHost', 'caching_policy_manager', 'content_type_registry', 'error_log', 'plone_utils', 'portal_actions', 'portal_catalog', 'portal_controlpanel', 'portal_diff', 'portal_groupdata', 'portal_groups', 'portal_memberdata', 'portal_membership', 'portal_migration', 'portal_password_reset', 'portal_properties', 'portal_quickinstaller', 'portal_registration', 'portal_skins', 'portal_types', 'portal_uidannotation', 'portal_uidgenerator', 'portal_uidhandler', 'portal_url', 'portal_view_customizations', 'portal_workflow', 'translation_service', 'portal_form_controller', 'mimetypes_registry', 'portal_transforms', 'portal_archivist', 'portal_historiesstorage', 'portal_historyidhandler', 'portal_modifier', 'portal_purgepolicy', 'portal_referencefactories', 'portal_repository', 'acl_users', 'portal_resources', 'portal_registry', 'HTTPCache', 'RAMCache', 'ResourceRegistryCache', 'training', 'schedule', 'location', 'sponsors', 'sprint']
>>> app['Plone']['training']
<FolderishDocument at /Plone/training>

Note

Plone and its objects are stored in an object database, the ZODB. You can use bin/instance debug as a database client (in the same way e.g. psql is a client for PostgreSQL). Instead of a special query language (like SQL) you simply use Python to access and manipulate ZODB objects. Don't worry if you accidentally change objects in bin/instance debug - you would have to commit your changes explicitly to make them permanent. The Python code to do so is:

>>> import transaction
>>> transaction.commit()

You have been warned.

8.3.1.4. Exercise 4

Change the port of the frontend to 1234

Solution

By default the frontend will start on port 3000. You can change the port and/or hostname for the frontend by specifying the environment variables PORT and/or HOST:

$ HOST=localhost PORT=1234 yarn start

TODO:

  • Find out if that actually works

8.4. Walkthrough of the UI

Let's see what is there...

  • header:

    • logo: with a link to the front page

    • searchbox: search (with live-search)

  • navigation: The global navigation

  • portal-footer: portlets for the footer, site actions, and colophon

  • toolbar: a vertical bar on the left side of the browser window with editing options for the content

On the edit bar, we find options affecting the current context...

  • edit

  • folder contents

  • add

There is a menu with three dots that holds additional options:

  • state

  • view

  • history

  • sharing

At the bottom of the toolbar is a silhouette-icon that holds a menu with the following links:

  • logout

  • profile

  • preferences

  • site-setup

Some edit bar options only show when appropriate; for example, folder contents and add are only shown for Folders.

8.5. Users

Let's create our first users within Plone. So far we used the admin user (admin:admin) configured in the buildout. This user is often called "Zope root" and is not managed in Plone but only by Zope. Therefore the user is missing some features like email and full name and won't be able to use some of Plone's features. But the user has all possible permissions. As with the root user of a server, it's bad practice to make unnecessary use of Zope root. Use it to create Plone sites and their initial users, but not much else.

You can also add Zope users via the terminal by entering:

$ ./bin/instance adduser <someusername> <supersecretpassword>

That way you can access databases you get from customers where you have no Plone user.

To add a new user in Plone, click on the user icon at the bottom of the left vertical bar and then on Site setup. This is Plone's control panel. You can also access it by browsing to http://localhost:8080/Plone/@@overview-controlpanel

../_images/features_control_panel1.png

Click on Users and Groups and add a user. If we had configured a mail server, Plone could send you a mail with a link to a form where you can choose a password. (Or, if you have Products.PrintingMailHost in your buildout, you can see the email scrolling by in the console, just the way it would be sent out.) We set a password here because we haven't yet configured a mail server.

Make this user with your name an administrator.

../_images/features_add_user_form1.png

Then create another user called testuser. Make this one a normal user. You can use this user to see how Plone looks and behaves to users that have no admin permissions.

Now let's see the site in 3 different browsers with three different roles:

  • as anonymous

  • as editor

  • as admin

8.6. Configure a Mailserver

For production-level deployments you have to configure a mailserver. Later in the training we will create some content rules that send emails when new content is put on our site.

For the training you don't have to configure a working mailserver since the Plone-Add-on Products.PrintingMailHost is installed which will redirect all emails to the console.

  • Server: localhost

  • Username: leave blank

  • Password: leave blank

  • Site 'From' name: Your name

  • Site 'From' address: Your email address

Click on Save and send test e-mail. You will see the mail content in the console output of your instance. Plone will not actually send the email to the receivers address unless your remove Products.PrintingMailHost.

8.7. The site structure

First delete all existing content from the site since we won't use it!

  • Click on the folder-icon in the toolbar while on the frontpage

  • Select all displayed content items

  • Click on the trash icon to delete them

Now we have a clean slate and can start creating the structure we want:

Root (Frontpage)
├── Training
├── Schedule
├── Location
├── Sponsors
├── Sprint
└── Contact

Below we'll add appropriate content.

Edit the front page:

  • Change the title to Plone Conference 2050, Solis Lacus, Mars

  • Add some dummy text

  • Save the page

Create a site structure:

  • Add a Page "Training"

  • Add a Folder "Schedule"

  • Add a Folder "Location"

  • Add a Page "Sponsors"

  • Add a Page "Sprint"

  • Add a Page "Contact"

The view of the newly created site structure.

The view of the newly created site structure.

  • In /news: Add a News Item "Conference Website online!" with some image

  • In /news: Add a News Item "Submit your talks!"

  • In /events: Add an Event "Deadline for talk submission" Date: 2025/08/10

  • Add a Folder "Register"

  • Add a Folder "Intranet"

The view of the extended navigation bar.

The view of the extended navigation bar.

8.8. Default content types

The default Plone content types are:

Page

A Page is the most flexible content type. You can use the editor to create, edit and arrange blocks on a page. You can choose from blocks for Text, Image, Video, List of existing content and many more. Pages - like folders - can also contain other content. This means you can use them to structure your site.

../_images/features_add_a_page.png
Folder

Folders are used to structure content like in a file-system. They can display a listing of its content. Pages can also contain other content.

../_images/features_add_a_folder.png
File

A file like a pdf, video or Word document.

../_images/features_add_a_file.png
Image

Like files but png, jpeg or other image types

../_images/features_add_a_image.png
Event

These are basically pages with start and end dates and some additional fields for

../_images/features_add_a_event.png
Link

A link to an internal oder external target.

../_images/features_add_a_link.png
News Item

Basically a page with an image and an image caption to be used for press releases an such.

../_images/features_add_a_news_item.png
Collection

Collections are virtual containers of lists of items found by doing a specialized search. With Volto you usually do not use them anymore. Instead you can use a page with one or more listing blocks.

Editing a collection

8.9. Folders

  • Go to 'schedule'

  • explain the difference between title, ID, and URL

  • explain /folder_contents

  • change the order of items

  • explain bulk actions

  • dropdown "display"

  • Explain default pages (in classic Plone)

  • Explain Folderish Pages (in Plone6 and Volto)

8.10. Collections

  • add a new collection: "all content that has pending as wf_state".

  • explain the default collection for events at http://localhost:3000/events/aggregator/edit

  • mention listing blocks for the pastanaga editor

  • multi-path queries

  • constraints, e.g. /Plone/folder::1

8.11. Content Rules

Warning

Content-rules can not be configured in Volto yet. See https://github.com/plone/volto/issues/10. You need to use the backend to configure content rules.

  • Create new rule "a new talk is in town"!

  • New content in folder "Talks" -> Send Mail to reviewers.

Add a rule through the web.

Add a rule through the web.

Add an action to the rule.

Add an action to the rule.

Add mail action.

Add mail action.

Assign the newly created rule.

Assign the newly created rule.

8.12. History

Show and explain; mention versioning and its relation to types.

8.13. Manage members and groups

  • add/edit/delete Users

  • roles

  • groups

    • Add group "Editors" and add the user 'editor' to it

    • Add group: orga

    • Add group: jury and add user 'jurymember' to it.

8.14. Workflows

Take a look at the state drop down on the edit bar on the homepage. Now, navigate to one of the folders just added. The homepage has the status published and the new content is private.

Let's look at the state transitions available for each type. We can make a published item private and a private item published. We can also submit an item for review.

Each of these states connects roles to permissions.

  • In published state, the content is available to anonymous visitors;

  • In private state, the content is only viewable by the author (owner) and users who have the can view role for the content.

A workflow state is an association between a role and one or more permissions. Moving from one state to another is a transition. Transitions (like submit for review) may have actions — such as the execution of a content rule or script — associated with them.

A complete set of workflow states and transitions makes up a workflow. Plone allows you to select among several pre-configured workflows that are appropriate for different types of sites. Individual content types may have their own workflow. Or, and this is particularly interesting, they may have no workflow. In that case, which initially applies to file and image uploads, the content object inherits the workflow state of its container.

Note

An oddity in all of the standard Plone workflows: a content item may be viewable even if its container is not. Making a container private does not automatically make its contents private.

8.15. Working copy

Warning

Working copies can not be used in Volto yet.

Published content, even in an intranet setting, can pose a special problem for editing. It may need to be reviewed before changes are made available. In fact, the original author may not even have permission to change the document without review. Or, you may need to make a partial edit. In either case, it may be undesirable for changes to be immediately visible.

Plone's working copy support solves this problem by adding a check-out/check-in function for content — available on the actions menu. A content item may be checked out, worked on, then checked back in. Or it may be abandoned if the changes weren't acceptable. Not until check in is the new content visible.

While it's shipped with Plone, working copy support is not a common need. So, if you need it, you need to activate it via the add-on packages configuration page. Unless activated, check-in/check-out options are not visible.

Note

Working Copy Support has limited support for Dexterity content types. The limitation is that there are some outstanding issues with folderish items that contain many items. See: plone/Products.CMFPlone#665

8.16. Placeful workflows

Warning

Placeful workflows can not be configured in Volto yet. Workflow-settings that you configure in the classic frontend are working though.

You may need to have different workflows in different parts of a site. For example, we created an intranet folder. Since this is intended for use by our conference organizers — but not the public — the simple workflow we wish to use for the rest of the site will not be desirable.

Plone's Workflow Policy Support package gives you the ability to set different workflows in different sections of a site. Typically, you use it to set a special workflow in a folder that will govern everything under that folder. Since it has effect in a "place" in a site, this mechanism is often called "Placeful Workflow".

As with working-copy support, Placeful Workflow ships with Plone but needs to be activated via the add-on configuration page. Once it's added, a Policy option will appear on the state menu to allow setting a placeful workflow policy.