Doplňky slovníku SPOT SPOTým Finální specifikace požadavků Tým: SPOTým Bc. Pavel Máčka Bc. Jan Bešta Bc. Jan Plas Bc. Vojtěch Žihla Autor: Pavel Máčka Datum: 22.dubna
1. Úvod Cílem tohoto dokumentu je popsat základní požadavky, které jsou kladeny na aplikaci - vytvářené doplňky k překladovému slovníku SPOT. Těmito doplňky jsou: - Zjednodušení administrace slovníku SPOT - Přidávání nenalezených slov do slovníku SPOT na žádost uživatelů - Skinovatelnost slovníku SPOT 2. Základní části aplikace a funkce jimi poskytované Aplikace se dělí na 3 části ucelené množiny doplňků ke stávajícímu slovníku SPOT. Zde jsou tyto části a jejich požadované funkčnosti podrobněji rozepsány. 2.1 Zjednodušení administrace slovníku SPOT Ve správě slovníku je nutno vytvořit možnost třídit výstupy v kategoriích správa komentářů, správa kontextu, správa projektů a správa typů zdrojů. Umožnit třídění alespoň podle abecedy či data vytvoření. Zjednodušit a sjednotit administraci u jednotlivých kategorií (hromadný edit, příjemnější práce s tlačítky). Umožnit administrátorovi založit nového uživatele. Protože do sekce správa slovníku má přístup pouze administrátor, bude se zde brát jako jediný uživatel a nebude již dále uváděn. 2.1.1 Třídění výstupů v uvedených kategoriích ve správě slovníku Měla by být implementována možnost třídění výstupů alespoň podle data vytvoření a podle abecedy. Tato funkcionalita se týká kategorií, které obsahují velmi mnoho výstupů a je pak obtížné a zdlouhavé se jimi probírat. Těmito kategoriemi jsou: - Správa komentářů - Správa projektů - Správa typů zdrojů - Správa uživatelů - Schvalování slovní zásoby 2.1.2 Zjednodušení a sjednocení administrace u správy komentářů Zvlášť u komentářů je zvýšené riziko spamu, proto je hlavně zde požadována možnost označit více komentářů a hromadně je smazat. Přidat k jednotlivým komentářům checkboxy, tlačítka Vybrat všechno / nic / Smazat, a pomocí nich komentáře hromadně spravovat. Dále se zde požaduje nahradit odkaz URL, který má odkazovat na stránku slova, kde se daný komentář nachází. Místo URL použít například Zobrazit slovo.
2.1.3 Zjednodušení a sjednocení administrace u správy projektů Požadována možnost hromadné správy, tzn. u každého projektu checkbox a pak pomocí tlačítek vybrat všechny projekty nebo žádné a následně pomocí tlačítek provádět hromadně mazání / zakazování / povolování projektů. 2.1.4 Zjednodušení a sjednocení administrace u správy uživatelů Přidat checkboxy k jednotlivým uživatelům a umožnit hromadnou správu, tj. hromadné mazání / zakázání / povolení. U každého uživatele by měla být možnost zobrazit základní údaje o uživateli: - Kdo jsou význační uživatelé (ikonka označující administrátora, moderátora) - Možnost rozkliknutí, jak se daný uživatel jmenuje Editaci, která se zobrazí po kliknutí na ikonku tužky sjednotit, aby se daný formulář objevil na stejné stránce tj. stránce správy uživatelů. 2.1.5 Umožnit administrátorovi přidat uživatele Administrátor musí mít možnost sám založit uživatele. Formulář pro přidání nového uživatele se bude vyskytovat na stránce správy uživatelů dole. Uvážit, zda formulář napevno zobrazit nebo jej rozkliknout pomocí JavaScriptu. 2.1.6 Sjednocení administrace u ostatních kategorií U zbývajících kategorií, jimiž jsou - Správa kategorií - Správa typů zdrojů - Správa úzů - Správa odkazů je nutné sjednotit jejich administraci s předchozími kategoriemi. Odstranit ikonku křížku pro mazání a místo toho přidat checkboxy a tlačítka pro hromadnou administraci. 2.2 Přidávání překladů na žádost uživatelů Pokud není dané slovo nalezeno, umožnit i pro nezaregistrované přidat návrh na překlad nebo navrhnout jeho překlad. Moderátoři by měli být informováni (mailem) o žádostech přidání překladů včetně priority přeložení daného slova. 2.2.1 Pokud uživatel nenalezne překlad možnost přidat termín Libovolný uživatel zavítá na stránky slovníku SPOT a hledá překlad k určitému anglickému slovu, ale nenalezne jej. Dostane tedy možnost přidat toto slovo do databáze SPOTu. Pokud se jedná o přihlášeného uživatele, slovo se normálně uloží pod ním. Pokud se jedná o anonymního uživatele, slovo se uloží pod speciálního proxy (defaultního) uživatele, který bude pro tyto případy vytvořen. Přístup: Všichni uživatelé
2.2.2 Přidání statistiky žádostí o překlad Na stránce originálního slova bude formulář pro žádost o překlad. Bude obsahovat captchu a možnost kliknutí, kterým uživatelé vyjádří svou žádost o překlad. Tyto žádosti se budou sčítat a aktuální součty ukládat k danému slovu. Přístup: Všichni uživatelé 2.2.3 Zobrazení žebříčku žádostí o překlad Přihlášený uživatel bude mít možnost na hlavní stránce SPOTu si nechat zobrazit žebříček žádostí o překlad. Žebříček bude možno zobrazit podle priority vycházející ze statistiky žádostí o překlad anebo chronologicky dle datumů prvních žádostí o překlad. Přístup: Přihlášení uživatelé 2.2.4 Přidání lepšího překladu od nepřihlášeného / nezaregistrovaného uživatele Pokud daný termín nemá zatím žádný (nevyhovující) překlad, umožnit i nepřihlášenému / nezaregistrovanému uživateli přidat (lepší) překlad k danému termínu. Dát mu na výběr ze dvou formulářů buď formulář registrace nebo speciální formulář pro přidání překladu, kde by uživatel uvedl popis k jeho navrženému překladu a nějaký kontakt na něj (email). Přístup: Všichni uživatelé, ale význam má pro nepřihlášeného neregistrovaného uživatele 2.2.5 Umožnit správu žádostí o překlad Přidat správu žádostí o překlad do Správy slovníku. Administrátor bude mít nejen přehled o všech žádostech, ale může je i spravovat; rozhodovat, která slova mají již adekvátní překlady a vyřadit je z žádostí o překlad apod. Jedná se spíše zatím jen o dodatečnou funkčnost s menší prioritou. Přístup: Administrátor 2.3 Skinovatelnost slovníku SPOT Umožnit vytváření skinů (přes CSS a obrázky) pro slovník a přepínat je. HTML základ zůstává stejný. Přepínání by mohlo být pro uživatele (v profilu) nebo projekt (pro odlišení, ve kterém projektu se právě nacházím). Projektový skin má větší prioritu než skin uživatele. Určit výchozí (defaultní) skin SPOTu pro nepřihlášeného uživatele.
2.3.1 Administrátor nahrává skiny Administrátor nahraje do systému jednotlivé skiny (CSS + obrázky) a pak přidá nové skiny ve Správě slovníku -> Správa skinů. Přidá tak skin do databáze včetně cesty a dalších jeho atributů (viz výše). Přístup: Administrátor 2.3.2 Uživatel si může nastavit skin Každý zaregistrovaný přihlášený uživatel si může vybrat libovolný skin v nabídce. Možnost výběru skinu bude mít přihlášený uživatel na svém profilu. V nabídce skinů uvidí název skinu, popis a printscreen každého daného skinu pro představu. Přístup: Každý zaregistrovaný přihlášený uživatel 2.3.3 U daného projektu lze nastavit vybraný skin U každého projektu lze nastavit vybraný skin. Správce daného projektu vybere skin k tomuto projektu a ten se pak zobrazí přihlášeným uživatelům, kteří se do tohoto projektu přepnou. Skin projektu má přednost před skinem uživatele. Přístup: Každý zaregistrovaný přihlášený uživatel přiřazený u nějakého projektu 2.3.4 Určení defaultního skinu SPOTu Bude jeden defaultní skin, který bude nastaven, když nebude uživatel přihlášen. Defaultní skin vybere administrátor ve správě skinů. Přístup: Každý uživatel 3. Mimofunkční požadavky Záležitosti, které nesouvisí s konkrétní funkcionalitou, ale je potřeba je zohlednit při vytváření výsledného produktu. 3.1 Systémové požadavky Protože se jedná pouze o rozšíření aplikace, kde se nečeká žádna větší a komplexnější změna funkčnosti ovlivňující systémové požadavky, jsou systémové požadavky stejné jako systémové požadavky samotného slovníku SPOT bez implementace této aplikace.