README.md in caramelize-0.3.0 vs README.md in caramelize-0.4.0

- old
+ new

@@ -1,10 +1,10 @@ # caramelize -Caramelize is a compact and flexible wiki content migration tool. It is intended for easily transfering content from otherwise rare supported legacy wikis. With caramelize you can create your own export configurations and migrate your data into a git-based [gollum](gollum)-wiki retaining all your history and gaining the most flexible access to your wiki content. +Caramelize is a compact and flexible wiki content migration tool. It is intended for easily transfering content from otherwise rare supported legacy wikis. With caramelize you can create your own export configurations and migrate your data into a git-based [gollum](https://github.com/github/gollum)-wiki retaining all your history and gaining the most flexible access to your wiki content. -In the future more target wikis may be added. For the moment migration is supported for [WikkaWiki](wikka) and [Redmine](redmine)-Wiki. +In the future more target wikis may be added. For the moment migration is supported for [WikkaWiki](http://wikkawiki.org/) and [Redmine](http://www.redmine.org/)-Wiki. ## Usage ### Installation @@ -39,22 +39,21 @@ $ caramelize run --config my_caramel_configuration.rb Executes the given configuration. $ caramelize --verbose [command] - $ caramelize -v [command] Displays more verbose output to the command line. ## Content migration ### Wiki support -Caramelize comes with direct support for [WikkaWiki](wikka) and [Redmine](redmine)-Wiki. +Caramelize comes with direct support for [WikkaWiki](http://wikkawiki.org/) and [Redmine](http://www.redmine.org/)-Wiki. More custom wikis can be supported by creating a suitable configuration file. -Any imported wiki exports into a [gollum](gollum) git-repository. This is a wiki based around a git-repository. This gives you the flexibility of having all wiki pages exported as physical files, while keeping the history and having an easy and wide-supported way of access by using the wiki server gollum features. +Any imported wiki exports into a [gollum](https://github.com/github/gollum) git-repository. This is a wiki based around a git-repository. This gives you the flexibility of having all wiki pages exported as physical files, while keeping the history and having an easy and wide-supported way of access by using the wiki server gollum features. Since wiki software may have special features, that are not common among other wikis, content migration may always have a loss of style or information. Caramelize tries to support the most common features. * Page meta data * title @@ -74,15 +73,15 @@ Custom import allows you to import data from wikis that are not natively supported by caramelize. Defining your own wiki import requires a bit of knowledge on Ruby and MySQL as you setup the access to your wiki database and need to define how the data is to be transformed. Depending on the database model of the wiki this can be one simple call for all revisions in the database, or it can get more complicated with multiple mysql-calls as the database becomes more complex. For a custom wiki you need to create a `wiki` instance object, that receives the necessary database creditials. - wiki = Caramelize::Wiki.new({:host => "localhost", - :username => "user", - :database => "database_name", - :password => 'monkey', - :markup => :wikka}) + wiki = Caramelize::InputWiki::Wiki.new(host: "localhost", + username: "user", + database: "database_name", + password: 'monkey', + markup: :wikka}) This example ignores custom markup conversion and assumes WikkaWiki-markup. Once the object is established we need to hook in a method that defines how revisions are read from the database and how they are processed. @@ -92,19 +91,19 @@ revisions, titles = [], [] results = database.query(sql) results.each do |row| titles << row["tag"] author = authors[row["user"]] - page = Page.new({:id => row["id"], - :title => row["tag"], - :body => row["body"], - :markup => 'wikka', - :latest => row["latest"] == "Y", - :time => row["time"], - :message => row["note"], - :author => author, - :author_name => row["user"]}) + page = Page.new({id: row["id"], + title: row["tag"], + body: row["body"], + markup: 'wikka', + latest: row["latest"] == "Y", + time: row["time"], + message: row["note"], + author: author, + author_name: row["user"]}) revisions << page end # titles is the list of all unique page titles contained in the wiki titles.uniq! # revisions is the list of all revisions ordered by date @@ -148,10 +147,6 @@ * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it. ## Copyright -Copyright (c) 2011-2013 Daniel Senff. See LICENSE.md for further details. - -[wikka]: http://wikkawiki.org/ -[gollum]: https://github.com/github/gollum -[redmine]: http://www.redmine.org/ +Copyright (c) 2011-2015 Daniel Senff. See LICENSE.md for further details.