dl look terrible
Oleg
committed Oct 29, 2010
commit 9966705519b5a879e8876070097cc9a411a042ad
Showing 1
changed file with
19 additions
and 49 deletions
README.md
+19
-49
| @@ | @@ -57,67 +57,37 @@ So there's your layout and the `{cms:page:content}` defines a place where render |
| #### Page Blocks | |
| pieces of content that will be output on the page: | |
| - | |
| - | <dl> |
| - | <dt><em>{ cms:page:some_label:text }</em></dt> |
| - | <dd>alternatively <em>{ cms:page:some_label }</em>, will render a text area during page creation</dd> |
| - | |
| - | <dt><em>{ cms:page:some_label:string }</em></dt> |
| - | <dd>will render a text field during page creation</dd> |
| - | |
| - | <dt><em>{ cms:page:some_label:datetime }</em></dt> |
| - | <dd>datetime select widget</dd> |
| - | |
| - | <dt><em>{ cms:page:some_label:integer }</em></dt> |
| - | <dd>a number field</dd> |
| - | </dl> |
| + | |
| + | { cms:page:some_label:text } # will render a text area during page creation |
| + | # alternatively you may use: { cms:page:some_label } |
| + | { cms:page:some_label:string } # will render a text field during page creation |
| + | { cms:page:some_label:datetime } # datetime select widget |
| + | { cms:page:some_label:integer } # a number field |
| #### Page Fields | |
| pieces of content that are not rendered. They are useful for hidden values you want to use inside your app. `@cms_page` instance variable is available when you need to access field values. | |
| - | <dl> |
| - | <dt><em>{ cms:field:some_label:text }</em></dt> |
| - | <dd>text area for the page creation form</dd> |
| - | |
| - | <dt><em>{ cms:field:some_label:string }</em></dt> |
| - | <dd>same as <em>{ cms:field:some_label }</em>, this is a text field</dd> |
| - | |
| - | <dt><em>{ cms:field:some_label:datetime }</em></dt> |
| - | <dd>datetime</dd> |
| - | |
| - | <dt><em>{ cms:field:some_label:integer }</em></dt> |
| - | <dd>a number field</dd> |
| - | </dl> |
| + | { cms:field:some_label:text } # text area for the page creation form</dd> |
| + | { cms:field:some_label:string } # same as { cms:field:some_label }, this is a text field |
| + | { cms:field:some_label:datetime } # datetime |
| + | { cms:field:some_label:integer } # a number field |
| #### Snippets | |
| bits of reusable content that can be used in pages and layouts | |
| - | |
| - | <dl> |
| - | <dt><em>{ cms:snippet:snippet_slug }</em></dt> |
| - | <dd></dd> |
| - | </dl> |
| - | |
| + | |
| + | { cms:snippet:snippet_slug } |
| + | |
| #### Helpers | |
| are tags that map to your view helpers methods | |
| - | |
| - | <dl> |
| - | <dt><em>{ cms:helper:method_name }</em></dt> |
| - | <dd>gets translated to method_name( )</dd> |
| - | |
| - | <dt><em>{ cms:helper:method_name:value_a:value_b }</em></dt> |
| - | <dd>gets translated to method_name('value_a', 'value_b')</dd> |
| - | </dl> |
| - | |
| + | |
| + | { cms:helper:method_name } # gets translated to <%= method_name( ) %> |
| + | { cms:helper:method_name:x:y:z } # gets translated to <%= method_name('x', 'y', 'z') %> |
| + | |
| #### Partials | |
| are exactly that. You don't want to do IRB inside CMS so there's a handy tag: | |
| - | <dl> |
| - | <dt><em>{ cms:partial:path/to/partial }</em></dt> |
| - | <dd>gets translated to render :partial => 'path/to/partial'</dd> |
| - | |
| - | <dt><em>{ cms:partial:path/to/partial:value_a:value_b }</em></dt> |
| - | <dd>gets translated to render :partial => 'path/to/partial', :locals => { :param_1 => 'value_a', :param_2 => 'value_b'}</dd> |
| - | </dl> |
| + | { cms:partial:path/to/partial } # gets translated to <%= render :partial => 'path/to/partial' %> |
| + | { cms:partial:path/to/partial:x:y } # gets translated to <%= render :partial => 'path/to/partial', :locals => { :param_1 => 'x', :param_2 => 'y'} %> |
| You don't have to define entire html layout, however. You can simply re-use your application one. Page content will be yielded into it like any normal view. | |