Skip to content

Commit

Permalink
[IMP] excel_import_export: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@AungKoKoLin1997
AungKoKoLin1997 committed Nov 25, 2024
1 parent 6e7e03d commit 88e5c63
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 27 deletions.
6 changes: 6 additions & 0 deletions excel_import_export/README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ Then, simply install **excel_import_export**.

For demo, install **excel_import_export_demo**

Configuration
=============

If you have existing templates from the version 16.0.1.2.0 or earlier, you need to click 'REMOVE EXPORT ACTION'
and then click 'ADD EXPORT ACTION' in these templates for export actions to work as expected.

Usage
=====

Expand Down
2 changes: 2 additions & 0 deletions excel_import_export/readme/CONFIGURE.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
If you have existing templates from the version 16.0.1.2.0 or earlier, you need to click 'REMOVE EXPORT ACTION'
and then click 'ADD EXPORT ACTION' in these templates for export actions to work as expected.
57 changes: 30 additions & 27 deletions excel_import_export/static/description/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@

/*
:Author: David Goodger ([email protected])
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.
Despite the name, some widely supported CSS2 features are used.

See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
Expand Down Expand Up @@ -275,7 +274,7 @@
margin-left: 2em ;
margin-right: 2em }

pre.code .ln { color: gray; } /* line numbers */
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
Expand All @@ -301,7 +300,7 @@
span.pre {
white-space: pre }

span.problematic, pre.problematic {
span.problematic {
color: red }

span.section-subtitle {
Expand Down Expand Up @@ -382,18 +381,19 @@ <h1 class="title">Excel Import/Export/Report</h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#installation" id="toc-entry-1">Installation</a></li>
<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</a><ul>
<li><a class="reference internal" href="#concepts" id="toc-entry-3">Concepts</a></li>
<li><a class="reference internal" href="#use-cases" id="toc-entry-4">Use Cases</a></li>
<li><a class="reference internal" href="#easy-reporting-option" id="toc-entry-5">Easy Reporting Option</a></li>
<li><a class="reference internal" href="#configuration" id="toc-entry-2">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="toc-entry-3">Usage</a><ul>
<li><a class="reference internal" href="#concepts" id="toc-entry-4">Concepts</a></li>
<li><a class="reference internal" href="#use-cases" id="toc-entry-5">Use Cases</a></li>
<li><a class="reference internal" href="#easy-reporting-option" id="toc-entry-6">Easy Reporting Option</a></li>
</ul>
</li>
<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-6">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-7">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-8">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-9">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-10">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-11">Maintainers</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-7">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-8">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-9">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-10">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-11">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-12">Maintainers</a></li>
</ul>
</li>
</ul>
Expand All @@ -404,10 +404,15 @@ <h1><a class="toc-backref" href="#toc-entry-1">Installation</a></h1>
<p>Then, simply install <strong>excel_import_export</strong>.</p>
<p>For demo, install <strong>excel_import_export_demo</strong></p>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
<p>If you have existing templates from the version 16.0.1.2.0 or earlier, you need to click ‘REMOVE EXPORT ACTION’
and then click ‘ADD EXPORT ACTION’ in these templates for export actions to work as expected.</p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
<h1><a class="toc-backref" href="#toc-entry-3">Usage</a></h1>
<div class="section" id="concepts">
<h2><a class="toc-backref" href="#toc-entry-3">Concepts</a></h2>
<h2><a class="toc-backref" href="#toc-entry-4">Concepts</a></h2>
<p>This module contain pre-defined function and wizards to make exporting, importing and reporting easy.</p>
<p>At the heart of this module, there are 2 <cite>main methods</cite></p>
<ul class="simple">
Expand All @@ -422,7 +427,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">Concepts</a></h2>
<p>As this module provide tools, it is best to explain as use cases. For example use cases, please install <strong>excel_import_export_demo</strong></p>
</div>
<div class="section" id="use-cases">
<h2><a class="toc-backref" href="#toc-entry-4">Use Cases</a></h2>
<h2><a class="toc-backref" href="#toc-entry-5">Use Cases</a></h2>
<p><strong>Use Case 1:</strong> Export/Import Excel on existing document</p>
<p>This add export/import action menus in existing document (example - excel_import_export_demo/import_export_sale_order)</p>
<ol class="arabic simple">
Expand Down Expand Up @@ -466,7 +471,7 @@ <h2><a class="toc-backref" href="#toc-entry-4">Use Cases</a></h2>
</ol>
</div>
<div class="section" id="easy-reporting-option">
<h2><a class="toc-backref" href="#toc-entry-5">Easy Reporting Option</a></h2>
<h2><a class="toc-backref" href="#toc-entry-6">Easy Reporting Option</a></h2>
<p>Technically, this option is the same as “Create Excel Report” use case. But instead of having to write XML / Python code like normally do,
this option allow user to create a report based on a model or view, all by configuration only.</p>
<ol class="arabic simple">
Expand All @@ -491,40 +496,38 @@ <h2><a class="toc-backref" href="#toc-entry-5">Easy Reporting Option</a></h2>
</div>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#toc-entry-6">Known issues / Roadmap</a></h1>
<h1><a class="toc-backref" href="#toc-entry-7">Known issues / Roadmap</a></h1>
<ul class="simple">
<li>Module extension e.g., excel_import_export_async, that add ability to execute as async process.</li>
</ul>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-7">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#toc-entry-8">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20excel_import_export%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#toc-entry-8">Credits</a></h1>
<h1><a class="toc-backref" href="#toc-entry-9">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#toc-entry-9">Authors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-10">Authors</a></h2>
<ul class="simple">
<li>Ecosoft</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#toc-entry-10">Contributors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-11">Contributors</a></h2>
<ul class="simple">
<li>Kitti Upariphutthiphong. &lt;<a class="reference external" href="mailto:kittiu&#64;gmail.com">kittiu&#64;gmail.com</a>&gt; (<a class="reference external" href="http://ecosoft.co.th">http://ecosoft.co.th</a>)</li>
<li>Saran Lim. &lt;<a class="reference external" href="mailto:saranl&#64;ecosoft.co.th">saranl&#64;ecosoft.co.th</a>&gt; (<a class="reference external" href="http://ecosoft.co.th">http://ecosoft.co.th</a>)</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#toc-entry-11">Maintainers</a></h2>
<h2><a class="toc-backref" href="#toc-entry-12">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org">
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
</a>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
Expand Down

0 comments on commit 88e5c63

Please sign in to comment.