CommonMark

1.9 päivityksen jälkeen on aiheeseen liittyvissä ketjuissa puhuttu jonkin verran sen mukanaan tuomista muutoksista tapaan jolla tekstien muotoilut koodataan viestieditorissa. Asia on sen verran olennainen palstan käytön kannalta, että lienee hyvä selittää se kunnolla auki,

Ohjelmistoalustamme Discourse on aina käyttänyt MarkDown merkintätapaa tekstin muotoiluun. Se on John Gruberin vuonna 2004 kehittämä merkintäkieli ja nykyään hyvin yleinen erilaisissa web-sovelluksissa. Sen idea on olla tehokas, eli nopea kirjoittaa suoraan näppäimistöltä, ilman hiirivalikoiden käsittelyä. Siinä oli kuitenkin yksi valuvika – sitä ei oltu yksiselitteisesti dokumentoitu tai standardoitu, joten toteutukset ja tulkinnat vaihtelivat. Tämän ongelman ratkaisee CommonMark -standardi, jonka Discourse otti käyttöön vasta versiossa 1.9.

http://commonmark.org/

Yksinkertaisimpia perusmuotoiluja:


Lihavointi
Italic

Lainaus


Nämä kirjoitetaan editoriin seuraavasti:

**Lihavointi**
_Italic_ tai *Italic*
> Lainaus

Hyödyllisiä linkkejä:

Perusmuotoilujen ohjeet: Markdown Reference
10 minuutin pikakurssi (englanniksi): Markdown Tutorial - Introduction
Testiympäristö harjoitteluun: commonmark.js demo
Discoursen artikkeli taulukoiden tekemisestä: Add a table to your post using markdown - users - Discourse Meta
Suunnilleen sama opas taulukoista suomeksi: https://tappara.co/t/testaillaan-taulukkoja/8212/2

Rikkinäisiä viestejä palstalla?

Koska CommonMark tuli Discoursessa käyttöön hieman turhan myöhään, palstaltamme löytyy nyt jonkin verran viestejä joiden muotoilu voi olla hieman rikki. Virheitä näkyy ainakin otsikoissa (###) ja lainauksissa. Käyttäjiä pyydetään editoimaan oma rikkinäinen viestinsä ehjäksi, tai raportoimaan @henkilökunta tietoon liputtamalla muulla syyllä - tästä viestin kirjoittaja ei tietenkään saa miinuspisteitä, mutta editoidaan viestit kuntoon.

Tässä ketjussa sopii kysellä ja keskustella CommonMarkin käytöstä ja ominaisuuksista. Toivon että yhteisö ottaa tekstin muotoilun mahdollisuudet nykyistä laajemmin käyttöön, jolloin saadaan sisältörikkaampaa ja luettavampaa sisältöä.

4 tykkäystä

Onko näin ettei Quotet ja URLit enää toimi vai enkö enää osaa?
Tässä esimerkki:

Kävin kokeileen, CAPSIT ei jostain syystä toimi. En korjannut sun viestiäs, mutta voit korjata sen vaihtamalla QUOTE:n ja URL:n pienaakkosiksi.

1 tykkäys

Näin tein ja korjasin.

Onkohan toi bug vai ominaisuus, en meinaan koskaan ole aiemmin törmännyt siihen että caps quote / url ei toimi. Oppinut käyttämään noita capseilla kun erottuvat paremmin ja helpompi hahmottaa jos on esim typoomassa ulr url sijaan :).

Ping @paarma ja @rizka

Markdown Reference

1 tykkäys