NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[MERGE] Forward-port of branch 14.0 to master

Browse Source
This commit is contained in:
Antoine Vandevenne (anv) 2021-06-11 17:06:51 +02:00
commit c3eb3f015e
5 changed files with 149 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
content/applications/finance/accounting/fiscal_localizations/localizations/italy_IT.rst
View File

@ -25,9 +25,10 @@ elettronica sono i seguenti:
di posta elettronica certificata sono fornite dal tuo fornitore o dal
Ministero. Lo stesso server deve essere configurato come server che
gestisce tutta la corrispondenza mail in Odoo, per saperne di più si
puo’ consultare la relativa :doc:`guida </applications/productivity/discuss/advanced/email_servers>`.
può consultare la relativa :doc:`guida
</applications/productivity/discuss/advanced/email_servers>`.
- Indirizzo PEC dell’ Azienda, tale indirizzo deve essere lo stesso
- Indirizzo PEC dell’Azienda, tale indirizzo deve essere lo stesso
registrato presso l’Agenzia delle Entrate per l’utilizzo dei servizi
di fatturazione elettronica.
@ -36,13 +37,13 @@ elettronica sono i seguenti:
Entrate, ricorda che l’Agenzia delle Entrate potrebbe cambiare questo
indirizzo in seguito, previa comunicazione.
- Partita IVA e Codice Fiscale. Per far si che la Fatturazione
Elettronica funzioni correttamente, questi cambi devono essere
- Partita IVA e Codice Fiscale. Per far sì che la Fatturazione
Elettronica funzioni correttamente, questi campi devono essere
compilati correttamente.
- Regime Fiscale. Il regime fiscale a cui è sottoposta l’Azienda deve
essere selezionato scegliendo dalla lista precompilata fornita da
Odoo. Chiedi al commercialista qual’è il corretto regime fiscale!
Odoo. Chiedi al commercialista qual è il corretto regime fiscale!
- Numero di Iscrizione nel registro delle Imprese.

4
content/applications/sales/sales/invoicing/expense.rst
View File

@ -3,8 +3,8 @@ Re-invoice expenses to customers
================================
It often happens that your employees have to spend their personal money
while working on a project for your client. Let's take the example of an
consultant paying an hotel to work on the site of your client. As a
while working on a project for your client. Let's take the example of a
consultant paying for a hotel to work on the site of your client. As a
company, you would like to be able to invoice that expense to your
client.

2
content/applications/websites/website/publish/domain_name.rst
View File

@ -100,7 +100,7 @@ How to make sure that all my URLs use my custom domain?
To set up the root URL of your website and of all the links sent in emails, you can ask an administrator of your database (any user in the *Settings* group) to perform a login from the login screen. It's as simple as that!
If you want to do it manually, you can go to :menuselection:`Settings --> Technical --> System Parameters` .
If you want to do it manually, go to :menuselection:`Settings --> Technical --> System Parameters`.
Find the entry called ``web.base.url`` (you can create it if it does not exist) and enter the full URL of your website, like ``https://www.myodoowebsite.com``.
.. warning::

42
content/contributing/documentation/content_guidelines.rst
View File

@ -7,9 +7,9 @@ tricks that will make your content shine at its brightest! While we encourage yo
writing style, some rules still apply to give the reader more clarity and comprehension.
.. note::
We strongly recommend contributors to carefully read the other documents in this *Contribution*
section of the documentation. Good knowledge of the ins and outs of **RST writing** is required
to write and submit your contribution. Note that it also affects your writing style itself.
We strongly recommend contributors to carefully read the other documents related to this section
of the documentation. Good knowledge of the ins and outs of **RST writing** is required to write
and submit your contribution. Note that it also affects your writing style itself.
- :doc:`../documentation`
- :doc:`rst_cheat_sheet`
@ -89,7 +89,7 @@ To write good titles and headings:
| | Examples | Explanations |
+==================+===================================+========================================================+
| | **Titles** | *Quotation Templates* | "Quotation Templates" is a feature in Odoo. |
| | (h1) +-----------------------------------+--------------------------------------------------------+
| | (H1) +-----------------------------------+--------------------------------------------------------+
| | *Lead Mining* | "Lead Mining" is a feature in Odoo. |
| +-----------------------------------+--------------------------------------------------------+
| | *Resupply from another Warehouse* | "Warehouse" is capitalized as we refer to the feature |
@ -99,7 +99,7 @@ To write good titles and headings:
| | with Odoo* | |
+------------------+-----------------------------------+--------------------------------------------------------+
| | **Headings** | *Confirm the quotation* | "The quotation" is a common noun not referring to a |
| | (h2, h3, etc.) | | feature in Odoo. |
| | (H2, H3, etc.) | | feature in Odoo. |
| +-----------------------------------+--------------------------------------------------------+
| | *Test environment* | "Environment" is a common noun. |
| +-----------------------------------+--------------------------------------------------------+
@ -111,16 +111,17 @@ To write good titles and headings:
.. _contributing/document-structure:
Document's structure
====================
Document structure
==================
Use different **headings levels** to organize your text by sections and sub-sections. Your headings
are also displayed in a dynamic *navigation bar* on the side.
Use different **heading levels** to organize your text by sections and sub-sections. Your headings
are not only displayed in the document but also on the navigation menu (only the H1) and on the
"On this page" sidebar (all H2 to H6).
+---------------------------------------------------------------------------------------+
| | **H1: Page title** |
| | Your *page title* gives your reader a quick and clear understanding of what your |
| content is about. It is also referenced in the section's *table of contents*. |
| content is about. |
| |
| The *content* in this section describes the upcoming content from a **business point |
| of view**, and shouldn't put the emphasis on Odoo, as this is documentation and not |
@ -154,6 +155,27 @@ are also displayed in a dynamic *navigation bar* on the side.
- :ref:`RST cheat sheet: headings <contributing/headings>`
- :ref:`RST cheat sheet: specialized directives <contributing/specialized-directives>`
.. _contributing/organizing-documentation:
Organizing the documentation
============================
When writing documentation about a given topic, try to keep pages within the same folder organized.
For most topics, a single page should do the job. Place it in the appropriate section of the
documentation (e.g., content related to the CRM app go under :menuselection:`Applications
-> Sales -> CRM`) and follow the :ref:`document structure <contributing/document-structure>`
guidelines.
For more complex topics, you may need several pages to cover all their aspects. Usually, you will
find yourself adding documentation to a topic that is already partially covered. In that case,
either create a new page and place it at the same level as other related pages or add new sections
to an existing page. If you are documenting a complex topic from scratch, organize your content
between one parent page (the :abbr:`TOC (Tree Of Contents)` page) and several child pages. Whenever
possible, write content on the parent page and not only on the child pages. Make the parent page
accessible from the navigation menu by using the :ref:`show-content
<contributing/document-metadata>` metadata directive.
.. _contributing/content-images:
Images

144
content/contributing/documentation/rst_cheat_sheet.rst
View File

@ -14,28 +14,31 @@ Headings
encounter different heading formatting and in a different order, in which case you should follow
the formatting in place in the document. In any other case, use the formatting shown below.
+--------------+---------------+-------------------------------+
| Heading size | Formatting | Min/Max number of occurrences |
+==============+===============+===============================+
| H1 | | ``=======`` | 1/1 |
| | | ``Heading`` | |
| | | ``=======`` | |
+--------------+---------------+-------------------------------+
| H2 | | ``Heading`` | 0/∞ |
| | | ``=======`` | |
+--------------+---------------+-------------------------------+
| H3 | | ``Heading`` | 0/∞ |
| | | ``-------`` | |
+--------------+---------------+-------------------------------+
| H4 | | ``Heading`` | 0/∞ |
| | | ``~~~~~~~`` | |
+--------------+---------------+-------------------------------+
| H5 | | ``Heading`` | 0/∞ |
| | | ``*******`` | |
+--------------+---------------+-------------------------------+
| H6 | | ``Heading`` | 0/∞ |
| | | ``^^^^^^^`` | |
+--------------+---------------+-------------------------------+
+--------------+---------------+
| Heading size | Formatting |
+==============+===============+
| H1 | | ``=======`` |
| | | ``Heading`` |
| | | ``=======`` |
+--------------+---------------+
| H2 | | ``Heading`` |
| | | ``=======`` |
+--------------+---------------+
| H3 | | ``Heading`` |
| | | ``-------`` |
+--------------+---------------+
| H4 | | ``Heading`` |
| | | ``~~~~~~~`` |
+--------------+---------------+
| H5 | | ``Heading`` |
| | | ``*******`` |
+--------------+---------------+
| H6 | | ``Heading`` |
| | | ``^^^^^^^`` |
+--------------+---------------+
.. important::
Each document must have **exactly one H1 heading**. No less, no more.
.. _contributing/markup:
@ -373,13 +376,13 @@ RST
.. code-block:: rst
.. note::
Use this to get the attention of the reader about additional information.
Use this admonition to grab the reader's attention about additional information.
Render
~~~~~~
.. note::
Use this to get the attention of the reader about additional information.
Use this admonition to grab the reader's attention about additional information.
.. _contributing/tip:
@ -392,15 +395,32 @@ RST
.. code-block:: rst
.. tip::
Use this to inform the reader about a useful trick that requires an
action.
Use this admonition to inform the reader about a useful trick that requires an action.
Render
~~~~~~
.. tip::
Use this to inform the reader about a useful trick that requires an
action.
Use this admonition to inform the reader about a useful trick that requires an action.
.. _contributing/exercise:
Exercise
--------
RST
~~~
.. code-block:: rst
.. exercise::
Use this admonition to suggest an exercise to the reader.
Render
~~~~~~
.. exercise::
Use this admonition to suggest an exercise to the reader.
.. _contributing/important:
@ -413,13 +433,13 @@ RST
.. code-block:: rst
.. important::
Use this to notify the reader about an important information.
Use this admonition to notify the reader about an important information.
Render
~~~~~~
.. important::
Use this to notify the reader about an important information.
Use this admonition to notify the reader about an important information.
.. _contributing/warning:
@ -432,15 +452,15 @@ RST
.. code-block:: rst
.. warning::
Use this to require the reader to proceed with caution with what is
described in the warning.
Use this admonition to require the reader to proceed with caution with what is described in
the warning.
Render
~~~~~~
.. warning::
Use this to require the reader to proceed with caution with what is
described in the warning.
Use this admonition to require the reader to proceed with caution with what is described in the
warning.
.. _contributing/danger:
@ -453,13 +473,65 @@ RST
.. code-block:: rst
.. danger::
Use this to alarm the reader about a serious threat.
Use this admonition to bring the reader's attention to a serious threat.
Render
~~~~~~
.. danger::
Use this to alarm the reader about a serious threat.
Use this admonition to bring the reader's attention to a serious threat.
.. _contributing/custom-admonition:
Custom
------
RST
~~~
.. code-block:: rst
.. admonition:: Title
Customize this admonition with a **Title** of your choice.
Render
~~~~~~
.. admonition:: Title
Customize this admonition with a **Title** of your choice.
.. _contributing/document-metadata:
Document metadata
=================
| Sphinx supports document-wide metadata directives that specify a behavior for the entire page.
| They must be placed between colons (`:`) at the top of the source file.
+-----------------+--------------------------------------------------------------------------------+
| **Metadata** | **Purpose** |
+-----------------+--------------------------------------------------------------------------------+
| `show-content` | Make a toctree page accessible from the navigation menu. |
+-----------------+--------------------------------------------------------------------------------+
| `code-column` | | Show a dynamic side column that can be used to display interactive |
| | tutorials or code excerpts. |
| | | For example, see :doc:`/developer/webservices/upgrade` or |
| | :doc:`/applications/finance/accounting/overview/main_concepts/memento`. |
+-----------------+--------------------------------------------------------------------------------+
| `hide-page-toc` | Hide the "On this page" sidebar and use full page width for the content. |
+-----------------+--------------------------------------------------------------------------------+
| `custom-css` | Link CSS files (comma-separated) to the document. |
+-----------------+--------------------------------------------------------------------------------+
| `custom-js` | Link JS files (comma-separated) to the document. |
+-----------------+--------------------------------------------------------------------------------+
| `classes` | Assign the specified classes to the `<main/>` element of the document. |
+-----------------+--------------------------------------------------------------------------------+
| `orphan` | Suppress the need to include the document in a toctree. |
+-----------------+--------------------------------------------------------------------------------+
| `nosearch` | Exclude the document from search results. |
+-----------------+--------------------------------------------------------------------------------+
.. _contributing/formatting-tips: