Skip to content

First steps

This page lists first steps you can take after installing eZ Platform. These are most common actions you may need to take in a new installation.

Beginner tutorial

To go through a full tutorial that leads from a clean installation to creating a full site, see Building a bicycle route tracker in eZ Platform.

Create a Content Type

1. Go to the Back Office: <your_domain>/admin.

2. Select Admin and go to Content Types.

3. Enter the Content group and create a new Content Type.

Creating a Content Type

4. Input the Content Type's name, for example "Blog Post", and identifier: blog_post.

5. Below, add a Field definition of the type Text Line. Name it "Title" and give it identifier title.

6. Add another Field definition: Text (type Rich text) with identifier text.

7. Save the Content Type.

More information

Create Twig templates and match then with view config

To display Content in the front page you need to define content views and templates.

Content views decide which templates and controllers are used to display Content.

1. In app/config/ezplatform.yml add the following block under ezpublish.system.site_group, before admin_group (pay attention to indentation: content_view should be one level below site_group):

1
2
3
4
5
6
content_view:
    full:
        blog_post:
            template: 'full\blog_post.html.twig'
            match:
                Identifier\ContentType: [blog_post]

Content view templates use the Twig templating engine.

2. Create a template file app/Resources/views/full/blog_post.html.twig:

1
2
<h1>{{ ez_render_field(content, 'title') }}</h1>
<div>{{ ez_render_field(content, 'text') }}</div>

Create content and test view templates

1. Go to the Back Office, activate Content/Content structure and create a new Content item using the button in the right menu.

Creating a Blog Post

2. Select a Blog Post Content Type. Fill in the Content item and publish it.

3. To preview the new Content item on the front page, go to <yourdomain>/<Content-item-name>. For example, if the title of the Blog post is "First blog post", the address will be <yourdomain>/first-blog-post.

Previewing Content

Add SiteAccesses

You can use SiteAccesses to serve different versions of the website.

SiteAccesses are used depending on matching rules. They are set up in YAML configuration under the ezpublish.siteaccess.list key.

1. In app/config/ezplatform.yml add a new SiteAccess called de for the German version of the website:

1
2
3
4
5
6
ezpublish:
    # ...
    siteaccess:
        list: [site, admin, de]
        groups:
            site_group: [site, de]

The SiteAccess will automatically be matched using the last part of the URI.

2. You can now access the front page through the new SiteAccess: <yourdomain>/de.

Log in

At this point you need to log in to preview the new SiteAccess, because an anonymous visitor does not have permissions to view it. See section about permissions below.

For now the new SiteAccess does not differ from the main site.

More information

Add a language and translate Content

One of the most common use cases for SiteAccesses is having different language versions of a site.

1. To set up the de SiteAccess to use a different language, add its configuration under ezpublish.system:

1
2
3
4
5
6
7
site:
    languages:
        - eng-GB
de:
    languages:
        - ger-DE
        - eng-GB

This means that German will be used as the main language for this SiteAccess, and English as a fallback.

2. Remove or comment the following line under ezpublish.system.site_group: languages: [eng-GB].

Also, add the ger-DE language under admin_group:

1
2
3
admin_group:
    # ...
    languages: [eng-GB, ger-DE]

3. Go to the Back Office and select Admin > Languages. Add a new language called "German", with language code ger-DE. Make sure it is enabled.

Creating a language

4. Next, go to the Content structure and open the blog post you had created earlier. Switch to the Translations tab and add a new translation.

Adding a translation

5. Select German and base the new translation on the English version. Edit the Content item and publish it.

6. Go to the front page. The blog post will now display different content depending on which SiteAccess you enter it from: <yourdomain>/<content-name> or <yourdomain>/de/<content-name>.

Previewing translated Content

Add a design

The design engine enables you to use different themes consisting of templates and assets. Each theme is stored in a separate folder and assigned to a SiteAccess.

To create a new theme:

1. Add the following configuration at the bottom of app/config/ezplatform.yml (at the same level as ezpublish):

1
2
3
4
ezdesign:
    design_list:
        site_design: [site_design]
        de_design: [de_design]

2. In configuration of the de SiteAccess (under ezpublish.system.de) add: design: de_design

3. Under site_group, add design: site_design

4. Go back to the content_view configuration for the blog post. Change the path to the template so that it points to the folder for the correct design: template: '@ezdesign\full\blog_post.html.twig'

This means that the app will look for the blog_post.html.twig file in a folder relevant for the SiteAccess: de_design for the de SiteAccess, or site_design for other SiteAccesses in site_group.

5. Create a themes folder under app/Resources/views, and two folders under it: de_design and site_design.

6. Move the existing full\blog_post.html.twig file under site_design.

7. Copy it also under de_design. Modify the second one in any way (for example, add some html), so you can preview the effect.

8. To see the difference between the different themes, compare what is displayed at <yourdomain>/<content-name> and <yourdomain>/de/<content-name>

Set up permissions

To allow a group of users to edit only a specific Content Type (in this example, blog posts), you need to set up permissions for them.

Users and User Groups are assigned Roles. A Role can contain a number of Policies, which are rules that permit the user to perform a specific function. Policies can be additionally restricted by Limitations.

1. Go to Admin > Users. Create a new User Group (the same way you create regular Content). Call the group "Bloggers".

2. In the new group create a User. Remember their username and password. Mark the user as "Enabled".

Creating a User

3. Go to Admin > Roles. Create a new Role called "Blogger".

4. Enter the Role and add Policies that will allow the User to log in:

  • user/login
  • content/read
  • content/versionread
  • section/view
  • content/reverserelatedlist

5. Now add Policies that will allow the User to create and publish content, limited to Blog Posts:

  • content/create with Limitation for Class (Content Type) Blog Post
  • content/edit with Limitation for Class (Content Type) Blog Post
  • content/publish with Limitation for Class (Content Type) Blog Post

Adding Limitations to a Policy

6. In the Assignments tab assign the "Blogger" Role to the "Bloggers" group.

Assigning a Role

You can now log out and log in again as the new User. You will be able to create Blog Posts only.

More information

Read the Docs