Problems with the TinyMCE plugin docs
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- javascript, php
- Lĩnh vực
- documentation
Hướng nghiên cứu
Xem lại trang plugin TinyMCE tại moodledev.io/docs/4.2/apis/plugintypes/tiny, bao gồm các phần plugin-options và key-files, sau đó kiểm tra layout tiny_example và các comment trong lib/editor/tiny/classes/plugin.php. Tái cấu trúc hướng dẫn để có thể tìm kiếm các ví dụ, giải thích việc truyền option và các bước kiểm tra capability, làm rõ lựa chọn giữa button và menu-item, đồng thời cải thiện các comment PHPdoc; hoàn tất khi cả bảy vấn đề đã được nêu đều được xử lý.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
What is the URL of the page?
https://moodledev.io/docs/4.2/apis/plugintypes/tiny
What is the issue with this page?
Some issues observed while trying (and failing) to make a TinyMCE plugin during the GlobalMoot DevJam.
-
All the useful examples are hidden incollapsbile reasons, so you have to click to see them, and Find-in-page does not work.
-
https://moodledev.io/docs/4.2/apis/plugintypes/tiny#plugin-options---optionsjs-and-plugininfophp spends huge amounts of text explaining how to to pass one string value from PHP to JS - is it really that complicated? Anyway, there is no information about why you might want to do this, when it is appropriate.
-
No-where explains where is the right place to put in a capability check for a feature that should only be available to some users.
-
The page says how to add a button, and how to add a menu item. However, there is no discussion of how to choose which of those you should use.
-
https://moodledev.io/docs/4.2/apis/plugintypes/tiny#key-files - well it starte with common.js, which is hardly key, just a recommended refactoring. Why not, in The directory layout for the
tiny_exampleplugin, and a one-line comment for what each file is. -
I am not sure a tutorial on plguinskel is the thing to put first. It just gets in the way until you know things like whether you want a button or a menu item. I would put that at the end, with a forward-reference.
-
While we are at it, the PHPdoc comments in the code are not great. E.g. the comments on lib/editor/tiny/classes/plugin.php are like a parody of what https://moodledev.io/general/development/abc/comments says you should not to.
Are you able to provide a patch for this?
No (Default)
- Ngôn ngữ chính
- TypeScript
- Star
- 74
- Fork
- 652
- Merge trung bình
- 2 ngày 50 phút
- Pull request đã merge (30 ngày)
- 12
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của moodle/devdocs
-
bug documentation help wanted needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
documentation enhancement help wanted needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
bug documentation help wanted needs-triage
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 65/100
-
bug documentation good first issue needs-triage
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
-
bug documentation help wanted needs-triage
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
Tất cả issue của moodle/devdocs
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
vercel-labs/just-bash#464 ·
-
looksLikeSlug() is ASCII-only, so non-Latin entity slugs (e.g. Korean) skip exact match and collapse Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
TanStack/tanstack.com#1293 ·