diff --git a/content/applications/finance/accounting/bank.rst b/content/applications/finance/accounting/bank.rst index 605be70d3..883aaf44e 100644 --- a/content/applications/finance/accounting/bank.rst +++ b/content/applications/finance/accounting/bank.rst @@ -1,8 +1,8 @@ :nosearch: -=========== -Bank & Cash -=========== +============= +Bank and cash +============= .. toctree:: :titlesonly: diff --git a/content/applications/finance/accounting/bank/feeds.rst b/content/applications/finance/accounting/bank/feeds.rst index 19b527680..6291307da 100644 --- a/content/applications/finance/accounting/bank/feeds.rst +++ b/content/applications/finance/accounting/bank/feeds.rst @@ -1,7 +1,7 @@ :nosearch: ========== -Bank Feeds +Bank feeds ========== .. toctree:: diff --git a/content/applications/finance/accounting/bank/feeds/bank_statements.rst b/content/applications/finance/accounting/bank/feeds/bank_statements.rst index b589bac1a..cc8528c10 100644 --- a/content/applications/finance/accounting/bank/feeds/bank_statements.rst +++ b/content/applications/finance/accounting/bank/feeds/bank_statements.rst @@ -1,5 +1,5 @@ =============== -Bank Statements +Bank statements =============== Importing your bank statements in Odoo Accounting allows you to keep track of the financial diff --git a/content/applications/finance/accounting/bank/feeds/bank_synchronization.rst b/content/applications/finance/accounting/bank/feeds/bank_synchronization.rst index 886a15b3c..97b9750be 100644 --- a/content/applications/finance/accounting/bank/feeds/bank_synchronization.rst +++ b/content/applications/finance/accounting/bank/feeds/bank_synchronization.rst @@ -1,5 +1,5 @@ ====================================== -Bank Synchronization: Automatic Import +Bank synchronization: Automatic import ====================================== Odoo can synchronize directly with your bank institution to get all bank statements imported diff --git a/content/applications/finance/accounting/bank/reconciliation.rst b/content/applications/finance/accounting/bank/reconciliation.rst index 626f71940..0cfb8f132 100644 --- a/content/applications/finance/accounting/bank/reconciliation.rst +++ b/content/applications/finance/accounting/bank/reconciliation.rst @@ -1,7 +1,7 @@ :nosearch: =================== -Bank Reconciliation +Bank reconciliation =================== .. toctree:: diff --git a/content/applications/finance/accounting/fiscal_localizations.rst b/content/applications/finance/accounting/fiscal_localizations.rst index 92bf39257..e7260411f 100644 --- a/content/applications/finance/accounting/fiscal_localizations.rst +++ b/content/applications/finance/accounting/fiscal_localizations.rst @@ -1,7 +1,7 @@ :nosearch: ==================== -Fiscal Localizations +Fiscal localizations ==================== .. toctree:: diff --git a/content/applications/finance/accounting/fiscal_localizations/overview/fiscal_localization_packages.rst b/content/applications/finance/accounting/fiscal_localizations/overview/fiscal_localization_packages.rst index 6b7b4a5bc..fb4bc5c88 100644 --- a/content/applications/finance/accounting/fiscal_localizations/overview/fiscal_localization_packages.rst +++ b/content/applications/finance/accounting/fiscal_localizations/overview/fiscal_localization_packages.rst @@ -1,5 +1,5 @@ ============================ -Fiscal Localization Packages +Fiscal localization packages ============================ **Fiscal Localization Packages** are country-specific modules that install pre-configured taxes, diff --git a/content/applications/finance/accounting/fiscal_localizations/overview/localizations_list.rst b/content/applications/finance/accounting/fiscal_localizations/overview/localizations_list.rst index 4a57a3e4b..3b9c807db 100644 --- a/content/applications/finance/accounting/fiscal_localizations/overview/localizations_list.rst +++ b/content/applications/finance/accounting/fiscal_localizations/overview/localizations_list.rst @@ -10,7 +10,7 @@ available on Odoo. :align: center :alt: Odoo Accounting. -Fiscal Localization Packages available +Fiscal localization packages available ====================================== - Algeria - Accounting diff --git a/content/applications/finance/accounting/getting_started.rst b/content/applications/finance/accounting/getting_started.rst index 698505090..f122f172b 100644 --- a/content/applications/finance/accounting/getting_started.rst +++ b/content/applications/finance/accounting/getting_started.rst @@ -1,7 +1,7 @@ :nosearch: =============== -Getting Started +Getting started =============== .. toctree:: diff --git a/content/applications/finance/accounting/getting_started/initial_configuration.rst b/content/applications/finance/accounting/getting_started/initial_configuration.rst index eb4f1686d..499fec32a 100644 --- a/content/applications/finance/accounting/getting_started/initial_configuration.rst +++ b/content/applications/finance/accounting/getting_started/initial_configuration.rst @@ -1,7 +1,7 @@ :nosearch: ===================== -Initial Configuration +Initial configuration ===================== .. toctree:: diff --git a/content/applications/finance/accounting/others/analytic.rst b/content/applications/finance/accounting/others/analytic.rst index 1a18aa7a3..b9c0998ae 100644 --- a/content/applications/finance/accounting/others/analytic.rst +++ b/content/applications/finance/accounting/others/analytic.rst @@ -1,8 +1,8 @@ :nosearch: -=========== +======== Analytic -=========== +======== .. toctree:: :titlesonly: diff --git a/content/applications/finance/accounting/payables.rst b/content/applications/finance/accounting/payables.rst index ac1d80f61..a6738bc5f 100644 --- a/content/applications/finance/accounting/payables.rst +++ b/content/applications/finance/accounting/payables.rst @@ -1,7 +1,7 @@ :nosearch: ================ -Account Payables +Account payables ================ .. toctree:: diff --git a/content/applications/finance/accounting/payables/pay.rst b/content/applications/finance/accounting/payables/pay.rst index 25316375d..d8c929cc2 100644 --- a/content/applications/finance/accounting/payables/pay.rst +++ b/content/applications/finance/accounting/payables/pay.rst @@ -1,7 +1,7 @@ :nosearch: =============== -Vendor Payments +Vendor payments =============== .. toctree:: diff --git a/content/applications/finance/accounting/payables/pay/check.rst b/content/applications/finance/accounting/payables/pay/check.rst index 7380ff351..ed9b92e1a 100644 --- a/content/applications/finance/accounting/payables/pay/check.rst +++ b/content/applications/finance/accounting/payables/pay/check.rst @@ -1,5 +1,5 @@ ============= -Pay by Checks +Pay by checks ============= Once you decide to pay a supplier bill, you can select to pay by check. diff --git a/content/applications/finance/accounting/payables/supplier_bills.rst b/content/applications/finance/accounting/payables/supplier_bills.rst index be784f67d..b4519cca1 100644 --- a/content/applications/finance/accounting/payables/supplier_bills.rst +++ b/content/applications/finance/accounting/payables/supplier_bills.rst @@ -1,7 +1,7 @@ :nosearch: ============ -Vendor Bills +Vendor bills ============ .. toctree:: diff --git a/content/applications/finance/accounting/payables/supplier_bills/assets.rst b/content/applications/finance/accounting/payables/supplier_bills/assets.rst index 4c6d11646..ceec9fcce 100644 --- a/content/applications/finance/accounting/payables/supplier_bills/assets.rst +++ b/content/applications/finance/accounting/payables/supplier_bills/assets.rst @@ -1,5 +1,5 @@ =================================== -Non-current Assets and Fixed Assets +Non-current assets and fixed assets =================================== **Non-current Assets**, also known as **long-term assets**, are investments that are expected to be diff --git a/content/applications/finance/accounting/payables/supplier_bills/deferred_expenses.rst b/content/applications/finance/accounting/payables/supplier_bills/deferred_expenses.rst index 34ccd48b1..0803f8e1c 100644 --- a/content/applications/finance/accounting/payables/supplier_bills/deferred_expenses.rst +++ b/content/applications/finance/accounting/payables/supplier_bills/deferred_expenses.rst @@ -1,5 +1,5 @@ ================================= -Deferred Expenses and Prepayments +Deferred expenses and prepayments ================================= **Deferred expenses** and **prepayments** (also known as **prepaid expense**), are both costs that diff --git a/content/applications/finance/accounting/payables/supplier_bills/manage.rst b/content/applications/finance/accounting/payables/supplier_bills/manage.rst index 9a10b038b..46caf7f7d 100644 --- a/content/applications/finance/accounting/payables/supplier_bills/manage.rst +++ b/content/applications/finance/accounting/payables/supplier_bills/manage.rst @@ -1,5 +1,5 @@ =================== -Manage vendor Bills +Manage vendor bills =================== The **Purchase** application allows you to manage your purchase orders, diff --git a/content/applications/finance/accounting/payables/supplier_bills/ocr.rst b/content/applications/finance/accounting/payables/supplier_bills/ocr.rst index e2d52ec90..7e4fd264d 100644 --- a/content/applications/finance/accounting/payables/supplier_bills/ocr.rst +++ b/content/applications/finance/accounting/payables/supplier_bills/ocr.rst @@ -1,5 +1,5 @@ ============================================================== -Digitize Vendor Bills with Optical Character Recognition (OCR) +Digitize vendor bills with optical character recognition (OCR) ============================================================== Encoding bills manually can be a time-consuming task. Having a solution that allows you to digitize diff --git a/content/applications/finance/accounting/payables/supplier_bills/purchase_receipts.rst b/content/applications/finance/accounting/payables/supplier_bills/purchase_receipts.rst index 2d5245111..1099ef6ee 100644 --- a/content/applications/finance/accounting/payables/supplier_bills/purchase_receipts.rst +++ b/content/applications/finance/accounting/payables/supplier_bills/purchase_receipts.rst @@ -1,5 +1,5 @@ ================= -Purchase Receipts +Purchase receipts ================= **Purchase Receipts** are not invoices but rather confirmations of received payments, such as a diff --git a/content/applications/finance/accounting/receivables.rst b/content/applications/finance/accounting/receivables.rst index 04d8e818a..e444f36c0 100644 --- a/content/applications/finance/accounting/receivables.rst +++ b/content/applications/finance/accounting/receivables.rst @@ -1,7 +1,7 @@ :nosearch: =================== -Account Receivables +Account receivables =================== .. toctree:: diff --git a/content/applications/finance/accounting/receivables/customer_invoices.rst b/content/applications/finance/accounting/receivables/customer_invoices.rst index 9d36f5e82..cd5daef47 100644 --- a/content/applications/finance/accounting/receivables/customer_invoices.rst +++ b/content/applications/finance/accounting/receivables/customer_invoices.rst @@ -1,7 +1,7 @@ :nosearch: ================= -Customer Invoices +Customer invoices ================= .. toctree:: diff --git a/content/applications/finance/accounting/receivables/customer_invoices/cash_rounding.rst b/content/applications/finance/accounting/receivables/customer_invoices/cash_rounding.rst index 29d8b281c..f6fdc2bab 100644 --- a/content/applications/finance/accounting/receivables/customer_invoices/cash_rounding.rst +++ b/content/applications/finance/accounting/receivables/customer_invoices/cash_rounding.rst @@ -1,5 +1,5 @@ ============= -Cash Rounding +Cash rounding ============= **Cash rounding** is required when the lowest physical denomination diff --git a/content/applications/finance/accounting/receivables/customer_invoices/credit_notes.rst b/content/applications/finance/accounting/receivables/customer_invoices/credit_notes.rst index 900636ec1..0722e9f48 100644 --- a/content/applications/finance/accounting/receivables/customer_invoices/credit_notes.rst +++ b/content/applications/finance/accounting/receivables/customer_invoices/credit_notes.rst @@ -1,5 +1,5 @@ ======================== -Credit Notes and Refunds +Credit notes and refunds ======================== A **credit note**, or **credit memo**, is a document issued to a customer that notifies them that they have been credited diff --git a/content/applications/finance/accounting/receivables/customer_invoices/deferred_revenues.rst b/content/applications/finance/accounting/receivables/customer_invoices/deferred_revenues.rst index 3ca9efcb2..0996005d7 100644 --- a/content/applications/finance/accounting/receivables/customer_invoices/deferred_revenues.rst +++ b/content/applications/finance/accounting/receivables/customer_invoices/deferred_revenues.rst @@ -1,5 +1,5 @@ ================= -Deferred Revenues +Deferred revenues ================= **Deferred revenues**, or **unearned revenue**, are payments made in advance by customers for diff --git a/content/applications/finance/accounting/receivables/customer_invoices/payment_terms.rst b/content/applications/finance/accounting/receivables/customer_invoices/payment_terms.rst index cdb05a6d4..1210b3687 100644 --- a/content/applications/finance/accounting/receivables/customer_invoices/payment_terms.rst +++ b/content/applications/finance/accounting/receivables/customer_invoices/payment_terms.rst @@ -1,5 +1,5 @@ =================================== -Payment Terms and Installment Plans +Payment terms and installment plans =================================== **Payment Terms** specify all the conditions under which a sale is paid, mostly to ensure customers diff --git a/content/applications/finance/accounting/receivables/customer_invoices/snailmail.rst b/content/applications/finance/accounting/receivables/customer_invoices/snailmail.rst index ca824822f..10c976c9e 100644 --- a/content/applications/finance/accounting/receivables/customer_invoices/snailmail.rst +++ b/content/applications/finance/accounting/receivables/customer_invoices/snailmail.rst @@ -1,5 +1,5 @@ ====================================== -Send your Invoices by Post (Snailmail) +Send your invoices by post (Snailmail) ====================================== Direct mail is a great way to capture individuals’ attention at a time where inboxes are always diff --git a/content/applications/finance/accounting/receivables/customer_payments.rst b/content/applications/finance/accounting/receivables/customer_payments.rst index 647a1641f..9517f3dc6 100644 --- a/content/applications/finance/accounting/receivables/customer_payments.rst +++ b/content/applications/finance/accounting/receivables/customer_payments.rst @@ -1,7 +1,7 @@ :nosearch: ================= -Customer Payments +Customer payments ================= .. toctree:: diff --git a/content/applications/finance/accounting/receivables/customer_payments/batch.rst b/content/applications/finance/accounting/receivables/customer_payments/batch.rst index 48e5d6598..e70f9d19d 100644 --- a/content/applications/finance/accounting/receivables/customer_payments/batch.rst +++ b/content/applications/finance/accounting/receivables/customer_payments/batch.rst @@ -1,5 +1,5 @@ ================================================== -Batch Payments: Batch Deposits (checks, cash etc.) +Batch payments: Batch deposits (checks, cash etc.) ================================================== A **Batch Deposit** groups multiple payments in a single batch. This allows you to deposit several diff --git a/content/applications/finance/accounting/receivables/customer_payments/batch_sdd.rst b/content/applications/finance/accounting/receivables/customer_payments/batch_sdd.rst index e973ee591..f0f9b0d13 100644 --- a/content/applications/finance/accounting/receivables/customer_payments/batch_sdd.rst +++ b/content/applications/finance/accounting/receivables/customer_payments/batch_sdd.rst @@ -1,5 +1,5 @@ ======================================= -Batch Payments: SEPA Direct Debit (SDD) +Batch payments: SEPA Direct Debit (SDD) ======================================= SEPA, the Single Euro Payments Area, is a payment-integration initiative of the European Union for diff --git a/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst b/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst index 808fafada..7219b4eb8 100644 --- a/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst +++ b/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst @@ -1,5 +1,5 @@ ====================== -Invoice Online Payment +Invoice online payment ====================== To make it more convenient for your customers to pay the invoices you issue, you can activate the diff --git a/content/applications/finance/accounting/reporting.rst b/content/applications/finance/accounting/reporting.rst index 3b449442f..88e33295e 100644 --- a/content/applications/finance/accounting/reporting.rst +++ b/content/applications/finance/accounting/reporting.rst @@ -1,8 +1,8 @@ :nosearch: -=========== +========= Reporting -=========== +========= .. toctree:: :titlesonly: diff --git a/content/applications/finance/accounting/reporting/declarations/tax_returns.rst b/content/applications/finance/accounting/reporting/declarations/tax_returns.rst index 08a5ad988..749c115df 100644 --- a/content/applications/finance/accounting/reporting/declarations/tax_returns.rst +++ b/content/applications/finance/accounting/reporting/declarations/tax_returns.rst @@ -1,5 +1,5 @@ ============================ -Tax Return (VAT Declaration) +Tax return (VAT declaration) ============================ Companies that are registered for **VAT (Value Added Tax)** must file a **Tax return** on a monthly diff --git a/content/applications/finance/accounting/taxation/fiscal_year.rst b/content/applications/finance/accounting/taxation/fiscal_year.rst index f9a1fec9e..bf47e661a 100644 --- a/content/applications/finance/accounting/taxation/fiscal_year.rst +++ b/content/applications/finance/accounting/taxation/fiscal_year.rst @@ -1,7 +1,7 @@ :nosearch: =========== -Fiscal Year +Fiscal year =========== .. toctree:: diff --git a/content/applications/finance/accounting/taxation/taxes/default_taxes.rst b/content/applications/finance/accounting/taxation/taxes/default_taxes.rst index 27f839e02..90c419ad1 100644 --- a/content/applications/finance/accounting/taxation/taxes/default_taxes.rst +++ b/content/applications/finance/accounting/taxation/taxes/default_taxes.rst @@ -1,5 +1,5 @@ ============= -Default Taxes +Default taxes ============= **Default Taxes** define which :doc:`taxes ` are automatically selected when there is no diff --git a/content/applications/finance/accounting/taxation/taxes/eu_distance_selling.rst b/content/applications/finance/accounting/taxation/taxes/eu_distance_selling.rst index e6e41a101..b5ccf8689 100644 --- a/content/applications/finance/accounting/taxation/taxes/eu_distance_selling.rst +++ b/content/applications/finance/accounting/taxation/taxes/eu_distance_selling.rst @@ -1,5 +1,5 @@ =================================== -EU intra-community Distance Selling +EU intra-community distance selling =================================== **Distance sales within the European Union** include cross-border sales of goods and services to a diff --git a/content/applications/finance/accounting/taxation/taxes/fiscal_positions.rst b/content/applications/finance/accounting/taxation/taxes/fiscal_positions.rst index 02267439e..ba36b52ea 100644 --- a/content/applications/finance/accounting/taxation/taxes/fiscal_positions.rst +++ b/content/applications/finance/accounting/taxation/taxes/fiscal_positions.rst @@ -1,5 +1,5 @@ ========================================== -Fiscal Positions (tax and account mapping) +Fiscal positions (tax and account mapping) ========================================== Default taxes and accounts are set on products and customers to create new transactions on the fly. diff --git a/content/contributing/documentation/content_guidelines.rst b/content/contributing/documentation/content_guidelines.rst index 3d81dbc04..57c43176e 100644 --- a/content/contributing/documentation/content_guidelines.rst +++ b/content/contributing/documentation/content_guidelines.rst @@ -72,42 +72,38 @@ Titles and headings To write good titles and headings: - **Be concise.** -- **Avoid sentences**, questions, and titles starting with "how to." -- **Don't use pronouns** in your titles, especially 2nd person (*your*) + + - **Avoid sentences**, unnecessary verbs, questions, and titles starting with "how to." + +- **Don't use pronouns** in your titles, especially 2nd person (*your*). - Use **sentence case**. This means you capitalize only: - the first word of the title or heading - the first word after a colon - proper nouns (brands, product and service names, etc.) - - app features, as written in the apps -.. important:: - Do not capitalize common nouns when they are not referred to as features. This is more likely - to happen in headings rather than in titles. +.. note:: + - Most titles and headings generally refer to a concept and do *not* represent the name of a + feature or a model. + - Do not capitalize the words of an acronym if they don't entail a proper noun. + - Verbs in headings are fine since they often describe an action. -+------------------+-----------------------------------+--------------------------------------------------------+ -| | Examples | Explanations | -+==================+===================================+========================================================+ -| | **Titles** | *Quotation Templates* | "Quotation Templates" is a feature in Odoo. | -| | (H1) +-----------------------------------+--------------------------------------------------------+ -| | *Lead Mining* | "Lead Mining" is a feature in Odoo. | -| +-----------------------------------+--------------------------------------------------------+ -| | *Resupply from another Warehouse* | "Warehouse" is capitalized as we refer to the feature | -| | | in the app rather than to a real warehouse. | -| +-----------------------------------+--------------------------------------------------------+ -| | *Synchronize Google Calendar | "Google Calendar" is a product and "Odoo" is a brand. | -| | with Odoo* | | -+------------------+-----------------------------------+--------------------------------------------------------+ -| | **Headings** | *Confirm the quotation* | "The quotation" is a common noun not referring to a | -| | (H2, H3, etc.) | | feature in Odoo. | -| +-----------------------------------+--------------------------------------------------------+ -| | *Test environment* | "Environment" is a common noun. | -| +-----------------------------------+--------------------------------------------------------+ -| | *Add a new Payment Acquirer* | "Payment Acquirers" is a feature in Odoo. | -| +-----------------------------------+--------------------------------------------------------+ -| | *Generate SEPA Direct Debit XML | "SEPA Direct Debit" and "XML" are considered as proper | -| | files to submit payments* | nouns. | -+------------------+-----------------------------------+--------------------------------------------------------+ +.. example:: + - **Titles** (H1) + + - Quotation templates + - Lead mining + - Resupply from another warehouse + - Synchronize Google Calendar with Odoo + - Batch payments: SEPA Direct Debit (SDD) + - Digitize vendor bills with optical character recognition (OCR) + + - **Headings** (H2, H3) + + - Project stages + - Email alias + - Confirm the quotation + - Generate SEPA Direct Debit XML files to submit payments .. _contributing/document-structure: