You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Martin Trigaux 17fc4219bd
[ADD] searchbar based on Sphinx search tool
1 年之前
.tx [I18N] export 11.0 source terms 1 年之前
_extensions [ADD] searchbar based on Sphinx search tool 3 天之前
_static [FIX] accounts unbalanced in continental accounting for stock transactions 1 月之前
accounting [FIX] accounting: foreign currency 3 週之前
crm [FIX] crm: Fix typo in acquire_leads.rst 1 年之前
db_management [IMP] db_management: update screenshot to v11 uninstall wizard 1 年之前
discuss [FIX] discuss : typos + wording and wrong link email_servers 1 年之前
ecommerce [FIX] paypal: documentation for EWP (#396) 1 月之前
expense [IMP] expense: Update doc flow to v11 2 年之前
general [IMP] crm: Whole documentation overhaul 1 年之前
getting_started [FIX] getting_started/documentation: dead link 1 月之前
helpdesk [ADD] helpdesk: Record and invoice time for tickets 1 年之前
inventory [MERGE] Forward-port of 10.0 up to 2a17601b52c80e8e52bd5916fe1d16fa91326bd1 3 週之前
legal [FIX] legal: typo in partnership contract 2 月之前
livechat [FIX] livechat: Display options in bold 1 年之前
locale [I18N] Update translation terms from Transifex 2 週之前
manufacturing [FIX] manufacturing : bill of material fix wrong direction 1 年之前
mobile [ADD] mobile: Setup your Firebase Cloud Messaging 1 年之前
odoo_sh [FIX] odoo_sh: typo 1 月之前
point_of_sale [FIX] point_of_sale: POSBoxless 5 月之前
portal [ADD]Documentation: added new section eplaining My Account 1 年之前
project [FIX] project: update link to non-existant section 1 年之前
purchase [FIX] purchase: remove reference to old page 4 月之前
sales [IMP] sale: Rewrite the 'Invoicing Method' subsection 1 年之前
website Update SSL doc for the saas 1 月之前
.gitignore [FIX] a pair of leftover warnings 1 年之前
Makefile [IMP] latex: copy PDF files next to HTML output 3 年之前
README.rst [IMP] README bits 4 年之前
accounting.rst [ADD] accounting: Switzerland Accounting Localization 2 年之前
applications.rst [MERGE] Forward-port of 10.0 up to 2a17601b52c80e8e52bd5916fe1d16fa91326bd1 3 週之前
business.rst [FIX] mementoes: Fix some terms/computation/links 2 年之前
conf.py [IMP] legal: backport latest changes from 12.0 2 月之前
crm.rst [IMP] crm: Whole documentation overhaul 1 年之前
discuss.rst [ADD] discuss: Get organized by planning activities 1 年之前
ecommerce.rst [ADD] ecommerce: New app section 3 年之前
general.rst [ADD] general: How to allow users to sign in with their Google account 2 年之前
helpdesk.rst [ADD] helpdesk: Record and invoice time for tickets 1 年之前
index.rst [ADD] link to business memento 2 年之前
inventory.rst [IMP] inventory: make the structure consistent with the 'Odoo 9 Documentation' spreadsheet 4 年之前
legal.rst [IMP] legal: backport latest changes from 12.0 2 月之前
manufacturing.rst [IMP] manufacturing: Restructure pages 1 年之前
point_of_sale.rst [ADD] point_of_sale: belgian fiscal data module documentation 3 年之前
practical.rst [ADD]Documentation: added new section eplaining My Account 1 年之前
project.rst [IMP] Remove empty pages from TOCs 3 年之前
purchase.rst [ADD] purchase: How to setup a minimum stock rule? 4 年之前
sales.rst [ADD] sales: Use quotation templates 1 年之前
website.rst [ADD] website: How to track your traffic through Google Analytics 3 年之前

README.rst

===========================
End-user Odoo documentation
===========================

Building requirements:

* Python 2.7
* recent `Sphinx <http://sphinx-doc.org>`_ (at least Sphinx 1.2)

you can check if Sphinx is installed by trying to launch

.. code-block:: console

$ sphinx-build --version

See `the sphinx documentation <http://sphinx-doc.org/install.html>`_
for local installation instructions.
* `git <http://www.git-scm.com>`_
* clone this repository using git, then at the root of the repository,
in a console,

.. code-block:: console

$ make html

this should compile the documentation to HTML, and put the generated
HTML in ``_build/html/index.html``.

Contributions
=============

For simple edition (typo, just add paragraphs of text without markup),
the Github web interface can be used directly.

For more complex edition, to add images or advanced directives, edit
locally. **Do not commit if there are warnings or errors when building
the documentation** fix them first. rST is fairly sensitive to
whitespace and newlines (especially the lack of newlines). It's a bit
annoying but it's not hard to learn.

Issues can be reported on the repository's bug tracker as usual.

Custom features
===============

Extensions
----------

Two custom directives are provided for integration with Odoo's demo
system:

* ``demo:fields:: {external_id}`` lists all the fields with a
tooltip (``help``) of the action whose ``external_id`` is provided.

- Uses the ``form`` view by default, can be customized by specifying
``:view:``.
- The list of fields displayed can be filtered with ``:only:`` which
should be a list of space-separated fields to display. Note that
this will further reduce the number of fields displayed, it will
not force fields to be listed when they don't have a ``help``.

.. code-block:: restructuredtext

.. demo:fields:: account_asset.action_account_asset_asset_list_normal_sale
:only: name

will display a table of just the ``name`` field and its ``help`` (or
nothing if the ``name`` field does not have a ``help``)

* ``demo:action:: {external_id}`` will create a link button to the
action (specified by external id) on the demo site. The text of the
button should be provided as the directive's content:

.. code-block:: restructuredtext

.. demo:action:: account_asset.action_account_asset_asset_list_normal_sale

View *Asset Types*

Theme Customisations
--------------------

* The Odoo theme supports *Banner Images* at the top of
documents. These banners are configured by setting a ``:banner:``
field at the top of the document (before the page title), the banner
images will be looked up in the ``_static`` folder at the root of
the project

.. code-block:: restructuredtext

:banner: banners/accounting.png

==========
Accounting
==========

[...]

.. warning::

because banners are wide images and each page may have one, it is
strongly recommended to compress them well. For PNG, use
`pngquant <https://pngquant.org>`_ (or a UI to it) to reduce the
number of colors in the image followed by regular PNG
recompression tools like `pngcrush
<http://pmt.sourceforge.net/pngcrush/>`_ and `pngout
<http://www.advsys.net/ken/util/pngout.htm>`_.



Importing existing documents
============================

For documents which already exist in an other format or in Google
docs, it's possible to get a head-start by converting the existing
document using `Pandoc <http://pandoc.org>`_. The main issue is that
anything but trivial original documents will need fixing up (possibly
lots of it) to get *good* rST (or possibly working rST at all).

Example::

pandoc -f docx -t rst path/to/document.docx -o new_doc.rst --extract-media=.

will convert ``path/to/document.docx`` to ``new_doc.rst`` and export
all images to ``./media`` (and link them from the document). While
there are issues with the exported document, it's much more convenient
than manually re-typing the original.