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

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

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

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
css, html
Lĩnh vực
frontend

Hướng nghiên cứu

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.

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

Mô tả

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.

Ngôn ngữ chính
Python
Star
205
Fork
17
Merge trung bình
6 giờ 4 phút
Pull request đã merge (30 ngày)
45

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

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

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 txoof/PaperPi

Tất cả issue của txoof/PaperPi

Issue tương tự

Thêm issue về Python

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.