Rewrite the help, shown inside ECCE
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 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
- 平均合併
- 1 小時 45 分鐘
- 30 天內合併 PR
- 5
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南，環境需要你自己搭建：先看它的 README，通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
FriendsofECCE/ECCE 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 70/100
FriendsofECCE/ECCE#529 ·
-
bug
難度 2/5 1-3 小時 新手友好度 63/100
FriendsofECCE/ECCE#519 · 2 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 70/100
FriendsofECCE/ECCE#336 · 1 則留言 ·
-
難度 5/5 一週以上 新手友好度 35/100
FriendsofECCE/ECCE#613 ·
-
Compare Energies: sums of calculations, E/E+ZPE/H/G, solvation energy可能已有人在做 @ohlincha 今天認領。 未關閉
FriendsofECCE/ECCE#612 · 1 則留言 · 已指派 1 人 ·
查看 FriendsofECCE/ECCE 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 76/100
colbymchenry/codegraph#2982 ·
維護者通常 1 天內回覆
-
area/build-framework kind/new-feature
難度 2/5 1-3 小時 新手友好度 78/100
yugabyte/yugabyte-db#36023 ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 77/100
維護者通常 1 天內回覆
-
Add masked GPIO pull configuration APIs可能已有人在做 關聯的 PR 仍在進行中或已合併。 未關閉
難度 2/5 1-3 小時 新手友好度 68/100
raspberrypi/pico-sdk#3279 ·
維護者通常 3 天內回覆
-
documentation
難度 1/5 1-3 小時 新手友好度 91/100
維護者通常 1 天內回覆