Home
ApPHP MicroBlog
Getting Started

Getting Started with ApPHP MicroBlog (for v4.0.0 or above)

1. General.
- 1.1 MVC Framework.
- 1.2 Directy CMF.
2. MicroBlog's Backend.
- 2.1 Module Installation.
- 2.2 Updating a Module.
- 2.3 Edit Module Settings.
- 2.4 Module Settings.
- 2.5 Blog Categories.
- 2.6 Blog Posts.
- 2.7 Blog Pages.
- 2.8 Resources.
1. General.

In this section described what are ApPHP MVC Framework and ApPHP Directy CMF.

1.1 ApPHP MVC Framework.

ApPHP MVC Framework is designed to provide modern and rapid development of websites, web applications and web services. MicroBlog script requires framework version 0.4.0 or later for stable work. You may read more information about the framework from this Framework Documantation page.

1.2 ApPHP Directy CMF.

ApPHP Directy CMF is an open-source content management framework (CMF), built on ApPHP MVC Framework that provides a basic functionality required for creating websites and publishing web content. It includes Frontend and Backend parts, supports multi-language, roles and privileges, templates, modular development etc.

Building an application without ApPHP Directy CMF could take a weeks and weeks of hard developing, debugging and testing (depending on your experience level with PHP).

ApPHP Directy CMF eliminates the need for most of this work, freeing your valuable time for making great and modern applications. Each web applications that built with Directy CMF represents the triple chain, where application logic encapsulated in the special module: MVC Framework ↔ Directy CMF ↔ Web Application.

Find more information about the ApPHP Directy CMF in this Getting Started guide.

2. MicroBlog's Backend.

This section describes how to start work with ApPHP MicroBlog Backend.

2.1 Module Installation.

First of all make sure MicroBlog module is installed on your site. To check it go to Modules / Modules Management page and select System Modules tab. If you see this module in the list with status Enabled it means it's successfully installed.

If for some reason it's still not installed, you have to perform this operation before starting to work with it. To install the module simply click on Install link from the column named Actions.

2.2 Updating a Module.

Remove an old version of the module from protected/modules/ directory and upload there the new one. Then go to Modules / Modules Management page and select System Modules tab. If a new version of MicroBlog module is greater than previous you will see update icon link in Actions column. Click this icon to update the module. If update operation completed successfully update icon will disappear and module version number will be changed to the latest.

2.3 Edit Module Settings.

Once installed the MicroBlog module will appear in the list of available modules on Application Modules page. Now you may edit module parameters (only allowed for system modules).

To edit a module click Edit icon from the Actions menu. On edit module page you may see all module parameters and change some of them, for ex.:
- Display About Me Block
- Display Avatar In About Me
- Display Archive Block
- Display Author Block
- etc.
2.4 Module Settings.

Module Settings allows you to configure important settings of the module. To access this page go to Modules / Modules Management, select System Modules tab and then click MicroBlog module link or click on MicroBlog module icon from the dashboard.

Currently you may configure following settings:
- Function for displaying About me block
- Show avatar in About block
- Archive Settings / Settings:
  - Function for displaying Archive Block
  - The maximum number of archives to show in block
- Author Settings / Settings:
  - Function for displaying Author Block
  - Defines a SEO format for author links that will be used in the blog
  - The maximum number of authors to show in block
- Category Settings / Settings:
  - Function for displaying Categories Block
  - Show Category Tag in post footer
  - Defines a SEO format for categories links that will be used in the blog
  - The maximum number of categories to show in block
- Comments Settings / Settings:
  - Possibility to allow comments to posts
  - The maximum length of a comment
  - Possibility to allow pre-moderation for comments
  - Possibility allow image verification (captcha) for comments
- Pages Settings / Settings:
  - Function for displaying static Pages Block
  - The maximum number of pages to show in block
  - SEO format for post links that will be used in the blog
- Post Setting / Settings:
  - Defining link that leads to the page with all blog posts
  - Specifying how many posts will be shown per page
  - Maximum length of the post in characters that will be shown on the Frontend
  - SEO format for post links that will be used in the blog
- Resource Settings / Settings:
  - Function for display Resources Block
  - The maximum number of resources to show in block
- Tags Settings / Settings:
  - Function for display Tag Clouds Block
  - Show limit for count Tags in Added/Edited modes
2.5 Blog Categories.

Blog Categories page allows administrator or author to create, edit and manage all categories on the blog. It enables to create unlimited number of categories, where each category has it's name, sort order and status: active or not.
Once created category becomes visible each post may be added/assigned to it. You may relate different posts to one category.

2.6 Blog Posts.

On Blog Posts page administrator or author can create, edit and manage blog posts. Administrator can view and manage all the posts, and blog author can manage only his own posts.

To add a new post click the "Add Post" button on the Posts Management page. On this page you may add post header, post text, allow comments, define specific tags for this post and relate it to selected category. You may also publish the post or just save changes without publishing. Click the "Create" button to finish the process.

To edit existing post - select an appropriate post from the list on Posts Management and click the "Edit" icon in the actions column. Perform all changes you need and then press "Update" button.

If you want to insert/upload images into your post - click the "Insert Image" icon in the toolbar of WYSIWYG editor, then upload/select your image and press "Submit" button.

You may add available modules to each post. To do this just copy and paste into the text in appropriate place a special module tag, for example: {module:gallery}, {module:webforms} etc.

2.7 Blog Pages.

On Blog Pages page administrator can create, edit and manage blog static pages. This option available for administrator only.

2.8 Resources.

This page allows you to create and manage resources links. To do this go to Modules -> Micro Blog -> Resources Management. Resources are managed with a standard CRUD page. You can add, delete or edit resource link and info.