Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cristi committed Oct 15, 2009
1 parent ce24002 commit b58cfda
Showing 1 changed file with 65 additions and 7 deletions.
72 changes: 65 additions & 7 deletions readme.md
Expand Up @@ -55,12 +55,55 @@ When creating a new page, the locale will be changed automatically to the defaul

###Available Tags

* See the "available tags" documentation built into the Radiant page admin for more details.
* Use the <r:locale /> tag to render the current locale.
* Use the <r:locales /> tag to render the locales you use in the application.
* Use the <r:with_locale /> tag to temporarly switch the locale within the block.
* Use the <r:if_translation_title /> and <r:unless_translation_title /> tags to render the page only if/unless the title is translated.
* Use the <r:if_translation_content /> and <r:unless_translation_content /> tags to rander the page only if/unless the content is translated.
* See the "available tags" documentation built into the Radiant page admin for more details.
* Use the <r:locale /> tag to render the current locale.
* Use the <r:locales /> tag to render the locales you use in the application.
* Use the <r:with_locale /> tag to temporarly switch the locale within the block.
* Use the <r:if_translation_title /> and <r:unless_translation_title /> tags to render the page only if/unless the title is translated.
* Use the <r:if_translation_content /> and <r:unless_translation_content /> tags to render the page only if/unless the content is translated.
* If you pass to <r:link /> tag the `locale` attribute it will generate the link to the translated version of the current document
* The <r:children:each /> tag cycles through all of the **translated** children. If you need to cycle through all the children (regardless if they are translated or not) set the tag's `locale` attribute to `false`
* If you're using the Paginate Extension, the <r:paginate:each /> tag will find only **translated** children. If you need to find all the children (regardless if they are translated or not) set the tag's `locale` attribute to `false`


Compatibility
---

The following extensions were tested and work with Globalize2 Extension:

### [Copy-Move][cm]

You need to load Copy-Move before Globalize2

config.extensions = [ :copy_move, :globalize2, :all ]

### [Custom Fields][cf]

You need to load Custom Fields before Globalize2

config.extensions = [ :custom_fields, :globalize2, :all ]

### [Reoder][ro]

You need to migrate Reorder extension before Globalize2

### [Paginate][pe]

You need to load Paginate after Globalize2

config.extensions = [ :globalize2, :paginate, :all ]

### [Paperclipped][pc]

You need to install [Globalize2Paperclipped][g2p] Extension. Follow the installation notes on the extension's official page.

### [Tiny Paper][tp]

Because Tiny Paper is based on Paperclipped, you neeed to install [Globalize2Paperclipped][g2p].

### Out-of-the-box compatible

Other extensions that have been tested and don't need any special treatment: [Mailer Extension][rm], [Stereotype Extension][rs], [SNS Extension][sns], [SNS Minifier][snsm], [SNS SASS Filter Extension][snss], [Database Mailer Extension][dbm], [Super Export Extension][rse]

TODO
---
Expand All @@ -72,4 +115,19 @@ Contributors
[aissac]: http://aissac.ro
[radiant]: http://radiantcms.org/
[rse]: http://github.com/Squeegy/radiant-settings
[arg2]: http://blog.aissac.ro/radiant/globalize2-extension/
[arg2]: http://blog.aissac.ro/radiant/globalize2-extension/

[cm]:http://github.com/pilu/radiant-copy-move
[cf]:http://github.com/Aissac/radiant-custom-fields-extension/
[ro]:http://github.com/radiant/radiant-reorder-extension/
[pe]:http://github.com/Aissac/radiant-paginate-extension/
[pc]:http://github.com/kbingman/paperclipped/
[g2p]:http://github.com/Aissac/radiant-globalize2-paperclipped-extension/
[tp]:http://github.com/Aissac/radiant-tiny-paper-extension/
[rm]:http://github.com/radiant/radiant-mailer-extension/
[rs]:http://github.com/Aissac/radiant-stereotype-extension/
[sns]:http://github.com/radiant/radiant-sns-extension/
[snsm]:http://github.com/Aissac/radiant-sns-minifier-extension/
[snss]:http://github.com/SwankInnovations/radiant-sns-sass-filter-extension/
[dbm]:http://github.com/Aissac/radiant-database-mailer-extension/
[rse]:http://github.com/Aissac/radiant-super-export-extension/tree/master

0 comments on commit b58cfda

Please sign in to comment.