From 0d4603f4f97289d0fae3b811eb3d5b7ac1da0ded Mon Sep 17 00:00:00 2001 From: help <> Date: Mon, 20 Aug 2012 14:57:16 +0530 Subject: [PATCH 1/2] [IMP]improved modules description from rst2html bzr revid: help-20120820092716-x61hs1o7d8lz6tpg --- addons/account/__openerp__.py | 4 +- .../account_analytic_analysis/__openerp__.py | 4 +- .../account_analytic_default/__openerp__.py | 2 +- addons/account_analytic_plans/__openerp__.py | 31 +++++----- addons/account_anglo_saxon/__openerp__.py | 19 ++++--- addons/account_asset/__openerp__.py | 5 +- .../__openerp__.py | 7 ++- addons/account_budget/__openerp__.py | 16 ++++-- addons/account_cancel/__openerp__.py | 4 +- addons/account_check_writing/__openerp__.py | 1 + addons/account_coda/__openerp__.py | 56 +++++++++++++------ addons/account_followup/__openerp__.py | 18 +++--- addons/account_payment/__openerp__.py | 12 +++- addons/account_sequence/__openerp__.py | 1 + .../__openerp__.py | 2 +- .../__openerp__.py | 2 +- .../analytic_contract_project/__openerp__.py | 1 + addons/auth_anonymous/__openerp__.py | 5 +- addons/auth_ldap/__openerp__.py | 6 +- addons/auth_oauth/__openerp__.py | 5 +- addons/auth_openid/__openerp__.py | 5 +- addons/auth_reset_password/__openerp__.py | 5 +- addons/auth_signup/__openerp__.py | 5 +- addons/base_action_rule/__openerp__.py | 2 +- addons/base_calendar/__openerp__.py | 1 + addons/base_crypt/__openerp__.py | 6 +- addons/base_iban/__openerp__.py | 2 +- addons/base_module_record/__openerp__.py | 1 + addons/base_status/__openerp__.py | 9 ++- addons/base_vat/__openerp__.py | 27 ++++----- addons/caldav/__openerp__.py | 13 +++-- addons/crm_partner_assign/__openerp__.py | 1 + addons/crm_profiling/__openerp__.py | 2 +- addons/crm_todo/__openerp__.py | 1 + addons/document/__openerp__.py | 1 + addons/document_webdav/__openerp__.py | 24 ++++---- addons/event/__openerp__.py | 6 +- addons/event_moodle/__openerp__.py | 14 +++-- addons/fetchmail/__openerp__.py | 5 +- addons/google_base_account/__openerp__.py | 5 +- addons/google_docs/__openerp__.py | 5 +- addons/hr/__openerp__.py | 1 + addons/hr_expense/__openerp__.py | 1 + addons/hr_holidays/__openerp__.py | 11 ++-- addons/hr_payroll_account/__openerp__.py | 2 +- addons/hr_timesheet_sheet/__openerp__.py | 6 +- addons/import_base/__openerp__.py | 4 +- addons/import_google/__openerp__.py | 5 +- addons/import_sugarcrm/__openerp__.py | 5 +- addons/l10n_ar/__openerp__.py | 1 + addons/l10n_at/__openerp__.py | 7 ++- addons/l10n_be/__openerp__.py | 10 +++- .../l10n_be_hr_payroll_account/__openerp__.py | 1 + addons/l10n_be_invoice_bba/__openerp__.py | 14 ++--- addons/l10n_br/__openerp__.py | 2 +- addons/l10n_ch/__openerp__.py | 41 +++++++------- addons/l10n_cl/__openerp__.py | 2 +- addons/l10n_cr/__openerp__.py | 1 + addons/l10n_es/__openerp__.py | 2 +- addons/l10n_fr/__openerp__.py | 2 +- addons/l10n_fr_hr_payroll/__openerp__.py | 1 + addons/l10n_fr_rib/__openerp__.py | 7 ++- addons/l10n_hn/__openerp__.py | 3 + addons/l10n_pe/__openerp__.py | 4 +- addons/l10n_syscohada/__openerp__.py | 4 ++ addons/l10n_uk/__openerp__.py | 4 +- addons/l10n_us/__openerp__.py | 1 + addons/mail/__openerp__.py | 6 +- addons/marketing_campaign/__openerp__.py | 3 +- addons/membership/__openerp__.py | 1 + addons/mrp_operations/__openerp__.py | 4 +- addons/mrp_repair/__openerp__.py | 1 + addons/mrp_subproduct/__openerp__.py | 2 + addons/pad_project/__openerp__.py | 1 + addons/plugin/__openerp__.py | 1 + addons/portal/__openerp__.py | 2 +- addons/portal_claim/__openerp__.py | 4 +- addons/portal_crm/__openerp__.py | 4 +- addons/portal_event/__openerp__.py | 4 +- addons/portal_hr_employees/__openerp__.py | 4 +- addons/portal_project/__openerp__.py | 4 +- addons/portal_project_issue/__openerp__.py | 4 +- addons/portal_sale/__openerp__.py | 4 +- addons/process/__openerp__.py | 5 +- addons/product/__openerp__.py | 1 + addons/product_expiry/__openerp__.py | 1 + addons/product_manufacturer/__openerp__.py | 1 + .../product_visible_discount/__openerp__.py | 2 +- addons/project_mailgate/__openerp__.py | 1 + addons/report_webkit/__openerp__.py | 3 +- addons/sale/__openerp__.py | 6 +- addons/sale_journal/__openerp__.py | 6 +- addons/sale_order_dates/__openerp__.py | 1 + addons/stock/__openerp__.py | 1 + addons/stock_location/__openerp__.py | 12 ++-- addons/stock_planning/__openerp__.py | 33 ++++++----- addons/subscription/__openerp__.py | 1 + addons/web_linkedin/__openerp__.py | 5 +- addons/web_shortcuts/__openerp__.py | 1 + 99 files changed, 376 insertions(+), 236 deletions(-) diff --git a/addons/account/__openerp__.py b/addons/account/__openerp__.py index e1b9078ec3f..aaa71db0a7d 100644 --- a/addons/account/__openerp__.py +++ b/addons/account/__openerp__.py @@ -44,8 +44,8 @@ Creates a dashboard for accountants that includes: * Company Analysis * Graph of Treasury -The processes like maintaining of general ledger is done through the defined financial Journals (entry move line orgrouping is maintained through journal) for a particular -financial year and for preparation of vouchers there is a module named account_voucher. +The processes like maintaining of general ledger is done through the defined financial Journals (entry move line orgrouping is maintained through journal) +for a particular financial year and for preparation of vouchers there is a module named account_voucher. """, 'website': 'http://www.openerp.com', 'images' : ['images/accounts.jpeg','images/bank_statement.jpeg','images/cash_register.jpeg','images/chart_of_accounts.jpeg','images/customer_invoice.jpeg','images/journal_entries.jpeg'], diff --git a/addons/account_analytic_analysis/__openerp__.py b/addons/account_analytic_analysis/__openerp__.py index e0bec840467..4e328f84e28 100644 --- a/addons/account_analytic_analysis/__openerp__.py +++ b/addons/account_analytic_analysis/__openerp__.py @@ -28,9 +28,7 @@ This module is for modifying account analytic view to show important data to project manager of services companies. =================================================================================================================== -Adds menu to show relevant information to each manager. -You can also view the report of account analytic summary -user-wise as well as month-wise. +Adds menu to show relevant information to each manager.You can also view the report of account analytic summary user-wise as well as month-wise. """, "author": "Camptocamp", "website": "http://www.camptocamp.com/", diff --git a/addons/account_analytic_default/__openerp__.py b/addons/account_analytic_default/__openerp__.py index 5ec1fc66c73..72e196a49b6 100644 --- a/addons/account_analytic_default/__openerp__.py +++ b/addons/account_analytic_default/__openerp__.py @@ -25,7 +25,7 @@ "category": 'Accounting & Finance', 'description': """ Set default values for your analytic accounts. -============================================= +============================================== Allows to automatically select analytic accounts based on criterions: --------------------------------------------------------------------- diff --git a/addons/account_analytic_plans/__openerp__.py b/addons/account_analytic_plans/__openerp__.py index a9000cfa490..ac0ce9d8d7d 100644 --- a/addons/account_analytic_plans/__openerp__.py +++ b/addons/account_analytic_plans/__openerp__.py @@ -26,38 +26,41 @@ 'category': 'Accounting & Finance', 'description': """ This module allows to use several analytic plans according to the general journal. -=================================================================================== +================================================================================== Here multiple analytic lines are created when the invoice or the entries are confirmed. For example, you can define the following analytic structure: - Projects +------------------------------------------------------------- + **Projects** Project 1 SubProj 1.1 + SubProj 1.2 Project 2 - Salesman + + **Salesman** Eric + Fabien -Here, we have two plans: Projects and Salesman. An invoice line must -be able to write analytic entries in the 2 plans: SubProj 1.1 and -Fabien. The amount can also be split. The following example is for -an invoice that touches the two subproject and assigned to one salesman: - -Plan1: +Here, we have two plans: Projects and Salesman. An invoice line must be able to write analytic entries in the 2 plans: SubProj 1.1 and Fabien. The amount can also be split. + +The following example is for an invoice that touches the two subprojects and assigned to one salesman: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Plan1:** SubProject 1.1 : 50% + SubProject 1.2 : 50% -Plan2: + +**Plan2:** Eric: 100% -So when this line of invoice will be confirmed, it will generate 3 analytic lines, -for one account entry. +So when this line of invoice will be confirmed, it will generate 3 analytic lines,for one account entry. -The analytic plan validates the minimum and maximum percentage at the time of creation -of distribution models. +The analytic plan validates the minimum and maximum percentage at the time of creation of distribution models. """, 'author': 'OpenERP SA', 'website': 'http://www.openerp.com', diff --git a/addons/account_anglo_saxon/__openerp__.py b/addons/account_anglo_saxon/__openerp__.py index 5073d6522e3..9856add884e 100644 --- a/addons/account_anglo_saxon/__openerp__.py +++ b/addons/account_anglo_saxon/__openerp__.py @@ -27,15 +27,18 @@ This module supports the Anglo-Saxon accounting methodology by changing the accounting logic with stock transactions. ===================================================================================================================== -The difference between the Anglo-Saxon accounting countries and the Rhine (or also called -Continental accounting) countries is the moment of taking the Cost of Goods Sold versus -Cost of Sales. Anglo-Saxons accounting does take the cost when sales invoice is created, -Continental accounting will take the cost at the moment the goods are shipped. +The difference between the Anglo-Saxon accounting countries and the Rhine +(or also called Continental accounting) countries is the moment of taking +the Cost of Goods Sold versus Cost of Sales. Anglo-Saxons accounting does +take the cost when sales invoice is created, Continental accounting will +take the cost at the moment the goods are shipped. -This module will add this functionality by using a interim account, to store the value of -shipped goods and will contra book this interim account when the invoice is created to -transfer this amount to the debtor or creditor account. Secondly, price differences between -actual purchase price and fixed product standard price are booked on a separate account.""", +This module will add this functionality by using a interim account, to +store the value of shipped goods and will contra book this interim +account when the invoice is created to transfer this amount to the +debtor or creditor account. Secondly, price differences between actual +purchase price and fixed product standard price are booked on a separate +account.""", "images": ["images/account_anglo_saxon.jpeg"], "depends": ["product", "purchase"], "category": "Accounting & Finance", diff --git a/addons/account_asset/__openerp__.py b/addons/account_asset/__openerp__.py index 2cf79e9d30d..1c205808b26 100644 --- a/addons/account_asset/__openerp__.py +++ b/addons/account_asset/__openerp__.py @@ -28,8 +28,9 @@ Financial and accounting asset management. ========================================== -This Module manages the assets owned by a company or an individual. It will keep track of depreciation's occurred on those assets. -And it allows to create Move's of the depreciation lines. +This Module manages the assets owned by a company or an individual. It will keep +track of depreciation's occurred on those assets. And it allows to create Move's +of the depreciation lines. """, "website" : "http://www.openerp.com", diff --git a/addons/account_bank_statement_extensions/__openerp__.py b/addons/account_bank_statement_extensions/__openerp__.py index a3765d33622..2e3ec89e2e3 100644 --- a/addons/account_bank_statement_extensions/__openerp__.py +++ b/addons/account_bank_statement_extensions/__openerp__.py @@ -30,13 +30,16 @@ Module that extends the standard account_bank_statement_line object for improved =================================================================================================== This module adds: +----------------- - valuta date - batch payments - traceability of changes to bank statement lines - bank statement line views - bank statements balances report - - performance improvements for digital import of bank statement (via 'ebanking_import' context flag) - - name_search on res.partner.bank enhanced to allow search on bank and iban account numbers + - performance improvements for digital import of bank statement (via + 'ebanking_import' context flag) + - name_search on res.partner.bank enhanced to allow search on bank + and iban account numbers ''', 'depends': ['account'], 'demo_xml': [], diff --git a/addons/account_budget/__openerp__.py b/addons/account_budget/__openerp__.py index e03c66c2132..dd1a1c71883 100644 --- a/addons/account_budget/__openerp__.py +++ b/addons/account_budget/__openerp__.py @@ -32,16 +32,20 @@ Once the Budgets are defined (in Invoicing/Budgets/Budgets), the Project Manager can set the planned amount on each Analytic Account. The accountant has the possibility to see the total of amount planned for each -Budget in order to ensure the total planned is not greater/lower than what he planned -for this Budget. Each list of record can also be switched to a graphical view of it. +Budget in order to ensure the total planned is not greater/lower than what he +planned for this Budget. Each list of record can also be switched to a graphical +view of it. Three reports are available: +---------------------------- + 1. The first is available from a list of Budgets. It gives the spreading, for + these Budgets, of the Analytic Accounts. - 1. The first is available from a list of Budgets. It gives the spreading, for these Budgets, of the Analytic Accounts. + 2. The second is a summary of the previous one, it only gives the spreading, + for the selected Budgets, of the Analytic Accounts. - 2. The second is a summary of the previous one, it only gives the spreading, for the selected Budgets, of the Analytic Accounts. - - 3. The last one is available from the Analytic Chart of Accounts. It gives the spreading, for the selected Analytic Accounts of Budgets. + 3. The last one is available from the Analytic Chart of Accounts. It gives + the spreading, for the selected Analytic Accounts of Budgets. """, 'author': 'OpenERP SA', 'website': 'http://www.openerp.com', diff --git a/addons/account_cancel/__openerp__.py b/addons/account_cancel/__openerp__.py index c616cc9d5e0..0cd61a8be1d 100644 --- a/addons/account_cancel/__openerp__.py +++ b/addons/account_cancel/__openerp__.py @@ -25,10 +25,10 @@ "author" : "OpenERP SA", "category": 'Accounting & Finance', "description": """ -Allows cancelling accounting entries. +Allows canceling accounting entries. ===================================== -This module adds 'Allow Cancelling Entries' field on form view of account journal. +This module adds 'Allow Canceling Entries' field on form view of account journal. If set to true it allows user to cancel entries & invoices. """, 'website': 'http://www.openerp.com', diff --git a/addons/account_check_writing/__openerp__.py b/addons/account_check_writing/__openerp__.py index faba82928ed..ecac0fe6e86 100644 --- a/addons/account_check_writing/__openerp__.py +++ b/addons/account_check_writing/__openerp__.py @@ -25,6 +25,7 @@ "category": "Generic Modules/Accounting", "description": """ Module for the Check Writing and Check Printing. +================================================ """, 'website': 'http://www.openerp.com', 'init_xml': [], diff --git a/addons/account_coda/__openerp__.py b/addons/account_coda/__openerp__.py index 094ab45acc0..a98d40a9e40 100644 --- a/addons/account_coda/__openerp__.py +++ b/addons/account_coda/__openerp__.py @@ -29,44 +29,64 @@ Module to import CODA bank statements. ====================================== Supported are CODA flat files in V2 format from Belgian bank accounts. +---------------------------------------------------------------------- * CODA v1 support. * CODA v2.2 support. * Foreign Currency support. * Support for all data record types (0, 1, 2, 3, 4, 8, 9). - * Parsing & logging of all Transaction Codes and Structured Format Communications. + * Parsing & logging of all Transaction Codes and Structured Format + Communications. * Automatic Financial Journal assignment via CODA configuration parameters. * Support for multiple Journals per Bank Account Number. - * Support for multiple statements from different bank accounts in a single CODA file. - * Support for 'parsing only' CODA Bank Accounts (defined as type='info' in the CODA Bank Account configuration records). - * Multi-language CODA parsing, parsing configuration data provided for EN, NL, FR. + * Support for multiple statements from different bank accounts in a single + CODA file. + * Support for 'parsing only' CODA Bank Accounts (defined as type='info' in + the CODA Bank Account configuration records). + * Multi-language CODA parsing, parsing configuration data provided for EN, + NL, FR. The machine readable CODA Files are parsed and stored in human readable format in CODA Bank Statements. Also Bank Statements are generated containing a subset of -the CODA information (only those transaction lines that are required for the creation -of the Financial Accounting records). The CODA Bank Statement is a 'read-only' -object, hence remaining a reliable representation of the original CODA file whereas -the Bank Statement will get modified as required by accounting business processes. +the CODA information (only those transaction lines that are required for the +creation of the Financial Accounting records). The CODA Bank Statement is a +'read-only' object, hence remaining a reliable representation of the original +CODA file whereas the Bank Statement will get modified as required by accounting +business processes. CODA Bank Accounts configured as type 'Info' will only generate CODA Bank Statements. -A removal of one object in the CODA processing results in the removal of the associated -objects. The removal of a CODA File containing multiple Bank Statements will also -remove those associated statements. +A removal of one object in the CODA processing results in the removal of the +associated objects. The removal of a CODA File containing multiple Bank +Statements will also remove those associated statements. The following reconciliation logic has been implemented in the CODA processing: - -1) The Company's Bank Account Number of the CODA statement is compared against the Bank Account Number field of the Company's CODA Bank Account configuration records (whereby bank accounts defined in type='info' configuration records are ignored). If this is the case an 'internal transfer' transaction is generated using the 'Internal Transfer Account' field of the CODA File Import wizard. -2) As a second step the 'Structured Communication' field of the CODA transaction line is matched against the reference field of in- and outgoing invoices (supported : Belgian Structured Communication Type). -3) When the previous step doesn't find a match, the transaction counterparty is located via the Bank Account Number configured on the OpenERP Customer and Supplier records. -4) In case the previous steps are not successful, the transaction is generated by using the 'Default Account for Unrecognized Movement' field of the CODA File Import wizard in order to allow further manual processing. +------------------------------------------------------------------------------- + 1) The Company's Bank Account Number of the CODA statement is compared against + the Bank Account Number field of the Company's CODA Bank Account + configuration records (whereby bank accounts defined in type='info' + configuration records are ignored). If this is the case an 'internal transfer' + transaction is generated using the 'Internal Transfer Account' field of the + CODA File Import wizard. + 2) As a second step the 'Structured Communication' field of the CODA transaction + line is matched against the reference field of in- and outgoing invoices + (supported : Belgian Structured Communication Type). + 3) When the previous step doesn't find a match, the transaction counterparty is + located via the Bank Account Number configured on the OpenERP Customer and + Supplier records. + 4) In case the previous steps are not successful, the transaction is generated + by using the 'Default Account for Unrecognized Movement' field of the CODA + File Import wizard in order to allow further manual processing. In stead of a manual adjustment of the generated Bank Statements, you can also re-import the CODA after updating the OpenERP database with the information that was missing to allow automatic reconciliation. Remark on CODA V1 support: -In some cases a transaction code, transaction category or structured communication code has been given a new or clearer description in CODA V2. -The description provided by the CODA configuration tables is based upon the CODA V2.2 specifications. +~~~~~~~~~~~~~~~~~~~~~~~~~~ +In some cases a transaction code, transaction category or structured +communication code has been given a new or clearer description in CODA V2.The +description provided by the CODA configuration tables is based upon the CODA +V2.2 specifications. If required, you can manually adjust the descriptions via the CODA configuration menu. ''', "images" : ["images/coda_logs.jpeg","images/import_coda_logs.jpeg"], diff --git a/addons/account_followup/__openerp__.py b/addons/account_followup/__openerp__.py index e8724b01b4e..d6bb507df49 100644 --- a/addons/account_followup/__openerp__.py +++ b/addons/account_followup/__openerp__.py @@ -28,22 +28,20 @@ Module to automate letters for unpaid invoices, with multi-level recalls. ========================================================================== You can define your multiple levels of recall through the menu: +--------------------------------------------------------------- + **Invoicing** / **Configuration** / **Miscellaneous** / **Follow-ups** - Invoicing/Configuration/Miscellaneous/Follow-ups - -Once it is defined, you can automatically print recalls every day through simply -clicking on the menu: - - Invoicing/Periodical Processing/Billing/Send follow-ups +Once it is defined, you can automatically print recalls every day through simply clicking on the menu: +------------------------------------------------------------------------------------------------------ + **Invoicing** / **Periodical Processing** / **Billing** / **Send follow-ups** It will generate a PDF with all the letters according to the the different levels of recall defined. You can define different policies for different companies. You can also send mail to the customer. -Note that if you want to check the follow-up level for a given partner/account -entry, you can do from in the menu: - - Invoicing/Reporting/Generic Reporting/Partners/Follow-ups Sent +Note that if you want to check the follow-up level for a given partner/account entry, you can do from in the menu: +------------------------------------------------------------------------------------------------------------------ + **Invoicing** / **Reporting** / **Generic Reporting** / **Partners** / **Follow-ups Sent** """, 'author': 'OpenERP SA', diff --git a/addons/account_payment/__openerp__.py b/addons/account_payment/__openerp__.py index 9e7209a348e..814b0dabcae 100644 --- a/addons/account_payment/__openerp__.py +++ b/addons/account_payment/__openerp__.py @@ -28,13 +28,19 @@ Module to manage the payment of your supplier invoices. ======================================================= -This module allows you to create and manage your payment orders, with purposes to +This module allows you to create and manage your payment orders, with purposes to +--------------------------------------------------------------------------------- * serve as base for an easy plug-in of various automated payment mechanisms. * provide a more efficient way to manage invoice payment. Warning: --------- -The confirmation of a payment order does _not_ create accounting entries, it just records the fact that you gave your payment order to your bank. The booking of your order must be encoded as usual through a bank statement. Indeed, it's only when you get the confirmation from your bank that your order has been accepted that you can book it in your accounting. To help you with that operation, you have a new option to import payment orders as bank statement lines. +~~~~~~~~ +The confirmation of a payment order does _not_ create accounting entries, it just +records the fact that you gave your payment order to your bank. The booking of +your order must be encoded as usual through a bank statement. Indeed, it's only +when you get the confirmation from your bank that your order has been accepted +that you can book it in your accounting. To help you with that operation, you +have a new option to import payment orders as bank statement lines. """, 'images': ['images/payment_mode.jpeg','images/payment_order.jpeg'], 'depends': ['account','account_voucher'], diff --git a/addons/account_sequence/__openerp__.py b/addons/account_sequence/__openerp__.py index 0f860d400e9..c366d01ff60 100644 --- a/addons/account_sequence/__openerp__.py +++ b/addons/account_sequence/__openerp__.py @@ -30,6 +30,7 @@ This module maintains internal sequence number for accounting entries. Allows you to configure the accounting sequences to be maintained. You can customize the following attributes of the sequence: +----------------------------------------------------------- * Prefix * Suffix * Next Number diff --git a/addons/analytic_contract_expense_project/__openerp__.py b/addons/analytic_contract_expense_project/__openerp__.py index b569330d117..e5cc6af2c1b 100644 --- a/addons/analytic_contract_expense_project/__openerp__.py +++ b/addons/analytic_contract_expense_project/__openerp__.py @@ -26,7 +26,7 @@ 'category': 'Hidden', 'description': """ This module is for modifying project view to show some data related to the hr_expense module. - +============================================================================================= """, "author": "OpenERP S.A.", "website": "http://www.openerp.com/", diff --git a/addons/analytic_contract_hr_expense/__openerp__.py b/addons/analytic_contract_hr_expense/__openerp__.py index 6d5cca8b574..e95e1f49670 100644 --- a/addons/analytic_contract_hr_expense/__openerp__.py +++ b/addons/analytic_contract_hr_expense/__openerp__.py @@ -26,7 +26,7 @@ 'category': 'Hidden', 'description': """ This module is for modifying account analytic view to show some data related to the hr_expense module. - +====================================================================================================== """, "author": "OpenERP S.A.", "website": "http://www.openerp.com/", diff --git a/addons/analytic_contract_project/__openerp__.py b/addons/analytic_contract_project/__openerp__.py index 4e4f621663c..2ca11521614 100644 --- a/addons/analytic_contract_project/__openerp__.py +++ b/addons/analytic_contract_project/__openerp__.py @@ -28,6 +28,7 @@ "depends" : ["project", "account_analytic_analysis"], "description": """ Add "Contract Data" in project view. +==================================== """, "init_xml" : [], "update_xml": ["analytic_contract_project_view.xml"], diff --git a/addons/auth_anonymous/__openerp__.py b/addons/auth_anonymous/__openerp__.py index 95d98e65fea..db75b1ba2c3 100644 --- a/addons/auth_anonymous/__openerp__.py +++ b/addons/auth_anonymous/__openerp__.py @@ -1,6 +1,9 @@ { 'name': 'Anonymous', - 'description': 'Allow anonymous access to OpenERP.', + 'description': """ +Allow anonymous access to OpenERP. +================================== + """, 'author': 'OpenERP SA', 'version': '1.0', 'category': 'Authentication', diff --git a/addons/auth_ldap/__openerp__.py b/addons/auth_ldap/__openerp__.py index 4e5bc811dca..8182fa51a11 100644 --- a/addons/auth_ldap/__openerp__.py +++ b/addons/auth_ldap/__openerp__.py @@ -30,7 +30,7 @@ Adds support for authentication by LDAP server. This module allows users to login with their LDAP username and password, and will automatically create OpenERP users for them on the fly. -Note: This module only work on servers who have Python's ``ldap`` module installed. +**Note:** This module only work on servers who have Python's ``ldap`` module installed. Configuration: -------------- @@ -64,7 +64,7 @@ It is also possible to have local OpenERP users in the database along with LDAP-authenticated users (the Administrator account is one obvious example). Here is how it works: - +--------------------- * The system first attempts to authenticate users against the local OpenERP database; * if this authentication fails (for example because the user has no local @@ -84,7 +84,7 @@ Template*. If set, this user will be used as template to create the local users whenever someone authenticates for the first time via LDAP authentication. This allows pre-setting the default groups and menus of the first-time users. -Warning: if you set a password for the user template, this password will be +**Warning:** if you set a password for the user template, this password will be assigned as local password for each new LDAP user, effectively setting a *master password* for these users (until manually changed). You usually do not want this. One easy way to setup a template user is to diff --git a/addons/auth_oauth/__openerp__.py b/addons/auth_oauth/__openerp__.py index 6c79bba2151..99a3a25af5a 100644 --- a/addons/auth_oauth/__openerp__.py +++ b/addons/auth_oauth/__openerp__.py @@ -24,7 +24,10 @@ 'name': 'OAuth2 Authentication', 'version': '1.0', 'category': 'Tools', - 'description': """Allow users to login through Google OAuth2.""", + 'description': """ +Allow users to login through Google OAuth2. +=========================================== +""", 'author': 'Victor Tabuenca', 'maintainer': 'OpenERP s.a.', 'website': 'http://www.openerp.com', diff --git a/addons/auth_openid/__openerp__.py b/addons/auth_openid/__openerp__.py index cd1a12fce7f..b372e35efbb 100644 --- a/addons/auth_openid/__openerp__.py +++ b/addons/auth_openid/__openerp__.py @@ -24,7 +24,10 @@ 'name': 'OpenID Authentification', 'version': '2.0', 'category': 'Tools', - 'description': """Allow users to login through OpenID.""", + 'description': """ +Allow users to login through OpenID. +==================================== +""", 'author': 'OpenERP s.a.', 'maintainer': 'OpenERP s.a.', 'website': 'http://www.openerp.com', diff --git a/addons/auth_reset_password/__openerp__.py b/addons/auth_reset_password/__openerp__.py index 76528bbfeb8..f7a67aa4b4d 100644 --- a/addons/auth_reset_password/__openerp__.py +++ b/addons/auth_reset_password/__openerp__.py @@ -1,6 +1,9 @@ { 'name': 'Reset Password', - 'description': 'Allow users to reset their password from the login page', + 'description': """ +Allow users to reset their password from the login page. +======================================================== +""", 'author': 'OpenERP SA', 'version': '1.0', 'category': 'Authentication', diff --git a/addons/auth_signup/__openerp__.py b/addons/auth_signup/__openerp__.py index 765a36ef252..80f120efd9b 100644 --- a/addons/auth_signup/__openerp__.py +++ b/addons/auth_signup/__openerp__.py @@ -21,7 +21,10 @@ { 'name': 'Signup', - 'description': 'Allow users to sign up', + 'description': """ +Allow users to sign up. +======================= + """, 'author': 'OpenERP SA', 'version': '1.0', 'category': 'Authentication', diff --git a/addons/base_action_rule/__openerp__.py b/addons/base_action_rule/__openerp__.py index eff92685313..ad75ab65b60 100644 --- a/addons/base_action_rule/__openerp__.py +++ b/addons/base_action_rule/__openerp__.py @@ -29,7 +29,7 @@ This module allows to implement action rules for any object. Use automated actions to automatically trigger actions for various screens. -Example: A lead created by a specific user may be automatically set to a specific +**Example:** A lead created by a specific user may be automatically set to a specific sales team, or an opportunity which still has status pending after 14 days might trigger an automatic reminder email. """, diff --git a/addons/base_calendar/__openerp__.py b/addons/base_calendar/__openerp__.py index 58f666baa0d..8f431d46dd2 100644 --- a/addons/base_calendar/__openerp__.py +++ b/addons/base_calendar/__openerp__.py @@ -28,6 +28,7 @@ This is a full-featured calendar system. ======================================== It supports: +------------ - Calendar of events - Alerts (create requests) - Recurring events diff --git a/addons/base_crypt/__openerp__.py b/addons/base_crypt/__openerp__.py index 62edc76b277..6e2046a42ee 100644 --- a/addons/base_crypt/__openerp__.py +++ b/addons/base_crypt/__openerp__.py @@ -30,7 +30,7 @@ Replaces cleartext passwords in the database with a secure hash. ================================================================ For your existing user base, the removal of the cleartext passwords occurs -immediately when you instal base_crypt. +immediately when you install base_crypt. All passwords will be replaced by a secure, salted, cryptographic hash, preventing anyone from reading the original password in the database. @@ -49,8 +49,8 @@ contain critical data. Appropriate security measures need to be implemented by the system administrator in all areas, such as: protection of database backups, system files, remote shell access, physical server access. -Interation with LDAP authentication: ------------------------------------- +Interaction with LDAP authentication: +------------------------------------- This module is currently not compatible with the ``user_ldap`` module and will disable LDAP authentication completely if installed at the same time. """, diff --git a/addons/base_iban/__openerp__.py b/addons/base_iban/__openerp__.py index f7778c13f2b..25619ee79ae 100644 --- a/addons/base_iban/__openerp__.py +++ b/addons/base_iban/__openerp__.py @@ -24,7 +24,7 @@ "category": 'Hidden/Dependency', 'description': """ This module installs the base for IBAN (International Bank Account Number) bank accounts and checks for it's validity. -===================================================================================================================== +====================================================================================================================== The ability to extract the correctly represented local accounts from IBAN accounts with a single statement. diff --git a/addons/base_module_record/__openerp__.py b/addons/base_module_record/__openerp__.py index 4cdc8116217..92d9a5b8146 100644 --- a/addons/base_module_record/__openerp__.py +++ b/addons/base_module_record/__openerp__.py @@ -39,6 +39,7 @@ This should help you to easily create reusable and publishable modules for custo configurations and demo/testing data. How to use it?: +--------------- Run Settings/Technical/Module Creation/Export Customizations As a Module wizard. Select datetime criteria of recording and objects to be recorded and Record module. """, diff --git a/addons/base_status/__openerp__.py b/addons/base_status/__openerp__.py index bbd82b703ac..5d282a7edde 100644 --- a/addons/base_status/__openerp__.py +++ b/addons/base_status/__openerp__.py @@ -24,12 +24,11 @@ 'version': '1.0', 'category': 'Hidden', 'description': """ -This module handles state and stage. It is derived from the crm_base and -crm_case classes from crm. -======================================================================== +This module handles state and stage. It is derived from the crm_base and crm_case classes from crm. +=================================================================================================== - * ``base_state``: state management - * ``base_stage``: stage management + * ``base_state``: state management + * ``base_stage``: stage management """, 'author': 'OpenERP SA', 'website': 'http://www.openerp.com', diff --git a/addons/base_vat/__openerp__.py b/addons/base_vat/__openerp__.py index 7b09ee24a58..e093b024976 100644 --- a/addons/base_vat/__openerp__.py +++ b/addons/base_vat/__openerp__.py @@ -33,19 +33,20 @@ be validated for all supported countries. The country is inferred from the will be validated using the Belgian rules. There are two different levels of VAT number validation: - - * By default, a simple off-line check is performed using the known validation - rules for the country, usually a simple check digit. This is quick and - always available, but allows numbers that are perhaps not truly allocated, - or not valid anymore. - * When the "VAT VIES Check" option is enabled (in the configuration of the user's - Company), VAT numbers will be instead submitted to the online EU VIES - database, which will truly verify that the number is valid and currently - allocated to a EU company. This is a little bit slower than the simple - off-line check, requires an Internet connection, and may not be available - all the time. If the service is not available or does not support the - requested country (e.g. for non-EU countries), a simple check will be performed - instead. +-------------------------------------------------------- + * By default, a simple off-line check is performed using the known validation + rules for the country, usually a simple check digit. This is quick and + always available, but allows numbers that are perhaps not truly allocated, + or not valid anymore. + + * When the "VAT VIES Check" option is enabled (in the configuration of the user's + Company), VAT numbers will be instead submitted to the online EU VIES + database, which will truly verify that the number is valid and currently + allocated to a EU company. This is a little bit slower than the simple + off-line check, requires an Internet connection, and may not be available + all the time. If the service is not available or does not support the + requested country (e.g. for non-EU countries), a simple check will be performed + instead. Supported countries currently include EU countries, and a few non-EU countries such as Chile, Colombia, Mexico, Norway or Russia. For unsupported countries, diff --git a/addons/caldav/__openerp__.py b/addons/caldav/__openerp__.py index 2946fe77b1f..a3d0b02f3b1 100644 --- a/addons/caldav/__openerp__.py +++ b/addons/caldav/__openerp__.py @@ -37,16 +37,21 @@ This module contains basic functionality for Caldav system. - Provides iCal Import/Export functionality To access Calendars using CalDAV clients, point them to: +-------------------------------------------------------- http://HOSTNAME:PORT/webdav/DATABASE_NAME/calendars/users/USERNAME/c To access OpenERP Calendar using WebCal to remote site use the URL like: +------------------------------------------------------------------------ http://HOSTNAME:PORT/webdav/DATABASE_NAME/Calendars/CALENDAR_NAME.ics Where, - HOSTNAME: Host on which OpenERP server(With webdav) is running - PORT : Port on which OpenERP server is running (By Default : 8069) - DATABASE_NAME: Name of database on which OpenERP Calendar is created - CALENDAR_NAME: Name of calendar to access + **HOSTNAME:** Host on which OpenERP server(With webdav) is running + + **PORT :** Port on which OpenERP server is running (By Default : 8069) + + **DATABASE_NAME:** Name of database on which OpenERP Calendar is created + + **CALENDAR_NAME:** Name of calendar to access """, 'category': 'Hidden/Dependency', "author": "OpenERP SA", diff --git a/addons/crm_partner_assign/__openerp__.py b/addons/crm_partner_assign/__openerp__.py index 5feb8c199d4..89d292adf7c 100644 --- a/addons/crm_partner_assign/__openerp__.py +++ b/addons/crm_partner_assign/__openerp__.py @@ -32,6 +32,7 @@ You can geolocalize your opportunities by using this module. Use geolocalization when assigning opportunities to partners. Determine the GPS coordinates according to the address of the partner. + The most appropriate partner can be assigned. You can also use the geolocalization without using the GPS coordinates. """, diff --git a/addons/crm_profiling/__openerp__.py b/addons/crm_profiling/__openerp__.py index 68594281b9b..36c0716e3dc 100644 --- a/addons/crm_profiling/__openerp__.py +++ b/addons/crm_profiling/__openerp__.py @@ -35,7 +35,7 @@ questionnaire and directly use it on a partner. It also has been merged with the earlier CRM & SRM segmentation tool because they were overlapping. - * Note: this module is not compatible with the module segmentation, since + * **Note:** this module is not compatible with the module segmentation, since it's the same which has been renamed. """, 'author': 'OpenERP SA', diff --git a/addons/crm_todo/__openerp__.py b/addons/crm_todo/__openerp__.py index 824dac13c21..5f5a5a20e2c 100644 --- a/addons/crm_todo/__openerp__.py +++ b/addons/crm_todo/__openerp__.py @@ -26,6 +26,7 @@ "category": 'Customer Relationship Management', 'description': """ Todo list for CRM leads and opportunities. +========================================== """, 'author': 'OpenERP SA', 'depends': ['crm','project_gtd'], diff --git a/addons/document/__openerp__.py b/addons/document/__openerp__.py index d9ad9a09675..5eea7b4d42f 100644 --- a/addons/document/__openerp__.py +++ b/addons/document/__openerp__.py @@ -37,6 +37,7 @@ This is a complete document management system. * Files Size by Month (graph) ATTENTION: +---------- - When you install this module in a running company that have already PDF files stored into the database, you will lose them all. - After installing this module PDF's are no longer stored into the database, diff --git a/addons/document_webdav/__openerp__.py b/addons/document_webdav/__openerp__.py index 4d39a4e8015..c63eeb3af6b 100644 --- a/addons/document_webdav/__openerp__.py +++ b/addons/document_webdav/__openerp__.py @@ -42,18 +42,20 @@ You can then use any compatible browser to remotely see the attachments of OpenO After installation, the WebDAV server can be controlled by a [webdav] section in the server's config. -Server Configuration Parameter: - [webdav] - ; enable = True ; Serve webdav over the http(s) servers - ; vdir = webdav ; the directory that webdav will be served at - ; this default val means that webdav will be - ; on "http://localhost:8069/webdav/ - ; verbose = True ; Turn on the verbose messages of webdav - ; debug = True ; Turn on the debugging messages of webdav - ; since the messages are routed to the python logging, with - ; levels "debug" and "debug_rpc" respectively, you can leave - ; these options on +Server Configuration Parameter: +------------------------------- +[webdav]: ++++++++++ + * enable = True ; Serve webdav over the http(s) servers + * vdir = webdav ; the directory that webdav will be served at + * this default val means that webdav will be + * on "http://localhost:8069/webdav/ + * verbose = True ; Turn on the verbose messages of webdav + * debug = True ; Turn on the debugging messages of webdav + * since the messages are routed to the python logging, with + * levels "debug" and "debug_rpc" respectively, you can leave + * these options on Also implements IETF RFC 5785 for services discovery on a http server, which needs explicit configuration in openerp-server.conf too. diff --git a/addons/event/__openerp__.py b/addons/event/__openerp__.py index 46eb9759ec2..6b2df4fec8b 100644 --- a/addons/event/__openerp__.py +++ b/addons/event/__openerp__.py @@ -30,14 +30,16 @@ Organization and management of Events. ====================================== -This module allows you +This module allows you: +----------------------- * to manage your events and their registrations * to use emails to automatically confirm and send acknowledgements for any registration to an event Note that: +---------- - You can define new types of events in - Events/Configuration/Types of Events + **Events** / **Configuration** / **Types of Events** """, 'author': 'OpenERP SA', 'depends': ['base_setup', 'board', 'email_template', 'google_map'], diff --git a/addons/event_moodle/__openerp__.py b/addons/event_moodle/__openerp__.py index 14f6de8668d..a1507e5b881 100644 --- a/addons/event_moodle/__openerp__.py +++ b/addons/event_moodle/__openerp__.py @@ -34,10 +34,10 @@ to avoid wasting time. Now you have a simple way to create training or courses with OpenERP and moodle. STEPS TO CONFIGURE: ------------------- +------------------- 1. Activate web service in moodle. ----------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ >site administration >plugins >web services >manage protocols activate the xmlrpc web service @@ -48,16 +48,18 @@ STEPS TO CONFIGURE: 2. Create confirmation email with login and password. ------------------------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ We strongly suggest you to add those following lines at the bottom of your event confirmation email to communicate the login/password of moodle to your subscribers. ........your configuration text....... -URL: your moodle link for exemple: http://openerp.moodle.com -LOGIN: ${object.moodle_username} -PASSWORD: ${object.moodle_user_password} +**URL:** your moodle link for exemple: http://openerp.moodle.com + +**LOGIN:** ${object.moodle_username} + +**PASSWORD:** ${object.moodle_user_password} """, 'author': 'OpenERP SA', 'depends': ['event'], diff --git a/addons/fetchmail/__openerp__.py b/addons/fetchmail/__openerp__.py index 1e8c57a9524..76aaf03e8f6 100644 --- a/addons/fetchmail/__openerp__.py +++ b/addons/fetchmail/__openerp__.py @@ -35,9 +35,8 @@ these accounts will be automatically downloaded into your OpenERP system. All POP3/IMAP-compatible servers are supported, included those that require an encrypted SSL/TLS connection. -This can be used to easily create email-based workflows for many email-enabled -OpenERP documents, such as: - +This can be used to easily create email-based workflows for many email-enabled OpenERP documents, such as: +---------------------------------------------------------------------------------------------------------- * CRM Leads/Opportunities * CRM Claims * Project Issues diff --git a/addons/google_base_account/__openerp__.py b/addons/google_base_account/__openerp__.py index 9dc4a233dcb..1edcaa87117 100644 --- a/addons/google_base_account/__openerp__.py +++ b/addons/google_base_account/__openerp__.py @@ -24,7 +24,10 @@ 'name': 'Google Users', 'version': '1.0', 'category': 'Tools', - 'description': """The module adds google user in res user.""", + 'description': """ +The module adds google user in res user. +======================================== +""", 'author': 'OpenERP SA', 'website': 'http://www.openerp.com', 'depends': ['base'], diff --git a/addons/google_docs/__openerp__.py b/addons/google_docs/__openerp__.py index 8cc5671e08a..4a005a5d769 100644 --- a/addons/google_docs/__openerp__.py +++ b/addons/google_docs/__openerp__.py @@ -34,5 +34,8 @@ 'res_config_user_view.xml' ], 'depends': ['google_base_account'], - 'description': 'Module to attach a google document to any model.' + 'description': """ +Module to attach a google document to any model. +================================================ +""" } diff --git a/addons/hr/__openerp__.py b/addons/hr/__openerp__.py index 65b2d5fc08f..b084783da74 100644 --- a/addons/hr/__openerp__.py +++ b/addons/hr/__openerp__.py @@ -32,6 +32,7 @@ Module for Human Resource Management. ===================================== You can manage: +--------------- * Employees and hierarchies : You can define your employee with User and display hierarchies * HR Departments * HR Jobs diff --git a/addons/hr_expense/__openerp__.py b/addons/hr_expense/__openerp__.py index c40670508f4..77113709c45 100644 --- a/addons/hr_expense/__openerp__.py +++ b/addons/hr_expense/__openerp__.py @@ -31,6 +31,7 @@ This module aims to manage employee's expenses. =============================================== The whole workflow is implemented: +---------------------------------- * Draft expense * Confirmation of the sheet by the employee * Validation by his manager diff --git a/addons/hr_holidays/__openerp__.py b/addons/hr_holidays/__openerp__.py index 45dd9ea39a5..8e6c752dee2 100644 --- a/addons/hr_holidays/__openerp__.py +++ b/addons/hr_holidays/__openerp__.py @@ -37,21 +37,24 @@ Implements a dashboard for human resource management that includes: * Leaves Note that: +~~~~~~~~~~ - A synchronisation with an internal agenda (use of the CRM module) is possible: in order to automatically create a case when an holiday request is accepted, you have to link the holidays status to a case section. You can setup this info and your colour preferences in - Human Resources/Configuration/Leave Type + + **Human Resources** / **Configuration** / **Leave Type** - An employee can make an ask for more off-days by making a new Allocation. It will increase his total of that leave type available (if the request is accepted). - There are two ways to print the employee's holidays: * The first will allow to choose employees by department and is used by clicking the menu item located in - Reporting/Human Resources/Leaves/Leaves by Department + **Reporting** / **Human Resources** / **Leaves** / **Leaves by Department** * The second will allow you to choose the holidays report for specific employees. Go on the list - Human Resources/Human Resources/Employees + **Human Resources** / **Human Resources** / **Employees** then select the ones you want to choose, click on the print icon and select the option 'Leaves Summary' - The wizard allows you to choose if you want to print either the Approved & Confirmed holidays or both. These states must be set up by a user from the group 'HR'. You can define these features in the security tab from the user data in - Settings/Users/Users + **Settings** / **Users** / **Users** + for example, you maybe will do it for the user 'admin'. """, 'images': ['images/hr_allocation_requests.jpeg', 'images/hr_leave_requests.jpeg', 'images/leaves_analysis.jpeg'], diff --git a/addons/hr_payroll_account/__openerp__.py b/addons/hr_payroll_account/__openerp__.py index f869c93697b..a96d609f875 100644 --- a/addons/hr_payroll_account/__openerp__.py +++ b/addons/hr_payroll_account/__openerp__.py @@ -25,7 +25,7 @@ 'category': 'Human Resources', 'description': """ Generic Payroll system Integrated with Accounting. -=================================================== +================================================== * Expense Encoding * Payment Encoding diff --git a/addons/hr_timesheet_sheet/__openerp__.py b/addons/hr_timesheet_sheet/__openerp__.py index 1acaa5780b8..d569cafce09 100644 --- a/addons/hr_timesheet_sheet/__openerp__.py +++ b/addons/hr_timesheet_sheet/__openerp__.py @@ -33,17 +33,19 @@ This module helps you to easily encode and validate timesheet and attendances wi * It will maintain attendances and track (sign in/sign out) events. * Track the timesheet lines. -Other tabs contains statistics views to help you analyse your -time or the time of your team: +Other tabs contains statistics views to help you analyse your time or the time of your team: +-------------------------------------------------------------------------------------------- * Time spent by day (with attendances) * Time spent by project This module also implements a complete timesheet validation process: +-------------------------------------------------------------------- * Draft sheet * Confirmation at the end of the period by the employee * Validation by the project manager The validation can be configured in the company: +------------------------------------------------ * Period size (day, week, month, year) * Maximal difference between timesheet and attendances """, diff --git a/addons/import_base/__openerp__.py b/addons/import_base/__openerp__.py index 294f864a0e3..1ce799c46d1 100644 --- a/addons/import_base/__openerp__.py +++ b/addons/import_base/__openerp__.py @@ -24,8 +24,8 @@ 'version': '0.9', 'category': 'Hidden/Dependency', 'description': """ -This module provide a class import_framework to help importing complex data from -other software. +This module provide a class import_framework to help importing complex data from other software. +================================================================================================ """, 'author': 'OpenERP SA', 'website': 'http://www.openerp.com', diff --git a/addons/import_google/__openerp__.py b/addons/import_google/__openerp__.py index 9e47a213072..0ff09b7ef64 100644 --- a/addons/import_google/__openerp__.py +++ b/addons/import_google/__openerp__.py @@ -23,7 +23,10 @@ 'name': 'Google Import', 'version': '1.0', 'category': 'Customer Relationship Management', - 'description': """The module adds google contact in partner address and add google calendar events details in Meeting.""", + 'description': """ +The module adds google contact in partner address and add google calendar events details in Meeting. +==================================================================================================== +""", 'author': 'OpenERP SA', 'website': 'http://www.openerp.com', 'depends': ['base', 'import_base', 'google_base_account', 'base_calendar'], diff --git a/addons/import_sugarcrm/__openerp__.py b/addons/import_sugarcrm/__openerp__.py index f84b096e28a..0c58da1fed2 100644 --- a/addons/import_sugarcrm/__openerp__.py +++ b/addons/import_sugarcrm/__openerp__.py @@ -24,8 +24,9 @@ 'version': '1.0', 'category': 'Customer Relationship Management', 'description': """ -This Module Import SugarCRM Leads, Opportunities, Users, Accounts, Contacts, Employees, -Meetings, Phonecalls, Emails, Project and Project Tasks Data into OpenERP Module.""", +This Module Import SugarCRM Leads, Opportunities, Users, Accounts, Contacts, Employees, Meetings, Phonecalls, Emails, Project and Project Tasks Data into OpenERP Module. +========================================================================================================================================================================= +""", 'author': 'OpenERP SA', 'website': 'http://www.openerp.com', 'depends': ['import_base','crm', 'document'], diff --git a/addons/l10n_ar/__openerp__.py b/addons/l10n_ar/__openerp__.py index ef04805d1b0..e73a0abc034 100644 --- a/addons/l10n_ar/__openerp__.py +++ b/addons/l10n_ar/__openerp__.py @@ -23,6 +23,7 @@ "version": "1.0", "description": """ Argentinian accounting chart and tax localization. +================================================== Plan contable argentino e impuestos de acuerdo a disposiciones vigentes diff --git a/addons/l10n_at/__openerp__.py b/addons/l10n_at/__openerp__.py index fc266e40d51..03fde22720b 100644 --- a/addons/l10n_at/__openerp__.py +++ b/addons/l10n_at/__openerp__.py @@ -27,9 +27,10 @@ "category" : "Localization/Account Charts", "depends" : ["account_chart", 'base_vat'], "description": """ -This module provides the standard Accounting Chart for Austria which is based on -the Template from BMF.gv.at. Please keep in mind that you should review and adapt -it with your Accountant, before using it in a live Environment.""", +This module provides the standard Accounting Chart for Austria which is based on the Template from BMF.gv.at. +============================================================================================================= +Please keep in mind that you should review and adapt it with your Accountant, before using it in a live Environment. +""", "demo_xml" : [], "update_xml" : ['account_tax_code.xml',"account_chart.xml",'account_tax.xml',"l10n_chart_at_wizard.xml"], "auto_install": False, diff --git a/addons/l10n_be/__openerp__.py b/addons/l10n_be/__openerp__.py index 1f4bcfe6284..a48b6a92bc6 100644 --- a/addons/l10n_be/__openerp__.py +++ b/addons/l10n_be/__openerp__.py @@ -34,16 +34,20 @@ After installing this module, the Configuration wizard for accounting is launche Thus, the pure copy of Chart Template is generated. Wizards provided by this module: +-------------------------------- * Partner VAT Intra: Enlist the partners with their related VAT and invoiced amounts. Prepares an XML file format. - Path to access : Invoicing/Reporting/Legal Reports/Belgium Statements/Partner VAT Intra + + **Path to access :** Invoicing/Reporting/Legal Reports/Belgium Statements/Partner VAT Intra * Periodical VAT Declaration: Prepares an XML file for Vat Declaration of the Main company of the User currently Logged in. - Path to access : Invoicing/Reporting/Legal Reports/Belgium Statements/Periodical VAT Declaration + + **Path to access :** Invoicing/Reporting/Legal Reports/Belgium Statements/Periodical VAT Declaration * Annual Listing Of VAT-Subjected Customers: Prepares an XML file for Vat Declaration of the Main company of the User currently Logged in Based on Fiscal year. - Path to access : Invoicing/Reporting/Legal Reports/Belgium Statements/Annual Listing Of VAT-Subjected Customers + + **Path to access :** Invoicing/Reporting/Legal Reports/Belgium Statements/Annual Listing Of VAT-Subjected Customers """, 'author': 'Noviat & OpenERP SA', diff --git a/addons/l10n_be_hr_payroll_account/__openerp__.py b/addons/l10n_be_hr_payroll_account/__openerp__.py index 4ad70f9687c..29b3d28a0d4 100644 --- a/addons/l10n_be_hr_payroll_account/__openerp__.py +++ b/addons/l10n_be_hr_payroll_account/__openerp__.py @@ -26,6 +26,7 @@ 'version': '1.0', 'description': """ Accounting Data for Belgian Payroll Rules. +========================================== """, 'auto_install': True, diff --git a/addons/l10n_be_invoice_bba/__openerp__.py b/addons/l10n_be_invoice_bba/__openerp__.py index 9f4efe1b31e..ca045c4f861 100644 --- a/addons/l10n_be_invoice_bba/__openerp__.py +++ b/addons/l10n_be_invoice_bba/__openerp__.py @@ -28,19 +28,19 @@ 'category' : 'Localization', 'description': """ -Belgian localisation for in- and outgoing invoices (prereq to account_coda): +Belgian localization for in- and outgoing invoices (prereq to account_coda): +============================================================================ - Rename 'reference' field labels to 'Communication' - Add support for Belgian Structured Communication -A Structured Communication can be generated automatically on outgoing invoices -according to the following algorithms: - +A Structured Communication can be generated automatically on outgoing invoices according to the following algorithms: +--------------------------------------------------------------------------------------------------------------------- 1) Random : +++RRR/RRRR/RRRDD+++ - R..R = Random Digits, DD = Check Digits + **R..R =** Random Digits, **DD =** Check Digits 2) Date : +++DOY/YEAR/SSSDD+++ - DOY = Day of the Year, SSS = Sequence Number, DD = Check Digits) + **DOY =** Day of the Year, **SSS =** Sequence Number, **DD =** Check Digits 3) Customer Reference +++RRR/RRRR/SSSDDD+++ - R..R = Customer Reference without non-numeric characters, SSS = Sequence Number, DD = Check Digits) + **R..R =** Customer Reference without non-numeric characters, **SSS =** Sequence Number, **DD =** Check Digits The preferred type of Structured Communication and associated Algorithm can be specified on the Partner records. A 'random' Structured Communication will diff --git a/addons/l10n_br/__openerp__.py b/addons/l10n_br/__openerp__.py index 022fa1b6a4d..abc024ca1b7 100644 --- a/addons/l10n_br/__openerp__.py +++ b/addons/l10n_br/__openerp__.py @@ -26,7 +26,7 @@ Base module for the Brazilian localization. =========================================== This module consists in: - +------------------------ - Generic Brazilian chart of accounts - Brazilian taxes such as: diff --git a/addons/l10n_ch/__openerp__.py b/addons/l10n_ch/__openerp__.py index 6de20acf98a..2619e6ef02e 100644 --- a/addons/l10n_ch/__openerp__.py +++ b/addons/l10n_ch/__openerp__.py @@ -21,20 +21,21 @@ {"name" : "Switzerland - Accounting", "description" : """ -Swiss localisation : - - DTA generation for a lot of payment types - - BVR management (number generation, report.) - - Import account move from the bank file (like v11) - - Simplify the way you handle the bank statement for reconciliation +Swiss localization : +==================== + - DTA generation for a lot of payment types + - BVR management (number generation, report.) + - Import account move from the bank file (like v11) + - Simplify the way you handle the bank statement for reconciliation You can also add ZIP and bank completion with: - - l10n_ch_zip - - l10n_ch_bank +---------------------------------------------- + - l10n_ch_zip + - l10n_ch_bank - Author: Camptocamp SA - Donors: Hasa Sàrl, Open Net Sàrl and Prisme Solutions Informatique SA - ------------------------------------------------------------------------- + **Author:** Camptocamp SA + + **Donors:** Hasa Sàrl, Open Net Sàrl and Prisme Solutions Informatique SA Module incluant la localisation Suisse de OpenERP revu et corrigé par Camptocamp. Cette nouvelle version comprend la gestion et l'émissionde BVR, le paiement @@ -43,16 +44,18 @@ et l'import du relevé de compte depuis la banque de manière automatisée. De p nous avons intégré la définition de toutes les banques Suisses(adresse, swift et clearing). Par ailleurs, conjointement à ce module, nous proposons la complétion NPA: - -Vous pouvez ajouter la completion des banques et des NPA avec with: - - l10n_ch_zip - - l10n_ch_bank - - Auteur: Camptocamp SA - Donateurs: Hasa Sàrl, Open Net Sàrl and Prisme Solutions Informatique SA - -------------------------------------------------------------------------- +Vous pouvez ajouter la completion des banques et des NPA avec with: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + - l10n_ch_zip + - l10n_ch_bank + + **Auteur:** Camptocamp SA + + **Donateurs:** Hasa Sàrl, Open Net Sàrl and Prisme Solutions Informatique SA + TODO : +------ - Implement bvr import partial reconciliation - Replace wizard by osv_memory when possible - Add mising HELP diff --git a/addons/l10n_cl/__openerp__.py b/addons/l10n_cl/__openerp__.py index d10acdae575..af04349686e 100644 --- a/addons/l10n_cl/__openerp__.py +++ b/addons/l10n_cl/__openerp__.py @@ -23,7 +23,7 @@ "version": "1.0", "description": """ Chilean accounting chart and tax localization. - +============================================== Plan contable chileno e impuestos de acuerdo a disposiciones vigentes """, diff --git a/addons/l10n_cr/__openerp__.py b/addons/l10n_cr/__openerp__.py index 562af835398..b9168597859 100644 --- a/addons/l10n_cr/__openerp__.py +++ b/addons/l10n_cr/__openerp__.py @@ -44,6 +44,7 @@ Chart of accounts for Costa Rica. ================================= Includes: +--------- * account.type * account.account.template * account.tax.template diff --git a/addons/l10n_es/__openerp__.py b/addons/l10n_es/__openerp__.py index b2897e07748..bcd99fe2c17 100644 --- a/addons/l10n_es/__openerp__.py +++ b/addons/l10n_es/__openerp__.py @@ -37,7 +37,7 @@ Spanish Charts of Accounts (PGCE 2008). * Defines templates for sale and purchase VAT * Defines tax code templates -Note: You should install the l10n_ES_account_balance_report module for yearly +**Note:** You should install the l10n_ES_account_balance_report module for yearly account reporting (balance, profit & losses). """, "license" : "GPL-3", diff --git a/addons/l10n_fr/__openerp__.py b/addons/l10n_fr/__openerp__.py index ec31f71513a..921403b38b4 100644 --- a/addons/l10n_fr/__openerp__.py +++ b/addons/l10n_fr/__openerp__.py @@ -51,7 +51,7 @@ and "service" VAT taxes. We consider that it is too "heavy" to have this by defa in l10n_fr; companies that sell services to DOM-based companies should update the configuration of their taxes and fiscal positions manually. -Credits: Sistheo, Zeekom, CrysaLEAD, Akretion and Camptocamp. +**Credits:** Sistheo, Zeekom, CrysaLEAD, Akretion and Camptocamp. """, "depends" : ['base_iban', 'account', 'account_chart', 'base_vat', 'l10n_fr_rib'], "init_xml" : [], diff --git a/addons/l10n_fr_hr_payroll/__openerp__.py b/addons/l10n_fr_hr_payroll/__openerp__.py index c3b2c332a46..feac3648977 100755 --- a/addons/l10n_fr_hr_payroll/__openerp__.py +++ b/addons/l10n_fr_hr_payroll/__openerp__.py @@ -33,6 +33,7 @@ French Payroll Rules. - New payslip report TODO : +------ - Integration with holidays module for deduction and allowance - Integration with hr_payroll_account for the automatic account_move_line creation from the payslip diff --git a/addons/l10n_fr_rib/__openerp__.py b/addons/l10n_fr_rib/__openerp__.py index fedac46381d..2e1594ed4e0 100644 --- a/addons/l10n_fr_rib/__openerp__.py +++ b/addons/l10n_fr_rib/__openerp__.py @@ -27,12 +27,15 @@ This module lets users enter the banking details of Partners in the RIB format (French standard for bank accounts details). =========================================================================================================================== -RIB Bank Accounts can be entered in the "Accounting" tab of the Partner form by specifying -the account type "RIB". The four standard RIB fields will then become mandatory: +RIB Bank Accounts can be entered in the "Accounting" tab of the Partner form by specifying the account type "RIB". + +The four standard RIB fields will then become mandatory: +-------------------------------------------------------- - Bank Code - Office Code - Account number - RIB key + As a safety measure, OpenERP will check the RIB key whenever a RIB is saved, and will refuse to record the data if the key is incorrect. Please bear in mind that this can only happen when the user presses the "save" button, for example on the diff --git a/addons/l10n_hn/__openerp__.py b/addons/l10n_hn/__openerp__.py index 25655e52e70..1e01a829fa8 100644 --- a/addons/l10n_hn/__openerp__.py +++ b/addons/l10n_hn/__openerp__.py @@ -37,6 +37,9 @@ 'version': '0.1', 'category': 'Localization/Account Charts', 'description': """ +This is the base module to manage the accounting chart for Honduras. +==================================================================== + Agrega una nomenclatura contable para Honduras. También incluye impuestos y la moneda Lempira. -- Adds accounting chart for Honduras. It also includes taxes and the Lempira currency.""", diff --git a/addons/l10n_pe/__openerp__.py b/addons/l10n_pe/__openerp__.py index 7908664ca83..87209b6ab23 100644 --- a/addons/l10n_pe/__openerp__.py +++ b/addons/l10n_pe/__openerp__.py @@ -22,8 +22,8 @@ "name": "Peru Localization Chart Account", "version": "1.0", "description": """ -Peruvian accounting chart and tax localization. Acording the PCGE 2010. - +Peruvian accounting chart and tax localization. According the PCGE 2010. +======================================================================== Plan contable peruano e impuestos de acuerdo a disposiciones vigentes de la SUNAT 2011 (PCGE 2010). diff --git a/addons/l10n_syscohada/__openerp__.py b/addons/l10n_syscohada/__openerp__.py index 2fd6917ec11..878e74dd26e 100644 --- a/addons/l10n_syscohada/__openerp__.py +++ b/addons/l10n_syscohada/__openerp__.py @@ -29,9 +29,13 @@ This module implements the accounting chart for OHADA area. =========================================================== It allows any company or association to manage its financial accounting. + Countries that use OHADA are the following: +------------------------------------------- Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo, + Ivory Coast, Gabon, Guinea, Guinea Bissau, Equatorial Guinea, Mali, Niger, + Replica of Democratic Congo, Senegal, Chad, Togo. """, "website": "http://www.baamtu.com", diff --git a/addons/l10n_uk/__openerp__.py b/addons/l10n_uk/__openerp__.py index 444ea2b9dd3..88113fb100d 100644 --- a/addons/l10n_uk/__openerp__.py +++ b/addons/l10n_uk/__openerp__.py @@ -24,8 +24,8 @@ 'version': '1.0', 'category': 'Localization/Account Charts', 'description': """ -This is the latest UK OpenERP localisation necessary to run OpenERP accounting -for UK SME's with: +This is the latest UK OpenERP localisation necessary to run OpenERP accounting for UK SME's with: +================================================================================================= - a CT600-ready chart of accounts - VAT100-ready tax structure - InfoLogic UK counties listing diff --git a/addons/l10n_us/__openerp__.py b/addons/l10n_us/__openerp__.py index f900c3d5e99..3dff6cbc9c3 100644 --- a/addons/l10n_us/__openerp__.py +++ b/addons/l10n_us/__openerp__.py @@ -25,6 +25,7 @@ "category": 'Localization/Account Charts', "description": """ United States - Chart of accounts. +================================== """, 'website': 'http://www.openerp.com', 'init_xml': [], diff --git a/addons/mail/__openerp__.py b/addons/mail/__openerp__.py index 0e1caabcf65..95b9036403f 100644 --- a/addons/mail/__openerp__.py +++ b/addons/mail/__openerp__.py @@ -26,9 +26,8 @@ "sequence": 2, "summary": "Discussions, Mailing Lists, News", 'description': """ -A business oriented Social Networking with a fully-integrated email -and message management. -===================================================================== +A business oriented Social Networking with a fully-integrated email and message management. +=========================================================================================== The Social Networking module provides an unified social network abstraction layer allowing applications to display a complete @@ -40,6 +39,7 @@ allows to follow documents, and to be constantly updated about recent news. The main features of the module are: +------------------------------------ * a clean and renewed communication history for any OpenERP document that can act as a discussion topic, * a discussion mean on documents, diff --git a/addons/marketing_campaign/__openerp__.py b/addons/marketing_campaign/__openerp__.py index e0cf8b56439..619cb02f392 100644 --- a/addons/marketing_campaign/__openerp__.py +++ b/addons/marketing_campaign/__openerp__.py @@ -35,6 +35,7 @@ This module provides leads automation through marketing campaigns (campaigns can ========================================================================================================================================= The campaigns are dynamic and multi-channels. The process is as follows: +------------------------------------------------------------------------ * Design marketing campaigns like workflows, including email templates to send, reports to print and send by email, custom actions * Define input segments that will select the items that should enter the @@ -49,7 +50,7 @@ The campaigns are dynamic and multi-channels. The process is as follows: While the campaign runs you can of course continue to fine-tune the parameters, input segments, workflow. -Note: If you need demo data, you can install the marketing_campaign_crm_demo +**Note:** If you need demo data, you can install the marketing_campaign_crm_demo module, but this will also install the CRM application as it depends on CRM Leads. """, diff --git a/addons/membership/__openerp__.py b/addons/membership/__openerp__.py index a05240c08e7..c6056358157 100644 --- a/addons/membership/__openerp__.py +++ b/addons/membership/__openerp__.py @@ -29,6 +29,7 @@ This module allows you to manage all operations for managing memberships. ========================================================================= It supports different kind of members: +-------------------------------------- * Free member * Associated member (e.g.: a group subscribes to a membership for all subsidiaries) * Paid members diff --git a/addons/mrp_operations/__openerp__.py b/addons/mrp_operations/__openerp__.py index 25446456dec..b585ff718f7 100644 --- a/addons/mrp_operations/__openerp__.py +++ b/addons/mrp_operations/__openerp__.py @@ -33,11 +33,13 @@ When finishing/confirming, cancelling manufacturing orders set all state lines to the according state. Create menus: - Manufacturing > Manufacturing > Work Orders +------------- + **Manufacturing** > **Manufacturing** > **Work Orders** Which is a view on "Work Orders" lines in manufacturing order. Add buttons in the form view of manufacturing order under workorders tab: +------------------------------------------------------------------------- * start (set state to confirm), set date_start * done (set state to done), set date_stop * set to draft (set state to draft) diff --git a/addons/mrp_repair/__openerp__.py b/addons/mrp_repair/__openerp__.py index c54a0c383ee..7cde9d3dcd4 100644 --- a/addons/mrp_repair/__openerp__.py +++ b/addons/mrp_repair/__openerp__.py @@ -29,6 +29,7 @@ The aim is to have a complete module to manage all products repairs. ==================================================================== The following topics should be covered by this module: +------------------------------------------------------ * Add/remove products in the reparation * Impact for stocks * Invoicing (products and/or services) diff --git a/addons/mrp_subproduct/__openerp__.py b/addons/mrp_subproduct/__openerp__.py index 793d0f104e0..939a7170407 100644 --- a/addons/mrp_subproduct/__openerp__.py +++ b/addons/mrp_subproduct/__openerp__.py @@ -31,9 +31,11 @@ This module allows you to produce several products from one production order. You can configure sub-products in the bill of material. Without this module: +-------------------- A + B + C -> D With this module: +----------------- A + B + C -> D + E """, 'author': 'OpenERP SA', diff --git a/addons/pad_project/__openerp__.py b/addons/pad_project/__openerp__.py index 3f4a279800a..9aaa63d95d3 100644 --- a/addons/pad_project/__openerp__.py +++ b/addons/pad_project/__openerp__.py @@ -25,6 +25,7 @@ "category": "Project Management", 'description': """ This module adds a PAD in all project kanban views. +=================================================== """, 'author': 'OpenERP SA', 'website': 'http://www.openerp.com', diff --git a/addons/plugin/__openerp__.py b/addons/plugin/__openerp__.py index 801e0571c58..a9008612ca1 100644 --- a/addons/plugin/__openerp__.py +++ b/addons/plugin/__openerp__.py @@ -26,6 +26,7 @@ 'category': 'Hidden/Dependency', 'description': """ The common interface for plug-in. +================================= """, 'author': 'OpenERP SA', 'website': 'http://www.openerp.com', diff --git a/addons/portal/__openerp__.py b/addons/portal/__openerp__.py index 283e007a598..7e8f05f9b88 100644 --- a/addons/portal/__openerp__.py +++ b/addons/portal/__openerp__.py @@ -31,7 +31,7 @@ 'category': 'Portal', 'description': """ Customize access to your OpenERP database to external users by creating portals. - +================================================================================ A portal defines a specific user menu and access rights for its members. This menu can ben seen by portal members, anonymous users and any other user that have the access to technical features (e.g. the administrator). diff --git a/addons/portal_claim/__openerp__.py b/addons/portal_claim/__openerp__.py index 197227cc45f..9f9e4b9157c 100644 --- a/addons/portal_claim/__openerp__.py +++ b/addons/portal_claim/__openerp__.py @@ -26,8 +26,8 @@ 'category': 'Tools', 'complexity': "easy", 'description': """ -This module adds claim menu and features to your portal if claim and portal are -installed. +This module adds claim menu and features to your portal if claim and portal are installed. +========================================================================================== """, 'author': 'OpenERP SA', 'depends': ['crm_claim','portal'], diff --git a/addons/portal_crm/__openerp__.py b/addons/portal_crm/__openerp__.py index 4fe023ccb48..d03a72b240e 100644 --- a/addons/portal_crm/__openerp__.py +++ b/addons/portal_crm/__openerp__.py @@ -26,8 +26,8 @@ 'category': 'Tools', 'complexity': "easy", 'description': """ -This module adds a contact page (with a contact form creating a lead when -submitted) to your portal if crm and portal are installed. +This module adds a contact page (with a contact form creating a lead when submitted) to your portal if crm and portal are installed. +==================================================================================================================================== """, 'author': 'OpenERP SA', 'depends': ['crm','portal'], diff --git a/addons/portal_event/__openerp__.py b/addons/portal_event/__openerp__.py index 2f5220c9f36..ddb881d2681 100644 --- a/addons/portal_event/__openerp__.py +++ b/addons/portal_event/__openerp__.py @@ -26,8 +26,8 @@ 'category': 'Tools', 'complexity': "easy", 'description': """ -This module adds event menu and features to your portal if event and portal are -installed. +This module adds event menu and features to your portal if event and portal are installed. +========================================================================================== """, 'author': 'OpenERP SA', 'depends': ['event','portal'], diff --git a/addons/portal_hr_employees/__openerp__.py b/addons/portal_hr_employees/__openerp__.py index ec883e78acf..33a988ead5e 100644 --- a/addons/portal_hr_employees/__openerp__.py +++ b/addons/portal_hr_employees/__openerp__.py @@ -26,8 +26,8 @@ 'category': 'Tools', 'complexity': "easy", 'description': """ -This module adds a list of employees to your portal's contact page if hr and -portal_crm (which creates the contact page) are installed. +This module adds a list of employees to your portal's contact page if hr and portal_crm (which creates the contact page) are installed. +======================================================================================================================================= """, 'author': 'OpenERP SA', 'depends': ['hr','portal_crm'], diff --git a/addons/portal_project/__openerp__.py b/addons/portal_project/__openerp__.py index 4f8774bf99e..a782e202558 100644 --- a/addons/portal_project/__openerp__.py +++ b/addons/portal_project/__openerp__.py @@ -26,8 +26,8 @@ 'category': 'Tools', 'complexity': "easy", 'description': """ -This module adds project menu and features (tasks) to your portal if project -and portal are installed. +This module adds project menu and features (tasks) to your portal if project and portal are installed. +====================================================================================================== """, 'author': 'OpenERP SA', 'depends': ['project','portal'], diff --git a/addons/portal_project_issue/__openerp__.py b/addons/portal_project_issue/__openerp__.py index 17ba4b0d5aa..1aebdb472c9 100644 --- a/addons/portal_project_issue/__openerp__.py +++ b/addons/portal_project_issue/__openerp__.py @@ -26,8 +26,8 @@ 'category': 'Tools', 'complexity': "easy", 'description': """ -This module adds issue menu and features to your portal if project_issue and -portal are installed. +This module adds issue menu and features to your portal if project_issue and portal are installed. +================================================================================================== """, 'author': 'OpenERP SA', 'depends': ['project_issue','portal'], diff --git a/addons/portal_sale/__openerp__.py b/addons/portal_sale/__openerp__.py index f87bebd19fd..99e6e83c59b 100644 --- a/addons/portal_sale/__openerp__.py +++ b/addons/portal_sale/__openerp__.py @@ -26,8 +26,8 @@ 'category': 'Tools', 'complexity': "easy", 'description': """ -This module adds sale menu and features to your portal if sale and portal are -installed. +This module adds sale menu and features to your portal if sale and portal are installed. +======================================================================================== """, 'author': 'OpenERP SA', 'depends': ['sale','portal'], diff --git a/addons/process/__openerp__.py b/addons/process/__openerp__.py index 657aee868b2..39dca254d58 100644 --- a/addons/process/__openerp__.py +++ b/addons/process/__openerp__.py @@ -28,8 +28,9 @@ This module shows the basic processes involved in the selected modules and in the sequence they occur. ====================================================================================================== -Note: This applies to the modules containing modulename_process.xml. -e.g product/process/product_process.xml. +**Note:** This applies to the modules containing modulename_process.xml. + +**e.g.** product/process/product_process.xml. """, 'author': 'OpenERP SA', diff --git a/addons/product/__openerp__.py b/addons/product/__openerp__.py index 5ade1a1a66b..87d013a63a5 100644 --- a/addons/product/__openerp__.py +++ b/addons/product/__openerp__.py @@ -36,6 +36,7 @@ Products support variants, different pricing methods, suppliers information, make to stock/order, different unit of measures, packaging and properties. Pricelists support: +------------------- * Multiple-level of discount (by product, category, quantities) * Compute price based on different criteria: * Other pricelist diff --git a/addons/product_expiry/__openerp__.py b/addons/product_expiry/__openerp__.py index 29e30bf380d..9188137c7a6 100644 --- a/addons/product_expiry/__openerp__.py +++ b/addons/product_expiry/__openerp__.py @@ -30,6 +30,7 @@ Track different dates on products and production lots. ====================================================== Following dates can be tracked: +------------------------------- - end of life - best before date - removal date diff --git a/addons/product_manufacturer/__openerp__.py b/addons/product_manufacturer/__openerp__.py index 98cf8d2d8de..7ac86b3c743 100644 --- a/addons/product_manufacturer/__openerp__.py +++ b/addons/product_manufacturer/__openerp__.py @@ -30,6 +30,7 @@ A module that adds manufacturers and attributes on the product form. ==================================================================== You can now define the following for a product: +----------------------------------------------- * Manufacturer * Manufacturer Product Name * Manufacturer Product Code diff --git a/addons/product_visible_discount/__openerp__.py b/addons/product_visible_discount/__openerp__.py index 0bba2cca4ac..c3e5204bb5e 100644 --- a/addons/product_visible_discount/__openerp__.py +++ b/addons/product_visible_discount/__openerp__.py @@ -28,7 +28,7 @@ This module lets you calculate discounts on Sale Order lines and Invoice lines b To this end, a new check box named "Visible Discount" is added to the pricelist form. -Example: +**Example:** For the product PC1 and the partner "Asustek": if listprice=450, and the price calculated using Asustek's pricelist is 225. If the check box is checked, we will have on the sale order line: Unit price=450, Discount=50,00, Net price=225. diff --git a/addons/project_mailgate/__openerp__.py b/addons/project_mailgate/__openerp__.py index 656a091d4e8..e6861c27ebb 100644 --- a/addons/project_mailgate/__openerp__.py +++ b/addons/project_mailgate/__openerp__.py @@ -36,6 +36,7 @@ Allows creating tasks based on new emails arriving at a given mailbox, similarly to what the CRM application has for Leads/Opportunities. There are two common alternatives to configure the mailbox integration: +----------------------------------------------------------------------- * Install the ``fetchmail`` module and configure a new mailbox, then select ``Project Tasks`` as the target for incoming emails. * Set it up manually on your mail server based on the 'mail gateway' script diff --git a/addons/report_webkit/__openerp__.py b/addons/report_webkit/__openerp__.py index 1021d129d39..9316713348f 100644 --- a/addons/report_webkit/__openerp__.py +++ b/addons/report_webkit/__openerp__.py @@ -38,6 +38,7 @@ This module adds a new Report Engine based on WebKit library (wkhtmltopdf) to su The module structure and some code is inspired by the report_openoffice module. The module allows: +------------------ - HTML report definition - Multi header support - Multi logo @@ -56,7 +57,7 @@ For a sample report see also the webkit_report_sample module, and this video: http://files.me.com/nbessi/06n92k.mov Requirements and Installation: ------------------------------ +------------------------------ This module requires the ``wkthtmltopdf`` library to render HTML documents as PDF. Version 0.9.9 or later is necessary, and can be found at http://code.google.com/p/wkhtmltopdf/ for Linux, Mac OS X (i386) and Windows (32bits). diff --git a/addons/sale/__openerp__.py b/addons/sale/__openerp__.py index b6be6f7b1e3..698cc3e3416 100644 --- a/addons/sale/__openerp__.py +++ b/addons/sale/__openerp__.py @@ -31,7 +31,7 @@ The base module to manage quotations and sales orders. Workflow with validation steps: ------------------------------- - * Quotation -> Sales order -> Invoice + * **Quotation** -> **Sales order** -> **Invoice** Create Invoice: --------------- @@ -46,10 +46,10 @@ Partners preferences: * Invoicing Products stocks and prices: --------------------------- +--------------------------- Delivery method: ------------------ +---------------- * The Poste * Free Delivery Charges * Normal Delivery Charges diff --git a/addons/sale_journal/__openerp__.py b/addons/sale_journal/__openerp__.py index 11408161bf4..3030ad0c4d8 100644 --- a/addons/sale_journal/__openerp__.py +++ b/addons/sale_journal/__openerp__.py @@ -30,17 +30,19 @@ The sales journal modules allows you to categorise your sales and deliveries (pi This module is very helpful for bigger companies that works by departments. You can use journal for different purposes, some examples: +---------------------------------------------------------- * isolate sales of different departments * journals for deliveries by truck or by UPS Journals have a responsible and evolves between different status: +----------------------------------------------------------------- * draft, open, cancel, done. Batch operations can be processed on the different journals to confirm all sales at once, to validate or invoice packing. -It also supports batch invoicing methods that can be configured by partners and -sales orders, examples: +It also supports batch invoicing methods that can be configured by partners and sales orders, examples: +------------------------------------------------------------------------------------------------------- * daily invoicing * monthly invoicing diff --git a/addons/sale_order_dates/__openerp__.py b/addons/sale_order_dates/__openerp__.py index f5ccef7ffe5..fc115796864 100644 --- a/addons/sale_order_dates/__openerp__.py +++ b/addons/sale_order_dates/__openerp__.py @@ -29,6 +29,7 @@ Add additional date information to the sales order. =================================================== You can add the following additional dates to a sale order: +----------------------------------------------------------- * Requested Date * Commitment Date * Effective Date diff --git a/addons/stock/__openerp__.py b/addons/stock/__openerp__.py index 55d9c7c6c5a..1e71239e86c 100644 --- a/addons/stock/__openerp__.py +++ b/addons/stock/__openerp__.py @@ -29,6 +29,7 @@ OpenERP Inventory Management module can manage multi-warehouses, multi and struc ====================================================================================================== Thanks to the double entry management, the inventory controlling is powerful and flexible: +------------------------------------------------------------------------------------------ * Moves history and planning, * Stock valuation (standard or average price, ...) * Robustness faced with Inventory differences diff --git a/addons/stock_location/__openerp__.py b/addons/stock_location/__openerp__.py index db2858bb44a..a9c2b3f0114 100644 --- a/addons/stock_location/__openerp__.py +++ b/addons/stock_location/__openerp__.py @@ -29,12 +29,13 @@ This module supplements the Warehouse application by effectively implementing Pu ============================================================================================================ Typically this could be used to: +-------------------------------- * Manage product manufacturing chains * Manage default locations per product * Define routes within your warehouse according to business needs, such as: - - Quality Control - - After Sales Services - - Supplier Returns + - Quality Control + - After Sales Services + - Supplier Returns * Help rental management, by generating automated return moves for rented products @@ -84,9 +85,10 @@ Use-Case: --------- You can use the demo data as follow: - CPU1: Sell some CPU1 from Chicago Shop and run the scheduler +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + **CPU1:** Sell some CPU1 from Chicago Shop and run the scheduler - Warehouse: delivery order, Chicago Shop: reception - CPU3: + **CPU3:** - When receiving the product, it goes to Quality Control location then stored to shelf 2. - When delivering the customer: Pick List -> Packing -> Delivery Order from Gate A diff --git a/addons/stock_planning/__openerp__.py b/addons/stock_planning/__openerp__.py index f83aa11ef63..d671e59308b 100644 --- a/addons/stock_planning/__openerp__.py +++ b/addons/stock_planning/__openerp__.py @@ -46,17 +46,20 @@ Forecast" and "Stock Planning" to emphasize that we use quantity values. Where to begin: --------------- Using this module is done in three steps: - * Create Stock Periods via the Warehouse>Configuration>Stock Periods menu +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + * Create Stock Periods via the **Warehouse** > **Configuration** > **Stock Periods** menu (Mandatory step) * Create Sale Forecasts fill them with forecast quantities, via the - Sales > Sales Forecast menu. (Optional step but useful for further planning) + **Sales** > **Sales Forecast** menu. (Optional step but useful for further planning) * Create the actual MPS plan, check the balance and trigger the procurements as required. The actual procurement is the final step for the Stock Period. Stock Period configuration: --------------------------- -You have two menu items for Periods in "Warehouse > Configuration > Stock Periods". +You have two menu items for Periods in "**Warehouse** > **Configuration** > **Stock Periods**". + There are: +~~~~~~~~~~ * "Create Stock Periods" - can automatically creating daily, weekly or monthly periods. * "Stock Periods" - allows to create any type of periods, change the dates @@ -67,6 +70,7 @@ button in "Stock Periods", but it is recommended to use the automatic assistant "Create Stock Periods". Remarks: +++++++++ - These periods (Stock Periods) are completely distinct from Financial or other periods in the system. - Periods are not assigned to companies (when you use multicompany). Module @@ -86,7 +90,8 @@ Remarks: Sales Forecasts configuration: ------------------------------ -You have few menus for Sales forecast in "Sales > Sales Forecasts": +You have few menus for Sales forecast in "**Sales** > **Sales Forecasts**": +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - "Create Sales Forecasts" - can automatically create forecast lines according to your needs - "Sales Forecasts" - for managing the Sales forecasts @@ -96,6 +101,7 @@ Category, for selected Period and for selected Warehouse. It is also possible to copy the previous forecast. Remarks: +++++++++ - This tool doesn't duplicate lines if you already have an entry for the same Product, Period, Warehouse, created or validated by the same user. If you wish to create another forecast, if relevant lines exists you have to do it @@ -130,8 +136,9 @@ MPS or Procurement Planning: ---------------------------- An MPS planning consists in Stock Planning lines, used to analyze and possibly drive the procurement of products for each relevant Stock Period and Warehouse. -The menu is located in "Warehouse > Schedulers > Master Procurement Schedule": +The menu is located in "**Warehouse** > **Schedulers** > **Master Procurement Schedule**": +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - "Create Stock Planning Lines" - a wizard to help automatically create many planning lines - "Master Procurement Schedule" - management of your planning lines @@ -186,14 +193,14 @@ Computation of Stock Simulation quantities: The Stock Simulation value is the estimated stock quantity at the end of the period. The calculation always starts with the real stock on hand at the beginning of the current period, then adds or subtracts the computed quantities. -When you are in the same period (current period is the same as calculated) Stock -Simulation is calculated as follows: -Stock Simulation = Stock of beginning of current Period - Planned Out + Planned In +When you are in the same period (current period is the same as calculated) Stock Simulation is calculated as follows: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Stock Simulation =** Stock of beginning of current Period - Planned Out + Planned In When you calculate period next to current: - -Stock Simulation = Stock of beginning of current Period - Planned Out of current Period +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Stock Simulation =** Stock of beginning of current Period - Planned Out of current Period + Confirmed In of current Period (incl. Already In) - Planned Out of calculated Period + Planned In of calculated Period . @@ -204,8 +211,8 @@ that you should complete the planning and procurement of the current Period befo going to the next one. When you plan for future Periods: - -Stock Simulation = Stock of beginning of current Period +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Stock Simulation =** Stock of beginning of current Period - Sum of Planned Out of Periods before calculated + Sum of Confirmed In of Periods before calculated (incl. Already In) - Planned Out of calculated Period @@ -215,7 +222,7 @@ Here "Periods before calculated" designates all periods starting with the curren until the period before the one being calculated. Remarks: - +++++++++ - Remember to make the proceed with the planning of each period in chronological order, otherwise the numbers will not reflect the reality - If you planned for future periods and find that real Confirmed Out is larger diff --git a/addons/subscription/__openerp__.py b/addons/subscription/__openerp__.py index 3a4220efe52..17a37805961 100644 --- a/addons/subscription/__openerp__.py +++ b/addons/subscription/__openerp__.py @@ -31,6 +31,7 @@ Create recurring documents. This module allows to create new documents and add subscriptions on that document. e.g. To have an invoice generated automatically periodically: +------------------------------------------------------------- * Define a document type based on Invoice object * Define a subscription whose source document is the document defined as above. Specify the interval information and partner to be invoice. diff --git a/addons/web_linkedin/__openerp__.py b/addons/web_linkedin/__openerp__.py index 122453d6096..614055899a4 100644 --- a/addons/web_linkedin/__openerp__.py +++ b/addons/web_linkedin/__openerp__.py @@ -5,8 +5,9 @@ 'complexity': "easy", "description": """ - OpenERP Web LinkedIn module. - This module provides the Integration of the LinkedIn with OpenERP. +OpenERP Web LinkedIn module. +============================ +This module provides the Integration of the LinkedIn with OpenERP. """, 'update_xml': [ 'web_linkedin_view.xml', diff --git a/addons/web_shortcuts/__openerp__.py b/addons/web_shortcuts/__openerp__.py index b587215a501..51b28957307 100644 --- a/addons/web_shortcuts/__openerp__.py +++ b/addons/web_shortcuts/__openerp__.py @@ -27,6 +27,7 @@ Enable shortcuts feature in the web client. =========================================== Add a Shortcut icon in the systray in order to access the user's shortcuts (if any). + Add a Shortcut icon besides the views title in order to add/remove a shortcut. """, 'author': 'OpenERP SA', From 71104d2c2055b773074404addf6437c7e2cf517b Mon Sep 17 00:00:00 2001 From: help <> Date: Tue, 21 Aug 2012 10:42:46 +0530 Subject: [PATCH 2/2] [IMP]stock_planning:improved module description for removing error bzr revid: help-20120821051246-cd4nafp5myiuhw09 --- addons/stock_planning/__openerp__.py | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/addons/stock_planning/__openerp__.py b/addons/stock_planning/__openerp__.py index d671e59308b..01844098364 100644 --- a/addons/stock_planning/__openerp__.py +++ b/addons/stock_planning/__openerp__.py @@ -200,9 +200,7 @@ When you are in the same period (current period is the same as calculated) Stock When you calculate period next to current: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**Stock Simulation =** Stock of beginning of current Period - Planned Out of current Period - + Confirmed In of current Period (incl. Already In) - Planned Out of calculated Period - + Planned In of calculated Period . +**Stock Simulation =** Stock of beginning of current Period - Planned Out of current Period + Confirmed In of current Period (incl. Already In) - Planned Out of calculated Period + Planned In of calculated Period . As you see the calculated Period is taken the same way as in previous case, but the calculation in the current Period is a little bit different. First you should @@ -212,11 +210,7 @@ going to the next one. When you plan for future Periods: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**Stock Simulation =** Stock of beginning of current Period - - Sum of Planned Out of Periods before calculated - + Sum of Confirmed In of Periods before calculated (incl. Already In) - - Planned Out of calculated Period - + Planned In of calculated Period. +**Stock Simulation =** Stock of beginning of current Period - Sum of Planned Out of Periods before calculated + Sum of Confirmed In of Periods before calculated (incl. Already In) - Planned Out of calculated Period + Planned In of calculated Period. Here "Periods before calculated" designates all periods starting with the current until the period before the one being calculated.