fix: Added a description line to the import spreadsheet template

[anaritadauane]

What

I added a description row to the import spreadsheet template, which now includes all the comments previously located in the header line.

Screenshot

Related issue(s) and discussion

• Added a new column on the right to accommodate the Description and Example rows
• Added some width to the Description cell
• Changed the code that wrote the comments in the header row to write them in the description row
• Fixes Add a description line to the import spreadsheet template on the producers platform #9879

[stephanegigandet]

@anaritadauane Thank you! For some reason, I get a completely empty spreadsheet when I run your branch, that's weird.

[anaritadauane]

@anaritadauane Thank you! For some reason, I get a completely empty spreadsheet when I run your branch, that's weird.

Really? Let me check

[stephanegigandet]

This is what I get in the logs:

stephane@stephane-jaguar-NS50-70MU:~/openfoodfacts-server/logs/apache2$ tail -f modperl_error_log 
[..]
[Thu Mar 14 15:58:22.438705 2024] [:error] [pid 22] [Thu Mar 14 15:58:22 2024] -e: Can't locate object method "add_format" via package "workbook" (perhaps you forgot to load "workbook"?) at /opt/product-opener/cgi/generate_sample_import_file.pl line 57.\n

There's a missing $

[stephanegigandet]

To see errors, you can do ~/openfoodfacts-server/logs/apache2$ tail -f modperl_error_log
after adding the missing $, there's another error

[anaritadauane]

To see errors, you can do ~/openfoodfacts-server/logs/apache2$ tail -f modperl_error_log after adding the missing $, there's another error

Thanks, I had to fork the repo to pull the request, then copy the changes and add some changes to the unforked repo to make a PR. I think I needed to go back and test the code to see if there were any errors.
Going to fix the code

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.52%. Comparing base (dc04d18) to head (ae2dd05).
Report is 115 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9920      +/-   ##
==========================================
- Coverage   49.54%   49.52%   -0.03%     
==========================================
  Files          67       71       +4     
  Lines       20650    20897     +247     
  Branches     4980     5018      +38     
==========================================
+ Hits        10231    10349     +118     
- Misses       9131     9254     +123     
- Partials     1288     1294       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[anaritadauane]

I have fixed the errors

[stephanegigandet]

@anaritadauane It works now, thank you!

This is what I'm getting when I open the file with LibreOffice Calc, is there a way to get more height in Description cells?

[stephanegigandet]

Could you make "Description" a translatable string?

To do that, you need to put lang("description") instead, and then add a stringid "description" in po/common.po and po/en.po (and it would be good to add it in another language so that you can test that you get a different string if you load for instance the site in Spanish: http://es.openfoodfacts.localhost/cgi/generate_sample_import_file.pl

Once you have added / changed a string in po/common.pot / en.po / es.po , you need to run:
make build_lang
make restart

and then you can use lang("description") in the Perl file instead of "Description".

[anaritadauane]

Hi @stephanegigandet,

Yes, I can. But I don't understand if I should add it as stringid or as msid, like in the po/common.po file?

[anaritadauane]

Followed the instructions and turned "Description" into a translatable string

[stephanegigandet]

@anaritadauane Great :)

Can you also add this to en.po so that we have an English translation (English is the default):

msgctxt "description"
msgid "Description"
msgstr "Description"

[anaritadauane]

Done

[stephanegigandet]

@anaritadauane looks good, thank you! just one request to make the "Description" text translatable

[anaritadauane]

@anaritadauane looks good, thank you! just one request to make the "Description" text translatable

Great! I will add the additional requests.

[stephanegigandet]

small typo, msgid should always be the same as the English translation

Suggested change

	msgid "Descripton"
	msgid "Description"

[anaritadauane]

sorry 😅, fixed the typo and changed the en.po file

[stephanegigandet]

@anaritadauane Could you run "make lint" to fix the formatting? Thank you!

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[anaritadauane]

@anaritadauane Could you run "make lint" to fix the formatting? Thank you!

Yes

[stephanegigandet]

Looks good, thank you! :)