WebToDate/Fulltext Google/Reference

Administrační rozhraní

Nabídka modulu

Nabídka modulu vypadá následovně:

Nástroje

Vyhledávací formulář

Nastavení

Globální

Vyhledávací stránka

Navigační lišta

Administrace

Předvolby

K administrační části modulu mají přístup pouze administrátoři WebToDate.

Nástroje

Funkce Nástroje obsahuje funkci pro vygenerování výchozího HTML kódu vyhledávacího formuláře a jeho uložení do těla nově založeného fragmentu. Volí se kategorie, publikace a jazyk fragmentu.

Nastavení

Funkce Vyhledávací stránka slouží k nastavení vyhledávací stránky, tj. její předlohy, způsobu formátování výsledků hledání apod. Samotná vyhledávací stránka se pak v prezentační části zobrazuje na adrese /scripts/modules/fg/fulltxt.php.

Ve formuláři se nastavují následující prvky:

• Předloha – vybírá se předloha vyhledávací stránky
• Formátování – volí se možnost formátovat výsledky hledání pomocí WebToDate stylu nebo XSLT transformace
• WebToDate styl – pokud je nastaveno použít WebToDate styl, aplikuje se na výsledky hledání styl zvolený v této rozevírací nabídce
• Transformace – pokud je nastaveno použít transformaci, aplikuje se na výsledky hledání XSLT transformace zvolená v této rozevírací nabídce (ukládá se do databáze transformací WebToDate)
• Počet záznamů / str. – definuje stránkování, tj. kolik položek se na každé stránce výpisu nalezených zobrazuje
• Uvozující nadpis výpisu odlišuje případy, kdy byla nalezena alespoň jedna položka a kdy nebyla nalezena žádná položka.

V předloze se výpis nalezených položek dosazuje za klíčové slovo <!--WTD_FULLTXT(LIST)-->, uvozující nadpis za klíčové slovo <!--WTD_FULLTXT(LABEL)-->. V definici uvozujícího nadpisu lze použít klíčová slova <!--WTD_FULLTXT(FROM)-->, <!--WTD_FULLTXT(TO)--> a <!--WTD_FULLTXT(TOTAL)-->.

Více o volbě formátování výsledků hledání pomocí stylu či transformace se dozvíte v kapitole Volba způsobu formátování výsledků hledání.

Ve formuláři Navigační lišta je definován vzhled lišty, která je používána pro stránkování seznamů položek.

Grafický vzhled jednotlivých prvků navigační lišty se definuje pomocí následujících polí:

1. Předchozí – HTML kód určující formátování odkazu pro přechod na předcházející stránku
2. Následující – HTML kód určující formátování odkazu pro přechod na další stránku
3. Hlavička – HTML kód který je umístěn na počátku výsledného kódu navigační lišty
4. Patička – HTML kód který je umístěn na konci výsledného kódu navigační lišty
5. Číslo stránky – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
6. Aktivní stránka – formátování údaje o čísle aktuální stránky
7. Separátor – oddělovač mezi jednotlivými čísly stránek.
8. Počet stránek určuje maximální počet čísel stránek v navigační liště a tím nepřímo ovlivňuje i její šířku.

Pro správnou funkci navigační lišty je nutné do výše popsaných polí zadávat i klíčová slova

<!--WTD_NAVIG(URL)--> a <!--WTD_NAVIG(NUMBER)-->.

Jejich použití je zřejmé z následujícího jednoduchého příkladu:

Definici navigační lišty je třeba po instalaci každého modulu v instalovaném modulu uložit – výchozí hodnoty se po instalaci v databázi nenacházejí a bez uložení se pak navigační lišta na žádné stránce nezobrazí.

Navigační lišta je pak v předloze reprezentována klíčovým slovem <!--WTD_FULLTXT(NAVIG)-->.

Administrace

Pomocí formuláře Předvolby se nastavují základní parametry napojení na vyhledávací stroj a další možnosti.

Ve formuláři se nastavují následující pole:

• Vyhledávací stroj – volí se Google Mini či Google Site Search podle použitého vyhledávacího stroje
• URL serveru Google – zadává se vyhledávací adresa Google Mini (tedy např. http://gm.mujserver.cz) nebo http://www.google.com pro vyhledávání přes službu Site Search
• Povinné parametry v URL – interně propojení modulu s vyhledávacím strojem pracuje tak, že při zpracování vyhledávacího formuláře odesílá pomocí http GET požadavek na výsledky hledání, kde celé volání obsahuje všechny zřetězené parametry (např. textovou vyhledávací podmínku, omezení na čas apod.). V tomto poli předvoleb lze uvést parametry, které se odesílají tímto způsobem vždy nezávisle na vyplnění vyhledávacího formuláře uživatelem. Přitom některé parametry jsou z hlediska vyhledávacího stroje povinné. Pro Google Mini se jedná o parametry site a client (zde musí být hodnota default_frontend), pro Site Search to jsou parametry cx (ID vyhledávače) a client (musí být hodnota google-csbe). Lze zde ale uvést i další parametry dle příslušné dokumentace, např. uvedením filter=0 se specifikuje, že se nemá provádět automatická filtrace (tj. zamezení prezentace duplicitního obsahu na různých URL).
• Timeout ve vteřinách pro spojení se serverem – definuje počet sekund, po které prezentační skript čeká na odezvu vyhledávacího stroje a navrácení výsledků hledání

Druhá část formuláře předvoleb definuje názvy metatagů stránek, které se mohou a nemusí používat pro vyznačení dalších informací o indexované stránce z hlediska metadat WebToDate. Jedná se např. o zařazení do stromu kategorií, ID publikace, čas poslední modifikace apod. Více viz Metatagy stránek.

Veřejné skripty

Prezentační skript

Vyhledávací skript se nachází na adrese /scripts/modules/fg/fulltxt.php. Skript typicky v dané předloze zobrazuje vyhledávací formulář a seznam nalezených položek.

Klíčová slova modulu

Pro formátování seznamu nalezených položek se používají následující klíčová slova.

Klíčová slova použitelná ve stylu nalezených výsledků
Klíčové slovo	Význam	Poznámka
<!--WTD_F(NUMBER)-->	Pořadové číslo položky
<!--WTD_F(TITLE)-->	Nadpis
<!--WTD_F(TITLELINK)-->	Odkaz
<!--WTD_F(DESCRIPTION)-->	Popis
<!--WTD_F(DATE)-->	Datum modifikace
<!--WTD_F(SOURCE)-->	Autor
<!--WTD_F(LANGUAGEABBREV)-->	Zkratka jazyka

Pro všechna uvedená klíčová slova s výjimkou <!--WTD_F(NUMBER)--> fungují i klíčová slova typu WTD_IF(…NULL) a WTD_IF(…NOTNULL) stejně jako u WebToDate stylů pro zprávy.

Klíčová slova použitelná v předloze vyhledávací stránky
Klíčové slovo	Význam	Poznámka
<!--WTD_FULLTXT(LIST)-->	Seznam nalezených	Reprezentuje seznam nalezených položek
<!--WTD_FULLTXT(NAVIG)-->	Navigační lišta	Reprezentuje místo, kde se vloží navigační lišta
<!--WTD_FULLTXT(LABEL)-->	Výpis výsledků	Reprezentuje výpis výsledků (např. Dokument 1 až 10 z 50)

Klíčová slova použitelná v předloze – chybové stavy a další podmínky
Klíčové slovo	Význam	Poznámka
<!--WTD_IF(EMPTYSEARCHSTRING,"")-->	Prázdný hledaný text	Kód se vloží v případě, že uživatel nezadal žádný hledaný textový řetězec
<!--WTD_IF(WRONGDATEFROM,"")-->	Špatný formát datumu od
<!--WTD_IF(WRONGDATETO,"")-->	Špatný formát datumu do
<!--WTD_IF(SEARCHPROCEEDED,"")-->	Vyhledávání bylo provedeno	Kód se vloží v případě, že skript již vrací výsledky vyhledávání (nikoliv výchozí stránku s prázdným formulářem)
<!--WTD_IF(CANTCONNECT,"")-->	Spojení nefunguje	Nelze se připojit k vyhledávacímu stroji

Klíčová slova použitelná ve výpisu výsledků
Klíčové slovo	Význam	Poznámka
<!--WTD_FULLTXT(FROM)-->	Počet od	Počáteční pořadové číslo položky na stránce v seznamu nalezených
<!--WTD_FULLTXT(TO)-->	Počet do	Koncové pořadové číslo položky na stránce v seznamu nalezených
<!--WTD_FULLTXT(TOTAL)-->	Počet celkem	Počet nalezených položek celkem
<!--WTD_FULLTXT(PAGECURRENT)-->	Aktuální stránka	Pořadové číslo stránky v rámci stránkování
<!--WTD_FULLTXT(PAGETOTAL)-->	Stránek celkem	Celkový počet stránek v rámci stránkování

Klíčová slova použitelná v definici navigační lišty
Klíčové slovo	Význam	Poznámka
<!--WTD_NAVIG(URL)-->	Odkaz	Klíčové slovo je nahrazováno za odkaz na určitou stránku v rámci stránkování seznamu
<!--WTD_NAVIG(NUMBER)-->	Číslo stránky	Klíčové slovo je nahrazováno za pořadové číslo určité stránky v rámci stránkování seznamu

Ve vyhledávacím formuláři se používají následující klíčová slova:

Klíčová slova použitelná v předloze vyhledávací stránky
Klíčové slovo	Význam	Poznámka
<!--WTD_FULLTXT(SEARCHTEXT)-->	Hledaný text	Hledaný text ve formuláři
<!--WTD_FULLTXT(DATEFROM)-->	Datum od	Datum od ve vyhledávacím formuláři
<!--WTD_FULLTXT(DATETO)-->	Datum do	Datum do ve vyhledávacím formuláři
<!--WTD_FULLTXT(LANGUAGES)-->	Jazyky	Seznam jazyků ve vyhledávacím formuláři
<!--WTD_FULLTXT(PUBLICATIONS)-->	Publikace	Seznam publikací ve vyhledávacím formuláři
<!--WTD_FULLTXT(SORT_RANK)-->	Třídění podle relevance	Nahrazuje se v případě zvolení řetězcem checked="checked"
<!--WTD_FULLTXT(SORT_DATE)-->	Třídění podle času	Nahrazuje se v případě zvolení řetězcem checked="checked"
<!--WTD_FULLTXT(SCOPE_FULL)-->	Prohledávání celého webu	Nahrazuje se v případě zvolení řetězcem checked="checked"
<!--WTD_FULLTXT(SCOPE_NEWS)-->	Prohledávání pouze zpráv	Nahrazuje se v případě zvolení řetězcem checked="checked"

Poslední čtyři výrazy jsou určeny pro volbu pomocí radiopřepínačů:

<input type="radio" name="sort" value="rank" <!--WTD_FULLTXT(SORT_RANK)-->/> Relevance
<input type="radio" name="sort" value="date" <!--WTD_FULLTXT(SORT_DATE)-->/> Času

resp.

<input type="radio" name="scope" value="full" <!--WTD_FULLTXT(SCOPE_FULL)-->/> Celý web
<input type="radio" name="scope" value="news" <!--WTD_FULLTXT(SCOPE_NEWS)-->/> Pouze zprávy

Celý kód fragmentu obsahujícího vyhledávací formulář i klíčová slova pro zobrazení seznamu nalezených položek může vypadat např. následovně:

<form action="/scripts/modules/fg/fulltxt.php" method="get">
<span class="error">
<!--WTD_IF(WRONGDATEFROM,"Chybně vložený formát v políčku s počátečním datem.")--> 
<!--WTD_IF(WRONGDATETO,"Chybně vložený formát v políčku s koncovým datem.")--> 
</span>
<table border="0" cellspacing="2" cellpadding="4">
<tr><th colspan="2"><strong>Vyhledávání</strong></th></tr>
<tr><td colspan="2">
<input type="text" id="searchtext" name="searchtext" value="<!--WTD_FULLTXT(SEARCHTEXT)-->" size="43" maxlength="80" /> 
<input type="submit" id="Action" name="Action" value="Hledat" />
</td></tr>
<tr><td colspan="2">
<label for="sort">Třídit podle</label>
<input type="radio" name="sort" value="rank" <!--WTD_FULLTXT(SORT_RANK)-->/> Relevance
<input type="radio" name="sort" value="date" <!--WTD_FULLTXT(SORT_DATE)-->/> Času
</td></tr>
<tr><td colspan="2">
<label for="scope">Prohledat</label>
<input type="radio" name="scope" value="full" <!--WTD_FULLTXT(SCOPE_FULL)-->/> Celý web
<input type="radio" name="scope" value="news" <!--WTD_FULLTXT(SCOPE_NEWS)-->/> Pouze zprávy
</td></tr>
<tr><td>
<span class="formlabel">Jazyk:</span><br />
<select id="langid" name="langid" class="formselectfield">
<option selected="selected" value="0">--všechny--</option>
<!--WTD_FULLTXT(LANGUAGES)-->
</select>
<br />
<span class="formlabel">Publikace:</span><br />
<select id="publid" name="publid" class="formselectfield">
<option selected="selected" value="0">--všechny--</option>
<!--WTD_FULLTXT(PUBLICATIONS)-->
</select>
</td><td>
<span class="formlabel">Datum od:</span><br />
<input type="text" id="datefrom" name="datefrom" size="11" maxlength="11" value="<!--WTD_FULLTXT(DATEFROM)-->" /><br />
<span class="formlabel">Datum do:</span><br />
<input type="text" id="dateto" name="dateto" size="11" maxlength="11" value="<!--WTD_FULLTXT(DATETO)-->" />
</td></tr>
</table>
</form>
<br />
<!--WTD_FULLTXT(NAVIG)-->
<br />
<span class="lbl"><!--WTD_FULLTXT(LABEL)--></span>
<br />
<!--WTD_FULLTXT(LIST)-->
<br />
<!--WTD_FULLTXT(NAVIG)-->

Tělo stylu pro zobrazení seznamu nalezených položek může vypadat např. následovně:

<div>
<!--WTD_F(NUMBER)-->.<a href="<!--WTD_F(TITLELINK)-->"><!--WTD_F(TITLE)--></a>
<br /><!--WTD_F(DATE)-->
<div class="anotace"><!--WTD_F(DESCRIPTION)--></div>
<!--WTD_IF(SOURCENOTNULL,"zdroj: <!--WTD_F(SOURCE)-->")-->
</div>

Formulářová pole a další možné parametry skriptu

Názvy formulářových polí je třeba přesně dodržet, jinak může být daný formulář nefunkční.

V názvech polí formulářů se rozlišují malá a velká písmena, zachovejte proto názvy polí vždy přesně tak, jak je příslušný pomocný nástroj vygeneroval nebo jak jsou uvedeny v dokumentaci.

Parametry vyhledávacího skriptu
Název pole nebo parametru	Význam	Poznámka
searchtext	Textová vyhledávací podmínka
sort	Způsob třídění	Ve formuláři se používají hodnoty rank a date, nicméně pokud je hodnotou parametru cokoliv jiného než date (včetně prázdné hodnoty), třídí se podle relevance
scope	Kde se prohledává	Ve formuláři jsou používané hodnoty full a news, nicméně pokud je hodnotou něco jiného než news, prohledává se celý web.
langid	ID jazyka
publid	ID publikace
categid	ID kategorie
datefrom	Datum od
dateto	Datum do
gp	Dodatečné parametry Google
pg	Číslo stránky v rámci stránkování
tmplid	Vynucené ID předlohy
lid	ID jazyka pro nastavení
locale	Zkratka jazyka pro nastavení
showxml	Ladící parametr	Pokud se uvede hodnota on, vloží se na začátek stránky XML kód vrácený Google bez jakékoli modifikace

Parametr gp lze nepovinně použít pro předání dalších parametrů do Google z vyhledávacího formuláře. Zde zadané parametry se nijak neinterpretují a posílají se do Google jsou součást URL, pouze je třeba zajistit správný URL encoding. Význam je podobný jako u předvolby modulu Povinné parametry v URL, zde jde ale o nastavení parametrů na úrovni formuláře a nikoli celého modulu (uživatel WebToDate může vytvořit několik různých formulářů a použít je v různých stránkách webu). Možné použití je např.:

<input type="hidden" name="gp" value="partialfields=mujmeta:hodnota">

což zajistí, že se bude z daného formuláře hledat pouze ve stránkách, které obsahují zadanou část hodnoty zvoleného metatagu (se kterým tento modul předem nijak nepočítá).

Poznámka: Vzhledem ke způsobu předávání parametrů službě Site Search není možno ve vyhledávacím formuláři v režimu modulu Site Search použít zároveň možnost zvolit třídění a zároveň volit hledání přes celý web / pouze ve zprávách; je třeba zvolit jen jednu z těchto možností.

Metatagy stránek a extenze modulu

Při indexaci si vyhledávací stroj Google sám detekuje určitá metadata, jako je např. jazyk stránky nebo datum poslední modifikace. Pomocí metatagů ve stránkách lze některé tyto údaje upřesnit, jiné přidat jako nové – konkrétně zde jde speciálně o prohledávání zpráv a možnost hledat podle publikace či kategorie.

Kompletní sada metatagů v HTML hlavičce stránky se zprávou může vypadat následovně:

<meta name="author" content="Jan Michlík" />
<meta name="wtd-publid" content="2" />
<meta name="wtd-categid" content="4" />
<meta name="wtd-categid" content="11" />
<meta name="last-modified" content="2007-06-14" />
<meta http-equiv="Content-language" content="CS" />
<title>MP3.com se vrací na internet s tvorbou nezávislých umělců</title>

Je třeba poznamenat, že názvy metatagů nejsou pevné a korespondují s nastavením v předvolbách modulu:

V předloze pro zprávy lze tento blok vložit následujícím kódem:

<meta name="author" content="<!--WTD_F(SOURCE)-->" />
<meta name="wtd-publid" content="<!--WTD_F(PUBLID)-->" />
<!--WTD_F(META_CATEGID)-->
<meta name="last-modified" content="<!--WTD_FORMAT(DATE,"Y-m-d","<!--WTD_F(DATEACT)-->")-->" />
<meta http-equiv="Content-language" content="<!--WTD_F(LANGUAGEABBREV)-->" />
<title><!--WTD_F(TITLE)--></title>

Všechny uvedené konstrukce jsou standardními funkcemi WebToDate kromě seznamu ID kategorií, ve kterých se zpráva nachází. Vložení seznamu ID kategorií realizuje extenze modulu /scripts/modules/fg/_fgdetail_inc.php. Extenze pracuje s klíčovým slovem <!--WTD_F(META_CATEGID)-->, za který ve stránce s celým textem zprávy dosadí seznam ID kategorií ve tvaru

<meta name="wtd-categid" content="4" />
<meta name="wtd-categid" content="11" />

kde název metatagu se načítá z předvoleb modulu.