Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Rewrite the help, shown inside ECCE

Đang mở
  • Có gì không ổn?
#219 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
c, markdown, python
Lĩnh vực
desktop, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
C
Star
10
Fork
8
Merge trung bình
21 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của FriendsofECCE/ECCE

Tất cả issue của FriendsofECCE/ECCE

Issue tương tự

Thêm issue về C

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.