[UPD] README.rst

2025-02-18 09:52:42 +02:00 · 2021-09-13 13:47:31 +00:00
parent 0bca742fb0
commit e2e2100248
2 changed files with 548 additions and 24 deletions
--- a/base_default_lang_translate/README.rst
+++ b/base_default_lang_translate/README.rst
@@ -1,35 +1,110 @@
-**This file is going to be generated by oca-gen-addon-readme.**
+============================
+Default Language Translation
+============================

-*Manual changes will be overwritten.*
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

-Please provide content in the ``readme`` directory:
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-backend/tree/12.0/base_default_lang_translate
+    :alt: OCA/server-backend
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/server-backend-12-0/server-backend-12-0-base_default_lang_translate
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/253/12.0
+    :alt: Try me on Runbot

-* **DESCRIPTION.rst** (required)
-* INSTALL.rst (optional)
-* CONFIGURE.rst (optional)
-* **USAGE.rst** (optional, highly recommended)
-* DEVELOP.rst (optional)
-* ROADMAP.rst (optional)
-* HISTORY.rst (optional, recommended)
-* **CONTRIBUTORS.rst** (optional, highly recommended)
-* CREDITS.rst (optional)
+|badge1| |badge2| |badge3| |badge4| |badge5| 

-Content of this README will also be drawn from the addon manifest,
-from keys such as name, authors, maintainers, development_status,
-and license.
+This modules allows to select a default language which is used for source terms in translations.
+Any update done with this default_language will be taken as source in translations
+and written in object directly.
+Also when updating a translatable term, all existing translations (but default language) will be set to to_translate

-A good, one sentence summary in the manifest is also highly recommended.
+This module is useless in case your main language is en_US or in case you have only 1 language installed
+(in thoses cases, Odoo performs correctly).
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============


-Automatic changelog generation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+To configure this module, you need to:

-`HISTORY.rst` can be auto generated using `towncrier <https://pypi.org/project/towncrier>`_.
+#. Go to Settings > Translations > Languages
+#. Select the language you want to use as default (enter form view)
+#. Edit, tick "By default", Save

-Just put towncrier compatible changelog fragments into `readme/newsfragments`
-and the changelog file will be automatically generated and updated when a new fragment is added.
+Note: only one language can be set as default.
+Should you want to change your default language, you would have to first untick previous one.

-Please refer to `towncrier` documentation to know more.
+Usage
+=====

-NOTE: the changelog will be automatically generated when using `/ocabot merge $option`.
-If you need to run it manually, refer to `OCA/maintainer-tools README <https://github.com/OCA/maintainer-tools>`_.
+To use this module, you need to:
+
+#. Go to any model with translatable fields (e.g. product, survey, etc.)
+#. Update a translatable field and Save, source term and object field in database will be set with your new value
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_default_lang_translate%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Le Filament
+* Mariano Ruiz
+
+Contributors
+~~~~~~~~~~~~
+
+* Rémi - Le Filament (https://le-filament.com)
+* Mariano Ruiz <https://launchpad.net/~marianoruiz>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+.. |maintainer-remi-filament| image:: https://github.com/remi-filament.png?size=40px
+    :target: https://github.com/remi-filament
+    :alt: remi-filament
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-remi-filament| 
+
+This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/12.0/base_default_lang_translate>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.