< návrat zpětHCM moduly
Seznam a popis syntaxe nativních HCM modulů.
Návod na tvorbu vlastních HCM modulů >
HCM moduly jsou jednoduché značky, jejichž prostřednictvím můžete do stránky vložit anketu, e-mailový formulář, seznam online uživatelů a podobně.
Seznam HCM modulů
Vždy je uveden název modulu, popis, parametry a ukázka zápisu.
- první parametr je vždy název modulu
- nepovinné parametry jsou v hranatých závorkách
- některé parametry udávají, zda se má něco zobrazit/provést či nikoliv (například
automaticky spustit
u přehrávače nebo zobrazit perex
u výpisu článků) - u těchto parametrů 1 znamená ano (zapnuto) a 0 ne (vypnuto)
| Funkční prvky |
|---|
| Menu | Slouží pro vypsání seznamu stránek. |
| Anketa | Slouží pro zobrazení ankety. |
| Shoutbox | Slouží pro zobrazení shoutboxu. |
| Přehrávač | Multimediální přehrávač. Umí přehrát soubory typu: mp3 a flv video. |
| Flash animace | Vloží flash animaci. |
| Vyhledávání | Slouží pro zobrazení vyhledávacího pole (pro boxy). |
| E-mailový formulář | Formulář pro odesílání e-mailových zpráv. |
| Přístup |
|---|
| Neveřejný obsah | Obsah, který bude zobrazen pouze přihlášeným uživatelům. |
| Obsah podle úrovně | Obsah, který bude zobrazen pouze uživatelům vyhovujícím podmínce minimální úrovně. |
| Obsah podle úrovně 2 | Obsah, který bude zobrazen pouze uživatelům s úrovní v daném rozmezí. |
| Články |
|---|
| Počet článků | Spočítá celkový počet článků (ze všech nebo pouze v určité kategorii). |
| Výpis článků | Zobrazí libovolný počet článků podle zadaných kritérií. |
| Uživatelské |
|---|
| Vypsání uživatelů | Vypíše určitý počet uživatelů seřazených podle zvolených kritérií. |
| Počet uživatelů | Spočítá celkový počet uživatelů (všech nebo pouze v určité skupině). |
| Uživatelské menu | Slouží pro zobrazení uživatelského menu (užitečné třeba v boxu). |
| Nejnovější příspěvky/komentáře | Vypíše nejnovější příspěvky nebo komentáře. |
| Soubory |
|---|
| Seznam souborů | Zobrazí výpis souborů v daném adresáři. |
| Obrázek | Sestaví HTML kód obrázku (atribut alt je vyplněn automaticky). |
| Náhled obrázku | Vytvoří náhled obrázku s odkazem na originál. |
| Obsah souboru | Zobrazí obsah textového/html souboru. |
| Náhodný text nebo obrázek | Zobrazí libovolný počet náhodných textů (txt,htm,html) nebo obrázků ze zvoleného adresáře. |
| Pokročilý výpis souborů | Vypíše soubory s podporou stránkování a dalších funkcí |
| Galerie |
|---|
| Malá galerie s automatickými náhledy | Zobrazí obrázky ze složky jako galerii. |
| Malá galerie s vlastními náhledy | Zobrazí obrázky ze složky jako galerii. |
| Obrázky z galerie | Zobrazí jeden nebo více obrázků z existující galerie. |
| Stránky |
|---|
| Odkaz na článek | Automaticky vytvoří odkaz na článek. |
| Odkaz na stránku | Automaticky vytvoří odkaz na stránku (sekce, kategorie, kniha, atd). |
| Popis stránky | Vypíše popis aktuální stránky |
| Odkaz na profil uživatele | Automaticky vytvoří odkaz na profil daného uživatele. |
| Sestavení kotvy | Automaticky sestaví kotvu (cesta#kotva) dle aktuální cesty. |
| Výpis cesty | Vypíše absolutní cestu aktuální stránky |
| Ostatní |
|---|
| PHP skript | Spustí php kód nebo jej načte ze souboru. Tento modul mohou používat pouze oprávnění uživatelé. |
| PHP kód se zvýrazněnou syntaxí | Zvýrazní výskyty php kódu v daném textu. |
| Zdrojový kód | Zobrazí zdrojový kód validním způsobem (převedení speciálních znaků na entity). |
| Smajlíci | V zadaném textu převede smajlíky, jako by to byl komentář. |
| Odkaz na e-mail | Vytvoří odkaz na e-mail tak, aby nebyl snadno rozpoznatelný spamboty. |
Menu |
Slouží pro vypsání seznamu stránek. |
Parametry
[limit od pořadového čísla], [limit po pořadové číslo]
Ukázka
[hcm]menu,0,10[/hcm]
|
Anketa |
Slouží pro zobrazení ankety. |
Parametry
ID ankety*, [šířka ankety v pixelech]
Ukázka
[hcm]poll,150[/hcm]
Vysvětlivky
* ID ankety je napsáno napravo od tlačítka Uložit při upravování ankety
|
Shoutbox |
Slouží pro zobrazení shoutboxu. |
Parametry
ID shoutboxu
Ukázka
[hcm]sbox,1[/hcm]
|
Přehrávač |
Multimediální přehrávač. Umí přehrát soubory typu: mp3 a flv video. |
Parametry
cesta k souboru*, [šířka přehrávače], [výška přehrávače], [automaticky spustit 1/0]
Ukázka
[hcm]player,upload/song.mp3[/hcm]
Vysvětlivky
* cesta k souboru relativně ke kořenovému adresáři nebo v absolutním tvaru
|
Flash animace |
Vloží flash animaci. |
Parametry
cesta k swf souboru*, [šířka], [výška]
Ukázka
[hcm]flash,upload/game.swf,400[/hcm]
Vysvětlivky
* cesta k souboru relativně ke kořenovému adresáři nebo v absolutním tvaru
|
Vyhledávání |
Slouží pro zobrazení vyhledávacího pole (pro boxy). |
Parametry
bez parametrů
Ukázka
[hcm]search[/hcm]
|
E-mailový formulář |
Formulář pro odesílání e-mailových zpráv. |
Parametry
e-mailová adresa (více adres oddělte středníkem), [povolit připojení přílohy 1/0], [přednastavený předmět]
Ukázka
[hcm]mailform,test@example.com,1,Zpráva z formuláře[/hcm]
|
Neveřejný obsah |
Obsah, který bude zobrazen pouze přihlášeným uživatelům. |
Parametry
obsah pro přihlášené, [obsah pro nepřihlášené]
Ukázka
[hcm]notpublic,Jste přihlášen(a),Nejste přihlášen(a)[/hcm]
|
Obsah podle úrovně |
Obsah, který bude zobrazen pouze uživatelům vyhovujícím podmínce minimální úrovně. |
Parametry
minimální úroveň, obsah pro vyhovující, [obsah pro nevyhovující]
Ukázka
[hcm]levelcontent,200,Vaše úroveň je 200 nebo více.,Vaše úroveň je méně než 200.[/hcm]
|
Obsah podle úrovně 2 |
Obsah, který bude zobrazen pouze uživatelům s úrovní v daném rozmezí. |
Parametry
minimální úroveň, maximální úroveň, obsah pro vyhovující, [obsah pro nevyhovující]
Ukázka
[hcm]levelcontent2,200,300,Vaše úroveň je v rozmezí 200 až 300.,Vaše úroveň není v rozmezí 200 až 300.[/hcm]
|
Počet článků |
Spočítá celkový počet článků (ze všech nebo pouze v určité kategorii). |
Parametry
[ID kategorie*]
Ukázka
[hcm]countart,5[/hcm]
Vysvětlivky
* ID kategorie je napsáno napravo od tlačítka Uložit provedené změny při upravování kategorie, můžete zadat více čísel kategorií oddělených pomlčkami
|
Výpis článků |
Zobrazí libovolný počet článků podle zadaných kritérií. |
Parametry
typ1, [počet], [zobrazovat perex 0/1/22], [zobrazovat info 1/0], [ID kategorie3]
Ukázka
[hcm]articles,1,5[/hcm]
Vysvětlivky
1 Typ:
- nejnovější
- nejčtenější
- nejlépe hodnocené
- nejčastěji hodnocené
- náhodné
- nedávno přečtené
- nedávno ohodnocené
- nedávno komentované
- nejvíce komentované
2 Mód perexu:
0 - nezobrazovat1 - zobrazit perex2 - zobrazit perex i obrázek
3 ID kategorie je napsáno napravo od tlačítka Uložit provedené změny při upravování kategorie, více čísel je možno oddělit pomlčkami
|
Vypsání uživatelů |
Vypíše určitý počet uživatelů seřazených podle zvolených kritérií. |
Parametry
způsob řazení*, [počet], [limit délky zobrazovaných jmen]
Ukázka
[hcm]users,2,3[/hcm]
Vysvětlivky
* způsob řazení:
- nedávno zaregistrovaní
- nedávno aktivní
- podle počtu příspěvků
- podle průměrneho hodnocení
|
Počet uživatelů |
Spočítá celkový počet uživatelů (všech nebo pouze v určité skupině). |
Parametry
[ID skupiny*]
Ukázka
[hcm]countusers,5[/hcm]
Vysvětlivky
* ID skupiny je napsáno napravo od tlačítka Uložit provedené změny při upravování skupiny
|
Uživatelské menu |
Slouží pro zobrazení uživatelského menu (užitečné třeba v boxu). |
Parametry
bez parametrů
Ukázka
[hcm]usermenu[/hcm]
|
Nejnovější příspěvky/komentáře |
Vypíše nejnovější příspěvky nebo komentáře. |
Parametry
[limit], [ID položek1], [typ položek2]
Ukázka
[hcm]recentposts,5[/hcm]
Vysvětlivky
1 čísla položek (podle typu), ze kterých se budou vypisovat příspěvky/komentáře, více čísel je možno oddělit pomlčkami
2 1=sekce, 2=články, 3=knihy
|
Seznam souborů |
Zobrazí výpis souborů v daném adresáři. |
Parametry
cesta k adresáři, [zobrazovat velikosti souborů 1/0]
Ukázka
[hcm]filelist,upload/stahnout/[/hcm]
|
Obrázek |
Sestaví HTML kód obrázku (atribut alt je vyplněn automaticky). |
Parametry
cesta k obrázku, [další parametry tagu img]
Ukázka
[hcm]ximg,upload/pepa.jpg[/hcm]
|
Náhled obrázku |
Vytvoří náhled obrázku s odkazem na originál. |
Parametry
cesta k obrázku, [výška náhledu], [titulek], [skupina obrázku lightboxu]
Ukázka
[hcm]img,upload/obrazek.jpg,128[/hcm]
|
Obsah souboru |
Zobrazí obsah textového/html souboru. |
Parametry
cesta k souboru
Ukázka
[hcm]file,upload/text.txt[/hcm]
|
Náhodný text nebo obrázek |
Zobrazí libovolný počet náhodných textů (txt,htm,html) nebo obrázků ze zvoleného adresáře. |
Parametry
adresář1, typ2, [počet], [výška náhledu3]
Ukázka
[hcm]randomfile,upload/obrazky/,2,10,128[/hcm]
Vysvětlivky
1 cesta k adresáři relativně ke kořenovému adresáři
2 1=textové soubory, 2=obrázky
3 pouze pokud je typ nastaven na obrázky
|
Pokročilý výpis souborů |
Vypíše soubory s podporou stránkování a dalších funkcí |
Parametry
cesta k adresáři, maska souborů, řazení položek, stránkování, maska položky, [zobrazení stránk.], [kód před výpisem], [kód za výpisem]
Ukázka
[hcm]xlist,"upload/obrazky/", "jpg;jpeg;png;gif", 1, 0, "<img src="[tag]link[/tag]" alt="[tag]name[/tag]" />"[/hcm]
Vysvětlivky
Viz. podrobná dokumentace tohoto modulu
|
Malá galerie s automatickými náhledy |
Zobrazí obrázky ze složky jako galerii. |
Parametry
adresář1, [velikost náhledu2], [počet obrázků na stranu]
Ukázka
[hcm]gallery,upload/galerie/,128[/hcm]
Vysvětlivky
1 cesta k adresáři s obrázky relativně ke kořenovému adresáři
1 možný formát je výška nebo šířka-výška
|
Malá galerie s vlastními náhledy |
Zobrazí obrázky ze složky jako galerii. |
Parametry
adresář*, [počet obrázků na stranu], [použít lightbox 1/0]
Ukázka
[hcm]gallery2,upload/galerie/[/hcm]
Vysvětlivky
Zadaný adresář musí obsahovat složku full (v ní mají být velké originály) a složku prev (v ní mají být malé náhledy). Velký originál a malý nahled se musí jmenovat stejně. * Cesta k adresáři s obrázky relativně ke kořenovému adresáři.
|
Obrázky z galerie |
Zobrazí jeden nebo více obrázků z existující galerie. |
Parametry
ID galerie1, typ2, [rozměr náhledu3], [limit]
Ukázka
[hcm]galimg,12,1,96[/hcm]
Vysvětlivky
1 ID galerie (více čísel je možno oddělit pomlčkami) - je napsáno napravo od tlačítka Uložit provedené změny při upravování galerie
2 1=nejnovější, 2=náhodné
3 možný formát je výška nebo šířka-výška
|
Odkaz na článek |
Automaticky vytvoří odkaz na článek. |
Parametry
ID článku1, [text odkazu], [odkaz do nového okna 1/0]
Ukázka
[hcm]linkart,42,Odkaz na článek,1[/hcm]
Vysvětlivky
1 je možné použít identifikátor článku namísto čísla ID
|
Odkaz na stránku |
Automaticky vytvoří odkaz na stránku (sekce, kategorie, kniha, atd). |
Parametry
ID stránky1, [text odkazu], [odkaz do nového okna 1/0]
Ukázka
[hcm]linkroot,42,Odkaz na stránku,1[/hcm]
Vysvětlivky
1 je možné použít identifikátor stránky namísto čísla ID
|
Popis stránky |
Vypíše popis aktuální stránky |
Parametry
[obalit odstavcem 1/0]
Ukázka
[hcm]iperex[/hcm]
|
Odkaz na profil uživatele |
Automaticky vytvoří odkaz na profil daného uživatele. |
Parametry
uživatelské jméno
Ukázka
[hcm]linkuser,Root[/hcm]
|
Sestavení kotvy |
Automaticky sestaví kotvu (cesta#kotva) dle aktuální cesty. |
Parametry
název kotvy
Ukázka
[hcm]anchor,moje_kotva[/hcm]
|
Výpis cesty |
Vypíše absolutní cestu aktuální stránky |
Parametry
-
Ukázka
[hcm]path[/hcm]
|
PHP skript |
Spustí php kód nebo jej načte ze souboru. Tento modul mohou používat pouze oprávnění uživatelé. |
Parametry
php kód1, [ze souboru2 1/0]
Ukázka
[hcm]php,$output="Ahoj světe!";[/hcm]
Vysvětlivky
1 má-li PHP kód na místo vložení vypsat nějaký text, nepoužívejte funkce echo ani print, ale požadovaný výstup uložte do proměnné $output.
2 je-li nastaveno na 1 (zapnuto), bude první parametr použit jako cesta k PHP souboru, ze kterého má být spuštěn PHP skript - spouštěnému skriptu jsou dostupné veškeré parametry uvedené navíc v proměnné $_params a výstup uložte také do proměnné $output nebo navraťte konstruktem return
|
PHP kód se zvýrazněnou syntaxí |
Zvýrazní výskyty php kódu v daném textu. |
Parametry
PHP kód
Ukázka
[hcm]phpsource,"<?php $output='Ahoj světe!'; ?>"[/hcm]
|
Zdrojový kód |
Zobrazí zdrojový kód validním způsobem (převedení speciálních znaků na entity). |
Parametry
kód
Ukázka
[hcm]source,"<a href='http://google.com/'>Google</a>"[/hcm]
|
Smajlíci |
V zadaném textu převede smajlíky, jako by to byl komentář. |
Parametry
text
Ukázka
[hcm]smileys,Toto je smajl - *1*[/hcm]
|
Odkaz na e-mail |
Vytvoří odkaz na e-mail tak, aby nebyl snadno rozpoznatelný spamboty. |
Parametry
email
Ukázka
[hcm]mailto,pepa@example.com[/hcm]
|
Syntaxe a použití
Zápis každého HCM modulu začíná značkou [hcm]
a končí [/hcm]
. Mezi těmito značkami se uvádí parametry. Například:
[hcm]poll,1,150[/hcm]
Syntaxe
- jednotlivé parametry se oddělují čárkou
- před a za jednotlivými parametry mohou být mezery i odřádkování
- hodnotu parametru je možné uzavřít do jednoduchých (') nebo složených uvozovek (")
- pokud je hodnota parametru v uvozovkách, nejsou čárky mezi nimi brány jako oddělovač parametrů, ale jako běžný znak
- pokud chcete v hodnotě parametru uzavřené v uvozovkách použít stejný znak pro uvozovku, přidejte před ně opačné lomítko - tj. \' nebo \"
Kde všude je možné HCM moduly použít
- v obsahu stránky (sekce, kategorie, knihy apod.)
- v obsahu článku a jeho infoboxu
- v obsahu boxu
