RubyGems - browsercms - Versions diffs - 3.0.6 → 3.1.0 - Mend

browsercms 3.0.6 → 3.1.0

Files changed (995) hide show

data/doc/guides/html/developer_guide.html DELETED

@@ -1,308 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-    <title>BrowserCMS Developer Guide</title>
-    <link rel="stylesheet" type="text/css" href="files/stylesheets/syntax.css" />
-    <script type="text/javascript" src="files/javascripts/code_highlighter.js"></script>
-    <script type="text/javascript" src="files/javascripts/highlighters.js"></script>
-    <style type="text/css">
-      body {
-        background: #FFFFFF url(images/bg.png) repeat-x scroll 0 0;
-        font-family: "Trebuchet MS", Helvetica, Verdana, Arial, sans-serif;
-        margin: 0;
-        padding: 0;
-      }
-      #page {
-        margin: 0 auto;
-        text-align: left;
-        width: 1000px;
-      }
-      #header {
-        height: 110px;
-      }
-      div.top_cap {
-        background: transparent url(images/top_cap.png) no-repeat scroll 0 0;
-        height: 10px;
-      }
-      #contentwrap {
-        background: transparent url(images/dot.png) repeat scroll 0 0;
-        float: left;
-        width: 1000px;
-      }
-      div.bottom_cap {
-        background: transparent url(images/bottom_cap.png) no-repeat scroll 0 0;
-        height: 9px;
-      }
-      div.top_cap_content {
-        background: transparent url(images/top_cap_content.png) no-repeat scroll 0 0;
-        height: 5px;
-      }
-      #content {
-        background-color: #FFFFFF;
-        margin: 0 5px;
-        padding: 0 10px;
-      }
-      div.title {
-        padding: 20px;
-      }
-      div.title h1 {
-        border-bottom: 3px solid #505358;
-        color: #FFFFFF;
-        font-size: 24pt;
-        font-weight: normal;
-        line-height: 1;
-        margin: 0 0 10px;
-        padding-bottom: 10px;
-      }
-      td.sidebar {
-        font-size: 8pt;
-        width: 165px;
-        padding: 5px;
-      }
-      td.sidebar ol {
-        margin-left: 20px;
-        padding: 0;
-        line-height: 1.5;
-      }
-      td.sidebar ol li {
-        margin: 0;
-        padding: 0;
-      }
-      td.sidebar ol li ul {
-        list-style-type: none;
-        padding-left: 10px;
-      }
-      td.guides {
-        font-size: 10pt;
-        width: 800px;
-        padding: 10px;
-      }
-      .code_container {
-        padding: 10px;
-        background: #eee;
-        border: 1px solid #ccc;
-        overflow: auto;
-        width: 760px;
-      }
-      pre, code {
-        overflow: auto;
-        white-space:pre;
-      }
-    </style>
-  </head>
-  <body>
-    <div id="page">
-      <div id="header">
-        <a href="index.html"><img style="border:0px" src="images/browsercms_logo.png" alt="BrowserCMS"/></a>
-      </div>
-      <div id="main">
-        <div class="top_cap"></div>
-        <div id="contentwrap">
-          <div class="title">
-            <h1>BrowserCMS Developer Guide</h1>
-          </div>
-          <div class="top_cap_content"></div>
-          <div id="content">
-            <table width="100%" cellpadding="0" cellspacing="0" border="0">
-              <tr>
-                <td class="sidebar" valign="top">
-                        <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><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>
-<p>This guide covers how to use the tools that come with BrowserCMS to extend the functionality of your BrowserCMS site.  The target audience for this guide is intermediate to advanced Rails developers.  You should also read the <a href="user_guide.html">Building a Site with BrowserCMS</a> guide first as well, so you know how to create pages and put content on pages.  This guide will cover:</p>
-<ul>
-	<li>What content blocks and portlets are and how they work</li>
-	<li>How to create custom content blocks</li>
-	<li>How to create custom portlets</li>
-	<li>How to create friendly URLs for pages</li>
-</ul>
-                  <h3 id="content-blocks">1 Content Blocks</h3>
-<p>Content Blocks are the basic unit used to add content to pages in a BrowserCMS site.  There are several pre-built content types that are part of BrowserCMS core.  The most commonly used one is the HtmlBlock content type, so we will use that as a starting example.</p>
-<p>If you look at the HtmlBlock model in BrowserCMS core, you will see that it is an ActiveRecord model, just like any model you create in a Rails application.  It also calls the <a href="/doc/app/classes/Cms/Acts/ContentBlock/MacroMethods.html">acts_as_content_block</a> method, which just sets up several <a href="/doc/app/classes/Cms/Behaviors.html">Behaviors</a> on the model.  One of the key Behaviors to understand is the <a href="/doc/app/classes/Cms/Behaviors/Rendering.html">Rendering</a> behavior.  Essentially what this behavior does is to allow a model (by model I mean a subclass of ActiveRecord::Base) to act as a mini-controller.  This is the same thing conceptually as <a href="http://yehudakatz.com/2007/09/06/merbs-parts-are-pretty-rocking-too">Merb Parts</a> or <a href="http://cells.rubyforge.org">Rails Cells</a>, the only difference is that content blocks are models as well, so they have attributes that are stored in the database like any other model.</p>
-<p>In the BrowserCMS implementation, first the render method of the object is called, which is like an action.  This is where instance variables are set.  In the case of an HtmlBlock, there are no other instance variables to set up, so this step is just skipped.  It is similar to a controller action that has no action method, it just goes straight to the view.</p>
-<p>The view is the render template, which is inside the <tt>cms/html_blocks</tt> directory in the view path.  If you look in the render template, you will see all it does is print the value of <tt>@content_block.content</tt>.  Content is the name of the property that holds the <span class="caps">HTML</span> content.</p>
-<h3 id="creating-a-custom-content-block">2 Creating A Custom Content Block</h3>
-<p>Let&#8217;s say that you are using BrowserCMS to build a website that will display a list of products.  The first step would be to create a product content block.  This will give the users of the <span class="caps">CMS</span> a way to create products.  To create a product content block, in an existing BrowserCMS project, run the content block generator:</p>
-<div class="code_container"><code class="html">$ script/generate content_block product name:string price:integer description:html</code></div>
-<p>You will notice that several things have been created:</p>
-<ul>
-	<li>A model in <tt>app/models/product.rb</tt></li>
-	<li>A migration for the product model</li>
-	<li>A controller for the product in <tt>app/controllers/cms/products_controller.rb</tt></li>
-	<li>A form partial in <tt>app/views/cms/products/_form.html.erb</tt></li>
-	<li>A render template in <tt>app/views/cms/products/render.html.erb</tt></li>
-	<li>A resource route for the controller</li>
-</ul>
-<p>If you look at <tt>app/models/product.rb</tt>, you will see that it is nothing more than:</p>
-<div class="code_container"><code class="ruby">class Product &lt; ActiveRecord::Base
-  acts_as_content_block
-end</code></div>
-<p>The controller created at <tt>app/controllers/cms/products_controller.rb</tt> is equally empty:</p>
-<div class="code_container"><code class="ruby">class Cms::ProductsController &lt; Cms::ContentBlockController
-end</code></div>
-<p>This controller is the controller used in the actual <span class="caps">CMS</span> interface.  If you want to create a controller to use in the front end of your application, create a products controller that is not in the <span class="caps">CMS</span> namespace, so as not to conflict the <span class="caps">CMS</span> functionality.  You will most likely not need to customize the <span class="caps">CMS</span> controller at all.</p>
-<p>The form partial at <tt>app/views/cms/products/_form.html.erb</tt> is the form that will be used when creating/editing the product content block in the content library of the <span class="caps">CMS</span>.  The contents of this file will be:</p>
-<div class="code_container"><code class="html">&lt;%= f.cms_text_field :name %&gt;
-&lt;%= f.cms_text_field :price %&gt;
-&lt;%= f.cms_text_editor :description %&gt;</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 &#8216;select&#8217; 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">&lt;%= f.cms_drop_down :category_id, Category.all(:order =&gt; &quot;name&quot;).map{|c| [c.name, c.id]},
-                    :prompt =&gt; &quot;Select a Category&quot;, :label =&gt; &quot;Category&quot;,
-                    :instructions=&gt;&quot;Determines which category is used on the homepage.&quot; %&gt;</code></div>
-<p>In product.rb:</p>
-<div class="code_container"><code class="ruby">class Product &lt; 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">&lt;%= f.cms_file_field :attachment_file, :label =&gt; &quot;File&quot; %&gt;</code></div>
-<p>In product.rb (Model)</p>
-<div class="code_container"><code class="ruby">class Product &lt; ActiveRecord::Base
-   acts_as_content_block :belongs_to_attachment =&gt; 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&#8217;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&#8217;s generate a portlet to display the most recently created products:</p>
-<div class="code_container"><code class="html">$ script/generate portlet recent_products limit:integer</code></div>
-<p>What you will see created is:</p>
-<ul>
-	<li>A portlet at <tt>app/portlets/recent_products_portlet.rb</tt></li>
-	<li>A form partial at <tt>app/views/portlets/recent_products/_form.html.erb</tt></li>
-	<li>A render template at <tt>app/views/portlets/recent_products/render.html.erb</tt></li>
-</ul>
-<p>What you don&#8217;t see created is a migration.  Portlets use the <a href="/doc/app/classes/Cms/Behaviors/DynamicAttributes.html">DynamicAttributes</a> behavior in order to store associated values in the database without having to create custom database tables.  What this means is that you can set and then store a value for any attribute for a portlet.</p>
-<p>So if you look at the form partial that was generate for this portlet, you will see this:</p>
-<div class="code_container"><code class="html">&lt;%= f.cms_text_field :name %&gt;
-&lt;%= f.cms_text_field :limit %&gt;
-&lt;%= f.cms_drop_down :handler, ActionView::Template.template_handler_extensions, :default_value =&gt; &quot;erb&quot; %&gt;
-&lt;%= f.cms_text_area :template, :default_value =&gt; @block.class.default_template %&gt;</code></div>
-<p>Every portlet instance has to have a name and that is stored in the main <tt>portlets</tt> table, but <tt>limit</tt> is stored in the <tt>portlet_attributes</tt> table.  You could add anything to this form, such as <tt>&lt;%= f.cms_text_field :foobar %&gt;</tt>, and whatever the user enters for <tt>foobar</tt> would get saved with the portlet.</p>
-<p>If you look at the code for the portlet, you will see:</p>
-<div class="code_container"><code class="ruby">class RecentProducts &lt; Portlet
-  def render
-    # Your Code Goes Here
-  end
-end</code></div>
-<p>As the comment says, you will want to fill in your application logic here.  We&#8217;re going to get the most recent products and use the value the user entered for limit when they filled out the form.  So edit the code to look like:</p>
-<div class="code_container"><code class="ruby">class RecentProducts &lt; Portlet
-  def render
-    @products = Product.all(:order =&gt; &quot;created_at desc&quot;, :limit =&gt; self.limit)
-  end
-end</code></div>
-<p><code>self</code> in this case is the portlet instance, which is also available in the instance variable
-<code>@portlet</code>.
-We are setting the <code>@products</code> instance variable so that will be available in the view.  If you look at the render template, you will see this:</p>
-<div class="code_container"><code class="html">&lt;%=h @portlet.name %&gt;</code></div>
-<p>This is simply a place holder, you should override this code with something similar to what you expect the user of your portlet to want to use.  In this case, let&#8217;s go with:</p>
-<div class="code_container"><code class="html">&lt;ul&gt;
-  &lt;% @products.each do |product| %&gt;
-    &lt;li&gt;&lt;%=h product.name %&gt;&lt;/li&gt;
-  &lt;% end %&gt;
-&lt;/ul&gt;</code></div>
-<p>Notice that in the last paragraph I said &#8220;similar to what you expect the user of your portlet to want to use&#8221;.  This value is simply the default starting point for the template of a portlet.  The actual value is entered into the form when the user creates an instance of this portlet.</p>
-<p>If you look back at the form partial that was generated, you&#8217;ll see:</p>
-<div class="code_container"><code class="html">&lt;%= f.cms_text_area :template, :default_value =&gt; @block.class.default_template %&gt;</code></div>
-<p>What this does is preload the template with whatever you entered into the render template.  The user is free to change it as they see fit and even have different values from one portlet instance to the next.</p>
-<h4 id="using-file-system-templates">3.1 Using File system templates</h4>
-<p>If you do not want to have the portlet&#8217;s render template stored in the <span class="caps">CMS</span> content libary, but would rather have it just render the file from the file system, simply add this to your portlet code:</p>
-<div class="code_container"><code class="ruby">class RecentProducts &lt; Portlet
-    render_inline false
-    def render
-      @products = Product.all(:order =&gt; &quot;created_at desc&quot;, :limit =&gt; self.limit)
-    end
-  end</code></div>
-<p>The key line being the <code>render_line false</code>.  Also, you will probably notice this line in the form that was generated:</p>
-<div class="code_container"><code class="html">&lt;%= f.cms_drop_down :handler,
-        ActionView::Template.template_handler_extensions,
-        :default_value =&gt; &quot;erb&quot; %&gt;</code></div>
-<p>This generates a drop-down menu for the user creating the portlet to select from the various portlet handlers installed in your Rails app.
-The default handler for portlet views is erb, but you could use alternative ones, like Haml. To do that, install the <span class="caps">HAML</span> gem and set the default_value to &#8216;haml&#8217; like so:</p>
-<div class="code_container"><code class="html">&lt;%= f.cms_drop_down :handler,
-        ActionView::Template.template_handler_extensions,
-        :default_value =&gt; &quot;haml&quot; %&gt;</code></div>
-<h4 id="pre-selecting-a-handler">3.2 Pre-selecting a handler</h4>
-<p>If you would rather not have the user select the handler type, or if you are using the file system instead of storing the template code in the <span class="caps">CMS</span>, you can set the handler to a different value like this:</p>
-<div class="code_container"><code class="ruby">class RecentProducts &lt; Portlet
-    handler &quot;haml&quot;
-    render_inline false
-    def render
-      @products = Product.all(:order =&gt; &quot;created_at desc&quot;, :limit =&gt; self.limit)
-    end
-  end</code></div>
-<p>The key line being <code>handler "haml"</code>.</p>
-<h3 id="page-routes">4 Page Routes</h3>
-<p><span class="caps">TODO</span></p>
-                </td>
-              </tr>
-            </table>
-          </div>
-        </div>
-        <br clear="all"/>
-        <div class="bottom_cap"></div>
-      </div>
-    </div>
-  </body>
-</html>

data/public/fckeditor/editor/css/behaviors/disablehandles.htc DELETED

@@ -1,15 +0,0 @@
-<public:component lightweight="true">
-<script language="javascript">
-function CancelEvent()
-{
-	return false ;
-}
-this.onresizestart = CancelEvent ;
-this.onbeforeeditfocus = CancelEvent ;
-</script>
-</public:component>

data/public/fckeditor/editor/css/behaviors/showtableborders.htc DELETED

@@ -1,36 +0,0 @@
-<public:component lightweight="true">
-<public:attach event="oncontentready" onevent="ShowBorders()" />
-<public:attach event="onpropertychange" onevent="OnPropertyChange()" />
-<script language="javascript">
-var oClassRegex = /\s*FCK__ShowTableBorders/ ;
-function ShowBorders()
-{
-	if ( this.border == 0 )
-	{
-		if ( !oClassRegex.test( this.className ) )
-			this.className += ' FCK__ShowTableBorders' ;
-	}
-	else
-	{
-		if ( oClassRegex.test( this.className ) )
-		{
-			this.className = this.className.replace( oClassRegex, '' ) ;
-			if ( this.className.length == 0 )
-				this.removeAttribute( 'className', 0 ) ;
-		}
-	}
-}
-function OnPropertyChange()
-{
-	if ( event.propertyName == 'border' || event.propertyName == 'className' )
-		ShowBorders.call(this) ;
-}
-</script>
-</public:component>

data/public/fckeditor/editor/css/fck_editorarea.css DELETED

@@ -1,110 +0,0 @@
-/*
- * FCKeditor - The text editor for Internet - http://www.fckeditor.net
- * Copyright (C) 2003-2008 Frederico Caldeira Knabben
- *
- * == BEGIN LICENSE ==
- *
- * Licensed under the terms of any of the following licenses at your
- * choice:
- *
- *  - GNU General Public License Version 2 or later (the "GPL")
- *    http://www.gnu.org/licenses/gpl.html
- *
- *  - GNU Lesser General Public License Version 2.1 or later (the "LGPL")
- *    http://www.gnu.org/licenses/lgpl.html
- *
- *  - Mozilla Public License Version 1.1 or later (the "MPL")
- *    http://www.mozilla.org/MPL/MPL-1.1.html
- *
- * == END LICENSE ==
- *
- * This is the default CSS file used by the editor area. It defines the
- * initial font of the editor and background color.
- *
- * A user can configure the editor to use another CSS file. Just change
- * the value of the FCKConfig.EditorAreaCSS key in the configuration
- * file.
- */
-/**
- * The "body" styles should match your editor web site, mainly regarding
- * background color and font family and size.
- */
-body
-{
-	background-color: #ffffff;
-	padding: 5px 5px 5px 5px;
-	margin: 0px;
-}
-body, td
-{
-	font-family: Arial, Verdana, sans-serif;
-	font-size: 12px;
-}
-a[href]
-{
-	color: -moz-hyperlinktext !important;		/* For Firefox... mark as important, otherwise it becomes black */
-	text-decoration: -moz-anchor-decoration;	/* For Firefox 3, otherwise no underline will be used */
-}
-/**
- * Just uncomment the following block if you want to avoid spaces between
- * paragraphs. Remember to apply the same style in your output front end page.
- */
-/*
-p, ul, li
-{
-	margin-top: 0px;
-	margin-bottom: 0px;
-}
-*/
-/**
- * Uncomment the following block, or only selected lines if appropriate,
- * if you have some style items that would break the styles combo box.
- * You can also write other CSS overrides inside the style block below
- * as needed and they will be applied to inside the style combo only.
- */
-/*
-.SC_Item *, .SC_ItemSelected *
-{
-	margin: 0px !important;
-	padding: 0px !important;
-	text-indent: 0px !important;
-	clip: auto !important;
-	position: static !important;
-}
-*/
-/**
- * The following are some sample styles used in the "Styles" toolbar command.
- * You should instead remove them, and include the styles used by the site
- * you are using the editor in.
- */
-.Bold
-{
-	font-weight: bold;
-}
-.Title
-{
-	font-weight: bold;
-	font-size: 18px;
-	color: #cc3300;
-}
-.Code
-{
-	border: #8b4513 1px solid;
-	padding-right: 5px;
-	padding-left: 5px;
-	color: #000066;
-	font-family: 'Courier New' , Monospace;
-	background-color: #ff9933;
-}