Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A Knowlege Management Framework for Rails 3.
Ruby JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
autotest
bin
config
lib
public
spec
testapp
.gitingore
Gemfile
Gemfile.lock
README.txt
Rakefile
inkling.gemspec
issues.txt
new_readme.txt
scratchpad.txt

README.txt

Inkling has been moved to http://github.com/tfw/inkling. 

----

Inkling is a DSL and framework for Rails 3 providing for defining your own knowledge management system. 

It isn't ready for general use yet, and will be refactored heavily in December; to reflect an emerging DSL for defining knowledge management systems.


Feature Overview
----------------

Types:

ActiveRecord objects can be adopted by the framework. Define your ActiveRecord with 'act_as_inkling' and it will be included in the system with menuing, security, routing, workflows.

Namespacing:

All tables are namespaced - e.g. inkling_users - to avoid collision with other tables - e.g. the user table of an ecommerce app..

Dashboard:

Create a partial (_.+*_dashboard.+*) in your app and it will be automatically included in the dashboard. So you can extend the interface for your own users and integrate whatever you like.

Tree:

A tree UI presents the arrangement of all types in the system, letting users drag and drop inklings, create news ones, edit them, etc..

Permissioning:

There's one default role, the administrator, that can do everything. But you can create others, and give them permissions (to, say, create but not delete images). You can also create new permissions and new roles for your own extensions. (Inkling uses CanCan)

Devise Authentication:

The authentication system can be turned on or off (you would turn it off to integrate it within your own app's authentication). It uses Devise (see http://github.com/plataformatec/devise)

Workflow API: (coming)

A simple default Workflow - draft -> publish - is included for most objects, but you can define your own and attach them to any inkling type.




For more see the Development Guide (http://wiki.github.com/biv/inkling/developers-guide) and the Roadmap (http://wiki.github.com/biv/inkling/roadmap).


The documentation below is a work in progress and will be revised at some point. The Installing advice is current.

Installing
----------

Some quick instructions for setting up Inkling and Inkling-CMS to get an idea of what's being built.

Clone inkling.

Go into inkling, run 'bundle install' (you'll need Ruby 1.9.x).

cd testapp

Configure your config/database.yml with a database for the test app. 

rake install

rake inkling:bootstrap


Implementing your own System
----------------------------

1) Define themes.

The administrator account will always be able to see the Inkling administrator layout, which contains configuration information. To implement a system, you must define two themes:

The management theme - this is the layout backend users will see when they use your system.
The content theme - this is the theme public visitors will see when they look at content.



Running The Tests
-----------------
Inkling is an engine and needs a Rails application to execute its tests against. Tests (rspec examples and cucumber features) are kept in the top level engine directory, and symlinked into the testapp/spec and testapp/featured directories.

To run the tests:

cd testapp

rake inkling:megatest #(a custom task which runs the environment, rspec, then features)


EXTENDING INKLING
-----------------


Content Type
------------
ŒFor an example of a content type, see inkling-cms or Inkling::Foo (in this project).

A generator for content types will be built at some stage, in the meantime, CTs follow some norms in Rails.

To create a Content Type:

* the model should act_as_content

class Acme::Mp3 < ActiveRecord::Base
  acts_as_content 'mp3'
end

The string arg. is optional, but provides a friendly name to use in the admin UI - a content creator will have the option to create an
'mp3'and not an 'Acme::Mp3'.

* the model should have a name field, preferably a String. This is used to make it addressable in a URL by site categorization.

Two controllers are presumed to exist, one to let permitted users manage the object (CRUD):

class Inkling::ContentTypes::Mp3sController < Inkling::BaseController
end

And another with a show method capable of rendering it:

class Inkling::Mp3sController < Inkling::BaseController; end

These namespaces are presumed to exist, although options may appear later for other namespaces.

The admin controller presumes CRUD methods (and routes) available for the model. The other controller is simply in charge
of rendering, and relies upon the 'show' method being implemented. When Inkling receives a request for an mp3 which is situated
in a folder somewhere in its site, it will call to the show method with an id.

Your content type is automatically included in the Content Tree. If you wish to restrict what types of content can be placed directly beneath it,
implement the restricts method on your content object.

For example,

class Acme::Mp3 < ActiveRecord::Base
  acts_as_inkling 'mp3'
  
  def restricts(content)
    unless content.is_a? Acme::MusicVideo
      [true, "MP3s can only include Music Videos."]
    end
  end
end


Roles
-----

Inkling only specifies one role - administrator. The hosting app. is able to create more.

Roles & Authentication & Landing Page
-------------------------------------

Inkling uses Devise, which searches for a user_root_path and then defaults a root_path, in that order. Inkling defines a inkling_user_root route (run 'rake routes') to reach the Inkling dashboard. If you want authenticating users to land here, map user_root or root to this:

match 'home', :to => 'admin/inkling/home#dashboard', :as => "user_root"



Integrated Dashboard
--------------------

Each user lands on the dashboard - app/views/inkling/users/home#dashboard. Inkling scans all engines for this directory, looking for files with _dashboard. and rendering them as partials. Thus, if you want your engine to add its own section to the dashboard, create a partial.

For example, if you have written a blog content type, and want to offer blog links create app/views/inkling/users/home/_blog_dashboard.html.erb (or haml, etc.). This will be rendered within the dashboard.

Contributors
------------

Thanks to
* Clifford Heath (contributing installation docs + the command line binary that will be used to generate Content Type engines). May, 2010.

Copyright Notice
----------------
COPYRIGHT (c) 2010 Nicholas Faiz, Tree Falling In The Woods Pty Ltd.


Inkling code is copyrighted to Tree Falling In The Woods, Pty Ltd. and available under the MIT License.
It includes software from other projects, other people, listed below, all available through the MIT license.

* Ruby on Rails - http://rubyonrails.org - David Heinemeier Hansson, etc..
* Enki - http://www.enkiblog.com/ - Xavier Shay. 

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE

Something went wrong with that request. Please try again.