Articles¶
Articles application serves for the creation and management of particular articles (posts) which you want to display on your website.
Before you will be able to add a new one, you have to add the Articles Component to your website pages tree. This is vital. Articles Component Page type allows you to display the articles on your website. There is no other way how to display them. Go to the CMS module, run the Website application, select the Website on which you want to display the created articles, edit it and add a new Page - Articles Component. After that you will be able to create articles in the Articles application in the Author Tools module.
Every article is bound to a website and one of its Article Components (you will probably have only one Article Component on your website, but you are able to have more of them).
To discover more about the Articles Component and about how to use it, please visit the related help-site.
Create Article¶
Run the application and click the New button to create a new article. A new window appears and then you have to insert all the required information:
Identification
Name - Name is the name of the article, it will be visible to the visitors of your website
Internal Name - This name is used as an identification of the article. It can be also displayed in the URL address in case you will not use an alias. This has to be a unique name within all the pages from the website selected below.
Configuration
Website - select the website which contains the Articles Component Page (the website on which you want to display the created article)
Component - select the Articles Component Page. This list contains all Articles Component Pages from the website selected above. Every created article is bound to the Articles Component and you are not able to display this created article in another Article Component.
Culture - select the Culture in which will be this Article created. Cultures are important for translating and localizations. The newly created article will be automatically opened in a new window. Work with it is basically the same as with the Content Page type.
General tab¶
The main settings are on the first General tab. Tags allows you to add metadata information used for identification, searching or filtering of this article in a very comfortable and easy way (thanks to the Articles Component Page which is used for displaying of the article).
Tag Manager is used to manage (create, edit or delete) all the tags for articles used in your BizBox Admin.
Content tab¶
Content tab is a place where you insert the code itself - remember this works just like the Content Page type, you are allowed to insert the valid HTML code (not only plain text).
Article tab¶
Article tab is used for setting up the article.
Perex is a field in which you can insert the opening paragraph of the article. In the Category Articles View (in the Article Component Page) which displays all articles from one category, this Perex can be displayed together with the name and teaser image of this article.
Categories allows you to select all categories to which the article belongs. Categories has to have been previously created in the Categories application in the Author Tools module.
Teaser Image is an image (optionally) displayed along with the article’s name and Perex. Select it from your File Manager.
Authors setting is used for connecting this article with its authors. Authors has to have been previously created in the Author Profiles application located also in the Author Tools module.
Subtitle - Subtitle is a subordinate name of the article. You can display it along with the name in the Articles Component Page type.
Photo - in case your article contains photos, insert in this field information about their author (optionally).
Source - in case your article has some source (it was published elsewhere for instance), identify the source in this field (optionally).
Published is the time of publication. You can display this information in the list of articles or in the detail of the article itself. This date does not affect the publication (availability) of the article. It is just information you are able to display in the Articles Component Page.
Start Publishing - this field allows you to specify the date and time from when this article will be available on your website. If you will set the date in the future, it will be automatically published. In case you left this field blank, the article will be published immediately and without any restrictions.
Finish Publishing - this field allows you to specify the date and time until when this article will be available on your website. It will be automatically removed according to the time set. If you left this field blank, the article will stay available.
Priority - Priority is a number which allows you to sort the display of articles in a category list (Category Articles View - a part of the Articles Component Page type). You set the order (ascending or descending) in the Articles Component Page settings. Apart from Priority, you will be able to sort articles by the name and the date of publishing.
Reading Time – the reading time serves as information for the site visitor (time required to read the article in minutes).
Translations tab¶
Translations tab is used for inserting translations in case you have some translation strings in the original article (and in case you have a multilingual website. The translation of an article is exactly the same at the translation of a Content Page.)
SEO tab¶
SEO tab allows you to insert SEO information. Remember that the article is still a page and it acts like a page. It makes you able to insert a title, description, keywords and robots settings used with search engines.
Page Description
Default – Automatically uses the Perex from the Article (without HTML tags).
None – In the Title will be displayed the complete URL address of the product.
Specific Value – Activates the field below and you will be able to define your own title.
For every Article an og:image is also automatically generated with the value of a teaser image or the first Big Image. Og:images are automatically created for every Product, Product Category and Article. As a default value for it the teaser image (Article) or the first Big Image (Products and Product Categories) is used.
Aliases tab¶
Aliases tab allows you to create aliases for the article. Alias is an alternative name for the Page and makes it accessible within this Alias.
Article Products¶
Article Products tab allows you to define products from your online store which you want to display as a part of this article. It will make the data about selected products available and you can work with them. Only products which can be displayed on the online store (according to the E-shop Settings) will be available.
Note
Only first 10 buyable products are available in the template: assigned products are grouped together, ordered according to their ID and their buyability is evaluated. Then first 10 buyable products are available on the website.
Click the Add button and select the particular Products, Product Categories or Price Categories from your products catalog, category tree and price categories.
To display products on your website (in the article detail) you need to edit the website code (Articles Component). Use the component.article.relatedProducts parameter which contains data about the connected products. In the article object (object page) the relatedProductCategories parameter is available. It is an array of all categories (object product category) connected to this article.
Relations tab¶
Relations is intended to add related articles and/or pages from the website. Click the Add button and start typing the name of article or page you want to add. Related articles can be displayed in detail of the article (the “Also Read” recommendations).
Categories¶
In Categories application particular categories of articles are created. Categories are used to group and display articles in connection with the Articles Component Page type. Without this Articles Component Page you will not be able to display any articles on your website.
Tip
You can change the order of the categories in the category tree by dragging them with the mouse.
Categories created here are available only for the articles created in the Articles application. Categories are in hierarchical form and you can display them as a menu in the Article Component Page type which is used for displaying your articles and categories.
Content of a category can be also displayed - it is one View of the Articles Component - as a list of particular articles from it. A special navigation tree Article Category can be used to display categories on the web.
To create a new category, run the Categories application and click the “New” button located in the toolbar. A new tab appears and you have to insert all required information:
Name - Name has to be unique within the Categories application. It can be displayed to visitors in case you do not fill in the Label field below.
Comment - Comment is used for your internal purposes. This can typically be a short information about the category - what kind of articles it contains or other info.
Name in URL - Insert a string of characters under which this category will be accessible to visitors. It has to be unique within the Categories application. The URL may contain “.”.
Teaser Image - Teaser Image is an image of this category. It is optional and you can use (display) it in the Articles Component Page.
Label - Label is a name displayed to visitors as a name of this category. As you can see, it is (unlike the name) a translated property
After you create a new category, it will be available for selection on the Articles tab in an article edition.
Data Lists¶
Data Lists allows you to create various lists of particular and related items, such as images, files, news or frequently asked questions, that you can subsequently (thanks display on your website. There are several Data List Types which you can create: Common List, Frequently Asked Questions, Image Gallery, Media, News, Reference List and Messages.
How to Display a Data List¶
The content of a Data List can be displayed to a website visitor only with an appropriate parameter inserted in a page content:
cms.dataLists.get('internal-name')
Instead of the internal-name use the real internal name of a Data List you want to display.
You must go to one of your content pages and edit it. Insert this piece of code to display all data list items names:
{% for item in cms.dataLists.get('internal-name').items %}
{{ item.name }}
{% endfor %}
For more info about the displaying of a data list please visit this help site.
How to Create a New Data List¶
Go to the Author Tools module and run the Data Lists application.
Click the New button and select the desired type of Data List you want to create.
Fill all fields:
Name - Insert a name for this Data List. This name is displayed only in BizBox Admin and is there for your better orientation.
Internal Name - Internal Name serves for system purposes and it is not displayed anywhere. You will use it in a page code to display it.
Culture - Select a Culture for which is this Data List created.
Use in All Cultures - In case of a multilingual website: If you set this option to YES, data from the default Culture (from the one you selected above) will be used in all Cultures without defined data. You can set the data for every language connected with this website directly when adding particular data. It means, in case you will have a multilingual website and you will not fill some data for some language, it will be replaced by data from the selected Default Culture.
Click the Add button and create a new Data List.
Go to the Items tab and click the Add button. You will get more information about particular Data List type on its own Help page.
Common List¶
Common List allows you to create a list with various items - other Data Lists are specialized only for some kinds of items (such as images, questions, answers or texts). All fields in the add item are optional.
Base Data Fields are all optional. You can define date, title, alternate title, text, alternate text, link, alternate link, file and alternate file.
General Properties:
Active - This option allows you to temporary disable this item (option NO). In case you set this option to YES, it will be normally visible to visitors.
Internal Name (optional) - This is an identification of this particular item. This name must be unique within this Data List.
Click the Cultures button for adding more languages. Along with new fields a use from default culture check box will be displayed, which will automatically use data from the appropriate field in the Default Culture.
For info about the displaying of a data list please visit this help site.
Frequently Asked Questions¶
Frequently Asked Questions Data List allows you to create a FAQ space for your website. You have to manually add particular questions and their answers.
Base Data Fields:
Question (required) - Insert a particular question. This field is required.
Answer (required) - Insert an answer for the question inserted above. This field is required.
Additional Data Fields allows you to define date, title, alternate title, link, alternate link, file and alternate file which you can display along with this item.
General Properties:
Active - This option allows you to temporary disable this item (option NO). In case you set this option to YES, it will be normally visible to visitors.
Internal Name (optional) - This is an identification of this particular item. This name must be unique within this Data List.
Start Publishing (optional) - This date defines when will be the item published.
Finish Publishing (optional) - This date defines until when will be the item displayed.
Click the Cultures button for adding more languages. Along with new fields a “use from default culture” check box will be displayed, which will automatically use data from the appropriate field in the Default Culture.
For info about the displaying of a data list please visit this help site.
Image Gallery¶
Image Gallery Data List allows you to group together images from the File Manager in order to create a website image gallery or an image slider.
Base Data Fields:
Image (required) - Select an image you want to add from the File Manager. This is the only required field.
Image Thumb (optional) - Select an image thumbnail from the File Manager.
Title (optional) - Insert a title for this image. This field can be displayed to your website visitors.
Description (optional) - Insert a description for this image. This field can be displayed to your website visitors (as an alt for this image).
Additional Data Fields allows you to define date, alternate title, alternate text, link and alternate link which you can display along with this item.
General Properties:
Active - This option allows you to temporary disable this item (option NO). In case you set this option to YES, it will be normally visible to visitors.
Internal Name (optional) - This is an identification of this particular item. This name must be unique within this Data List.
Start Publishing (optional) - This date defines when will be the item published.
Finish Publishing (optional) - This date defines until when will be the item displayed.
Click the Cultures button for adding more languages. Along with new fields a “use from default culture” check box will be displayed, which will automatically use data from the appropriate field in the Default Culture.
For info about the displaying of a data list please visit this help site.
Media¶
Media Data List allows you to group various files from your File Manager, which you want to make accessible for your website visitors.
Base Data Fields:
File (required) - Select a file from your File Manager you want to add to this Data List. This is the only required field.
Title (optional) - Insert a title for this file. This field can be displayed to your website visitors.
Description (optional) - Insert a description of the selected file. It can be displayed to your website visitors.
Image Thumb (optional) - You can select (from the File Manager) a thumbnail image for the file selected above.
Additional Data Fields allows you to define date, alternate title, alternate text, link and alternate link which you can display along with this item.
General Properties:
Active - This option allows you to temporary disable this item (option NO). In case you set this option to YES, it will be normally visible to visitors.
Internal Name (optional) - This is an identification of this particular item. This name must be unique within this Data List.
Start Publishing (optional) - This date defines when will be the item published.
Finish Publishing (optional) - This date defines until when will be the item displayed.
Click the Cultures button for adding more languages. Along with new fields a “use from default culture” check box will be displayed, which will automatically use data from the appropriate field in the Default Culture.
For info about the displaying of a data list please visit this help site.
News¶
News Data List allows you to create a text article, which contains a date, title, text and summary.
Base Data Fields:
Date (required) - Set the date related to this news. This is a required field and it’s visible to your website visitors.
Title (required) - Insert a title for this news. This is a required field and it’s visible to your website visitors.
Text (required) - Insert the full text of this item. This is a required field and it’s visible to your website visitors.
Summary (optional) - Insert a short summary of this item. This is an optional field and it’s visible to your website visitors.
Image (optional) - Select an image you want to add from the File Manager.
Image Thumb (optional) - You can select (from the File Manager) a thumbnail image for the file selected above.
Additional Data Fields allows you to define alternate title, link and alternate link which you can display along with this item.
General Properties:
Active - This option allows you to temporary disable this item (option NO). In case you set this option to YES, it will be normally visible to visitors.
Internal Name (optional) - This is an identification of this particular item. This name must be unique within this Data List.
Start Publishing (optional) - This date defines when will be the item published.
Finish Publishing (optional) - This date defines until when will be the item displayed.
Click the Cultures button for adding more languages. Along with new fields a “use from default culture” check box will be displayed, which will automatically use data from the appropriate field in the Default Culture.
For info about the displaying of a data list please visit this help site.
Reference List¶
Reference List allows you to create a list of your references (probably other companies you have business relations with).
Base Data Fields:
Name (required) - Insert a name of this reference. This is the only required field and it will be displayed to your website visitors.
Web address (optional) - Insert an URL address of a website connected with the reference you are creating. This is an optional field and it will be displayed to your website visitors.
Description (optional) - Insert a description of this reference. It is an optional field and it will be visible to your website visitors.
Image (optional) - Select an image from your File Manager you want to connect with this record. This is an optional field.
Additional Data Fields allows you to define date, alternate title, alternate text, alternate link and alternate file which you can display along with this item.
General Properties:
Active - This option allows you to temporary disable this item (option NO). In case you set this option to YES, it will be normally visible to visitors.
Internal Name (optional) - This is an identification of this particular item. This name must be unique within this Data List.
Start Publishing (optional) - This date defines when will be the item published.
Finish Publishing (optional) - This date defines until when will be the item displayed.
Click the Cultures button for adding more languages. Along with new fields a “use from default culture” check box will be displayed, which will automatically use data from the appropriate field in the Default Culture.
For info about the displaying of a data list please visit this help site.
Messages¶
Messages is a special type of a Data List that allows you to display a time-limited message on your website. It is not a usual Data List (a collection of similar information), it is intended as a one or a few messages which set the date of publication. A message can typically be a notice of maintenance, discount announcement or simple update messages.
You define the message and set a publication date (period of activity). When the date passes, the message won’t be displayed at all. It is necessary to insert this code into the page where you want to display the message:
{% set message = cms.dataLists.get( 'internalName' ).firstItem %} {{ message.title }} {{ message.text }}
Where the internalName is the Internal Name of the particular Message Data List.
In case there are more active messages, the first one will be used in preference (it means that the second one won’t be displayed).
See more info about using Data Lists on your website.
Contents¶
Contents is an application located in the Author Tools module. It is used to create a special type of page - Content. Content is not a separate page, it is just a text content that has to be inserted into a regular Content Page in the Website Editor.
Basically, there are three ways how to display easily changeable content on your website:
Articles - An Article is always bound to a website and to the concrete Article Component. It means that you are unable to use it separately. You cannot insert an Article to an ordinary page.
Data Lists - A Data List is a list of items. An item can be an image, file, text or a combination of these. Typically it is a list of news, faq or media for download. This can be successfully used in case you want to display more items per one page.
Contents - A Content is usually very similar to a Content Page. The difference is that the Content has to be inserted on a Content Page, without it you are unable to display it. It allows you to easily change a part of the Page’s content without editing the particular Page.
Contents contains normal content page elements, such as texts or pictures. To display it, you have to insert it directly into the code of a Content Page like this:
{% include '@content/content-internal-name' %}
The content-internal-name defines the concrete Content that will be displayed.
Contents are used in case you want to have easily editable content on your page. All you need to do is to go to the Author Tools module, run the Contents application and edit it. You don’t need to go to the Website Editor and edit a page.