From e36465f86d9dd6f15d8a71947caaba2b075c5276 Mon Sep 17 00:00:00 2001 From: jvelilla Date: Tue, 18 Nov 2014 09:26:52 -0300 Subject: [PATCH] Update concepts.md Added references to the important classes. --- doc/concepts.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/doc/concepts.md b/doc/concepts.md index e0af263..762fe13 100644 --- a/doc/concepts.md +++ b/doc/concepts.md @@ -13,7 +13,11 @@ Theme In a CMS , a theme is a collection of templates files (HTML, CSS, Images, etc ) that determine how a CMS web site looks. The goal of a theme is to let you change the look and feel of the site. Eiffel CMS uses the same default regions as Drupal for themes. -> Current Theme design [Work in Progress] +#### Important Classes + +* [CMS_THEME] (/library/src/theme/cms_theme.e): The deferred class CMS_THEME provides an abstraction to the actual theme. +* [SMARTY_CMS_THEME] (/library/src/theme/smarty_theme/smarty_cms_theme.e): The class SMARTY_CMS_THEME, is a theme implementation using the [Eiffel Smarty library] (https://github.com/eiffelhub/template-smarty). +* [CMS_TEMPLATE] (/library/src/theme/cms_template.e): The deferred CMS_TEMPLATE clas provides an abstraction to describe the theme, the variables to feed it and how to render it as html. At the moment there is only one implementation [SMARTY_CMS_PAGE_TEMPLATE] (/library/src/theme/smarty_theme/smarty_cms_page_template.e). Regions @@ -48,5 +52,10 @@ CMS_BLOCK **What is a cms block?** Blocks are chunk of content that can be created to display whatever you want, and then can be placed in various resgions in your template (theme) layout. +#### Important Classes + +* [CMS_BLOCK] (/library/src/kernel/content/cms_block.e): The deferred class CMS_BLOCK provides an abstraction to describe content to be placed inside Regions. +* [CMS_CONTENT_BLOCK] (/library/src/kernel/content/cms_content_block.e): The class CMS_CONTENT_BLOCK describe how to provide generic content. +* [CMS_MENU_BLOCK](/library/src/kernel/content/cms_menu_block.e): The class CMS_MENU_BLOCK describe how to provides a menu of navigational links. +* [CMS_SMARTY_TEMPLATE_BLOCK] (/library/src/kernel/content/cms_smarty_templateblock.e) The class CMS_SMARTY_TEMPLATE_BLOCK describe how to use a CMS block with smarty template file content. -> CMS block design [To be completed]