French translation (vignettes) #6455

phgrosjean · 2024-09-03T17:48:25Z

This is the French translation for fr.po and R-fr.po.

This is also the translation of the ten vignettes in French, in an "fr" subdirectory as discussed in #6221 (@MichaelChirico "As long as it actually works, I agree for now putting it in subdirectories is the way to go.")

However, the vignettes in subdirectories are not listed in the main help page of the package, nor by vignette(). This is a problem (they are essentially "unusable" as such). Also, there are twice more vignettes to compile now, and possibly even more if there are other translations.

So, the solution to place translated vignettes in a {data.table.fr} package along with the translation of the man pages may be a better solution. I also did a trial in this direction in phgrosjean/data.table.fr.

Please, check both approaches before deciding for this pull request.

rffontenelle · 2024-09-03T17:52:57Z

Out of curiosity, what are the commands you ran to generate the PO files and the MO files?

phgrosjean · 2024-09-03T17:54:46Z

We (we are indeed 5 translators) use poEdit to get the .po file from the .pot template, and when the .po file is saved in poEdit, the .mo file is automatically created.

rffontenelle · 2024-09-03T18:09:11Z

I now remembered you mentioned using rmdpo for extracting the POT from the vignettes.

phgrosjean · 2024-09-03T18:18:35Z

@rffontenelle Oh yes, sorry, you asked for the vignettes. We used indeed {rmdpo}. For now, it directly updates the existing .po file with changes in the vignette, but a pathway using a .pot file would be better.

The various files are here and in subdirectories, and the script that generates these files is here

We still have to figure out how to work with Weblate, if and when this will be available for {data.table}.

vignettes/fr/datatable-secondary-indices-and-auto-indexing.Rmd

vignettes/fr/datatable-reshape.Rmd

tdhock · 2024-09-03T20:16:33Z

Should there be a brief documentation somewhere about who was responsible for the translation of the vignette (so they can get credit, and to stay in contact for updates), as well as what resources were used for the translation? RFrench dictionary, {rmdpo}, etc. Probably for authorship DESCRIPTION Authors@R is best, with comment="French translation of vignettes and messages" or similar.
I'm not sure what would be the best place to document what resources were used, maybe that can stay out of the repo? for example on a wiki page? https://github.com/Rdatatable/data.table/wiki/Translations

However, the vignettes in subdirectories are not listed in the main help page of the package, nor by vignette(). This is a problem (they are essentially "unusable" as such). Also, there are twice more vignettes to compile now, and possibly even more if there are other translations.

For distributing the vignettes in a separate package, a drawback would be that it is not as easy for users to discover the additional vignettes in data.table.fr package (compared to the English vignettes in data.table package).

If we wanted to maintain discoverability, and keep the French vignettes in data.table package, we could move them to the main vignettes directory, but that may be a problem for build times?

Another place users may want to discover vignettes is on http://rdatatable.gitlab.io/data.table/ so I wonder how the vignettes would appear there?

phgrosjean · 2024-09-04T05:50:18Z

In phgrosjean/data.table.fr, translators are listed as contributors of the package, but this is not totally correct. We should list vignettes authors + translators with a clear indication of who did what. Is there a list of vignettes authors (a subset of all {data.table} authors, I suppose)?

Otherwise, I think French vignettes should appear in the menu Vignettes > fr > ... if the site is build using {pkgdown} on http://rdatatable.gitlab.io/data.table/. Could you try it in a sandbox somewhere?

Ideally, English vignettes should be replaced by French ones at the different places when the user sets LANGUAGE=fr as environment variable, but R help, vignette(), {pkgdown}... are not build like that. They are monolingual. Period. (for now)

This is a discussion for the R translation working group. But in the meantime, we have to find a satisfactory transient solution for {data.table}.

phgrosjean · 2024-09-04T05:52:54Z

Oh, and there is also the translation of the cheatsheet. Where to place it?

tdhock · 2024-09-04T10:55:52Z

the cheat sheets currently go in rstudio/cheatsheets#367

- paquet -> package in R-fr.po, datatable-importing.Rmd and datatable-reshape.Rmd - `"JFK" et "LAX"`-> `c("JFK", "LAX")` i, datatable-secondary-indices-and-auto-indexing.Rmd

phgrosjean · 2024-09-04T13:32:29Z

@tdhock New commit integrating the changes (paquet -> package) and c("JFK", "LAX")

MichaelChirico · 2024-09-05T04:50:58Z

Thanks so much! Would you mind splitting this into two PRs? One with the main package .po, the other with the vignette changes? Clearly the latter requires a bit more careful thought. The former can be merged right away.

MichaelChirico · 2024-09-05T04:52:07Z

.ci/.lintr.R

@@ -73,7 +73,7 @@ rm(dt_linters)
 # TODO(lintr#2172): Glob with lintr itself.
 exclusions = c(local({
  exclusion_for_dir <- function(dir, exclusions) {
-    files = file.path("..", list.files(dir, pattern = "\\.(R|Rmd|Rraw)$", full.names=TRUE, recursive=TRUE))


why revert this :)

Oh, I had to re-fork the repository and I did not notice this when I did my commit.
I'll do a separate pull request for the main package .po files, since the discussion here is mainly about vignettes.

phgrosjean · 2024-09-05T13:31:37Z

OK, only the vignettes in French in this pull request now.

tdhock · 2024-10-04T13:24:18Z

lint currently says

Warning: file=vignettes/fr/datatable-keys-fast-subset.Rmd,line=64,col=23,[sample_int_linter] sample.int(n, m, ...) is preferable to sample(1:n, m, ...).
Warning: file=vignettes/fr/datatable-keys-fast-subset.Rmd,line=65,col=23,[sample_int_linter] sample.int(n, m, ...) is preferable to sample(n, m, ...).
Warning: file=vignettes/fr/datatable-keys-fast-subset.Rmd,line=413,col=21,[sample_int_linter] sample.int(n, m, ...) is preferable to sample(n, m, ...).
Warning: file=vignettes/fr/datatable-secondary-indices-and-auto-indexing.Rmd,line=288,col=21,[sample_int_linter] sample.int(n, m, ...) is preferable to sample(n, m, ...).

other than that, is this PR ready to merge?

Could you try it in a sandbox somewhere?

I have not checked if we can see vignettes on pkgdown site yet, I will try on my local machine.

tdhock · 2024-10-04T13:33:19Z

I got an error, am I doing the build wrong?

> pkgdown::build_site("~/R/data.table")
── Installing package data.table into temporary library ────────────────────────
── Building pkgdown site for package data.table ────────────────────────────────
Reading from: ~/R/data.table
Writing to: ~/R/data.table/docs
── Sitrep ──────────────────────────────────────────────────────────────────────
✖ URLs not ok.
  In DESCRIPTION, URL is missing package url
  (https://rdatatable.gitlab.io/data.table).
  See details in `vignette(pkgdown::metadata)`.
✔ Favicons ok.
✔ Open graph metadata ok.
✔ Articles metadata ok.
✔ Reference metadata ok.
── Initialising site ───────────────────────────────────────────────────────────
── Building home ───────────────────────────────────────────────────────────────
✖ Icon "fas fa-home fa-lg" lacks an `aria-label`.
ℹ Specify `aria-label` to make the icon accessible to screen readers.
ℹ Learn more in `vignette(pkgdown::accessibility)`.
This message is displayed once every 8 hours.
Reading datatable-benchmarking.md
Writing `datatable-benchmarking.html`
Reading GOVERNANCE.md
Reading NEWS.0.md
Reading NEWS.1.md
Reading Seal_of_Approval.md
Reading .github/CONTRIBUTING.md
Reading README.md
Writing `404.html`
── Building function reference ─────────────────────────────────────────────────
Reading man/address.Rd
Writing `reference/address.html`
Reading man/all.equal.data.table.Rd
Reading man/as.data.table.Rd
Reading man/as.data.table.xts.Rd
Reading man/as.matrix.Rd
Reading man/as.xts.data.table.Rd
Reading man/assign.Rd
Reading man/between.Rd
Reading man/cdt.Rd
Reading man/chmatch.Rd
Writing `reference/chmatch.html`
Reading man/coalesce.Rd
Reading man/copy.Rd
Reading man/data.table-class.Rd
Reading man/data.table.Rd
Writing `reference/data.table.html`
Reading man/datatable-optimize.Rd
Reading man/dcast.data.table.Rd
Reading man/deprecated.Rd
Reading man/duplicated.Rd
Reading man/fcase.Rd
Reading man/fdroplevels.Rd
Reading man/fifelse.Rd
Reading man/foverlaps.Rd
Reading man/frank.Rd
Reading man/fread.Rd
Reading man/froll.Rd
Writing `reference/froll.html`
Reading man/fsort.Rd
Writing `reference/fsort.html`
Reading man/fwrite.Rd
Reading man/groupingsets.Rd
Reading man/IDateTime.Rd
Reading man/J.Rd
Reading man/last.Rd
Reading man/last.updated.Rd
Reading man/like.Rd
Reading man/measure.Rd
Reading man/melt.data.table.Rd
Reading man/merge.Rd
Reading man/na.omit.data.table.Rd
Reading man/nafill.Rd
Reading man/notin.Rd
Reading man/openmp-utils.Rd
Reading man/patterns.Rd
Reading man/print.data.table.Rd
Reading man/rbindlist.Rd
Reading man/rleid.Rd
Reading man/rowid.Rd
Reading man/setattr.Rd
Writing `reference/setattr.html`
Reading man/setcolorder.Rd
Reading man/setDF.Rd
Reading man/setDT.Rd
Reading man/setkey.Rd
Reading man/setNumericRounding.Rd
Reading man/setops.Rd
Reading man/setorder.Rd
Reading man/shift.Rd
Reading man/shouldPrint.Rd
Reading man/special-symbols.Rd
Reading man/split.Rd
Reading man/subset.data.table.Rd
Reading man/substitute2.Rd
Reading man/tables.Rd
Reading man/test.data.table.Rd
Reading man/test.Rd
Reading man/timetaken.Rd
Writing `reference/timetaken.html`
Reading man/transform.data.table.Rd
Reading man/transpose.Rd
Reading man/truelength.Rd
Reading man/tstrsplit.Rd
Reading man/update_dev_pkg.Rd
── Building articles ───────────────────────────────────────────────────────────
Reading vignettes/datatable-benchmarking.Rmd
Warning message:
Failed to parse example for topic "update_dev_pkg" 
Error: 
! in callr subprocess.
Caused by error in `.f(.x[[i]], ...)`:
! Failed to render vignettes/datatable-benchmarking.Rmd.
✖ Warning message:
✖ In file(con, "r") :
✖  cannot open file 'css/toc.css': No such file or directory
Caused by error:
! cannot open the connection
ℹ See `$stderr` for standard error.
Type .Last.error to see the more details.

in https://github.com/Rdatatable/data.table/blob/master/.gitlab-ci.yml (where I think the site is usually built) I see

  script:
    - R --version
    - *install-deps ## markdown pkg not present in r-pkgdown image
    - mkdir -p ./pkgdown/favicon/ && cp .graphics/favicon/* ./pkgdown/favicon/ ## copy favicons
    - rm -rf ./vignettes ## r-lib/pkgdown#2383
    - Rscript -e 'pkgdown::build_site(override=list(destination="./website"))'

MichaelChirico · 2024-10-04T16:59:12Z

lint currently says

Ignore that, it's present in the original but skipped:

data.table/.ci/.lintr.R

Line 89 in 036fb48

sample_int_linter = Inf

(or if anything, it should be fixed by a similar lintr config setup)

tdhock · 2024-10-07T21:11:58Z

so there are three blocking points that we need to decide before merging this PR.

do we keep vignettes in vignettes/fr sub-directory (probably not visible on CRAN, but visible on pkgdown site according to @phgrosjean but I was unable to verify because I got an error when I tried to build), or do we move them to regular vignettes directory? (should be visible on CRAN as well). I tend to think that for the short term we should just move them to the regular vignettes directory, so we can see them on CRAN, and maybe later we can move them?
do we want to add links between the different translations (link to French version on top of English version, etc) ?
where to give authorship credit to translators? I would suggest adding them to data.table/DESCRIPTOIN as below, is that OK?

  person("Philippe","Grosjean", role="ctb", comment = "French translation"),

AngelFelizR · 2024-11-02T04:38:18Z

I think that translations should only be posted on the website to avoid increasing the time required to install the package.

codecov · 2024-11-08T13:12:48Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.60%. Comparing base (319a53c) to head (9bb0103).
Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #6455   +/-   ##
=======================================
  Coverage   98.60%   98.60%           
=======================================
  Files          79       79           
  Lines       14518    14518           
=======================================
  Hits        14316    14316           
  Misses        202      202

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

jangorecki · 2024-11-09T19:50:18Z

in https://github.com/Rdatatable/data.table/blob/master/.gitlab-ci.yml (where I think the site is usually built) I see

  script:
    - R --version
    - *install-deps ## markdown pkg not present in r-pkgdown image
    - mkdir -p ./pkgdown/favicon/ && cp .graphics/favicon/* ./pkgdown/favicon/ ## copy favicons
    - rm -rf ./vignettes ## r-lib/pkgdown#2383
    - Rscript -e 'pkgdown::build_site(override=list(destination="./website"))'

This is workaround for bug in pkgdown described in linked issue. Follow this workaround when generating vignettes for a website. AFAIR bug was closed as wont fix but you can check once again with pkgdown team.
Ultimately I would aim for moving vignettes to litedown. That I am pretty sure wont be supported by pkgdown as well. In future we should be able to replace pkgdown with litedown as well. @yihui

tdhock · 2024-11-11T16:32:44Z

I'm merging because I added FR team to DESCRIPTION, and I added links from English to French vignettes. Please file another PR for any further updates we would need to do.

French translation (messages and vignettes)

739689e

phgrosjean requested a review from MichaelChirico as a code owner September 3, 2024 17:48

recursive exclusion for vignettes

f0f54c8

tdhock reviewed Sep 3, 2024

View reviewed changes

vignettes/fr/datatable-secondary-indices-and-auto-indexing.Rmd Outdated Show resolved Hide resolved

tdhock reviewed Sep 3, 2024

View reviewed changes

vignettes/fr/datatable-reshape.Rmd Outdated Show resolved Hide resolved

aitap mentioned this pull request Sep 4, 2024

File names for translated vignettes? #6221

Open

Corrections:

4da080a

- paquet -> package in R-fr.po, datatable-importing.Rmd and datatable-reshape.Rmd - `"JFK" et "LAX"`-> `c("JFK", "LAX")` i, datatable-secondary-indices-and-auto-indexing.Rmd

MichaelChirico reviewed Sep 5, 2024

View reviewed changes

po files taken out

e7275fa

phgrosjean changed the title ~~French translation (messages and vignettes)~~ French translation (vignettes) Sep 5, 2024

MichaelChirico added the translation issues/PRs related to message translation projects label Sep 21, 2024

tdhock mentioned this pull request Oct 9, 2024

adding join vignette to website #6562

Merged

Merge branch 'master' into french_translation

5b77a04

tdhock and others added 2 commits November 8, 2024 08:29

rm css/toc.css

980144e

french trans links

a44b045

tdhock requested a review from jangorecki as a code owner November 8, 2024 22:20

jangorecki removed their request for review November 9, 2024 19:50

French translation team

9bb0103

tdhock merged commit 2f49a0d into master Nov 11, 2024
6 of 8 checks passed

rikivillalba mentioned this pull request Nov 13, 2024

translated vignette proposal : all pages link back to EN root vignette #6613

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

French translation (vignettes) #6455

French translation (vignettes) #6455

phgrosjean commented Sep 3, 2024

rffontenelle commented Sep 3, 2024

phgrosjean commented Sep 3, 2024

rffontenelle commented Sep 3, 2024

phgrosjean commented Sep 3, 2024

tdhock commented Sep 3, 2024

phgrosjean commented Sep 4, 2024

phgrosjean commented Sep 4, 2024

tdhock commented Sep 4, 2024

phgrosjean commented Sep 4, 2024

MichaelChirico commented Sep 5, 2024

MichaelChirico Sep 5, 2024

phgrosjean Sep 5, 2024

phgrosjean commented Sep 5, 2024

tdhock commented Oct 4, 2024

tdhock commented Oct 4, 2024

MichaelChirico commented Oct 4, 2024

tdhock commented Oct 7, 2024

AngelFelizR commented Nov 2, 2024

codecov bot commented Nov 8, 2024 •

edited

Loading

jangorecki commented Nov 9, 2024

tdhock commented Nov 11, 2024

French translation (vignettes) #6455

French translation (vignettes) #6455

Conversation

phgrosjean commented Sep 3, 2024

rffontenelle commented Sep 3, 2024

phgrosjean commented Sep 3, 2024

rffontenelle commented Sep 3, 2024

phgrosjean commented Sep 3, 2024

tdhock commented Sep 3, 2024

phgrosjean commented Sep 4, 2024

phgrosjean commented Sep 4, 2024

tdhock commented Sep 4, 2024

phgrosjean commented Sep 4, 2024

MichaelChirico commented Sep 5, 2024

MichaelChirico Sep 5, 2024

Choose a reason for hiding this comment

phgrosjean Sep 5, 2024

Choose a reason for hiding this comment

phgrosjean commented Sep 5, 2024

tdhock commented Oct 4, 2024

tdhock commented Oct 4, 2024

MichaelChirico commented Oct 4, 2024

tdhock commented Oct 7, 2024

AngelFelizR commented Nov 2, 2024

codecov bot commented Nov 8, 2024 • edited Loading

Codecov Report

jangorecki commented Nov 9, 2024

tdhock commented Nov 11, 2024

codecov bot commented Nov 8, 2024 •

edited

Loading