Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Problems with the TinyMCE plugin docs

Aperta
#748 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
javascript, php
Ambito
documentation

Direzione di ricerca

Esamina la pagina del plugin TinyMCE all'indirizzo moodledev.io/docs/4.2/apis/plugintypes/tiny, incluse le sezioni plugin-options e key-files, quindi ispeziona il layout tiny_example e i commenti in lib/editor/tiny/classes/plugin.php. Ristruttura le indicazioni in modo che gli esempi siano ricercabili, spiega il passaggio delle opzioni e i controlli delle capability, chiarisci la scelta tra pulsante e voce di menu e migliora i commenti PHPdoc; il lavoro è completato quando tutte e sette le segnalazioni sono state affrontate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug documentation help wanted needs-triage
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.

  1. All the useful examples are hidden incollapsbile reasons, so you have to click to see them, and Find-in-page does not work.

  2. 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.

  3. 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.

  4. 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.

  5. 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_example plugin, and a one-line comment for what each file is.

  6. 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.

  7. 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)

Lingua principale
TypeScript
Stelle
74
Fork
652
Merge medio
2g 50m
PR unite (30g)
12

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di moodle/devdocs

Tutte le issue di moodle/devdocs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.