# Instrukcja obsługi wyszukiwarki WikiMiner

Do płyty został dołączony program wyszukujący o nazwie WikiMiner. Pozwala on na znalezienie w encyklopedii dowolnych słów, zarówno w tytułach, jak i w treści artykułów. Na tej stronie znajduje się szczegółowy opis jego opcji.

Widok okna programu wyszukiwarki w polskiej wersji językowej pod Windows
A - słowa do znalezienia
B - rozpoczyna poszukiwanie i przechodzi bezpośrednio do artykułu,
jeśli jest artykuł o tej nazwie
C - rozpoczyna poszukiwanie, ale zawsze w wyniku
przedstawia wszystkie znalezione artykuły
D - jeśli szpilka jest wbita, okno będzie zawsze na wierzchu,
jeśli nie - będzie się chować za inne
E - statystyka bazy artykułów
F - liczba wyników na jednej stronie
G - poprzednia strona z wynikami
H - numer pierwszego wyświetlanego wyniku
J - następna strona z wynikami
K - link do stopki tego wydania Wikipedii
L - link do niniejszej strony pomocy

## Uruchamianie programu

Program można uruchomić zarówno po jego zainstalowaniu, z dysku twardego, jak i bezpośrednio z płyty DVD.
Program instalacyjny pod Windows tworzy ikony wyszukiwarki zarówno na pulpicie, jak i w menu Start.
Program można też pod Windows uruchomić za pomocą kombinacji przycisków Alt+Shift+W
Aby pod Windows uruchomić program wyszukiwarki bezpośrednio z płyty DVD, wystarczy użyć pliku WYSZUKIWARKA.BAT w głównym katalogu płyty.

Pod innymi systemami operacyjnymi po zainstalowaniu Javy można uruchamiać program, będąc w katalogu WYSZUKIWARKA na płycie DVD, albo w katalogu do którego został skopiowany, za pomocą polecenia:

java -jar WIKIMINER.JAR

## Wyszukiwanie słów

Program wyszukuje dowolne słowa w obrębie wszystkich artykułów Wikipedii, z wyjątkiem spisów kategorii, stron historii, opisów grafik i innych stron technicznych. Program stara się uwzględniać polską gramatykę odcinając końcówki deklinacyjne i koniugacyjne.

Małe i duże litery nie są rozróżniane. Słowa można wpisywać bez polskich liter, np. zolw zamiast żółw.

Jeśli podamy ciąg słów, zostaną odszukane wszystkie strony, na których każde z tych słów występuje przynajmniej raz w dowolnym miejscu i kolejności.

Po liście wyników można przemieszczać się używając klawiatury, co może być istotne dla ludzi ślepych i niedowidzących. Pod Windows Alt+1 przeskakuje do pierwszego wyniku, Alt+2 do drugiego, itp.

### Operatory logiczne

Program rozpoznaje także operatory i, lub oraz nie oraz nawiasy.
Przykłady:

- Adam i nie Małysz - odszuka wszystkie strony na których występuje słowo Adam, ale nie występuje słowo Małysz.
- Basia hoduje (kota lub chomika) - odszuka wszystkie strony na których występuje słowo Basia, słowo hoduje i przynajmniej jedno ze słów kot oraz chomik, ewentualnie odmienione przez przypadki lub w liczbie mnogiej.

Operator i ma wyższy priorytet (wykonywany jest najpierw) niż operator lub.

### Wyszukiwanie tytułów

Jeśli chcemy dane słowo wyszukać tylko w tytule strony, możemy użyć słowa kluczowego tytuł:.
Przykłady:

- tytuł:Adam Mickiewicz wyszuka wszystkie strony ze słowem Adam w tytule i Mickiewicz w tytule lub treści.
- tytuł:(Adam Mickiewicz) wyszuka strony ze słowami Adam i Mickiewicz w tytule
- tytuł:Adam lub tytuł:Bogdan wyszuka strony ze słowami Adam lub Bogdan w tytule

### Przeszukiwanie kategorii

Artykuł w Wikipedii może znajdować się w jednej, lub większej liczbie kategorii. Każda kategoria także może należeć do pewnych kategorii nadrzędnych.

Aby znaleźć wszystkie artykuły z kategorii mających w nazwie dane słowo, należy użyć komendy kateg: Przeszukiwane są także wszystkie kategorie podrzędne.

Przykłady:

- zamek kateg:Architektura wyszuka wszystkie strony o zamkach w kategorii Architektura i jej podkategoriach.
- kateg:islam kateg:chrześcijaństwo znajdzie wszystkie artykuły, które wśród kategorii nadrzędnych mają zarówno słowo islam jak i chrześcijaństwo.
- kateg:(islam i chrześcijaństwo) inna forma tego samego zapytania.
- obwód nie kateg:matematyka znajdzie słowo "obwód" w artykułach nie związanych z matematyką

### Wersje słów kluczowych

- Zamiast słowa i można też napisać and, &, &&, można je też pominąć
- Zamiast słowa lub można też napisać or, |, ||
- Zamiast słowa nie można też napisać not, !, ~
- Zamiast słowa tytuł: można też napisać title:, tytul:
- Zamiast słowa kateg: można też napisać categ:

### Stopwords

Program odrzuca z zapytania słowa zbyt częste (np. się). Listę tych słów można wyświetlić wykonując program z parametrem -stopwords

## Plik konfiguracyjny WIKI.INI

Program posiada plik konfiguracyjny WIKI.INI w którym mogą znaleźć się następujące opcje:

Opcje | Opis
--- | ---
root=ścieżka | podanie ścieżki do głównego katalogu z artykułami. Można podać kilka ścieżek, oddzielonych średnikami. Program wtedy przeszuka wszystkie.
browser=ścieżka | podanie ścieżki do domyślnej przeglądarki
lang=PL/EN | wybór języka wyszukiwarki (polski lub angielski)
deleteTemp=yes/no | czy w trybie GUI sprzątać po sobie tymczasowe pliki HTML
index=ścieżka | ścieżka do pliku WIKIINDEX.DAT z indeksem
map=ścieżka | ścieżka do pliku MAP.DAT
strings=ścieżka | ścieżka do pliku STRINGS.DAT
charOrder=ścieżka | ścieżka do pliku CHAR_ORDER.DAT
css=ścieżka | ścieżka do pliku WIKI.CSS
logo=ścieżka | ścieżka do pliku z logo Wikipedii
icon=ścieżka | ścieżka do pliku z ikoną Wikipedii
onTopIcon=ścieżka | ścieżka do pliku z ikoną wbitej szpilki (opcja "zawsze na wierzchu")
notOnTopIcon=ścieżka | ścieżka do pliku z ikoną wyciągniętej szpilki (opcja "nie zawsze na wierzchu")
front=ścieżka | ścieżka do strony Stopki
help=ścieżka | ścieżka do tej strony
checkDVD=yes/no | czy program ma sprawdzać, czy płyta DVD Wikipedii jest w napędzie
WWWLinks=yes/no | decyduje, czy obok linków na stronie z wynikami wyszukiwania mają się pojawić dodatkowo linki do ich odpowiedników w wersji Wikipedii na WWW
maxLinksOnPage=liczba | maksymalna liczba linków na jednej stronie z wynikami wyszukiwania
maxCategInResult=liczba | maksymalna liczba kategorii prezentowanych obok jednego linku na stronie z wynikami
Oprócz tego istnieją opcje związane z tworzeniem indeksu, tutaj niewymienione. Szczegóły na stronie domowej programu.

Ścieżki dostępu do plików można w pliku WIKI.INI podawać:

- jako bezwzględne, np. c:\wikidvd\map.dat
- względem katalogu z plikiem .JAR programu na dysku twardym, zaczynając je od tekstu {{JARPATH}}, np.
  map={{JARPATH}}map.dat
- względem ścieżki do płyty DVD podanej w opcji root, zaczynając je od tekstu {{ROOT}}, np.
  index={{ROOT}}WIKIINDEX.DAT

## Opcje linii poleceń

Program można wykonywać także z poziomu linii poleceń. Pozwala to na uruchamianie wyszukiwarki z poziomu skryptów powłoki.

Opcje linii poleceń:

Opcje | Opis
--- | ---
-ini plik.ini | podanie innego pliku z opcjami zamiast WIKI.INI
-lang PL/EN | wybór języka wyszukiwarki (polski/angielski)
slowa kluczowe | wyszukanie okreslonych slow kluczowych
-out plik.html | przekierowanie wyniku do danego pliku (dotyczy tylko linii poleceń)
-format txt | utworzenie tekstowego spisu stron zamiast w formacie HTML
-format wiki | utworzenie spisu do wklejenia na stronę Wikipedii
-start n | pokazanie spisu znalezionych stron począwszy od n-tej znalezionej
-max n | ograniczenie liczby pokazywanych stron do n
-stopwords | wyświetla listę nieindeksowanych słów (stopwords)
-verbose | wyświetlanie na konsoli komunikatów diagnostycznych

## Inne

- Program jest aplikacją Javy. Wymaga zainstalowanego Java Runtime Environment (JRE) w wersji co najmniej 1.5.
- Program pracuje pod dowolnym systemem operacyjnym, pod którym działa Java.
- Program rozpowszechniany jest na licencji GNU General Public License.
- Źródła do programu umieszczone są w jego pliku jar. Można do nich dotrzeć otwierając plik .JAR np. programem WinRAR.
- Nazwa programu pochodzi od słowa "Wikipedia" oraz znanego w statystyce pojęcia "Data mining" (zob. eksploracja danych).
- Strona domowa programu: WikiMiner.
- Kontakt do autora programu: Wikipedysta:Olaf (Olaf Matyja).