Changeset 15898 for trunk/inc

Timestamp:

01/19/12 01:26:10 (4 months ago)

Author:

Alexander Trofimov

Message:

Page - docs.

File:

• trunk/inc/classes/BxDolPage.php (modified) (5 diffs)

trunk/inc/classes/BxDolPage.php

@@ -19 +19 @@
  * Pages. 
  *
- * It allows to display pages build from studio. 
+ * It allows to display pages which are built from studio.
  *  
  * The new system has the following page features:
- * - layouts: page can have any page structure, not just columns.
+ * - Layouts: page can have any structure, not just columns.
  * - SEO: page can have own SEO options, like meta tags and meta keywords, as well as instructions for search bots.
- * - cache: page can be cached on server or in client's browser.
- * - visibility: page access can be controlled using member levels.
+ * - Cache: page can be cached on the server.
+ * - Access control: page access can be controlled using member levels.
  * 
  * 
@@ -34 +34 @@
  *
  * - object: name of the page object, in the format: vendor prefix, underscore, module prefix, underscore, internal identifier or nothing; for example: bx_profiles_view - profile view page.
- * - title: title to display as page title.
+ * - title: name to display as page title.
  * - module: the module this page belongs to.
- * - layout_id: page layout to use, it is id of the record from 'sys_pages_layouts' table.
+ * - layout_id: page layout to use, this is id of the record from 'sys_pages_layouts' table.
  * - visibile_for_levels: bit field with set of member level ids. To use member level id in bit field - the level id minus 1 as power of 2 is used, for example:
  *      - user level id = 1 -> 2^(1-1) = 1
@@ -47 +47 @@
  * - meta_keywords: meta keywords of the page.
  * - meta_robots: instructions for search bots.
- * - cache_server: number of seconds to store cache for on the server.
+ * - cache_server: number of seconds to store cache for.
  * - cache_editable: it determines if cache can be edited from page builder.
  * - deletable: it determines if page can be deleted from page builder.
@@ -75 +75 @@
  * - type: block type
  *      - raw: HTML block, displayed in page builder as HTML textarea.
- *      - html: HTML block, displayed in page builder as visual editor, line TinyMCE.
+ *      - html: HTML block, displayed in page builder as visual editor, like TinyMCE.
  *      - lang: translatable language string, displayed in page builder as editable language key.
  *      - image: just an image, displayed in page builder as HTML upload form.
  *      - rss: RSS block, displayed in page builder as editable URL to RSS resource, along with number of displayed items.
  *      - menu: menu block, displayed as menu selector.
- *      - service: to display block content, the provided serice method is used.
+ *      - service: to display block content, the provided service method is used.
  * - content: depending on 'type' field:
  *      - raw: HTML string.
@@ -91 +91 @@
  * - deletable: is block deletable from page builder
  * - copyable: is block can be copied to any other page from page builder.
- * - order: block order in some cell.
+ * - order: block order in particular cell.
  * 
  * Block design boxes are stored in 'sys_pages_design_boxes' table: