Skip to content

Commit

Permalink
account_brand: Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bosd committed Jan 6, 2025
1 parent 9d55282 commit e7f69d5
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 21 deletions.
26 changes: 18 additions & 8 deletions account_brand/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,18 @@ report.
Configuration
=============

To configure this module, please refer to the documentation of
`brand <https://github.com/OCA/brand/blob/12.0/brand/README.rst>`__. It
is important to note that if the brand type is not configured in the
Users & Companies settings, the field will not be visible in the invoice
view.
It is important to note that the "brand use level" **should** be set to
``Optional`` or ``Required``. The brand use level is configured in the
Users & Companies settings. By default it is set to 'Do not use brands
on business document'. Then the field to select a brand on the invoice
view will not be available.

To change the "brand use level":

#. Go to Settings > General Settings #. Select the brand use level, the
following options are available:
``Do not use brands on business document`` (Default) ``Optional``
``Required``

Usage
=====
Expand All @@ -54,10 +61,12 @@ To use this module, you need to:
1. Go to Accounting > Customers > Invoices
2. Select or create an invoice
3. Enter the information and select the brand
4. Print the PDF report. It includes the information of the brand.
4. Print the PDF report. It includes the style and information of the
brand.

To do point 4, the Brand External Report Layout OCA module must be
installed.
To do point 4, the `Brand External Report
Layout <https://github.com/OCA/brand/tree/18.0/brand_external_report_layout/README.rst>`__
OCA module must be installed.

Bug Tracker
===========
Expand Down Expand Up @@ -89,6 +98,7 @@ Contributors
- Vicent Cubells

- Ammar Officewala <[email protected]>
- bosd <<[email protected]>

Other credits
-------------
Expand Down
15 changes: 12 additions & 3 deletions account_brand/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
To configure this module, please refer to the documentation of
[brand](https://github.com/OCA/brand/blob/12.0/brand/README.rst).
It is important to note that if the brand type is not configured in the Users & Companies settings, the field will not be visible in the invoice view.
It is important to note that the "brand use level" **should** be set to `Optional` or `Required`.
The brand use level is configured in the Users & Companies settings.
By default it is set to 'Do not use brands on business document'.
Then the field to select a brand on the invoice view will not be available.

To change the "brand use level":

#. Go to Settings > General Settings
#. Select the brand use level, the following options are available:
`Do not use brands on business document` (Default)
`Optional`
`Required`
1 change: 1 addition & 0 deletions account_brand/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
- [Obertix](https://www.obertix.net):
- Vicent Cubells
- Ammar Officewala \<<[email protected]>\>
- bosd \<<[email protected]\>
4 changes: 2 additions & 2 deletions account_brand/readme/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ To use this module, you need to:
1. Go to Accounting \> Customers \> Invoices
2. Select or create an invoice
3. Enter the information and select the brand
4. Print the PDF report. It includes the information of the brand.
4. Print the PDF report. It includes the style and information of the brand.

To do point 4, the Brand External Report Layout OCA module must be installed.
To do point 4, the [Brand External Report Layout](https://github.com/OCA/brand/tree/18.0/brand_external_report_layout/README.rst) OCA module must be installed.
24 changes: 16 additions & 8 deletions account_brand/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -390,11 +390,16 @@ <h1 class="title">Account Brand</h1>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p>To configure this module, please refer to the documentation of
<a class="reference external" href="https://github.com/OCA/brand/blob/12.0/brand/README.rst">brand</a>. It
is important to note that if the brand type is not configured in the
Users &amp; Companies settings, the field will not be visible in the invoice
view.</p>
<p>It is important to note that the “brand use level” <strong>should</strong> be set to
<tt class="docutils literal">Optional</tt> or <tt class="docutils literal">Required</tt>. The brand use level is configured in the
Users &amp; Companies settings. By default it is set to ‘Do not use brands
on business document’. Then the field to select a brand on the invoice
view will not be available.</p>
<p>To change the “brand use level”:</p>
<p>#. Go to Settings &gt; General Settings #. Select the brand use level, the
following options are available:
<tt class="docutils literal">Do not use brands on business document</tt> (Default) <tt class="docutils literal">Optional</tt>
<tt class="docutils literal">Required</tt></p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
Expand All @@ -403,10 +408,12 @@ <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
<li>Go to Accounting &gt; Customers &gt; Invoices</li>
<li>Select or create an invoice</li>
<li>Enter the information and select the brand</li>
<li>Print the PDF report. It includes the information of the brand.</li>
<li>Print the PDF report. It includes the style and information of the
brand.</li>
</ol>
<p>To do point 4, the Brand External Report Layout OCA module must be
installed.</p>
<p>To do point 4, the <a class="reference external" href="https://github.com/OCA/brand/tree/18.0/brand_external_report_layout/README.rst">Brand External Report
Layout</a>
OCA module must be installed.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
Expand Down Expand Up @@ -436,6 +443,7 @@ <h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
</ul>
</li>
<li>Ammar Officewala &lt;<a class="reference external" href="mailto:aofficewala&#64;opensourceintegrators.com">aofficewala&#64;opensourceintegrators.com</a>&gt;</li>
<li>bosd &lt;&lt;<a class="reference external" href="mailto:c5e2fd43-d292-4c90-9d1f-74ff3436329a&#64;anonaddy.me">c5e2fd43-d292-4c90-9d1f-74ff3436329a&#64;anonaddy.me</a>&gt;</li>
</ul>
</div>
<div class="section" id="other-credits">
Expand Down

0 comments on commit e7f69d5

Please sign in to comment.