Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Rewrite the help, shown inside ECCE

Ouverte
  • Quelque chose ne va pas ?
#219 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
c, markdown, python
Domaine
desktop, documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
C
Étoiles
10
Forks
8
Merge moyen
21 min
PR mergées (30 j)
1

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de FriendsofECCE/ECCE

Toutes les issues de FriendsofECCE/ECCE

Issues similaires

Plus d'issues C

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.