Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Settings page: easier to read and understand (look, wording, layout examples, times; low priority)

未关闭
#261 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
35/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
css, html
领域
frontend

调研方向

Start with src/paperpi/web/templates/settings.html and src/paperpi/web/static/style.css, and read docs/decisions/web-interface.md for the limits: server-built pages, plain CSS, no build step, no JavaScript framework, and it must work on a phone. Work out the group headings, the separation between settings, and the key-on-the-left layout, and reword the shared help texts that mention the config file, giving the settings page its own wording. Done when the maintainer finds the page easy to read in a demo, with before/after screenshots and the design sources listed in the PR.

由索引模型根据 Issue 内容生成。

描述

area:web enhancement

Low priority. Seen in the web interface demo (2026-10-10).

Problem: the plugin settings page (/plugins/<n>/settings, M5 part 3a) is hard to read: the groups don't stand out, the settings run into each other, and the setting's key (lat, display_time, ...) is at the end of the help text.

Wanted:

  • clearer, bolder group headings ("Settings of this plugin", "When and how it is shown", "More settings")
  • better separation between settings
  • the setting's key on the left, its field and help next to or below it
  • base the design on common good practice for settings pages (for example the layout of well-known settings screens and form design guides) rather than inventing our own; list the sources used in the PR

Also (follow-up from part 3a): some shared help texts were written for the config file ("see Layouts above", "leave it out to use ...") and read oddly on the page; give the page its own short wording where needed.

Limits: server-built pages and plain CSS, no build step and no JavaScript framework (docs/decisions/web-interface.md); must work on a phone.

Where: src/paperpi/web/templates/settings.html, src/paperpi/web/static/style.css.

Done when: txoof finds the page easy to read in a demo; before/after screenshots in the PR.

More wanted (txoof, 2026-10-10, after the Library pictures demo of #265):

  • Layout examples: a folded area (opens when clicked) under the layout choice that shows each of the plugin's layouts as an example picture, drawn with the sample data at the screen's size. The Library pictures (#265, web/pictures.py) can be reused: draw one picture per layout instead of only the first.
  • "When it is shown" (level): the label "When it is shown: alert, interrupt or rotation" is unclear. Give each choice a plain label and one line that says what it does, for example "Takes turns with the other plugins" (rotation), "Shown right away when it has news, then the turns go on" (interrupt), "Stays on the screen until it is dismissed" (alert). Check the exact behaviour in scheduler.py before writing the texts.
  • "Which layout": the help text ("Which layout (see "Layouts" above). Leave it out to use the first") was written for the config file. On the page it should read something like "Layout: how the information is arranged on the screen", with the layout names in the choice list and the examples above.
  • Times in human units: "Seconds on screen per turn" (display_time) and other times in seconds (refresh, alert_reminder, alert_max_time) show numbers like 604800 that mean little to most people. Use a slider (or a choice list) with steps that grow: 1–60 seconds, then 5, 10, 15, 30, 60 minutes, then 1, 2, 4, 8, 16, 24 hours (and days where a setting allows it). Show the value as words ("2 hours"). The config file keeps seconds. To decide when starting: which settings get it, the exact steps, what happens with a value from the config file that is not one of the steps (show it as it is, e.g. "7 minutes 30 seconds"), and how it works without JavaScript.

Size: this probably needs two PRs, each based on main: (1) look and wording, (2) layout examples and the time control. Plan the split before coding.

主要语言
Python
星标
205
派生
17
平均合并
4 小时 8 分钟
30 天内合并 PR
72

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

txoof/PaperPi 的其他 Issue

查看 txoof/PaperPi 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。