{{ client_name }}
{% unless project_name == blank %}{{ project_name }}
{% endunless %} {{ formatted_content }}
{% for story_image in story_images %}
{% endfor %}
include Smithy::ContentBlocks::Model), a _form_fields partial (preferably utilizing formtastic) and it's own set of templates, managed within Smithy.
## Getting Started
To get started, add this to your Gemfile
```ruby
gem 'smithycms'
```
If you need basic authentication and don't want to integrate with existing auth in your system, add this to your Gemfile too:
gem 'smithycms-auth'
Installing the CMS is simple, you can just
```shell
bundle install
rake smithy:install:migrations
rake smithy_auth:install:migrations # (if you are using smithy-auth)
rake db:migrate
```
To your routes file, you need to mount Smithy - typically, this would be done at the root
```ruby
mount Smithy::Engine => "/"
```
Now start up your server and go to http://localhost:nnnn/smithy
## Integrating with third-party authentication
Add this to your routes file (before the `mount Smithy::Engine` line). It will redirect smithy/login|logout (the built-in paths) to your existing authentication paths.
```ruby
scope "/smithy" do
match "/login" => redirect("/your/login/path"), :as => :login
match '/logout' => redirect("/"), :as => :logout
end
```
Add the following to your application controller:
```ruby
def smithy_current_user
current_user # use whichever method name you have implemented to return the current_user
end
helper_method :smithy_current_user
```
If you wish for all of your users to have access to smithy, simply add this method to your user model:
```ruby
def smithy_admin?
true
end
```
Alternatively, you can add a boolean field (via migration) named `smithy_admin` to your users table and manage the field with with your existing user management.
Restart your local server and you should be good to go.
### Templates
Create your first Template, naming it whatever you want ("Home" or "Default" or something equally original). In the content, add `{{ page.container.main_content }}`. In the background, this will auto-create a container that will be used by any page using your template. You can name your container whatever you would like: `{{ page.container.foo }}` works as well. After you have created new page containers, they will automatically show up on the Page edit screen and allow you to add content to the container.
If you want, you can create Includes. For instance, if you create an Include named "header", you can utilize it in your Template via `{% include 'header' %}`.
Note, you can also create stylesheet and javascript files, included in your templates via smithy_stylesheet_link_tag and smithy_javascript_include_tag. javascript_include_tag calls out directly to ActionView so you can also access files from your host application directly. Eg. `{% smithy_javascript_include_tag 'my_special_javascript' %}`
### Pages
Follow the "Manage Content" link in the header and create your first page. Add a Title ("Home" for instance), select your Template and save the page. The page will save and you will be on the Edit screen for your new page. You can see that your "Main Content" container is now available.
### Content Blocks
Smithy comes with some useful Content Blocks already created, though you may need to add them to your system: Content, Image, PageList. After adding a Content Block, you must also create at least one template for it before you can use it on a page. Once you have added a template, you can utilize that Content Block in any available Page container.
### Adding Custom Content Blocks
While Smithy has some default Content Blocks, you will often want to add your own structured content, allowing you to manage templates for more structured content. To add a custom Content Block, do the following:
1. create a new table & model or use an existing one from your app. This can be a single, stand-alone model or a model with associations, Smithy doesn't really care.
2. Add `include Smithy::ContentBlocks::Model` to the top of your model. This gives some extra functionality for Smithy.
2. Add a views/mymodel/_form_fields.html.erb to your app, replacing "mymodel" with your new model name. This is identical to adding your own view/partial for the model. An "f" variable is passed to the partial, which represents a formtastic form. While formtastic is outside the scope of this document (look it up!), you can also just create your form however you want though it will be way simpler to just use formtastic syntax!
3. Smithy will automatically look for your _form_fields.html.erb partial to manage the Content Block when adding Page Content to a page.
4. Register your Content Block by entering the Smithy admin, clicking on Content Blocks and adding a new Content Block with your new model name, creating a template for your new Content Block at the same time.
Your _form_fields.html.erb file could look something like this:
```ruby
<%= f.inputs "Client Story" do %>
<%= f.input :client_name %>
<%= f.input :project_name %>
<%= f.input :content, :as => :text, :input_html => { :class => "span12" } %>
<% end %>
```
If you want to customize which columns are available to your liquid template, you can add a #to_liquid method to your model. Eg.:
```ruby
def to_liquid
{
'id' => self.id,
'client_name' => self.client_name,
'project_name' => self.project_name,
'content' => self.content,
'story_images' => self.images.map(&:to_liquid),
'formatted_content' => self.formatted_content
}
end
```
Using the above #to_liquid method, your template could look like this:
```html