Skip to content

Commit

Permalink
[UPD] CONFIGURE.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
AungKoKoLin1997 committed Apr 6, 2023
1 parent 192f04c commit 06257cc
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 18 deletions.
13 changes: 7 additions & 6 deletions report_csv/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,15 @@ This module provides a basic report class to generate csv report.
Configuration
=============

In order to add encode error handing in csv report you need to choose
encode error handling in reports.
In case the exported CSV report should be encoded in another system than UTF-8, following
fields of the report record (*Settings > Technical > Reports*) should be populated accordingly.

* Go to Settings > Technical > Reports > Your csv report
* Add encoding first
* Choose encode error handling
* Encoding: set an encoding system (such as cp932)
* Encode Error Handling: select 'Ignore' or 'Replace' as necessary.

Note: You can't see encode error handling if you don't add encoding first.
* 'Ignore': in case of an encoding error, the problematic character will be removed from the exported file.
* 'Replace': in case of an encoding error, the problematic character will be replaced with '?' symbol.
* Leaving the field blank: in case of an encoding error, the report generation fails with an error message.

Usage
=====
Expand Down
13 changes: 7 additions & 6 deletions report_csv/readme/CONFIGURE.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
In order to add encode error handing in csv report you need to choose
encode error handling in reports.
In case the exported CSV report should be encoded in another system than UTF-8, following
fields of the report record (*Settings > Technical > Reports*) should be populated accordingly.

* Go to Settings > Technical > Reports > Your csv report
* Add encoding first
* Choose encode error handling
* Encoding: set an encoding system (such as cp932)
* Encode Error Handling: select 'Ignore' or 'Replace' as necessary.

Note: You can't see encode error handling if you don't add encoding first.
* 'Ignore': in case of an encoding error, the problematic character will be removed from the exported file.
* 'Replace': in case of an encoding error, the problematic character will be replaced with '?' symbol.
* Leaving the field blank: in case of an encoding error, the report generation fails with an error message.
15 changes: 9 additions & 6 deletions report_csv/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -385,14 +385,17 @@ <h1 class="title">Base report csv</h1>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<p>In order to add encode error handing in csv report you need to choose
encode error handling in reports.</p>
<p>In case the exported CSV report should be encoded in another system than UTF-8, following
fields of the report record (<em>Settings &gt; Technical &gt; Reports</em>) should be populated accordingly.</p>
<ul class="simple">
<li>Go to Settings &gt; Technical &gt; Reports &gt; Your csv report</li>
<li>Add encoding first</li>
<li>Choose encode error handling</li>
<li>Encoding: set an encoding system (such as cp932)</li>
<li>Encode Error Handling: select ‘Ignore’ or ‘Replace’ as necessary.<ul>
<li>‘Ignore’: in case of an encoding error, the problematic character will be removed from the exported file.</li>
<li>‘Replace’: in case of an encoding error, the problematic character will be replaced with ‘?’ symbol.</li>
<li>Leaving the field blank: in case of an encoding error, the report generation fails with an error message.</li>
</ul>
</li>
</ul>
<p>Note: You can’t see encode error handling if you don’t add encoding first.</p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
Expand Down

0 comments on commit 06257cc

Please sign in to comment.