Files
Jungfraujoch/viewer/windows/JFJochAlgorithmDocWindow.h
T
leonarski_fandClaude Opus 5 681e80e46d
Build Packages / build:viewer-tgz:cpu (push) Successful in 6m52s
Build Packages / build:viewer-tgz:cuda (push) Successful in 7m23s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 10m33s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 10m40s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 10m41s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 10m17s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 10m25s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 11m26s
Build Packages / build:rpm (rocky8) (push) Successful in 11m12s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 11m40s
Build Packages / build:rpm (rocky9) (push) Successful in 12m46s
Build Packages / Generate python client (push) Successful in 17s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 12m10s
Build Packages / Create release (push) Skipped
Build Packages / Build documentation (push) Successful in 1m9s
Build Packages / XDS test (durin plugin) (push) Successful in 8m27s
Build Packages / XDS test (JFJoch plugin) (push) Successful in 7m45s
Build Packages / DIALS test (push) Successful in 14m16s
Build Packages / XDS test (neggia plugin) (push) Successful in 7m30s
Build Packages / Unit tests (push) Successful in 1h32m14s
Build Packages / build:windows:nocuda (push) Canceled after 0s
Build Packages / build:windows:cuda (push) Canceled after 0s
Viewer: read the data-analysis algorithm documentation from Help
Adds Help > Data Analysis Algorithms, showing docs/CPU_DATA_ANALYSIS.md in a
window. The document is baked into the binary through the Qt resource system
(aliased to :/cpu_data_analysis.md), so it needs no docs/ directory at runtime
and cannot drift from the build it shipped with. Same shape as the existing
third-party licences window, created once and raised thereafter.

Limitation worth knowing: QTextBrowser::setMarkdown renders the headings, lists,
emphasis and inline code well, but it has no math support, so the inline LaTeX in
the more quantitative sections appears as raw "$...$" source. The descriptive
material - which is most of the 744 lines - reads fine. Fixing that properly
means either pre-rendering the document to HTML with a math filter at build time,
or sending the user to the Read The Docs copy instead; neither seemed worth doing
without knowing which you would prefer.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-26 22:05:11 +02:00

16 lines
564 B
C++

// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#pragma once
#include <QDialog>
// Modeless window showing the data-analysis algorithm documentation, rendered from the copy of
// docs/CPU_DATA_ANALYSIS.md baked into the binary (:/cpu_data_analysis.md), so it is available
// wherever the viewer runs and always matches the build.
class JFJochAlgorithmDocWindow : public QDialog {
Q_OBJECT
public:
explicit JFJochAlgorithmDocWindow(QWidget *parent = nullptr);
};