Kooboo CMS web site documentation guideline

From Kooboo document
Jump to: navigation, search

Kooboo provides practice to write web site documentation in order to be executed by a Kooboo developer. The documents of a standard Kooboo web site should contain the following parts: web site background, Site map, content type and folder, layout, pages.


Web site background

This should answer the following 3 basic questions.

- What is the purpose of this web site, what problem it try to solve or the business target behind it?

- What kind of users will be visiting the web site and how? For example, does it require login to view information?

- What user can do in the web site? The main function of it. For example, view article and post comment.

This is to help developer understand the business of it in order to make sure that developer can make some decision easily in unclear areas or can provide active advice of how the web site should be built.

Site map

Site map should contains the structure of the web site. Kooboo CMS provides a visual tool to generate site map, you can also create it using tools like Microsoft powerpoint. Below is a sample site map.

Kooboo CMS documentation guideline sitemap.png

Content type

This defines the columns of your information type in the web site. For example, our web site contains two type of information, which is we have two content types: news and category, and two folders.

Article

Name ControlType Validation Remark
Title TextBox Required
Summary TextArea Required
Detail TinyMce

Category

Name ControlType Validation Remark
Title TextBox Required


Current available control types:

Textbox CheckBox CheckBoxList RadioList DropdownList File MultiFiles TextArea TinyMce Int32 Float Date Hidden Display HighlightEditor

Content folder

This determines where your content is stored and how you are going to manage your content.

Folder name Content type Category folder Embedded folder Parent path
Article Article Category
Category Category

Definition of content folder is not required unless you have some special requirements; we will organize the content folder structure according to content type definition.

Layout

Layout is the master page of your web site that defines fixed layout positions to be filled with contents in the development.

Most of web sites have two layouts, one is homepage layout and the other is content page layout.

Kooboo CMS documentation guideline layout position.png

Pages

A page is the configuration of layout, views, html content or others. It is required to mark the information on page with the notation of database column.

Page information notation should use the followings:

[ContentType.FieldName]: For text that comes from database content folder. [Label:Keyname]: For small text that will be saved as a label in Kooboo CMS. [HtmlBlock:Keyname]: For block of HTML that might be re-used in several places. [InPageHtml] : For Html content that is attached to that page.

Below is an example

Page: ArticleList

Kooboo CMS documentation guideline detail page.png

Special remarks

When a page contains some special effects or other special things, you need to put them in this section.

For example, Mouse over effect or other special things.