This repo is archived. You can view files and clone it, but cannot push or open issues or pull requests.
RSS-reader/docs.org
Balazs Toldi 6ddbaeb9bf
Some checks failed
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is failing
Updated Documentation
2020-12-01 21:55:48 +01:00

3.1 KiB

RSS-Reader hf

Fejlesztői dokumentáció

A projekt lefordítása

A projektem Maven maven projekt managemant rendszert használja. Így a programot fordítása a következő parancsal fordíthatja le:

mvn clean package

Usecase-ek

Hírcsatornák kezelése: A felhasználónak lesz lehetősőge új csatornákatfelvenni, a meglévőket törölni vagy átcsoportosítani. Hírek böngészése: A letöltött hírekk között a felhasználó kedvére bön-gészhet Cikk olvasása: Egy cikk címére kattintva a felhasználó elolvashatja a kivá-lasztott cikket.

Osztályok leírása

Az osztályok leírását a JavaDoc dokumentációban olvasható el.

OsztályDiagram

/Bazsalanszky/RSS-reader/media/commit/bbf3d8819237f398fa6988fe8f140516dbccb16b/img/Main.jpg

Felhasználói dokumentáció

Felhasználói felület bemutatása

/Bazsalanszky/RSS-reader/media/commit/bbf3d8819237f398fa6988fe8f140516dbccb16b/img/abra1.png

  • Cikkek táblázata: itt olvashatóak a hírcsatornákhoz tartozó cikkek
  • Kereső: Az itt található szövegdoboz segítségével lehet keresni a cikkek között. A keresés írás közben végrehajtódik
  • Hírcsatonák fája: Itt jelennek meg a programhoz hozzáadott hírcsatornák. Ezekre bal egérgombal kattintva kétszer leszűkíthetjük a cikkeket csak a kijelölt hírcsatornára.
  • Menüpontok: Itt lehet új csatornákat hozzáadni,frissíteni őket,vakamint kilépni.

Hírcsatorna hozzáadása

Új csatorna hozzáadaása nagyon egyszerű. A fálj menü alatt az "Add Feed" opcióra kattintva megjelenik egy új ablak. Az itt található szövegdobozba kell beírni a kivánt hírcsatorna linkjét.

Példa

/Bazsalanszky/RSS-reader/media/commit/bbf3d8819237f398fa6988fe8f140516dbccb16b/img/abra2.png

Cikkek olvasása

A cikkek táblázatában egy cikkre bal egérgombal kattintva kétszer megnyitja az adott cikket a rendszer által megjelöl alapértelemezett böngészőben(ha ez lehetséges).

Csatornák átrendezése

A csatornák átrendezésére a hírcsatornák fájában van lehetőség. Egy csatornára hosszan bal egérgombal kattintva áthúzható egy másik helyre. Ezt a program automatikusan menti is.

Csoport létrehozása

Ha átrendezés során egy hírcsatornát egy másikra húzunk,akkor az egérgomb elengedése után a két hírcsatorna együtt egy csoportot alkotva fognak megjelenni. Hasonlóképpen új hírcsatornák is hozzáadhatók a csoporthoz.

Fontos megjegyzés: Egy csoporton belül nem hozható létre új csoport.

Csatornák törlése

Egy hírcsatornára jobb egérgombal kattintva és utána a "Remove" opciót választva a hírcsatorna törlésre kerül.

Csoportok átnevezése

Egy hírcsatorna csoportra jobb egérgombal kattintva és utána a "Rename" opciót választva a csoport egy felugró ablakon keresztül átnevezhető.

Csatornák frissítése

A csatornák 10 percenként automatikusan frissülnek.Emellett lehetőség van manuális frissítésre is. Ezt a fájl menü alatt található "Update Feeds" opció segítségével tehető meg.