From ad9d2cbe29f26125df4c8cef3539df13c21b8820 Mon Sep 17 00:00:00 2001 From: agelinas Date: Thu, 20 Aug 2015 23:06:28 -0400 Subject: [PATCH] Renamed Config file to Advanced Settings --- ...Configuration.rst => Advanced Settings.rst} | 18 +++++++++--------- docs/index.rst | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) rename docs/{Configuration.rst => Advanced Settings.rst} (93%) diff --git a/docs/Configuration.rst b/docs/Advanced Settings.rst similarity index 93% rename from docs/Configuration.rst rename to docs/Advanced Settings.rst index 9a77051..89bb520 100644 --- a/docs/Configuration.rst +++ b/docs/Advanced Settings.rst @@ -1,6 +1,6 @@ -********************************* -Configuration of Modeltranslation -********************************* +***************** +Advanced Settings +***************** Modeltranslation also has some advanced settings to customize its behaviour. @@ -17,7 +17,7 @@ Default: ``None`` To override the default language as described in :ref:`Configuration settings`, you can define a language in ``MODELTRANSLATION_DEFAULT_LANGUAGE``. Note that the value has to be in ``settings.LANGUAGES``, otherwise an -ImproperlyConfigured exception will be raised. +``ImproperlyConfigured`` exception will be raised. Example:: @@ -75,7 +75,7 @@ the default behaviour of unlisted languages. Example:: - MODELTRANSLATION_FALLBACK_LANGUAGES = {'default': ('pt', 'es'), 'fr': ('pt',)} + MODELTRANSLATION_FALLBACK_LANGUAGES = {'default': ('pt', 'es'), 'fr': ('es',)} .. note:: Each language has to be in the LANGUAGES setting, otherwise an ``Improperly Configured`` exception is raised. @@ -89,7 +89,7 @@ Prepopulate language ``MODELTRANSLATION_PREPOPULATE_LANGUAGE`` -Default: ``current active language`` +Default: ``the current active language`` By default modeltranslation will use the current request language for prepopulating admin fields specified in the ``prepopulated_fields`` admin property. This is often used to automatically fill slug fields. @@ -101,7 +101,7 @@ Example:: MODELTRANSLATION_PREPOPULATE_LANGUAGE = 'fr' .. note:: - The language has to be in the LANGUAGES setting, otherwise an ImproperlyConfigured exception is raised. + The language has to be in the ``LANGUAGES`` setting, otherwise an ``ImproperlyConfigured`` exception is raised. Translation files @@ -126,7 +126,7 @@ Syntax:: Example:: MODELTRANSLATION_TRANSLATION_FILES = ( - 'foo.translation', + 'news.translation', 'projects.translation', ) @@ -139,7 +139,7 @@ Custom fields Default: ``()`` (empty tuple) -Modeltranslation supports the fields listed in the `Matrix of supported_fields`. In most cases subclasses of the supported +Modeltranslation supports the fields listed in the `Matrix of supported_fields`_. In most cases subclasses of the supported fields will work fine, too. Unsupported fields will throw an ``Improperly Configured`` exception. The list of supported fields can be extended by defining a tuple of field names in your ``settings file``. diff --git a/docs/index.rst b/docs/index.rst index d4f4802..44b9591 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,7 +13,7 @@ Contents: Introduction Installation - Configuration + Advanced Settings Registering Models Usage Multilingual Manager