Improve documentation

If some issue needs documentation in the readme, please tag it with "needs documentation".
http://drupal.org/project/issues/search/i18nviews?issue_tags=Needs+Docum...

Someone please provide an initial README/INSTALL file to start documentation. I won't find time enough to initiate this.

Adding tags

I'm new to this too and still not entirely sure how this module works, or what it can do. Only related article I remember seeing was by ComputerMinds http://www.computerminds.co.uk/multilingual-views-drupal-when-using-i18n...

The best description I've found is in i18nviews_help(), which says "Supports translation for views strings: title, header, footer..." That's much clearer than what's on the project description, "Translate views using Internationalization," which suggests a larger scope of functionality than the module actually provides.

Module documentation guidelines: http://drupal.org/node/161085

How to write readme files: http://drupal.org/node/447604

Example README file: http://drupalcode.org/project/bot.git/blob/HEAD:/README.txt

My own try at creating a readme file for this module is attached. I followed the style of the example linked above, except that I also included the name of the module.

Since I still don't entirely understand what this module is supposed to do (does it really only translate a couple of strings that you might as well create a separate display for?), the module owner may wish to review my attachment first.

Thank you for your first step.

The module supports much more translatable elements than four elements.
It implements the views localization layer with the i18nstrings backend. The drupal core t() translation layer (views default) is against the core concept: t() should NOT translate user entered text and using this method leads to cluttered locale tables.

The module adds a "Translate" tab in Views (check the submenu, where you can export, clone a view also)

Displays are not intended to be created per language. If you once try to have 10 languages on a site, the amount of defined views displays start to explode. Also, using the translation layer, automatically switches to the right language wherever you integrate one display.

Can you update the README somehow with those additions? (Possibly with better wording. ;-) )

Hello Miro,

Thanks for your quick response.

I would have to try out Internationalization Views in order to write better documentation for it. Unfortunately I will not have time for that in the near future. (There was a project that would have been an ideal candidate, but due to a tight deadline we had already decided to go with the 'multiple displays' approach - only two languages, so not too bad).

If anybody else wants to take over, please be my guest.

Miro, if you feel more comfortable writing in German, perhaps you can write the documentation in German and I can translate to English if you like.

I can help out with this. I have written an internal document for myself (with screen shots even) and can re-purpose this with some more generic wording and general screens (using Garland or something).

Are people still needing this?

I have been playing with this module for a few months (lightly) and have reported a couple of string bugs where fields don't appear to work or translate properly and consistently.

Shane, as you can see from my comments I even completely misunderstood what the module is for, so it may be that people do not even know that they need better documentation. :-)

BTW, although it is nice that drupal.org provides guidelines for documentation writers, I feel for this module any documentation would be better than what little we have now. Maybe you could put up somewhere what you have now, and then we could all take a peek?