Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Rewrite the help, shown inside ECCE

Aberta
  • Algo errado?
#219 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
c, markdown, python
Domínio
desktop, documentation

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
C
Estrelas
10
Forks
8
Merge médio
21min
PRs com merge (30d)
1

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de FriendsofECCE/ECCE

Todas as issues de FriendsofECCE/ECCE

Issues semelhantes

Mais issues de C

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.