File: help/tutorial.en.md

Recommend this page to a friend!

help/tutorial.en.md

File:	`help/tutorial.en.md`
Role:	Auxiliary data
Content type:	`text/markdown`
Description:	Auxiliary data
Class:	Comfor PHP Discussion Forum Latest Displays the latest messages from "Comfor" forum
Author:	By ASCOOS CMS
Last change:	Updated to 1.0.1
Date:	4 months ago
Size:	`10,568 bytes`

Download

How to use Block `comfor-latest` of Ascoos Cms.

This tutorial is divided into four steps. 1) What is Comfor program. 2) Installing the comfor-latest Block 3) Editing and configuration of its parameters. 4) The result we have.

1. What is `Comfor`.

Comfor is a discussion program integrated into Ascoos Cms and enables discussions with multilingual messages.

Also, like all the programs in Ascoos CMS, it has the ability to: - change appearance through themes. - display in the user's current language. - Up to "personalized" access rights. - ... and much more.

In the image below we see a view of the Comfor default theme.

1. Installation

The first step is to install the Block on the Ascoos Cms website we have.

Block is installed only through the built-in installer in the admin section.

From the Ascoos Cms desktop, double-click the Installation Program icon you see in the image below.

This will open us the installer, in which we will have to follow some easy steps to complete the installation of our block.

Welcome

First the program welcomes us to the installer, giving us some information about it and the installation process.

Action Selection

Here we select the two action steps of the installer. - In the first step, we select the action Install, thus declaring to the installer that we will do a new installation. In case our block is already installed and we just want to upgrade it then we will choose Extension Upgrade. In case we want to uninstall a component then we will select Unistall. The first option `ASCOOS Upgrade' is for kernel version upgrade.

In the second action step, we choose the type of our extension. In our case here, we choose `Blocks`.

Then press the Next button to continue with the installation process.

Select installation package

Here we are asked to select from our computer the compressed zip file containing the installation package.

The program also informs us that the installation package should be certified by AlexSoft Software to have all the necessary security safeguards for your system.

We press Next and since in this particular case we have no parameters that must be set during the installation process, the program will complete the installation.

We will press the Close button at the end and we will finish our work with the installer.

Edit and configure the Block

On the Ascoos Cms desktop, double-click the ASCOOS Explorer icon to open the Ascoos component management program.

In the program that will open (see image below) we choose:

1) From the menu ribbon the Blocks tab to go to the Blocks management page.

2) we go to the Views section and from the drop-down named Block we select comfor-latest. This will show us in the list of blocks only the block with the title Comfor Latest Messages. 3) In the displayed list, click on Comfor Latest Messages to open our block for editing.

1. Edit the basic properties of the Block.

All Blocks in Ascoos Cms have their basic settings the same from the start.

From the editing page of the basic settings, we can adjust to the specific needs of each block, although the install.php file of our block's installation package takes care of presetting these specifics, as you can see in the image below.

let's analyze these pieces of basic settings one by one.

`BLOCK NAME`: Here we give the name our block will have. In addition to letters and numbers, we can also use the hyphen `-` and underscore hyphen `_`. - `Block Name` : it is essentially the name of the copy of the physical block. - `Natural Block Name` : It is the natural name of the block as it is on the server disk. We can create as many copies of the block as we want. Of course, each one will have a different name.

`BLOCK TITLE` : Here we can give multilingual titles to our block. Of course we can only in the languages supported by our website. We can add, remove and sort the titles as we wish.

`VIEW OPTIONS` : Here we define the display parameters of the block.
- `Envirenment` : The environment that will be displayed. e.g. in the image below, we tell it to appear in the foreground of the webpage. It could be set to appear in the admin section, newsletter, etc.

- `3LT Template (Front)` : Each Ascoos Template consists of 3 layers, `front`, `frontpage` and `efp (encapsulation frontpage)`.`front` is the main part of the template and does not change. Within this the two other layers listed below can appear, but only a frontpage. While we can embed multiple `efp`. With the technology of 3LT Template, `Ascoos Cms', gives the possibility to adjust from page to page, from article to article, etc., without changing our basic visual part.

- `3LT Template (Frontpage)`: The 2nd level of our template. It can contain individual code (like `native blocks`), contain as many `efp`s as we want but cannot contain another `frontpage` or `front`.

- `3LT Template (EFP)` : The 3rd level of the template. can be integrated into the previous two as many times as we like. `CAUTION - BONUS` : The combination of the three layers can give enormous flexibility in the appearance of our components. E.g. we create two copies of the block with different settings and parameters and while the display position is the same, if the frontpage is different, we will have only one block displayed, while the other block will appear on the frontpage we set for it, when the page contains this the frontpage. E.g. in the program `articles` we define another `frontpage` and in the program `contacts` another, but both have display positions, e.g. the "position1". Depending on which `frontpage` or `efp` we define in our block settings, the corresponding one will appear.

- `View Position` : The display position of the block. Each part of 3LT Templates can have different display positions. These are usually created during the template installation process, but can be created later as well.

- `View Order` : The order that will appear inside the `View Position`.

`BLOCK PROPERTIES` :
- `A/A` : Auto Increment number. Generated from the database.
- `User Group` : We declare the minimum user group access level.
- `Published` : Should the block be published?
- `Show Title` : Will the title of the block be displayed?
- `Cache` : Include the final code of the block in the cache?
- `Cache Duration` : Refresh rate of the data in the `Cache`, in seconds.

`COMMENTS ON BLOCK` : includes various comments the user wants to have about the block.

2. Permissions

How access rights work, not only for blocks but also for all components of Ascoos Cms is described in the video Ascoos Cms Blocks - Edit Permissions which is on youtube.

3. Edit Block's special parameters.

Each component of Ascoos Cms also has its own operating parameters. For the specific block are those shown in the following image.

1) GENERAL CONFIGURATION OPTIONS:


 - `Number of forum topics` : The number of discussion messages to be displayed.

 - `Showing regardless of language`: Display all messages regardless of the language of syntax.

 - `On which Frontpage will it appear?` : On which `frontpage` do you want it to appear? This will also determine which pages it will appear on. By default it is `fullpage' because it gives all the necessary width on the screen for the data to be displayed correctly.

 - `Theme of appearance of Block`: We choose the appearance theme of the block. Each block has at least one default display theme named "default". As one might aptly conclude, this option creates increased display potential.

2) FORUM CATEGORIES OPTIONS :

 - `Forum Categories that will be included` : Here we can choose for which specific discussion categories we will have the display of the latest messages.

 - `Forum Categories to be excluded` : Here we will select the discussion categories for which we do not want data to appear. If a category exists both here and in the previous field, then the exception category takes precedence and will not display the messages of the category declared in the previous field.