Skip to content
This repository has been archived by the owner on Sep 20, 2020. It is now read-only.

Commit

Permalink
Moved README to README.markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
myabc committed Apr 4, 2008
1 parent 099c571 commit c3546c1
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 78 deletions.
80 changes: 2 additions & 78 deletions README
@@ -1,80 +1,4 @@
= merb_global
== Localization (L10n) and Internationalization (i18n) support for the Merb MVC Framework

A plugin for the Merb framework providing Localization (L10n) and
Internationalization (i18n) support.

merb_global will have the following feature set:
* support for model (content) localization
- by default, localization stored in the database
- with DataMapper (targeted 0.1)
- with ActiveRecord (targeted 0.2)
- with Sequel ORM
and, with a choice of strategies in each case:
- single-table (c.f. globalize RoR plugin)
|title |varchar(100)|
|title_de|varchar(100)|
|title_fr|varchar(100)|
- joined-table for unlimited localizations (c.f. Symfony PHP)
- or, alternatively localizations can be stored outside of the domain
model, UI Strings.

* support for view (UI String) localization
- choice of providers (po, yaml, database)
Merb::Plugins.config[:merb_global] = {
#:provider => "po", # default
:provider => 'yaml'
#:provider => activerecord
#:provider => datamapper
#:provider => sequel
}
- for JRuby, wrapper allowing use of .properties files.

* Extract, update for PO/ POT files
* Currency, Date and Language Helpers
- stored either in the database, or for JRuby, wrappers around
built-in functionality provided by java.util.Currency, java.util.Locale

* support for localization of Merb generated code
* support for non-English Inflectors.

** WARNING ** : merb_global is in a very early planning/development stages.
At this point of time, this code should only be considered for consumption
by advanced Ruby and Merb developers. If you're looking for something for
production use, and still in the world of Rails, then you should examine their
page dedicated to localization techniques here:
http://wiki.rubyonrails.org/rails/pages/Internationalization

** REQUEST ** : Your development support is very much appreciated. Please
contact us below if you're interested in lending a hand with the development
of this project.

== License

merb_global is released under the MIT License. Copyright information, as well
as a copy of the License may be found in the LICENSE file.

== Installation and Setup

rake gem
sudo gem install pkg/merb_global-0.0.1.gem

== Support

** WARNING REPEATED ** : merb_global at a very early stage of development. You
should not use this code unless you're reasonably secure with both Ruby and
Merb. That said, please do get involved.

Your best source for support currently is either the wiki, IRC or the mailing
list:

merb_global Wiki (this is its temporary residence):
http://github.com/myabc/merb_global/wikis

merb_global mailing list:
http:// -- coming soon -- /

merb_global homepage:
http:// -- coming soon -- /

Contact the developers directly:
- alex@alexcolesportfolio.com | myabc on #datamapper, #merb IRC
Please see README.markdown.
80 changes: 80 additions & 0 deletions README.markdown
@@ -0,0 +1,80 @@
= merb_global

A plugin for the Merb framework providing Localization (L10n) and
Internationalization (i18n) support.

merb_global will have the following feature set:
* support for model (content) localization
- by default, localization stored in the database
- with DataMapper (targeted 0.1)
- with ActiveRecord (targeted 0.2)
- with Sequel ORM
and, with a choice of strategies in each case:
- single-table (c.f. globalize RoR plugin)
|title |varchar(100)|
|title_de|varchar(100)|
|title_fr|varchar(100)|
- joined-table for unlimited localizations (c.f. Symfony PHP)
- or, alternatively localizations can be stored outside of the domain
model, UI Strings.

* support for view (UI String) localization
- choice of providers (po, yaml, database)
Merb::Plugins.config[:merb_global] = {
#:provider => "po", # default
:provider => 'yaml'
#:provider => activerecord
#:provider => datamapper
#:provider => sequel
}
- for JRuby, wrapper allowing use of .properties files.

* Extract, update for PO/ POT files
* Currency, Date and Language Helpers
- stored either in the database, or for JRuby, wrappers around
built-in functionality provided by java.util.Currency, java.util.Locale

* support for localization of Merb generated code
* support for non-English Inflectors.

** WARNING ** : merb_global is in a very early planning/development stages.
At this point of time, this code should only be considered for consumption
by advanced Ruby and Merb developers. If you're looking for something for
production use, and still in the world of Rails, then you should examine their
page dedicated to localization techniques here:
http://wiki.rubyonrails.org/rails/pages/Internationalization

** REQUEST ** : Your development support is very much appreciated. Please
contact us below if you're interested in lending a hand with the development
of this project.

== License

merb_global is released under the MIT License. Copyright information, as well
as a copy of the License may be found in the LICENSE file.

== Installation and Setup

rake gem
sudo gem install pkg/merb_global-0.0.1.gem

== Support

** WARNING REPEATED ** : merb_global at a very early stage of development. You
should not use this code unless you're reasonably secure with both Ruby and
Merb. That said, please do get involved.

Your best source for support currently is either the wiki, IRC or the mailing
list:

merb_global Wiki (this is its temporary residence):
http://github.com/myabc/merb_global/wikis

merb_global mailing list:
http:// -- coming soon -- /

merb_global homepage:
http:// -- coming soon -- /

Contact the developers directly:
- alex@alexcolesportfolio.com | myabc on #datamapper, #merb IRC

0 comments on commit c3546c1

Please sign in to comment.