= Welcome to Hieraki 1.0+ (Noc)

== What is Hieraki 1.0+?

In short: wiki & hierarchy = Hieraki 1.0+.
Hieraki is an open source, wiki-like system that allows you to organize documents (such as tutorials for instance) in a highly structured fashion. Thus, Hieraki is ideal for applications where you want to impose a degree of structure that resembles most a file web browser.

Hieraki 1.0+ is based on Noc -- a multi-user learning object repository developed at Truman State University (for more information and screenshots go to: http://www2.truman.edu/~ah428/noc.html).

Features:

    * attachments for documents
    * embed ruby code with syntax highlighting: 

        {{{ ruby

            def my_method

                @foo = "foo"

            end

        }}}

    * embed images: 

        {{{ image src="1" align="right"

            here goes my caption ...

        }}}

        The src-argument specifies the id of the attachment you would like to embed.

    * version control for every document and attachment
    * the ability to work on documents as a team of different users sharing permissions across the repository
    * moving folders and documents wherever you want by using a cut and paste method
    * protecting documents from being editited by unauthorized users
    * finding dead links in the repository with one mouse click
    * caches to speed up the non-administrator view 

For more information, feel free to contact alexh [at] truman.edu.

Enjoy,
Alexander Horn

== Why Noc?

Since Noc was designed to be a learning object repository, there is a shift in philosphy: pages become documents and chapters become folders, for instance. The net effect is that documents and folders have different properties than chapters and books. A prime example is one of Noc's features that lets you bundle attachments with documents. Overall, Noc is designed to treat information in more flexible fashion that corresponds more closely with how resources are organized on the web.

== Dependencies

Mysql 4.1+
Ruby  1.8.2
Rails 0.13+
Rubygems
Gems: syntax redcloth

== Database

You will need mysql installed on your machine (or you may simply adapt the schemas). 
You can find the mysql schema in the db/ folder.

Example:

  mysqladmin -u root create hieraki
  mysql -u root hieraki < db/schema.mysql.sql


Commenting out the line

  "require active_record/vendor/mysql411" in 
   /usr/lib/ruby/gems/1.8/gems/activerecord-1.11.1/lib/active_record/connection_adapters/mysql_adapter.rb 
	(or the latest version you have) helped me with my "packet out of order" error.

After you have created the db you should import the sample_data.sql for testing purposes. Also, please verify the settings in config/database.yml.

== Configuration

cd into the config dir and rename
  config.yml.example => config.yml
  database.yml.example => database.yml 
 
and update accordingly.

== Web server

The simplest way to get Hieraki running is to use the rails shipped webrick server

  ruby scripts/server -e production
  
This will launch a web server on port 3000 (e.g simply go to http://localhost:3000 and you will see the intro page)
  
Note that you properly will need a more sophisticated installation.

Recommended and supported installation types :

 * Apache/mod_fcgi with following configurations
  - as vhost
  - using a symlink from docroot to hieraki/public
  - using an alias to noc/public

Make sure that you run Hieraki in production mode(!)


== Customization

A good way to customize your installation is to change the default permission settings for users who want share documents (see lib/permissions.rb).

If you want to skip the Hieraki intro page (index.html), check out config/routes.rb.

== Troubleshooting

For questions please contact me by email at alexh [at] truman.edu.