Skip to content

Commit

Permalink
[IMP] account_journal_dashboard_statement_button: improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rrebollo committed Dec 16, 2024
1 parent e060f39 commit 7fcc69b
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 35 deletions.
28 changes: 11 additions & 17 deletions account_journal_dashboard_statement_button/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,7 @@ Account Journal Dashboard Statement Button

|badge1| |badge2| |badge3| |badge4| |badge5|

This module enhances the Account Journal Dashboard by introducing a
shortcut button for Bank and Cash journals. The button provides a direct
link to the Bank Statements view, streamlining access to statement
management.
This module enhances the Account Journal Dashboard by introducing a shortcut button for Bank and Cash journals. The button provides a direct link to the Bank Statements view, streamlining access to statement management.

**Table of contents**

Expand All @@ -41,19 +38,17 @@ management.
Use Cases / Context
===================

The purpose is to make the transition to newer versions smoother for
users coming from older versions like v14, where clicking on the journal
name previously led to the Statements view.
In the default (vanilla) behavior of Odoo CE, when a user clicks on the name of a Bank or Cash journal in the Accounting dashboard, they are redirected to the Statements view. However, this behavior changes when installing the OCA Reconcile add-ons or using Odoo EE.

This module offers an alternative by adding a **Statements** button directly into the journal card, providing users with a one-click option to access the Statements view. This approach ensures that users can maintain the familiar workflow of quickly accessing the Statements view, even when other customizations or versions are in place, without altering the default functionality.

Usage
=====

The Statement button will only appear once there are records linked to
the corresponding journal.

|Account Journal Dashboard|
The Statement button will only appear once there are records linked to the corresponding journal.

.. |Account Journal Dashboard| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_journal_dashboard_statement_button/static/img/account_journal_dashboard.png
.. image:: https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_journal_dashboard_statement_button/static/img/account_journal_dashboard.png
:alt: Account Journal Dashboard

Bug Tracker
===========
Expand All @@ -69,19 +64,18 @@ Credits
=======

Authors
-------
~~~~~~~

* Binhex

Contributors
------------
~~~~~~~~~~~~

- Binhex (https://binhex.cloud)

- Rolando Pérez Rebollo [email protected]
- Rolando Pérez Rebollo <[email protected]>

Maintainers
-----------
~~~~~~~~~~~

This module is maintained by the OCA.

Expand Down

This file was deleted.

3 changes: 3 additions & 0 deletions account_journal_dashboard_statement_button/readme/CONTEXT.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
In the default (vanilla) behavior of Odoo CE, when a user clicks on the name of a Bank or Cash journal in the Accounting dashboard, they are redirected to the Statements view. However, this behavior changes when installing the OCA Reconcile add-ons or using Odoo EE.

This module offers an alternative by adding a **Statements** button directly into the journal card, providing users with a one-click option to access the Statements view. This approach ensures that users can maintain the familiar workflow of quickly accessing the Statements view, even when other customizations or versions are in place, without altering the default functionality.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
The Statement button will only appear once there are records linked to the corresponding journal.

![Account Journal Dashboard](../static/img/account_journal_dashboard.png)
.. image:: ../static/img/account_journal_dashboard.png
:alt: Account Journal Dashboard
Original file line number Diff line number Diff line change
Expand Up @@ -370,10 +370,7 @@ <h1 class="title">Account Journal Dashboard Statement Button</h1>
!! source digest: sha256:2d4ab98478de6b41e174886e654fef4d7442564c034b0968e78b915626fe0fab
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/bank-statement-import/tree/16.0/account_journal_dashboard_statement_button"><img alt="OCA/bank-statement-import" src="https://img.shields.io/badge/github-OCA%2Fbank--statement--import-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/bank-statement-import-16-0/bank-statement-import-16-0-account_journal_dashboard_statement_button"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/bank-statement-import&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module enhances the Account Journal Dashboard by introducing a
shortcut button for Bank and Cash journals. The button provides a direct
link to the Bank Statements view, streamlining access to statement
management.</p>
<p>This module enhances the Account Journal Dashboard by introducing a shortcut button for Bank and Cash journals. The button provides a direct link to the Bank Statements view, streamlining access to statement management.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
Expand All @@ -390,15 +387,13 @@ <h1 class="title">Account Journal Dashboard Statement Button</h1>
</div>
<div class="section" id="use-cases-context">
<h1><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h1>
<p>The purpose is to make the transition to newer versions smoother for
users coming from older versions like v14, where clicking on the journal
name previously led to the Statements view.</p>
<p>In the default (vanilla) behavior of Odoo CE, when a user clicks on the name of a Bank or Cash journal in the Accounting dashboard, they are redirected to the Statements view. However, this behavior changes when installing the OCA Reconcile add-ons or using Odoo EE.</p>
<p>This module offers an alternative by adding a <strong>Statements</strong> button directly into the journal card, providing users with a one-click option to access the Statements view. This approach ensures that users can maintain the familiar workflow of quickly accessing the Statements view, even when other customizations or versions are in place, without altering the default functionality.</p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
<p>The Statement button will only appear once there are records linked to
the corresponding journal.</p>
<p><img alt="Account Journal Dashboard" src="https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_journal_dashboard_statement_button/static/img/account_journal_dashboard.png" /></p>
<p>The Statement button will only appear once there are records linked to the corresponding journal.</p>
<img alt="Account Journal Dashboard" src="https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_journal_dashboard_statement_button/static/img/account_journal_dashboard.png" />
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
Expand All @@ -419,10 +414,8 @@ <h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
<ul class="simple">
<li>Binhex (<a class="reference external" href="https://binhex.cloud">https://binhex.cloud</a>)<ul>
<li>Rolando Pérez Rebollo <a class="reference external" href="mailto:r.perez&#64;binhex.cloud">r.perez&#64;binhex.cloud</a></li>
</ul>
</li>
<li>Binhex (<a class="reference external" href="https://binhex.cloud">https://binhex.cloud</a>)
- Rolando Pérez Rebollo &lt;<a class="reference external" href="mailto:r.perez&#64;binhex.cloud">r.perez&#64;binhex.cloud</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8" ?>
<!-- Copyright 2024 [email protected]
License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). -->

<odoo>
<record id="account_journal_dashboard_kanban_view" model="ir.ui.view">
<field name="model">account.journal</field>
Expand Down

0 comments on commit 7fcc69b

Please sign in to comment.