Rewrite the help, shown inside ECCE
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 領域
- desktop, documentation
調査の方向性
Start with the existing help-key entries in data/client/config, the client packaging, and the screenshot workflow at tools/screenshots/look.py; the issue also points to the first-calculation tutorial (#12) and window-layout work (#210). The viewer and context links are estimated at about a day, but content is planned chapter by chapter after the layout settles. Done means current, task-oriented help is available in the built-in offline viewer, with context links and tooltips, and the old pages can eventually be retired.
索引モデルが issue の本文から書いたものです。
説明
Summary
ECCE's help is the PNNL-era HTML manual: about 8.6 MB of pages, opened in an external web browser and, in server mode, served by the data server. It describes the 2010 application rather than the current one. This issue replaces it with new help that is written for the current program and shown inside ECCE.
Until the new help is ready, the old pages ship with the client package (7bc69ed0), so Help works on client-only installs and in local mode (#216).
Design
- Viewer:
wxHtmlHelpController. wx's built-in help window has a contents tree, an index and search, and works offline. It behaves the same on Linux, macOS and Windows (#133). No browser or web server is involved. - Context help. F1 or a dialog's Help button opens the help at that dialog's topic. The existing help-key entries (about 274 in
data/client/config) are remapped to the new topics or removed. - Tooltips on fields carry one-line explanations, so most questions are answered without opening the help window.
- Source. Markdown in the repository, converted at build time with
python3-markdown(a build dependency only; nothing is added at run time) into one help book that ships in the client package. - Content. Short and task-oriented: setting up a geometry optimisation, running on a cluster, reading the MO diagram, and so on. The "first calculation" tutorial (#12) is the first chapter.
- Screenshots come from
tools/screenshots/look.py(#210), so they can be regenerated whenever the windows change.
Order
The viewer and the context links take about one day. The content is written chapter by chapter after the window chrome and layout work (#210) has settled, so that the text and screenshots stay current. The old pages are removed in 9.x once the new help covers the same tasks.
- 主要言語
- C
- スター
- 10
- フォーク
- 8
- 平均マージ
- 21分
- マージ済み PR（30日）
- 1
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
FriendsofECCE/ECCE のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
FriendsofECCE/ECCE#336 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
FriendsofECCE/ECCE#339 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 28/100
FriendsofECCE/ECCE#338 · コメント 2 件 ·
-
Basis Set Tool: periodic table cut off on the right; elements 110-118 still have placeholder namesオープン
難易度 4/5 3〜5日 初心者へのやさしさ 40/100
FriendsofECCE/ECCE#337 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 8/100
FriendsofECCE/ECCE#335 ·
FriendsofECCE/ECCE の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
メンテナーはふだん 1 日以内に返信
-
`inverse()` of a controlled `CUGate` drops the phase parameter γ対応中かも @rupasri118 が今日担当しました。 オープンbug mod: circuit
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
Qiskit/qiskit#17223 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
OpenPrinting/libcupsfilters#284 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
libsdl-org/SDL#16530 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
fw876/helloworld#2067 ·
メンテナーはふだん 1 日以内に返信