PKSI dokumentacja

W tym miejscu znajdziesz ogólne informacje związane z katalogiem

Instalacja/konfiguracja

Instalacja katalogu jest bardzo prosta. Polega na rozpakowaniu archiwum do docelowego folderu na serwerze.

W głównym katalogu szukamy pliku config.php, w którym znajduje się główna konfiguracja

// Ustawienia bazy danych
define('DB_NAME',       'db.sqlite');
// Szablon strony
define( "TEMPLATEPATH", "themes/default" );
// Dane do PA
define('PA_USER',       'demo');
define('PA_PASS',       'demo');

gdzie zdefiniowane są:

define(‚DB_NAME’, ‚db.sqlite’) – nazwa pliku bd, pozostawiamy bez zmian
define( „TEMPLATEPATH”, „themes/default” ) – ścieżka do szablonu. Szablon znajduje się w katalogu themes
define(‚PA_USER’, ‚demo’) – login do panelu administracyjnego warto zmienić
define(‚PA_PASS’, ‚demo’) – hasło do panelu administracyjnego warto zmienić

Adres do panelu administracyjnego http://twoja-domena.pl/admin

Struktura katalogów

• _cache – przechowywane są pliki cache(fragmenty stron, miniatury, konfiguracja katalogu)
• _db – znajduje się bd sqlite
• _log – znajdują się pliki logów
• admin – panel administracyjny
• class – główne klasy, niedostępne do edycji
• cron – skrypty, które możną podpiąć pod cron-a
• inc – w tym katalogu umieszczane są zewnętrzne biblioteki/klasy
• themes – w tym folderze znajdują się skórki. Domyślną skórką jest default. W katalogu skórki znajdują się pliki css(katalog css), pliki js(katalog js), grafika(images) oraz przede wszystkim pliki odpowiedzialne za wygląd katalogu 🙂 Oto lista plików:
  • _drawrating.php – wstawka w widoku wpisu, ocena wpisu
  • add.php – strona z formularzem, za pomocą którego dodawane są wpisy przykład
  • calendar.php – kalendarium przykład, lista wpisów dodanych danego dnia/miesiąca/roku
  • contact.php – strona kontaktowa, przykład, wiadomość wysyłana na adres email podany w konfiguracji
  • footer.php – stopka
  • header.php – nagłówek
  • hp.php – strona główna, lista ostatnich wpisów, warto pamiętać, że lista jest cache-owana
  • list.php – większość list wpisów
  • other.php – inne linki, linki do innych stron/katalogów wprowadzane w konfiguracji(panel admina)
  • pagerank.php – lista stron z danym PR, przykład
  • rating.php – strony top oraz popularne
  • recommend.php – polecane strony lista tworzona na podstawie id w konfiguracji
  • regulations.php – regulamin katalogu – wprowadzany w konfiguracji(panel admina)
  • rss.php – rss
  • search.php – strona z wynikami wyszukiwania
  • sitebar.php – zawartość lewej kolumny(formularz wyszukiwarki, bloczek statystki, losowe tagi, polecane)
  • tag.php – lista wpisów dla danego taga, przykład
  • tags.php – chmura tagów, przykład
  • wpis.php – strona wpisu
  • wpisy.php – lista wpisów

Panel administracyjny

Dalsza konfiguracja katalogu odbywa się w panelu administracyjnym w zakładce konfiguracja. Po wprowadzeniu zmian zapisujemy konfigurację, klikając przycisk zapisz(na rysunku oznaczono 2) . Jeśli wprowadzone zmiany mają pojawić się w katalogu, należy kliknąć link Zapisz konfigurację do pliku(na rysunku oznaczono 3).

Nazwa	Opis	Pełny opis
Konfiguracja
add_wps_security	Bezpieczne dodawanie wpisów	Jeśli ta opcja ustawiona jest na TAK, podczas dodawania wpisu user musi jeszcze odpowiedzieć na pytanie(np. stolica Polski). Pytania dodaje się w panelu administracyjnym w zakładce Konfiguracja -> Pytania.
admin_email	Adres email admina	Adres email na który będą wysyłane zapytania z formularza umieszczonego na stronie kontaktowej
ads_footer	Reklama w stopce strony	Kod reklamowy html/js umieszczony w stopce strony
ads_header	Reklama na górze strony	Kod reklamowy html/js umieszczony w nagłówku strony
ads_inter_1	Reklama na liście	Kod reklamowy html/js umieszczony na listach między 3 a 4 elementem
ads_left	Reklama na lewej kolumnie	Kod reklamowy html/js umieszczony w lewej kolumnie (plik templatki – sidebar.php)
ads_show	Czy pokazywać reklamy?	Jeśli ta opcja ustawiona jest na TAK to wtedy pojawiają się reklamy, w przeciwnym razie się nie pojawiają
ads_sub_h1	Reklamy pod H1	Kod reklamowy html/js umieszczony pod h1 na większości podstron
api_key	Klucz api – dodawanie wpisów przez api – darmowe wpisy	Klucz publiczny, który właściciel katalogu może udostępnić innym. Mając adres katalogu i klucz(publiczny./prywatny) user za pomocą dodawarki będzie mógł dodać dodać wpis. Jeśli katalog jest płatny, to tylko osoba posiadająca klucz prywatny będzie mogła dodać wpis (póki co jeszcze nie wykorzystywany)
api_key_2	Klucz api – dodawanie wpisów przez api – nawet jeśli włączone są płatności	Klucz prywatny, właściciel katalogu zostawia go dla siebie.
blocked_phrase	Blokowane frazy przy dodawaniu wpisów	Niedozwolone frazy – wpis nie zostanie dodany jeśli w jego tytule/opisie/słowach występują te frazy. Frazy rozdzielone są pionową linią, np. fraza 1|fraza 2|blokowane słowa
desc_hp	Opis na stronie głównej katalogu	Tekst html jaki będzie się znajdował na stronie głównej katalogu. Pojawi się na samej górze w prawej kolumnie
desc_max	Maksymalna długość opisu	Maksymalna długość opisu dla dodawanej strony
desc_min	Minimalna długość opisu	Minimalna długość opisu dla dodawanej strony
description	Opis katalogu	Opis katalogu wykorzystywany w meta description
gm_links	Ile linków w sitemap	Ilość linków w jednym pliku sitemap
is_debug	Debugowanie	Jeśli ta opcja ustawiona jest na TAK to wtedy do logów trafiają informacje o próbach dodania wpisu. Z każdego dnia tworzy się plik add_yyyy_mm_dd.txt Logi dostępne są w zakładce Logi
keywords	Słowa kluczowe	Słówa kluczowe wykorzystywane w meta keywords
kw_max	Maksymalna długość słów kluczowych	Maksymalna ilość znaków słów kluczowych dla dodawanej strony
kw_min	Minimalna długość słów kluczowych	Minimalna ilość znaków słów kluczowych dla dodawanej strony
mail_send_fmail	Wysyłka maila(tak->funkcja mail/nie->phpmailer)	Wysyłka maila. Jeśli wybrano TAK – wysyłka za pomocą funkcji mail. Jeśli wybrano NIE– wysyłka za pomocą phpmailer. Ważne, aby w pliku config.php uzupełnić dane dla phpmailer(login, hasło)
number_links	lość rekordów na stronie / uzywany przy tworzeniu pagera	lość rekordów na stronie – używany przy tworzeniu pagera
other_links	Inne linki	Kod html, kótry pojawi się na stronie www.adres/inne . Tam możemy wrzucać linki zwrotne itp.
proxy_hp	Proxy [host:port] (curl)	Niestety z internetem łączę się przez proxy, dlatego ta opcja 🙂
proxy_use	Czy używać ustawień proxy?	Jeśli opcja TAK aktywna, katalog korzysta z ustawień proxy przy pobieraniu stron itp.
proxy_userpwd	Proxy autoryzacja (curl) [login:haslo]	Autoryzacja proxy
recommend	Polecane wpisy(id po przecinku)	W panelu administracyjnym w zakładce konfiguracja znajdziemy recommend Polecane wpisy(id po przecinku) – tam podajemy id wpisów oddzielone przecinkami. Wpisy te pojawią się: – na stronie www.adreskatalogu/polecamy – w ostatnim kroku dodawania wpisu, user dostanie listę linków do tych wpisów – na stronie głównej – prawa kolumna – rotujące losowe polecane wpisy
recommend_left	Bloczek Polecamy na lewej kolumnie	Kod html. Bloczek pojawia się na lewej kolumnie. Kolejność bloczku można zmienić w pliku templatki sidebar.php
reg	Regulamin katalogu	Regulamin katalogu  dostępny pod adresem www.adreskatalogu/regulamin
seo_check_page_exists	Sprawdza czy strona istnieje	Jeśli ta opcja ustawiona jest na TAK to wtedy do losowo sprawdzane są adresy url wpisów. Wyniki znajdziemy w panelu admina w zakładce Stats
seo_ping	Pingowanie	Jeśli ta opcja ustawiona jest na TAK, wtedy pingowane są podstrony katalogu
serv_proxy	Serwery proxy [adres:port] każdy serwer od nowej linii.	Serwery proxy używane podczas pingowania
serv_rpc	Serwery RPC	Serwery RPC używane podczas pingowania
stats_ga	GoogleAnalitics	Kod Google Analitics
stats_robots	Meta- Validate – google, yahoo, msn	Meta- Validate – google, msn
title	Tytuł katalogu	Tytł katalogu wykorzystywany w meta title
title_max	Maksymalna długość tytułu	Maksymalna ilość znaków tytułu dla dodawanej strony
title_min	Minimalna długość tytułu	Minimalna ilość znaków tytułu dla dodawanej strony
wps_add_paid	Płatne wpisy	Jeśli opcja ustawiona jest na TAK przy dodawaniu wpisu należy podać kod dostępu. Zarządzanie kodami dostępu – zakładaka Konfiguracja -> Kody
wps_add_paid_info	Informacja o sposobie płatności za kody	Informacja o sposobie płatności za kody
wps_per_code	Ilość wpisów dla jednego kodu	Ilość wpisów jakie można dodać wykorzystując jeden kod. Wartość ta ustawia ilość wpisów podczas dodawania nowy kodów.
Konfiuracja -> Zapisz konfigurację do pliku
Aby zmieny wprowadzone w konfiguracji były widoczne w katalogu, należy kliknąć w link zapisz konfiguację do pliku
Konfiguracja -> Cache
W tym miejscu możemy przeglądać zawartość cache-u, czyli: zmienne sesyjne, miniaturki oraz fragmenty kodu stron
Konfiguracja -> Kody
Zarządzanie kodami dosępu. Dodawanie/usuwanie edycja kodów dostępu. Podczas dodawania nowych kodów, każdy kod wprowadzamy w nowej linii. Ustawiamy także ilość wpisów – czyli ile wpisów będzie mogło być dodanych przy wykorzystaniu jednego kodu
Konfiguracja -> Pytania
Zarządzanie pytaniami. Definiujemy pytania, które na które będą musieli odpowiedzieć userzy podczas dodawania wpisu. Proste zabezpieczenie przez nadmiernym spamem.
Mapa strony
Zarządzanie mapami strony. Możliwość ręcznego tworzenia/aktualizacji map/indexmap
Wpisy
Lista wpisów w katalogu. Możliwość sortowania/wyszukiwania/edycji/usuwania wpisów
Tagi
Lista tagów w katalogu. Możliwość wyszukiwania/edycji/usuwania tagów
Stats
Lista dostępności adresów url. Jeśli adres zwraca kod strony różny od 200 to informacja o tym zostaje zapisana.
Oceny
Lista ocenianych wpisów – ilość głosów, średnia ocena. Opcja Czyść info usuwa informacje o głosujących
Logi
W katalogu mogą być logowane następujące informacje: – odpowiedź pingownaych serwerów rpc/wpisów – pliki log_*.txt – przebieg dodawania stron przez użytkowników – pliki add_*.txt – obecność robotów/użytkowników na podstronach katalogu – pliki robot_*.txt

Szablony

Wszystkie szablony znajdują się w katalogu themes. Na starcie dostępne są trzy szablony. Najprostrzym sposobem stworzenia nowego szablonu jest skopiowanie już istniejącego i dokonania zmian graficznych w nowym szablonie.

W pliku config.php zdefiniowany jest defaultowy szablon

Update

Update polega na nadpisaniu istniejących plików. Szczególną uwagę należy zwrócić na pliki, które zostały zmodyfikowane przez użytkownika. Nie wolno nadpisywać głównego pliku konfiguracyjnego config.php oraz bazy danych, która znajdujesię w katalogu _db