aura 0.0.1.pre10

data/manual/models.md

@@ -0,0 +1,58 @@
+title: Models
+page_type: section
+--
+All models are Sequel models. Aura also uses the Sequel plugin system.
+
+#### Creating a model
+Subclass `Sequel::Model`.
+
+    [app/models/movie.rb (ruby)]
+    class Movie < Sequel::Model
+      # ...
+    end
+  
+#### Setting up migrations
+Migrations are defined in `app/migrations/`. Use
+[Sinatra-Sequel](http://github.com/rtomayko/sinatra-sequel)'s `migration`
+method in your migrations files.
+
+    [app/migrations/movie.rb (ruby)]
+    class Main
+      migration "foo v0.0.1 - create" do
+        database.create_table do
+          primary_key :id
+
+          String :name
+          String :description
+          
+          # ...
+        end
+      end
+    end
+
+#### Setting up plugins
+Use Sequel's `plugin` class method.
+
+    [app/models/movie.rb (ruby)]
+    class Movie < Sequel::Model
+      plugin :aura_editable
+      plugin :aura_sluggable
+      plugin :aura_hierarchy
+    end
+
+## Example
+
+In your extension, create a model file like so.
+
+    # extensions/myext/models/post.rb
+    class Post < Sequel::Model
+
+      # put guts here
+      # for example:
+
+      plugin :aura_editable
+      plugin :aura_sluggable
+
+      def shown_in_menu?() true; end
+    end
+

data/manual/recipes.md

@@ -0,0 +1,38 @@
+title: Recipes
+page_type: section
+--
+## Creating custom page types
+
+#### Use subtype
+In your model:
+
+    class Page < Sequel::Model
+      subtype :portfolio,
+        :name     => "Portfolio page",
+        :template => "id_portfolio"
+
+      custom_field :excerpt
+
+      form :portfolio do
+        text :excerpt, "Portfolio excerpt"
+      end
+    end
+
+## Adding something to the admin sidebar
+
+#### Adding models
+If it's a model you want on there:
+
+    class MyModel < Sequel::Model
+      def self.show_on_sidebar?; true; end
+    end
+
+#### The rest
+For anything else, put this in your app's initializers. (See {Aura::Menu} for more info)
+
+    [app/init/menu.rb (ruby)]
+    Aura.admin.menu.add "id",
+      :name => "My menu entry",
+      :href => '/admin/foo',
+      :icon => 'settings'
+

data/manual/recipes/bundling_sample_data.md

@@ -0,0 +1,30 @@
+title: Bundling sample data
+--
+You may want to bundle some sample data with the application when you deploy.
+This may be useful when you're delivering the CMS as one self-contained
+package to your client.
+
+#### Freeze your data
+Assuming you have Aura working locally, freeze it using `rake db:dump`.
+This creates a `config/seed.yml` file.
+
+    $ rake db:dump
+    * Working...
+    * Writing to config/seed.yml...
+
+    Done.
+
+    ...
+
+#### config/seed.yml
+Be sure to add this file to your repository.
+
+    $ ls -la config/seed.yml
+    -rw-r--r--   1 rsc  staff  28115 Jul 23 23:14 seed.yml
+
+    $ git add config/seed.yml
+
+The next time your application starts, it will rebuild the database from
+that snapshot. You can use `rake db:flush` to ensure that this will
+happen the next time the application loads.
+

data/manual/recipes/creating_themes.md

@@ -0,0 +1,10 @@
+title: Creating themes
+--
+A theme is just an extension.
+
+- Make an extension that has a `mytheme/views/` folder
+- Make up a `mytheme/views/layout.haml`
+- Override the look of a page in `mytheme/views/base/default.haml`
+- Put public stuff (images et al) in `mytheme/public/`
+- Put CSS files in `mytheme/views/css/`
+

data/manual/recipes/using_markdown_or_textile.md

@@ -0,0 +1,24 @@
+title: Using Markdown or Textile
+--
+
+#### Custom formatting
+You can use Markdown in your CMS. Go to HTML editing mode, and simply use
+`<div format='markdown'>` on a block you want to Markdown-ify.
+
+    <div format='markdown'>
+      ### Hello
+
+      * This is Markdown text.
+      * In your site, this will look just like how it should be.
+    </div>
+
+#### Textile
+To use Textile, just use `format='textile'` instead.
+
+    <div format='textile'>
+      h3. Hello again
+
+      * This is Textile text!
+      * In your site, this will look just like how it should be.
+    </div>
+

data/manual/routes.md

@@ -0,0 +1,39 @@
+title: Routes
+page_type: section
+--
+Routes are defined and used exactly as how you would in Sinatra.
+
+#### Defining routes
+Create a file in the `app/routes/` folder of your app.
+
+    [app/routes/foo.rb (rb)]
+    class Main
+      get '/foo' do
+        show :foo
+      end
+    end
+
+#### Handling 404's
+You should use `pass` instead of `not_found`. This lets the default
+Aura routes pick it up in case it points to something else.
+
+    [app/routes/foo.rb (rb)]
+    class Main
+      get '/book/:id' do |id|
+        @book = Book[id] or pass
+
+        # ...
+      end
+    end
+
+#### Defining admin pages
+Use the `show_admin` and `require_login` helpers.
+
+    [app/routes/foo.rb (rb)]
+    class Main
+      get '/admin/something' do |id|
+        require_login
+
+        show_admin :something
+      end
+    end

data/manual/theming.md

@@ -0,0 +1,55 @@
+title: Theming
+page_type: section
+--
+## Themes
+#### Theming
+Just change the views.
+
+    $
+    app/views/layout.haml
+    app/views/page/show.haml
+
+## CSS
+
+#### Adding CSS
+Put files in `app/css/`. You can put Sass, SCSS, Less or plain CSS files.
+
+    [app/css/main.scss (css)]
+    $red: #833;
+
+    #main {
+      color: $red;
+    }
+
+#### Accessing them
+These files will be accessible in `http://localhost:4567/css`. For example,
+these paths may correspond to the following files.
+
+    $ http://localhost:4567/css/screen.css
+    # ~/myapp/app/css/screen.css
+    
+    $ http://localhost:4567/css/main.css
+    # ~/myapp/app/css/main.scss (Rendered by Sass CSS)
+
+    $ http://localhost:4567/css/admin/top.css
+    # ~/myapp/app/css/admin/top.less (Rendered by Less)
+
+## JavaScript
+
+#### Adding JavaScript
+You may put files in `app/js/`. You can put CoffeeScript in here as well.
+
+    [app/js/application.js (js)]
+    $(function() {
+      $("#top").show();
+    });
+
+#### Accessing them
+These files will be accessible in `http://localhost:4567/js`. For example,
+these paths may correspond to the following files.
+
+    $ http://localhost:4567/js/prototype.js
+    # ~/myapp/app/js/prototype.js
+    
+    $ http://localhost:4567/js/main.js
+    # ~/myapp/app/js/main.coffee (Rendered by CoffeeScript)

data/manual/views.md

@@ -0,0 +1,128 @@
+title: Views
+page_type: section
+--
+Aura has a unique way of handling views, different from Sinatra's `render`.
+
+#### Creating views
+To create a view, put them in the `view/` folder of your extension.
+
+    [app/views/hello.haml (haml)]
+    %h1
+      Hello, world!
+
+#### Showing views
+Now call it in your Ruby code using `show`.
+Unlike Sinatra's `render`, using `show` will automatically try and find the file
+in the view directories of all extensions, and guess the right filetype based
+on the extension.
+
+    [app/routes/hello.rb (ruby)]
+    get '/hello' do
+      show :hello
+    end
+
+#### Showing views for models
+You can pass a model to `show`. In this example, since the record is a `Page`,
+Aura will render `:page/index` or `:base/index`, whichever it finds first.
+
+    page = Page['/about.html']
+
+    show page, :index
+
+## Partials
+
+#### Using Partials
+Aura provides a `partial` helper.
+
+    [app/views/hello.haml (haml)]
+    %hgroup
+      != partial :'hello/heading', title: 'Hello'
+
+#### Defining partials
+    [extension/myext/views/hello/heading.haml (haml)]
+    %h1= title
+
+## Layouts
+
+#### Defining layouts
+Use the `layout` helper to define which layout will be used. This example will look for
+a view called `cart.haml` (or any other layout extension).
+
+    [app/views/cart/list.haml (haml)]
+    - layout 'cart'
+
+    %h1 Your shopping cart
+
+#### Layout files
+Layouts are ordinary view files that use `yield`.
+
+    [app/views/cart.haml (haml)]
+    !!! 5
+    %html
+      %title Shopping cart
+      %body(class='cart')
+        != yield
+
+#### Nested layouts
+You may nest layouts using the `layout` helper in layouts as well. This example
+will place everything inside the `default.haml` layout.
+
+    [app/views/cart.haml (haml)]
+    - layout 'default'
+
+    %section#cart
+      != yield
+    
+## Content sections
+
+#### Content sections
+Aura uses `sinatra-content-for`. In your views, you can use the `content_for` helper.
+
+    [app/views/cart/list.haml (haml)]
+    - layout 'cart'
+
+    - content_for :sidebar do
+      %h3 Your cart
+      %a(href='/checkout') Checkout
+      %a(href='/') Continue shopping
+
+#### Defining regions
+In your layout, use `yield_content` to show the content for it.
+
+    [app/views/cart.haml (haml)]
+    %aside#sidebar
+      != yield_content :sidebar
+
+
+## View folders
+
+Using `show` will find the file in all view directories. Those are:
+
+ - Your app's view path (`app/views/`)
+ - Views in your extensions
+ - The default views in the Aura gem
+
+#### Example
+For instance, if you have this structure:
+
+    extensions/
+    '- one/
+    |  '- views/
+    |     |- home.haml
+    |     '- footer.haml
+    '- two/
+       '- views/
+          '- header.erb
+
+#### for #show
+You can then use:
+
+    show :home       # Finds one/views/home.haml
+    show :footer     # Finds one/views/footer.haml
+    show :header     # Finds two/views/header.erb
+
+#### for #partial
+This is also done for partials:
+
+    partial :header     # Finds views/header.erb
+    partial :header, :name => "Archer"

data/public/js/admin.form_builder.js

@@ -0,0 +1,15 @@
+;(function ($) {
+  $('.form-builder fieldset').livequery(function () {
+    var $this = $(this);
+    $(this).sortable({
+      axis: 'y',
+      opacity: 0.5
+    });
+
+    $('a.delete', $this).live('click', function () {
+      var $p = $(this).closest('p');
+      $p.slideUp('fast', function () { $(this).remove(); });
+      return false;
+    })
+  });
+})(jQuery);

data/public/js/admin.js

@@ -0,0 +1,62 @@
+;(function ($) {
+  // This is the glue file.
+  // Most stuff here just glues together lib.* and jquery.* stuff.
+
+  $.uiscreen.background = "";
+  $.uiscreen.opacity = 0.8;
+  $.uiscreen.fadeout_time = 0;
+
+  // Focus
+  $("textarea, input, select")
+    .live('focus', function () {
+      $('body').find('.focus').removeClass('focus');
+      $(this).closest('form p').addClass('focus');
+    })
+    .live('blur', function () {
+      $(this).closest('form p').removeClass('focus');
+    });
+
+  // Redudndant submit
+  $("a[href=#submit]").live('click', function (e) {
+    $("form").submit();
+    return false;
+  });
+
+  // Preload of sorts
+  $(function () { $("body").show().addClass("loaded"); });
+
+  // Wysiwyg
+  $("textarea.html, p.html textarea").livequery(function () {
+    var $textarea = $(this);
+    $(function(){ $textarea.auraWysiwyg(); });
+  });
+
+  // How to:
+  // - area_class 'editable-title'
+  // - in the form, set the class to 'main-title' for the main title
+  //
+  // Set your form to have a class 'main-title' to have this cool thing here
+  // 
+  $("#area.editable-title p.main-title").livequery(function () {
+    var $p     = $(this);
+    var $input = $p.find('input');
+    var $title = $("#title .title-c");
+    var $label = $p.find('label');
+    var $h1    = $title.find('h1');
+
+    var $newInput = $("<input type='text'>");
+    $newInput.attr('value', $input.val());
+    $newInput.attr('placeholder', $label.text().replace(/^\s*|:?\s*$/g,'').replace(/\s+/g,' '));
+
+    $h1.remove();
+    $p.hide();
+
+    $title.append($newInput);
+
+    function onChange() {
+      $input.val($newInput.val());
+    };
+
+    $newInput.bind('keypress blur change', onChange);
+  });
+})(jQuery);