diff --git a/README.md b/README.md index e1f3302..1cb1b99 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,10 @@ The goal of the library is to provide the following features. - doc -- Documentation. **Documentation** - >[CMS design](https://github.com/EiffelWebFramework/ROC). - >[CMS concepts](https://github.com/EiffelWebFramework/ROC). + + >[CMS concepts](/doc/concepts.md). - \ No newline at end of file + >[CMS design](/doc/design.md). + + >[CMS tutorial](/doc/tutorial.md). + diff --git a/doc/CMS_design.md b/doc/CMS_design.md deleted file mode 100644 index e69de29..0000000 diff --git a/doc/concepts.md b/doc/concepts.md new file mode 100644 index 0000000..e0af263 --- /dev/null +++ b/doc/concepts.md @@ -0,0 +1,52 @@ +CMS Concepts +============ +[Work in progress] + +##### Table of Contents +[Theme](#theme) +[Regions](#regions) +[Blocks](#blocks) + + +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] + + +Regions +------- +The layout of a CMS web page has predefined area called **regions**. The Eiffel CMS uses the same default regions as Drupal, so let's see them in the following image. + + +![default page layout](http://themery.com/sites/default/files/figure-15-10.png) + +``` +regions[page_top] = Top +regions[header] = Header +regions[content] = Content +regions[highlighted] = Highlighted +regions[help] = Help +regions[footer] = Footer +regions[first_sidebar] = first sidebar +regions[second_sidebar] = second sidebar +regions[page_bottom] = Bottom +``` + +**Regions Hold Blocks** + +What goes inside regions? Generally, regions hold smaller piece of content called blocks. Blocks hold chunks of content, like the user login form, navigation menu or the information for the footer. + +Regions are defined in a configuration file theme.info. + + + +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. + + +> CMS block design [To be completed] diff --git a/doc/CMS_concepts.md b/doc/design.md similarity index 100% rename from doc/CMS_concepts.md rename to doc/design.md diff --git a/doc/tutorial.md b/doc/tutorial.md new file mode 100644 index 0000000..6e04431 --- /dev/null +++ b/doc/tutorial.md @@ -0,0 +1,25 @@ +CMS Tutorial +============ +[Work in progress] + +##### Table of Contents +[Getting Started](#init) +[Building your module](#module) +[Lifecycle](#cycle) + + + +Getting Started +------------- + + + +Building your own module +----------------------- + + +Lifecycle +--------- + + + diff --git a/library/src/kernel/content/cms_block.e b/library/src/kernel/content/cms_block.e index 7800a39..16ce3ae 100644 --- a/library/src/kernel/content/cms_block.e +++ b/library/src/kernel/content/cms_block.e @@ -1,5 +1,5 @@ note - description: "Summary description for {CMS_BLOCK}." + description: "Describe content to be placed inside Regions." date: "$Date: 2014-08-28 08:21:49 -0300 (ju. 28 de ago. de 2014) $" deferred class