README

= jekyll-localization - Jekyll plugin that adds localization features to the rendering engine.

== VERSION

This documentation refers to jekyll-localization version 0.1.7


== DESCRIPTION

Jekyll plugin that adds localization features to the rendering engine.

Add the following to your <tt>_plugins/ext.rb</tt> file:

  require 'jekyll/localization'

Then start using Jekyll::Filters#t in your templates, which will extract
the target language from the file name (<tt><NAME>.<LANG>.<EXT></tt>,
where +LANG+ is supposed to be a two-letter language code). The order
of the arguments corresponds to the order of the languages defined in
Jekyll::Localization::LANGUAGES (e.g., +en+, +de+, +fr+):

  Some <%= t 'translated', 'übersetzter' %> text. (ERb-style)
  Some {{ 'translated' | t: 'übersetzter' }} text. (Liquid-style)

You can modify Jekyll::Localization::LANGUAGES to add languages or change
their order. The first one is the default language and will be used when a
translation is missing (+fr+ in this example). Note that, when you do add
languages and in particular when you change their order, you should adjust
Jekyll::Localization::HUMAN_LANGUAGES accordingly!


== LINKS

<b></b>
Documentation:: http://rdoc.info/gems/jekyll-localization
Source code::   http://github.com/prometheus-ev/jekyll-localization
RubyGem::       http://rubygems.org/gems/jekyll-localization


== AUTHORS

* Jens Wille <mailto:jens.wille@gmail.com>
* Arne Eilermann <mailto:eilermann@lavabit.com>


== LICENSE AND COPYRIGHT

Copyright (C) 2010-2012 University of Cologne,
Albertus-Magnus-Platz, 50923 Cologne, Germany

Copyright (C) 2013 Jens Wille

jekyll-localization is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your option)
any later version.

jekyll-localization is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
for more details.

You should have received a copy of the GNU Affero General Public License along
with jekyll-localization. If not, see <http://www.gnu.org/licenses/>.