{ "info": { "author": "Santiago Gabriel Romero", "author_email": "sromero@machinalis.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "Django i18n helper\n==================\n\nProvides a simple way to visualize translated strings in Django templates \nby wrapping translated content with custom HTML and CSS. Therefore and\nmost important, helps you to visualize untraslated strings too.\n\n\nHow does it work\n----------------\n\nDjango i18n helper is a common Django app that overriddes Django core functions\non load to provide the desired behavior.\n\nThe application will automatically detect when tests are being run and won't\noverride any methods in such a case to preserve tests integrity.\n\n\nInstallation\n------------\n\nGet it\n\n pip install django-i18n-helper\n\nAfter, all you need to do is add \"i18n_helper\" to your installed apps and\nactivate the internationalization debug. In your settings.py, make sure to have:\n\n INSTALLED_APPS = (\n ...,\n 'i18n_helper'\n )\n\nand\n\n I18N_HELPER_DEBUG = True\n\ndjango-i18n-helper provides a default behavior that consists in wrapping the\ntranslated content with an HTML div with the following properties:\n\n
Translated text
\n\nThis provides a soft highlight for translated strings, but this behavior can be\nmodified within settings.py.\n\n\nCustomization\n-------------\n\nSome configuration variables are provided in order to customize how you want the translated strings to be wrapped.\n\n#### I18N_HELPER_HTML\n\nDefines a whole HTML block for wrapping the translations. This string will be\nformatted (http://docs.python.org/library/stdtypes.html#str.format) with the\ntranslated text. Thus every occurrence of \"{0}\" will be replaced with the\ntranslation.\n\n I18N_HELPER_HTML = \"{0}\"\n\nIf **I18N_HELPER_HTML** is not set, the code used will be\n\n
{0}
\n\n\n#### I18N_HELPER_CLASS\n\nDefines the class to use for the HTML div if **I18N_HELPER_HTML** is not used. Defaults to \"i18n-helper\".\n\n I18N_HELPER_CLASS = \"my-custom-class\"\n\n\n#### I18N_HELPER_STYLE\n\nDefines the inline CSS for the HTML div if no **I18N_HELPER_HTML** or\n**I18N_HELPER_CLASS** have been set (case in which it's assumed that the css \nfor the class provides the desired style). Defaults to \"display: inline; background-color: #FAF9A7;\".\n\n I18N_HELPER_CLASS = \"font-weight: bold; background-color: yellow;\"\n\n\nScreenshots\n-----------\n\nGraphical examples are sometimes the better way to understand how does something works or looks like. So here go two examples of how completely translated templates would look like, and two of how partially translated templates would.\n\nFully translated templates\n\n\n\n\n\n\nPartially translated templates. Note that it's also possible to see from the admin site which model fields haven't set the _verbose_name_ attribute to translate the field name.\n\n\n\n\n\n\nDisclaimer notes\n----------------\n\nThe application should **only** be used when \"debugging\" code translations, since it overrides the default Django HTML scaping mechanism and thus outputs unescaped (possibly undesired) code.\nBesides, there are some warnings you should be aware of:\n\n* You will see weird HTML within you buttons or inputs if you have things like <input type=\"text\" value=\"{% trans \"Search\" %}\" ...> Then the wrapping HTML of your translations will be shown _within_ the inputs or buttons. This will happen for sure in the admin site.\n\n* Set **I18N_HELPER_DEBUG** to False before syncing your database, otherwise you might see errors like \"value too long for type character varying(50)\".\n\n* Set **I18N_HELPER_DEBUG** to False before running your migrations, otherwise you might see errors like \"value too long for type character varying(50)\".\n\n* From version **0.1.1** this helper will only be enabled when running the **runserver** command, so you shouldn't need to worry about turning it off for doing syncdb, migrations, or anything.\n\n* Some capitalization might be lost\n\n\nTested with\n-----------\n\n* Django 1.3 / 1.4\n* Python 2.6.1 / 2.7.2\n\n\nContact\n-------\n\nAuthor: Santiago Gabriel Romero\n\nContact: sromero@machinalis.com", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/machinalis/django-i18n-helper", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "django-i18n-helper", "package_url": "https://pypi.org/project/django-i18n-helper/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-i18n-helper/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/machinalis/django-i18n-helper" }, "release_url": "https://pypi.org/project/django-i18n-helper/0.1.1/", "requires_dist": null, "requires_python": null, "summary": "A internationalization helper that highlights translated strings", "version": "0.1.1" }, "last_serial": 789830, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "d6cede33d29ae7af3cf9f01ccaf00f19", "sha256": "c3780c843633561bc947edaa1f77b57fa44166185595ff2428c5a74b4404fd81" }, "downloads": -1, "filename": "django-i18n-helper-0.1.tar.gz", "has_sig": false, "md5_digest": "d6cede33d29ae7af3cf9f01ccaf00f19", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6760, "upload_time": "2012-08-23T20:57:12", "url": "https://files.pythonhosted.org/packages/f8/60/c608b8e57ce2c065d5ab8b2f69acd42357a2164bf0a52af1697268ea9263/django-i18n-helper-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "6b5eab76264240b420baa86e8e68298e", "sha256": "a2c41e31e26120d49d5241789eb1b2fde0e8f528488fccea370893852c99f4fa" }, "downloads": -1, "filename": "django-i18n-helper-0.1.1.tar.gz", "has_sig": false, "md5_digest": "6b5eab76264240b420baa86e8e68298e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6879, "upload_time": "2012-09-20T03:09:47", "url": "https://files.pythonhosted.org/packages/11/fb/3820f573fa98670747ac80e2380d33c31a0dfbd8171d49f43f3e980fd8e9/django-i18n-helper-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6b5eab76264240b420baa86e8e68298e", "sha256": "a2c41e31e26120d49d5241789eb1b2fde0e8f528488fccea370893852c99f4fa" }, "downloads": -1, "filename": "django-i18n-helper-0.1.1.tar.gz", "has_sig": false, "md5_digest": "6b5eab76264240b420baa86e8e68298e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6879, "upload_time": "2012-09-20T03:09:47", "url": "https://files.pythonhosted.org/packages/11/fb/3820f573fa98670747ac80e2380d33c31a0dfbd8171d49f43f3e980fd8e9/django-i18n-helper-0.1.1.tar.gz" } ] }