Chybějící syntaxe

[ethanius]

Připadá mi, že chybí celkem hodně základních možností, jak text formátovat (budu uvádět html ekvivalenty, ať nemusím opisovat význam):

• br
• hr
• komplet tabulky
• code
  • neurčený code, formátovaný jako pre nebo code v html
  • volitelně možnost podporovat zvýrazňování syntaxe pro jazyk (inforamce o něm by se dala přidávat k code a interpret by mohl, ale nemusel tuto zohlednit)
• v dokumentaci zmiňovaný akronym, zkratka, horní/dolní index
• atribut class, který by umožnil odlišit prvek/prvky od ostatních stejného druhu a do html by se samozřejmě přepisoval právě jako class (kde by text vznikal i se interpretoval, tam to dává možnosti, kde ne, tam by mělo být bezpečné atribut ignorovat, aniž by text ztratil na smyslu)

[andrejtokarcik]

Uvedenie do kontextu: Dokumentácia je zastaralá (t. j. de facto, sa nejedná o špecifikáciu jazyka CzechTile, čomu by napriek všetkému mohlo mnohé nasvedčovať), súčasná implementácia nemálo z týchto nedostatkov už vyriešila bez toho, aby sa to odzrkadlilo na týchto textoch.

Každopádne by sa zišlo venovať trochu lásky ako i dokumentácií, tak i implementácií, každá pomocná ruka padne vhod.

[ethanius]

Však ano. Domlouval jsem se s Almadem, že vytvořím implementaci v JS, respektive, že vytvořím v JS WYSIWYG editor, který jako vstupní i výstupní formát bude mít czechtile. Pročetl jsem tedy dokumentaci a zjistil, že to není dost dobře možné, protože jazyku chybí některé základní výrazové prostředky a u některých popsaných částí je postup implementace nejednoznačný.

[andrejtokarcik]

V takomto prípade by stálo za zváženie, či nie je výhodnejšie asynchrónnym volaním získavať výstup Python CzechTile parsera umiestnenom na serveri a pracovať s ním, skôr ako spracovávať text priamo v JavaScripte. Jediným nedostatkom v tom prípade by bolo, že by bolo treba doprogramovať ďalší expander do samotného CzechTile, aby aj ten samotný mohol byť výstupným formátom (bolo by to však veľmi podobné expanderu do MediaWiki syntaxe, ktorý už v repozitári existuje).

Ktoré konkrétne časti implementácie sú nejednoznačné? Dávnejšie som začal reimplementovať CzT i SneakyLang (čo je framework, na ktorom je Python-CzT parser postavený), čiže som otvorený k návrhom na vylepšenia, oba tieto projekty majú ešte celkom ďalekú cestu k nejakému dokončeniu. A môžem sa tomu teraz začať trochu viac venovať.

Anyway, čo sa týka tohto specu, tak by sa zišli BNF notácie elementov syntaxe, tie by sa jednoduchšie udržiavali relevantné a samotný human-readable text by sa nechal na neskôr.

[ethanius]

Koukám, že máš chuť léčit příznaky. To já bych se raději vrhnul na příčiny. Neúplnost jazyka a jeho dokumentace celkem spolehlivě brání jakékoliv jiné implementaci, než je ta autorova. Je fajn, že je to už někde vyřešené, ale v čem to pomůže komukoliv, kdo bude chtít provést implementaci vlastní?

Nejednoznačnost dokumentace jsem popsal v samostatné issue, tady jsem to zmínil jen proto, že spolu s nedostatečnou množinou významových struktur to je hlavní překážka v implementaci třetí strany. Líbí se mi cíl jazyka (umožnit formátovat text po vzoru wiki, ale pouze se znaky z české klávesnice), ale ten není naplněn. Pokud v nějaké implementaci ano, pak ve specifikaci jazyka ne. Výše popsané jsou prvky, které mě napadly na jeden zátah. Je dost možné, že jazyku chybí výrazových prostředků víc, ale zase není třeba z toho dělat html s jinými značkami. Jestli jsem záměr projektu pochopil správně, pak je v zásadě třeba vzít wiki syntax a pro každou její variantu vymyslet alternativu psanou pouze znaky na české klávesnici. A podle toho teprve psát nějaký parser.

Psal jsem tohle všechno Almadovi a ten na to, ať to hodím jako issue na gihubu. Tak to dělám, ale rozhodně ne proto, aby se to jen tak zametlo pod koberec. Přiznávám, že když mi o tom říkal, žil jsem v domnění, že jazyk je kompletní a stačí ladit implementace.

[andrejtokarcik]

Niekoľko poznámok:

• "jazyk" CzechTile (v aspoň jednej jeho variante) je viac úplný, ako sa zdá;
• CzechTile nemá špecifikáciu v pravom slova zmysle, t. j. takú, ktorá by bola vytvorená predom a podľa ktorej by sa mali riadiť súčasné implementácie parserov -- obsah tohto repozitára, czechtile-syntax, nemožno brať ako špecifikáciu;
• CzechTile má neúplnú a zastaralú dokumentáciu, vytvorenú po naimplementovaní primárneho parsera -- a táto dokumentácia sa nachádza v tomto repozitári, czechtile-syntax.

Odvolávať sa na aktuálne texty v tomto repe ako na "špecifikáciu" teda nemožno a aj preto som navrhol tie BNF, ktoré sú dostatočne demonštratívne a silné na to, aby tvorili špecifikáciu (!) jazyka a umožnili aj implementácie zo strany iných autorov a všeobecne sa zídu aj za iným účelom (napr. na jednoduchšie vytvorenie parsera za pomoci yacc).

A nakoniec, tvojím cieľom je teda napísať WYSIWYG editor, alebo parser CzechTile-u v JavaScripte? Ak chceš v skutočnosti naozaj to prvé, tak vravím, že súčasné nedostatky dokumentácie (resp. pseudo-špecifikácie) nemusíš vôbec brať do úvahy, proste vzdialene zavoláš ten parser, ktorý už napísaný je.