How_to_release_notes.txt doc/guides/html/building_modules.html @@ -138,7 +138,17 @@ <li>How to use helpers to add dynamic content to templates and partials</li> <li>How to use the <span class="caps">CMS</span>-specific form builder extensions</li> </ul> - + <h2>Creating a template +Each page in BrowserCMS uses a single template, which is designed to provide overall layout structure of the page. Here’s the general process +that a design team might follow to create a <span class="caps">CMS</span> template.</h2> +<p>1. Start with a <span class="caps">PSD</span> or <span class="caps">JPG</span> of the design, which represents the end result of what the webpage should look like. +2. Create a static html file which implements that design. +3. When creating menus, use the same structural <span class="caps">HTML</span> markup as will be generated by the Menu <span class="caps">API</span>. (See Menu’s below) +4. Change the file extension from .htm to .html.erb and add it as a template to the <span class="caps">CMS</span>.</p> +<h2>Menus +BrowserCMS provides an <span class="caps">API</span> to allow menus to be dynamically generated based on the sitemap. The purpose of this is to make +it easy to add new pages, without having to modify templates.</h2> +<div class="code_container"><code class="ruby">render_menu</code></div> </td> </tr> </table> doc/guides/html/designer_guide.html @@ -127,7 +127,7 @@ <div id="subCol"> <h3 class="chapter"><img src="images/chapters_icon.gif" alt="" />Chapters</h3> <ol class="chapters"> -<li><a href="#content-blocks">Content Blocks</a><ul></ul></li><li><a href="#creating-a-custom-content-block">Creating A Custom Content Block</a><ul></ul></li><li><a href="#creating-a-custom-portlet">Creating A Custom Portlet</a><ul><li><a href="#using-file-system-templates">Using File system templates</a></li><li><a href="#pre-selecting-a-handler">Pre-selecting a handler</a></li></ul></li><li><a href="#page-routes">Page Routes</a><ul></ul></li></ol></div> +<li><a href="#content-blocks">Content Blocks</a><ul></ul></li><li><a href="#creating-a-custom-content-block">Creating A Custom Content Block</a><ul><li><a href="#attribute-types">Attribute Types</a></li></ul></li><li><a href="#creating-a-custom-portlet">Creating A Custom Portlet</a><ul><li><a href="#using-file-system-templates">Using File system templates</a></li><li><a href="#pre-selecting-a-handler">Pre-selecting a handler</a></li></ul></li><li><a href="#page-routes">Page Routes</a><ul></ul></li></ol></div> </td> <td class="guides"> <h2>BrowserCMS Developer Guide</h2> @@ -170,6 +170,48 @@ end</code></div> <p>The form helper methods that are prefixed with <tt>cms_</tt> will wrap that form helper with the <span class="caps">CMS</span> styling and extra functionality. The <tt>cms_text_editor</tt> will show the user a <span class="caps">WYSIWYG</span> editor for editing <span class="caps">HTML</span>. Additional <span class="caps">CMS</span> form builder extensions are covered in the <a href="designer_guide.html">BrowserCMS Designer Guide</a>.</p> <p>The render template at <tt>app/views/cms/products/render.html.erb</tt> is the template that will be used to render the <span class="caps">HTML</span> when this product is placed directly on a page. It is also what is shown when you view a product within the content library of the <span class="caps">CMS</span>.</p> <p>As you will see in the next section, custom content blocks are often not placed directly on a page, instead the data of a product is displayed through a portlet. For this reason, a more informational display, similar to what is automatically generated by the generator, is what the render template often contains. Depending on what your content block is, you may want to place the content block directly on a page, in which case you would most likely customize the render template.</p> +<h4 id="attribute-types">2.1 Attribute Types +This section covers some of the different attribute types that Content Blocks can have. Each attribute represents a +persistent column in the database, will appear as an editable control on the <em>form.html.erb, and may also need to need to be configured +on the content</em>block itself.</h4> +<p>List of Content Types</p> +<ul> + <li>Text Fields</li> + <li>Text Areas</li> + <li>Drop Down (Select)</li> + <li>Text Editor (<span class="caps">WYWIWYG</span>)</li> + <li>Attachment (File Upload)</li> + <li>Tag List (Allow</li> + <li>Date Picker</li> +</ul> +<h5 id="drop-down--selects">2.1.1 Drop Down / Selects +This is similar to the traditional ‘select’ helper, it renders a stylized select control which allows users to choose one item from a list.</h5> +<h6 id="cms-drop-down">2.1.1.1 cms_drop_down +In _form.html.erb:</h6> +<div class="code_container"><code class="html"><%= f.cms_drop_down :category_id, Category.all(:order => "name").map{|c| [c.name, c.id]}, + :prompt => "Select a Category", :label => "Category", + :instructions=>"Determines which category is used on the homepage." %></code></div> +<p>In product.rb:</p> +<div class="code_container"><code class="ruby">class Product < ActiveRecord::Base + belongs_to :category +end</code></div> +<h5 id="attachments">2.1.2 Attachments +Each content block can have a single file attachment, which will allow users to upload files into the content repository. After uploading, the file will be +stored in a section within the <span class="caps">CMS</span>. Since sections determine permissions, this will allow you to control which users can access the file itself. Attached files +will have their own versioning history, which will keep track of changes.</h5> +<h6 id="cms-file-field">2.1.2.1 cms_file_field +This helper will create a stylized file upload file. An uploaded file will be associated with the content_block to which it is attached.</h6> +<p>In _form.html.erb (View)</p> +<div class="code_container"><code class="html"><%= f.cms_file_field :attachment_file, :label => "File" %></code></div> +<p>In product.rb (Model)</p> +<div class="code_container"><code class="ruby">class Product < ActiveRecord::Base + acts_as_content_block :belongs_to_attachment => true +end</code></div> +<p>In create_products.rb (Migration)</p> +<div class="code_container"><code class="ruby">create_content_table :products do |t| + t.belongs_to :attachment + t.integer :attachment_version +end</code></div> <h3 id="creating-a-custom-portlet">3 Creating A Custom Portlet</h3> <p>Once you have created the product content block and created a few products in the content library, you need a way to display them on a page. To do that, you will want to create a portlet.</p> <p>A portlet is used to display dynamic data on a page. A portlet is a content block. A portlet will typically perform some kind of database query in the render method and then render it’s view. One difference between a portlet and typical content block is that each instance of a portlet can have a unique template because that template is stored as data along with the portlet. Let’s generate a portlet to display the most recently created products:</p> doc/guides/html/developer_guide.html @@ -155,7 +155,7 @@ $ script/server</code></div> <div class="code_container"><code class="html">$ rails my_new_project_name -d mysql -m http://browsercms.org/templates/demo.rb $ cd my_new_project_name $ script/server</code></div> -<p>Here we specify the -m mysql flag to rails, which will create our project using MySQL. You need to have the mysql gem installed for this to work.</p> +<p>Here we specify the -d mysql flag to rails, which will create our project using MySQL. You need to have the mysql gem installed for this to work.</p> <h4 id="using-your-site">2.3 Using your Site</h4> <p>Open your browser to <a href="http://localhost:3000/cms">http://localhost:3000/cms</a> to log into the admin for the <span class="caps">CMS</span>. Enter the default username/password (in development mode) is username=cmsadmin, password=cmsadmin. You should be now be logged in, viewing the home page of the site. You can now edit or add new content via the admin interface.</p> <p>To learn more about the types of things you can do with BrowserCMS, see the <a href="user_guide.html">User’s Guide</a>.</p> doc/guides/html/getting_started.html @@ -121,7 +121,7 @@ end In create_products.rb (Migration) <ruby> -create_versioned_table :products do |t| +create_content_table :products do |t| t.belongs_to :attachment t.integer :attachment_version end doc/guides/source/developer_guide.textile cc8816b6d5f9fda0323197e8b5878ae00ee680e8 peakpg peakpg@gmail.com http://github.com/browsermedia/browsercms/commit/283bffc183b14c1b3e322e4d0928fc674eeeb364 283bffc183b14c1b3e322e4d0928fc674eeeb364

2009-09-23T10:41:47-07:00

Updates to docs 9c863c64fae0e6bbfed3aad9029dfaad6dd2d908 peakpg peakpg@gmail.com