Pluginien yleinen graafinen editori

[sijualle]

Tällä hetkellä kaikki pluginien attribuutit annetaan markdownina ja käyttäjä kirjoittaa sen tekstinä. Tällöin käyttäjän pitää tietää että mitä attribuutteja pluginissa voi käyttää ja että missä muodossa ne pitää antaa. Noita pluginkohtaisia attribuutteja on dokumentoitu milloin missäkin päin TIMin ohjeita, mutta ne eivät ole aina ajan tasalla eikä uusi käyttäjä välttämättä löydä niitä tai lähde etsimään olisiko siellä joku ominaisuus jota en ole vielä huomannut. Itsekin olen lisännyt plugineihin monia attribuutteja eri käyttätapauksia varten, ja en edes omista lisäämistäni attribuuteista aina muista että kirjoitetaanko joku textArea isolla vai pienellä A:lla.

Plugineita voisi hyvin editoida graafisella käyttöliittymällä. Tässä liittymässä olisi lista kaikista plugineista, ja sille kelpaavia attribuutteja sen mukaan mikä plugin on kyseessä. Attribuuttien listasta voisi poimia ne attribuutit jotka haluaa käyttöön

Pohdintoja:

• Saatavilla olevat attribuutit pitäisi vaihtua pluginin mukaan, eli yleiset kaikille sopivat attribuutit + pluginin omat attribuutit
• Osa attribuuteista on melko kryptisiä ja niitä on käytetty vain yksittäisissä käyttötapauksissa. Tarvittaessa sellaisia joita ei peruskäyttäjä ei koskaan tarvitse voisi piilottaa jonkun "näytä vain yleisimmät"-ruksin taakse. Esim textfieldin "cols"-attribuutti varmaan on hyvä näyttää aina, "downloadButtonFile" voisi olla piilotettu oletuksena.
• Editorissa pitäisi olla integroitu suoraan ohjeet siitä että mihin plugin on tarkoitettu ja että mitä attribuutti tekee. Jotain pieniä ?-tooltippejä tai dialogi-ikkunoita joissa on lyhyt ohje (ehkä myös esimerkki?) attribuutin/pluginin käytöstä, ja perässä sitten linkki johonkin timin isompaan ohjesivuun.
• Attribuutteja ja pluginien nimiä pitäisi näyttää mahdollisimman selkokielisenä. Eli "multisave" sijaan suomikäännöksessä pluginin tyyppivalikossa olisi "Tallennusplugin (multisave)", yleinen "disableUnchanged" attribuutti enkkukäännöksessä "Disable saving without changes" tjsp
• Jos on plugin joka vaatii tehtävätunnisteen niin editorin pitäisi hälyttää jos se puuttuu.
• Jos editorilla muokkaa vanhaa pluginia ja vaihtaa tyyppiä/tehtävätunnistetta niin pitäisi varoittaa että saatat sotkea jotain jos tähän on jo vastattu (ehkä voisi palvelimelta tarkistaa onko vastauksia vielä)
• Editorin pitäisi jostain onkia tieto että mitkä pluginasetukset tulevat dokumenttiasetuksista tai preambleista yms, ja näyttää ne erikseen
• Attribuutit voisi varmaan kaikki alkuun antaa merkkijonona, kunhan integroidussa ohjeessa on selkeä ohje siitä missä muodossa attribuutti pitää antaa.
  • Myöhemmin voisi tarvittaessa näyttää jotain yksityiskohtaisemapaa syötekenttää. Esim undo voisi näyttää kolmena alitekstikenttänä (Napin teksti, Varmennuksen teksti jne). Bool-tyyppiset tai määrätyn sanajoukon attribuutit voisi olla radiobuttoneita tms, deadlinet jollain päivyrikomponentilla tms
  • Tosin jos haluaisi antaa editorissa makron, niin pitäisi olla joku tapa antaa attribuutti tarvittaessa tekstikenttäsyötteenä
• Makroja ei saisi syödä pois, kuten esim qst-editori nyt tekee (#3383)
• Esikatselu pitäisi olla samanlainen kuin normieditorissa. Ehkä voisi livenä näyttää myös että millaista yamlia näillä asetuksilla tulee
• Pakollisia attribuutteja ei välttämättä saisi voida poistaa. Tosin ehkä joskus niitä annetaan dokumentin global_plugin_attrsin kautta, joten ehkä niitä voisi antaa poistaa mutta varoittaa että "Pluginista puutuu pakollinen asetus type" cspluginin kohdalla jne

[vesal]

Olen tuota jo alusta asti miettinyt. Alunperin meillä ei ollut riittävästi käyttötapauksia suunitella tuota. Etenenisin seuraavasti:

1. Siirrytään yhteen nimeämistapaan (ihanne tilanteessa, tästä on kai korttikin, kelpaisi autosave, autoSave tai auto_save. Jos tuo on hankalaa, niin etsitään ja vaihdetaan kaikki olemassa olevat "väärin" kirjoitetut. Toki tulevaisuudessa tulee ongelmia joskus että onko kyseessä yksi vai kaksi sanaa ja kirjoitusasuun voi tulla vaihtelua. Entä jos pluginista tehtävä JSON aina tekisi lowercase + remove('_ '). Ja sisäisesti kaikki nimet olisivat lowercase?
2. Kiinnitetään mihin ja miten pluginien attribuutit dokumentoidaan. Yksi voisi olla että plugnien koodissa olisi ComTest-tyylisesti sovittu tapaa attribuuttien esittelyyn ja enkuksi kommentointiin. Sitten jokin funktio hakee attribuutit ja niiden kommentit TimTableen, jossa niitä on siten helppoa etsiä ja järjestää (yksi sarake voisi olla "tärkeys"). Muun kieliset versiot tehdään tuosta TIMin käännöksellä. Jos plugin perii muita kuin omat attribuuttinsa, niin niiden arvo "lainattaisiin" joko lainaamalla perityn pluginin TimTable tai yhdistämällä arvot (saattaisi mennä niin että TimTablen sisällön alkuun tuotaisiin makrolla edeltävät attribuutit, jolloin ylläpito olisi vaan siellä yhdessä paikassa). Jokaiselle pluginille on oma TIM-sivu. Joskus yritin aloittaa pluginien doc-sivuja, mutta se jäi kesken.
3. Editori tunnistaa että ollaan tekemässä pluginia ja kykenee näyttämään sen dokumentaation editorin PopUpiina käyttäjän kielellä. Siellä TimTablessa klikkaamalla työnnetään attribuutin nimi ja oletusarvo editoriin (vrt. ImageX preview:ssa klikkaaminen työntää koordinaatin editoriin).
4. Mietitään saadaanko edellisillä automaattisesti syntymään GUI-editori. Silloin olisi kaikki tavat käytössä. Ehkä Helpompi kuin tuo Simon kuva olisi jos siinä YAML-previewssa riviä klikaamalla editoriin tulisi sen attribuutin tiedot jossa arvoa voi tyypistä riippuen muuttaa ruksaamalla tai arvoa muuttamalla.

Haasteita tulee aika paljon tosiaan makroista. Sampsa on vienyt makrot vielä pykälää pidemmälle omalla kurssillaan. Simppelein ratkaisu olisi ettei koko editori aukea jos on makroja. Tai sitten editori voisi aueta readonlynä ja YAML-preview olisi näkymä makrot avattuun tilanteeseen, jolloin attrbuutteja voi kelailla. Jos attribuutin arvo tulee ilmankin makron avaamista (rivi esiintyy alkuperäisessä YAMLissa), niin silloin editori voisi toki sallia sen arvon muuttamisen.

Toinen haaste tulee olioattribuuteista. Sekin saattaisi välttävästi toimia jos YAML-previewessä näkyy ne oloina ja sitten klikataan jotakin olion omaa attribuuttia, niin editoriin tulee sen attribuutin muokkaus. Tähän taas haasteita voi tuoda jos olioita on esitetty JSONina.