Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
2180c36
i18n: wrap ~76 user-facing strings with tr() across Schedules tab
Ski90Moo May 4, 2026
aff35f2
ci: trigger build
Ski90Moo May 4, 2026
b1c5733
i18n: add comprehensive Spanish translation proof-of-concept (issue #…
Ski90Moo May 9, 2026
bce5a70
test: add GTest suite for i18n translation (issue #680)
Ski90Moo May 9, 2026
cdf9504
i18n: add full translations for 18 languages + 4 new languages (issue…
Ski90Moo May 23, 2026
d239658
i18n: fix remaining macumber/Copilot review issues (issue #680)
Ski90Moo May 23, 2026
7eb3da0
chore: untrack Qt-generated moc_*.cpp files
Ski90Moo May 23, 2026
f03e2ee
chore: ignore Qt-generated moc_*.cpp files
Ski90Moo May 23, 2026
4808ad1
test: add IddCoverageForAllFields test (issue #680)
Ski90Moo May 23, 2026
59cad72
test: check IDD coverage across all language .ts files (issue #680)
Ski90Moo May 23, 2026
b2a2d08
docs: update PR 873 review responses
Ski90Moo May 23, 2026
7e3be47
ci: add GitHub Actions translation drift check (issue #680)
Ski90Moo May 23, 2026
518b74f
docs: update PR 873 responses with translation CI details
Ski90Moo May 23, 2026
d74d92b
i18n: wrap hardcoded 'Merging Models' dialog titles with tr() (issue …
Ski90Moo May 23, 2026
05a157e
refactor: replace QCoreApplication::translate lambda/verbose calls wi…
Ski90Moo May 23, 2026
8d3ebce
fix: add missing QStringList include to Translation_GTest.cpp
Ski90Moo May 24, 2026
dce7d74
chore: remove internal PR review tracking document
Ski90Moo May 24, 2026
37c8d6b
i18n: add dialog translations missing from PR #873
Ski90Moo May 26, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions .github/workflows/translation_check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Translation Check

on:
push:
branches: [ master, develop ]
pull_request:
branches: [ master, develop ]

jobs:
check:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Install Qt6 lupdate
run: |
sudo apt-get update -q
sudo apt-get install -y qt6-l10n-tools

- name: Run lupdate against all .ts files
run: |
# -locations none: suppress line-number comments so only genuine
# string additions/removals cause a git diff change.
lupdate6 src/ \
-ts translations/OpenStudioApp_*.ts \
-extensions cpp,hpp \
-locations none \
2>&1 | tee lupdate_output.txt

- name: Detect vanished or new unfinished strings
run: |
# If lupdate changed any .ts file, strings were either added to source
# (new type="unfinished" stubs) or removed from source (type="obsolete").
# Either way the commit that introduced the drift should not merge until
# the .ts files are updated and translations are provided.
python3 ci/check_translations.py

- name: Upload artifacts on failure
if: failure()
uses: actions/upload-artifact@v4
with:
name: translation-check-${{ github.sha }}
path: |
lupdate_output.txt
translation_check.patch
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ profile/

*.sublime-workspace

# Qt-generated files
src/openstudio_lib/moc_*.cpp

*.sublime-project
cmake-build-debug

Expand Down
73 changes: 73 additions & 0 deletions ci/check_translations.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
#!/usr/bin/env python3
"""
Called by translation_check.yml after lupdate has run.

Checks whether lupdate changed any OpenStudioApp_*.ts file by running
`git diff translations/`. If there are changes it means:

- type="unfinished" stubs were ADDED → new tr() calls in source with no
translation yet. Fix: run translate_skeleton.py / translate_all_languages.py.

- type="obsolete" entries were ADDED → tr() calls removed from source but
still present as dead entries in the .ts files. Fix: run
`lupdate -no-obsolete` and commit the cleaned-up .ts files.

If the diff is empty, all .ts files are in sync with the C++ source.
Exits with code 1 if drift is detected so CI fails.
"""

import re
import subprocess
import sys


def run(cmd: list[str]) -> str:
return subprocess.check_output(cmd, text=True)


def main() -> int:
# Produce a diff of everything lupdate may have touched.
diff = run(["git", "diff", "translations/"])

if not diff:
print("All .ts files are in sync with the C++ source. ✓")
return 0

# Save patch as artifact for inspection.
with open("translation_check.patch", "w") as f:
f.write(diff)

# Classify what changed so the error message is actionable.
added_unfinished = len(re.findall(r'^\+.*type="unfinished"', diff, re.MULTILINE))
added_obsolete = len(re.findall(r'^\+.*type="obsolete"', diff, re.MULTILINE))

# Summarise changed files.
stat = run(["git", "diff", "--stat", "translations/"])
print("lupdate changed the following .ts files:")
print(stat)

if added_unfinished:
print(f" {added_unfinished} new empty unfinished string(s) detected.")
print(" These are new tr() calls in C++ source that have no translation yet.")
print(" Fix: run translate_skeleton.py (Spanish) or translate_all_languages.py")
print(" to batch-translate the new strings, then commit the updated .ts files.")
print()

if added_obsolete:
print(f" {added_obsolete} new obsolete string(s) detected.")
print(" These are tr() calls that were removed from C++ source.")
print(" Fix: run `lupdate src/ -no-obsolete -ts translations/OpenStudioApp_*.ts`")
print(" then commit the cleaned-up .ts files.")
print()

if not added_unfinished and not added_obsolete:
# Location comments or other minor changes — still fail so the dev is aware.
print(" .ts files changed in an unexpected way (not unfinished/obsolete).")
print(" Review translation_check.patch for details.")

print("Translation check FAILED. Commit the updated .ts files to fix CI.")
return 1


if __name__ == "__main__":
sys.exit(main())
30 changes: 28 additions & 2 deletions src/model_editor/InspectorGadget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@
#include <QIntValidator>
#include <QLabel>
#include <QLineEdit>
#include <QCoreApplication>
#include <QLocale>
#include <QPainter>
#include <QPushButton>
#include <QRadioButton>
Expand All @@ -53,6 +55,30 @@
#include <QVBoxLayout>

using namespace openstudio;

// Returns "Traducción (Field Name)" when the app locale is non-English and
// a translation exists in the "IDD" context of the loaded .qm file;
// otherwise returns the plain English field name.
//
// Format rationale: the translated term is shown first for readability in the
// target language. The original English IDD field name is retained in
// parentheses because these names are the canonical identifiers used in
// EnergyPlus documentation, the OpenStudio SDK, and .idf/.osm model files.
// A Spanish-speaking engineer who needs to cross-reference the EnergyPlus
// I/O Reference or file a bug report can read the English name without
// having to switch the application language and reload the model.
//
// To add or refine translations: add entries to the IDD context in
// OpenStudioApp_<lang>.ts and recompile with lrelease — no C++ changes needed.
static QString iddFieldDisplayName(const std::string& englishName) {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is really cool, I just wonder how we will be able to maintain this. The Translation test could possibly loop over each IddObject and verify that there is an entry for each one?

Same concern for the OutputVariables

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

That was one my concerns as well. I did a handful of them, but I could imagine the list of these objects would be enormous and difficult to maintain. It also makes the .ts file huge; no small task for the language contributors to review. I envision it would be more of a reactionary process whereby the contributors review the general GUI stuff, but we would get feedback as users stumble upon poorly translated objects.

The OutputVariables should be complete though. I will look into modifying the Translation test.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Good call. The OutputVariable gap is fixed — the original entries only had Zone X prefixed names, but outputVariableNames() returns bare names (e.g. Lights Electricity Energy). Added 359 bare-name entries auto-derived from the Zone translations, plus specific Site/Surface/People/Daylighting entries.

For IDD fields: all fields now have translations across all 18 language .ts files, generated via Claude API batch translation. Two complementary tools maintain coverage:

  • add_idd_skeleton.py — developer maintenance tool. Run after an SDK update to add skeleton entries for any new IDD fields, then run translate_skeleton.py to batch-translate them.
  • Translation_ts.IddCoverageAllLanguages GTest — uses IddFactory::instance() to enumerate every IddObject and its fields, then checks that each unique field name has a source entry in the IDD context of every OpenStudioApp_*.ts file. Fails with a per-language list of missing fields if any file is out of sync.

The test detects drift; the script fixes it. They run independently.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Did you forget to add add_idd_skeleton.py and translate_skeleton.py to the pr?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Added in commit 44b3e7d7. The two scripts are now in the repo root:

  • add_idd_skeleton.py — scans OS_*_FieldEnums.hxx under the OpenStudio build tree to find field names not yet in the IDD context and inserts empty <message> skeleton entries. IDD directory is auto-detected by glob or passed as a CLI argument.
  • translate_skeleton.py — batch-translates those unfinished entries via the Anthropic Messages Batches API (reads ANTHROPIC_API_KEY from the environment).

The IddCoverageAllLanguages test added in this PR already provides the CI enforcement side: it loops over every IDD object's fields via IddFactory and fails if any field name is missing from the IDD context in a .ts file.

const QString qname = QString::fromStdString(englishName);
if (QLocale().language() != QLocale::English) {
const QString translated = QCoreApplication::translate("IDD", englishName.c_str());
if (translated != qname)
return translated + " (" + qname + ")";
}
return qname;
}
using namespace openstudio::model;

const char* InspectorGadget::s_indexSlotName = "indexSlot";
Expand Down Expand Up @@ -507,7 +533,7 @@ void InspectorGadget::layoutText(QVBoxLayout* layout, QWidget* parent, openstudi
auto* vbox = new QVBoxLayout();
frame->setLayout(vbox);

auto* label = new QLabel(QString(name.c_str()), parent);
auto* label = new QLabel(iddFieldDisplayName(name), parent);
label->setWordWrap(true);
vbox->addWidget(label);

Expand Down Expand Up @@ -751,7 +777,7 @@ void InspectorGadget::layoutComboBox(QVBoxLayout* layout, QWidget* parent, opens
auto* frame = new QFrame(parent);
auto* vbox = new QVBoxLayout();
frame->setLayout(vbox);
auto* label = new QLabel(QString(name.c_str()), parent);
auto* label = new QLabel(iddFieldDisplayName(name), parent);
label->setWordWrap(true);

QComboBox* combo = new IGComboBox(parent);
Expand Down
1 change: 1 addition & 0 deletions src/openstudio_app/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,7 @@ set(${target_name}_test_src
test/OpenStudioAppFixture.hpp
test/OpenStudioAppFixture.cpp
test/Resources_GTest.cpp
test/Translation_GTest.cpp
test/Units_GTest.cpp
)

Expand Down
6 changes: 3 additions & 3 deletions src/openstudio_app/ExternalToolsDialog.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ ExternalToolsDialog::ExternalToolsDialog(const openstudio::path& t_dviewPath) :
mainLayout->setColumnMinimumWidth(1, 400);

int row = 0;
auto* title = new QLabel("Change External Tools");
auto* title = new QLabel(tr("Change External Tools"));
title->setObjectName("H1");
mainLayout->addWidget(title, row, 0, 1, 3);

// Dview
++row;
mainLayout->addWidget(new QLabel("Path to DView"), row, 0);
mainLayout->addWidget(new QLabel(tr("Path to DView")), row, 0);

m_dviewPathLineEdit->setText(QString::fromStdString(toString(t_dviewPath)));
mainLayout->addWidget(m_dviewPathLineEdit, row, 1);

auto* changeDviewButton = new QPushButton("Change");
auto* changeDviewButton = new QPushButton(tr("Change"));
connect(changeDviewButton, &QPushButton::clicked, this, [this] { ExternalToolsDialog::onChangeClicked(m_dviewPathLineEdit, "DView"); });
mainLayout->addWidget(changeDviewButton, row, 2);

Expand Down
8 changes: 4 additions & 4 deletions src/openstudio_app/LibraryDialog.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ LibraryDialog::LibraryDialog(const std::vector<openstudio::path>& paths, const s
auto* mainLayout = new QVBoxLayout();
setLayout(mainLayout);

auto* title = new QLabel("Change Default Libraries");
auto* title = new QLabel(tr("Change Default Libraries"));
title->setObjectName("H1");
mainLayout->addWidget(title);

Expand All @@ -39,17 +39,17 @@ LibraryDialog::LibraryDialog(const std::vector<openstudio::path>& paths, const s
auto* addRemoveLayout = new QHBoxLayout();
mainLayout->addLayout(addRemoveLayout);

auto* add = new QPushButton("Add");
auto* add = new QPushButton(tr("Add"));
addRemoveLayout->addWidget(add, 0);
connect(add, &QPushButton::clicked, this, &LibraryDialog::onAdd);

auto* remove = new QPushButton("Remove");
auto* remove = new QPushButton(tr("Remove"));
addRemoveLayout->addWidget(remove, 0);
connect(remove, &QPushButton::clicked, this, &LibraryDialog::onRemove);

addRemoveLayout->addStretch(1);

auto* restore = new QPushButton("Restore Defaults");
auto* restore = new QPushButton(tr("Restore Defaults"));
addRemoveLayout->addWidget(restore, 0, Qt::AlignRight);
connect(restore, &QPushButton::clicked, this, &LibraryDialog::onRestore);

Expand Down
9 changes: 6 additions & 3 deletions src/openstudio_app/OpenStudioApp.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1478,10 +1478,13 @@ bool OpenStudioApp::switchLanguage(const QString& rLanguage) {
}
}

if (m_currLang == QString("fa")) {
// Force Right to Left display. This is not done automatically like in Arabic because qt itself isn't translated (no qt_fa.qm / qt_base_fa.qm)
qDebug() << "Forcing RightToLeft";
if (m_currLang == "ar" || m_currLang == "fa" || m_currLang == "he") {
// Force Right to Left display for RTL languages that don't have qt_XX.qm files
// to trigger it automatically.
qDebug() << "Forcing RightToLeft for" << m_currLang;
OpenStudioApp::setLayoutDirection(Qt::RightToLeft);
} else {
OpenStudioApp::setLayoutDirection(Qt::LeftToRight);
}

return true;
Expand Down
Loading
Loading