Skip to content

docs(i18n): resync the 9 translated manuals with the current English pages - #67

Merged
seto77 merged 15 commits into
masterfrom
ccr-fc6e1a8d-vbbq9p
Sep 30, 2026
Merged

seto77 merged 15 commits into
masterfrom
ccr-fc6e1a8d-vbbq9p

Conversation

@seto77

@seto77 seto77 commented Sep 30, 2026 •

Copy link
Copy Markdown
Owner

Summary

Nine manual translations (de, es, fr, it, ko, pt, ru, zh-Hans, zh-Hant) had fallen out of sync with the English source. Several pages were still translations of the June–July English text, and later English corrections never reached them. The biggest one was the 2026-08-30 proofreading commit 346be81: in many languages it only changed notation, not the content. This PR brings all 9 languages back in line with the current English. English (en) and Japanese (ja) are not changed; Japanese was already in sync.

Pages rewritten from the current English

  • 8. Electron trajectory: the old translations described controls that don't exist: a selectable cross-section model and a Wulff/Schmidt/hemisphere projection. They also said the energy histogram shows energy loss ΔE. English says it shows the energy the BSE still carries at escape, "not their energy loss".
  • 9. HRTEM/STEM overview and 9.1 HRTEM: now use the current page structure. The old version put every setting on one page.

Content carried over from English

  • Appendix A1.2: the section on the two definitions of the excitation error $S_g$.
  • Macro reference: the ExcitationError row.
  • Rotation geometry: the paragraph on intrinsic vs laboratory-frame Euler angles.
  • EBSD: the Contrast slider, Flatten background and Match to image.
  • Spot ID v2: the Global fit and Donut items.
  • Physics corrections from 346be81:
    • A3 HRTEM: ΔE and Δ₀ are standard deviations, and the TCC limits are corrected.
    • F-lattice diagram note: "upper-left quarter of the projected cell".
    • CBED: the aperture is the probe-forming (condenser) aperture.
    • Attenuation: α_c with its validity caveats, and Jablonski (2008) for the stopping power.
    • Fluorescence: selection rules and the nuclear-charge explanation.
    • Scattering factor: the KLI wording.
    • Structure viewer: the tab introductions.
    • Main window: Peng 1996/1998, the zone-axis text and the F1 language note.
    • Troubleshooting: OpenGL 1.3 minimum / 4.3 recommended.
  • zh-Hans and zh-Hant: fixed a corrupted $s \approx 3$ in the scattering-factor appendix, where a BEL control character had replaced \a.

GUI labels follow each language's .resx strings. Where a control has no localized string, the English UI label is used. Screenshots point to cap-<lang>-auto only where that file exists.

Verification

  • A structural audit compared every translated page with English: headings, images, links, $$ blocks, inline math, tables and list items. No structural gaps remain. A few pages still differ by one in the inline-math count. That comes from wording only, e.g. $\det = 1$ written as one span, and the formulas are the same.
  • mkdocs build -f docs/mkdocs.yml --strict passes with no warnings.
  • No control characters remain in docs/src/**/*.md.
  • Only files under docs/src/<lang>/ changed: 14 commits, one per language per pass.

Not changed (English source; possible follow-ups)

  • The HRTEM/STEM pages use the heading "Waves", but the GUI group box is labelled "Diffracted waves".
  • Some localized screenshots are older than the current UI. For example, the zh-Hans EBSD experimental-image tab has no Contrast, Flatten or Match controls.
  • Some older translated pages still use English GUI labels throughout. Where this PR edited lines on those pages, it used the localized labels, so a few pages now mix the two.

Correction: an earlier version of this description said the STEM-EDX section of 2-stem-simulation.md documented a gated-out feature. That was wrong. 7f2ca45 gated STEM-EDX only temporarily, and 4.946 (034c5b0, 2026-08-05) released it, so the STEM-EDX documentation is current and stays.

🤖 Generated with Claude Code

https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb

Several zh-Hans pages were translated from the June-July English text and
missed later restructuring and corrections (electron trajectory, HRTEM/STEM
overview and HRTEM pages, appendix A1.2 excitation-error definitions,
ExcitationError macro row, rotation-geometry convention, and smaller
link/formula gaps). Rewrite or patch them to match the current English,
using zh-Hans GUI labels and localized screenshots.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Rewrite the electron-trajectory, HRTEM/STEM overview and HRTEM pages from
the current English, and patch smaller gaps (A1.2 excitation-error
definitions, ExcitationError macro row, rotation-geometry convention,
A3 HRTEM envelope widths, F-lattice note, troubleshooting OpenGL
requirement and links), using zh-Hant GUI labels.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Rewrite the electron-trajectory, HRTEM/STEM overview and HRTEM pages from
the current English, and patch smaller gaps (A1.2 excitation-error
definitions, ExcitationError macro row, rotation-geometry convention,
A2/A3 corrections, F-lattice note, EBSD contrast/flatten controls,
troubleshooting OpenGL requirement and links), using French GUI labels.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Rewrite the electron-trajectory, HRTEM/STEM overview and HRTEM pages from
the current English, and patch smaller gaps (A1.2 excitation-error
definitions, ExcitationError macro row, rotation-geometry convention,
A2/A3 corrections, F-lattice note, EBSD contrast/flatten controls,
troubleshooting OpenGL requirement and links), using Portuguese GUI labels.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Rewrite the electron-trajectory, HRTEM/STEM overview and HRTEM pages from
the current English, and carry over the content changes of the manual-wide
proofread and the EBSD contrast/flatten update that had reached only the
notation of the Italian pages (A1.2 excitation-error definitions,
ExcitationError macro row, rotation-geometry convention, A2/A3
corrections, F-lattice note, troubleshooting), using Italian GUI labels.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Rewrite the electron-trajectory, HRTEM/STEM overview and HRTEM pages from
the current English, and patch smaller gaps (A1.2 excitation-error
definitions, ExcitationError macro row, rotation-geometry convention,
A2/A3 corrections, F-lattice note, EBSD contrast/flatten controls,
troubleshooting OpenGL requirement and links), using German GUI labels.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Rewrite the electron-trajectory, HRTEM/STEM overview and HRTEM pages from
the current English, and carry over the content changes of the manual-wide
proofread and the EBSD contrast/flatten update (A1.2 excitation-error
definitions, ExcitationError macro row, rotation-geometry convention,
A2/A3 corrections, F-lattice note, troubleshooting), using Spanish GUI
labels.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Rewrite the electron-trajectory, HRTEM/STEM overview and HRTEM pages from
the current English, and carry over the content changes of the manual-wide
proofread and the EBSD contrast/flatten update (A1.2 excitation-error
definitions, ExcitationError macro row, rotation-geometry convention,
A2/A3 corrections, F-lattice note, troubleshooting), using Russian GUI
labels.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Rewrite the electron-trajectory, HRTEM/STEM overview and HRTEM pages from
the current English, and patch smaller gaps (A1.2 excitation-error
definitions, ExcitationError macro row, rotation-geometry convention,
A2/A3 corrections, F-lattice note, EBSD contrast/flatten controls,
troubleshooting OpenGL requirement and links), using Korean GUI labels.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
…e resync

Main window (Help menu labels, language note, zone-axis text, Peng
1996/1998), structure-viewer tab intros, Color-per-crystal labels,
kinematical-scope note, KLI wording, CBED probe-forming aperture, and a
corrupted \approx (stray BEL control character) in the scattering-factor
appendix.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Main window (Help menu labels, language note, zone-axis text, Peng
1996/1998), EBSD contrast slider, structure-viewer tab intros,
Color-per-crystal labels, STEM/potential voltage label and Waves heading,
fluorescence and KLI wording, CBED probe-forming aperture.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Main window (File menu labels, language note, zone-axis text, Peng
1996/1998), structure-viewer tab intros, Color-per-crystal labels, KLI
wording, CBED probe-forming aperture.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
Main window (Help menu labels, language note, zone-axis text, Peng
1996/1998, German menu subheadings), structure-viewer tab intros,
color-per-crystal labels, kinematical-scope note, KLI wording.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
…e resync

Main window, structure-viewer tab intros, color labels, Waves heading and
voltage label, A2 attenuation/fluorescence/scope wording, KLI wording,
CBED probe-forming aperture, F-lattice note, troubleshooting menu paths,
and a corrupted \approx (stray BEL control character) in the
scattering-factor appendix.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-30T07:45:43.432084Z 85af69f PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 85af69f520

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

\qquad s_\mp=\frac{1}{2}\left|\mathbf K\mp\frac{\mathbf g-\mathbf h}{2}\right|$$

Qui $\mathbf K$ è un vettore d'onda che percorre la sfera di Ewald e $\mathrm d\Omega$ è il suo elemento di angolo solido. ReciPro valuta questo integrale numericamente con la quadratura di Gauss–Legendre (l'integrando ha un picco acuto in avanti, quindi l'angolo polare viene suddiviso in intervalli geometrici del modulo del vettore di diffusione per risolverlo). Per la TDS raccolta da un rivelatore anulare STEM, o la TDS retrodiffusa in EBSD, **lo stesso integrando** viene integrato sull'intervallo angolare del rivelatore (un anello o l'emisfero posteriore).
Qui $\mathbf K$ è il vettore d'onda *diffuso*, che percorre la sfera $|\mathbf K| = k_{vac}$ con elemento di angolo solido $\mathrm d\Omega$, e $\mathbf K-\mathbf k_{vac}$ è quindi il vettore di diffusione di quella direzione. In modo equivalente, i due argomenti sono $s_- = \lvert(\mathbf K-\mathbf k_{vac})-\mathbf g\rvert/2$ e $s_+ = \lvert(\mathbf K-\mathbf k_{vac})-\mathbf h\rvert/2$, che è la forma valutata da ReciPro. ReciPro valuta questo integrale numericamente con la quadratura di Gauss–Legendre (l'integrando ha un picco acuto in avanti, quindi l'angolo polare viene suddiviso in intervalli geometrici del modulo del vettore di diffusione per risolverlo). Per la TDS raccolta da un rivelatore anulare STEM, o la TDS retrodiffusa in EBSD, **lo stesso integrando** viene integrato sull'intervallo angolare del rivelatore (un anello o l'emisfero posteriore).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Correct the Italian absorptive-factor equation

For readers using the Italian dynamical-diffraction appendix, this new paragraph defines $s_-$ and $s_+$ using $\mathbf K-\mathbf k_{vac}$, but the displayed equation immediately above still defines them from $\mathbf K$ alone. Those expressions are not equivalent when $\mathbf K$ is the scattered wave vector, so the page gives two conflicting integrands; update the displayed equation to include the current $\mathbf q=\mathbf K-\mathbf k_{vac}+(\mathbf g+\mathbf h)/2$ definition, as in the English source.

Useful? React with 👍 / 👎.

…section (11 languages)

The overview listed only Elastic / TDS / Elastic & TDS as display targets.
Since 4.946 a fourth choice, EDX, appears when the run also computed
STEM-EDX maps; the STEM page's table already lists it. Link to #stem-edx.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RZjJbJYenm1ZKX7eyoEhHb
@seto77
seto77 merged commit 79ed99b into master Sep 30, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants