diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..7bbf1e7 --- /dev/null +++ b/Readme.md @@ -0,0 +1,57 @@ +# Spletni urejevalnik s podporo za preverjanje pravopisa + +Spletni urejevalnik je nadgradnja urejevalnika HTML `
`, ki v besedilu urejevalnika preverja in podčrta pravopisne napake. Namenjen je vgradnji v različne spletne strani in storitve, kjer uporabniki vnašajo besedila v naravnem jeziku. + +## Sistemske zahteve + +- Pravopisni strežnik Amebis Besana na http://localhost:225. V končni verziji bo URL pravopisnega strežnika nastavljiv. +- Sodobni brskalnik s podporo za ECMA v(TODO: Vpiši najstarejšo verzijo, kjer še dela) in HTML(TODO: Vpiši najstarejšo verzijo, kjer še dela) + +## Navodila za vgradnjo + +V svoji kodi HTML vključimo Spletni urejevalnik tako, da: + +### 1. Vključimo JavaScript in CSS Spletnega urejevalnika + +Primer: + +```html + + ... + + + + +``` + +### 2. V kodo HTML vstavimo urejevalnik + +Primer: + +```html + +
Začetno besedilo
+``` + +Kadar vstavljamo urejevalnik v HTML-jev DOM dinamično (npr. z uporabo JavaScript), registriramo urejevalnik tako, da kličemo metodo `BesEditor.register(el)`, kjer `el` predstavlja naš element DOM našega urejevalnika. V tem primeru razred CSS `bes-online-editor` ni potreben. + +Primer: + +```JavaScript +const el = document.createElement('div') + +// Nastavimo, da uporabnik lahko ureja vsebino elementa urejevalnika. +el.contentEditable = "true"; + +// Element urejevalnika vstavimo v DOM. Element urejevalnika mora biti +// vstavljen v dokument pred klicem `BesEditor.register(el)`, ker +// registracija potrebuje njegovo pozicijo v drevesu DOM. +parent.appendChild(el) + +// Registriramo urejevalnik. +BesEditor.register(el) +``` + +## Navodila za razvijalce + +Programsko kodo v tem repozitoriju razvijamo s programom Visual Studio Code. Potrebna je namestitev vtičnika `esbenp.prettier-vscode`.