insite
Příkaz umožňující nastavení insite editace.
Příkaz má několik variant, které se odlišují klíčovým slovem, jehož použití by mělo být povinné.
Všechny varianty mohou volitelně používat modifikátor only
, jehož uvedení povede k tomu, že se tělo příkazu vyhodnotí jen v insite editaci; zda je aktivní insite editace se ověřuje stejně jako u proměnné _insite.
Hlavička
insite
[only
]header
statement-body/insite
Tento příkaz je nutné použít vždy, když chceme používat insite editaci. Příkaz se musí použít uvnitř HTML elementu head
. Je třeba počítat s tím, že použití příkazu může vložit do stránky skripty a styly. Příkaz se vyhodnotí různě v závislosti na tom, zda je insite editace aktivní nebo ne.
Doporučuje se nepoužívat v tomto případě modifikátor only
a tělo (statement-body) by mělo být vždy prázdné.
Patička
insite
[only
]footer
statement-body/insite
V novějších verzích insite editace je toto protějšek hlavičky, který je třeba umístit těsně před konec HTML elementu body
. Příkaz vloží do stránky seznam assetů (JavaScript pole), které se podíleli na vytvoření aktuální stránky. Platí tatáž doporučení jako pro hlavičku.
Nastavení konfiguračních možností
insite
[only
] (config
|cfg
) param-assignment statement-body/insite
Význam slov config
a cfg
je stejný; slovo lze také úplně vynechat, ale v tom případě není zaručena budoucí kompatibilita.
Příkaz se v této verzi používá v případech, kdy defaultní nastavení prvků insite editace nevyhovuje potřebám uživatelů.
Parametry
- Editovatelný asset: nastavuje se pomocí parametru
asset
. - Editovatelný atribut nebo vlastnost assetu: nastavuje se pomocí parametru
attribute
(neboattr
; pokud jde o atribut), případněproperty
(neboprop
; pokud jde o vlastnost assetu). - Samotné konfigurační položky editace – viz dále.
Zapnutí nebo vypnutí pro část stránky
insite
[only
] (enabled
|disabled
) [=
test-expression ] statement-body/insite
Jde vlastně o speciální verzi nastavení konfigurace. V tomto případě se ale doporučuje vynechat řídící slovo config
, budoucí kompatibilita je zaručena.
Hodnota test-expression se chápe jako Boolean; pokud není výraz uveden, bere se to jako hodnota true
.
Pokud je název parametru enabled
, pak se podle hodnoty výrazu buď povolí insite editace pro celý obsah statement-body (true
), nebo naopak zakáže (false
).
Pokud je název parametru disabled
, pracuje se s negovanou hodnotou.
Explicitní označení editovatelného elementu
insite
[only
]edit
param-assignment statement-body/insite
Tato varianta se používá, pokud automatické mechanismy nedokáží rozpoznat insite element, případně k přidání dodatečných editačních prvků. Další parametry jsou opět konfigurační, fungují stejně jako u varianty config
, použijí se přímo na daný element.
Možnosti vnoření příkazu
Efekt příkazu se projeví během vyhodnocování celého jeho těla, funguje tedy i na vnořené šablony, formátovače a další konstrukty mimo šablonu, ve které je příkaz použit.
Příkaz je ovšem určen primárně k místnímu použití a nepředpokládá se jeho aplikace na rozsáhlé úseky šablon. Příliš se nedoporučuje vkládání dovnitř jiného příkazu insite. Přesto může někdy takové vnoření být užitečné.
Proto je dovoleno vkládat do sebe příkazy insite, ovšem pouze za předpokladu, že jsou aplikovány na různé assety nebo atributy. Není podporováno vkládání obecného příkazu insite (platného pro všechny assety) do jiného obecného příkazu ani vnořování dvou příkazů pro tentýž asset nebo atribut. V případě použití takové konstrukce je chování systému nedefinováno.
Jedinou povolenou výjimkou je použití obecného konfiguračního parametru „enabled“, který je možné přepsat uvnitř jiného jeho nastavení. Hodnota se pak překrývá, tj. platí nejvnitřnější varianta. V tomto případě ale není možné používat ostatní konfigurační parametry ve vnějším obecném příkazu.
Je dovoleno nastavit konfigurační hodnoty pro jednotlivý asset (nebo jeho atribut) v kombinaci s obecnými (bez udání assetu). Tyto hodnoty se pak kombinují, tj. platí obě a v případě konfliktu má vždy přednost nastavení pro konkrétní asset, nezáleží na tom, který příkaz je vnitřní.
Jednotlivé konfigurační položky editace
Společné položky
enabled
- (Boolean) Zda povolit insite editaci.
defaultWitch
- (String) Identifikátor defaultního editoru.
editItems
- (Boolean) Zda povolit insite editaci prvků. Platné pro elementy reprezentující datový zdroj.
Položky pro jednotlivé editory
Parametry mají název ve tvaru witches:název-editoru:název-volby
.
witches:název-editoru:popup:název-volby
- Pro editory s možností otevírání do pop-upu (například
calendar
) specifikuje volby pop-upu. witches:add:folder
- Specifikuje složku, do které se budou přidávat assety, jejichž seznam je vypisovaný přes datový zdroj.
witches:add:namePattern
- Specifikuje pattern pro název nově přidávaných assetů, jejichž seznam je vypisovaný přes datový zdroj.
witches:add:assetType
- Specifikuje typ nově přidávaných assetů, jejichž seznam je vypisovaný přes datový zdroj.
witches:add:variant
- Specifikuje obsahovou variantu nově přidávaných assetů, jejichž seznam je vypisovaný přes datový zdroj.
Poznámky k různým verzím systému jNetPublish
Příkaz je dostupný od verze systému jNetPublish 3.2.5. Možné použití příkazu se poměrně radikálně vyvíjelo; popis se vztahuje na nejnovější verzi systému jNetPublish.