Innehåll Introduktion... 3 InteractiveScene.config... 3 Scener <scenes>... 3 Typsnitt <fonts>... 3 Övergångar <transitions>...

Transkript

1

2 Innehåll Introduktion... 3 InteractiveScene.config... 3 Scener <scenes>... 3 Typsnitt <fonts>... 3 Övergångar <transitions>... 4 Mall för slide <slidetemplates>... 5 <transitionin>, <transitionout>... 6 <elementtemplate>... 6 Mall för gadget <gadgettemplates>... 7 Defintioner <elementdefinitions>... 8 Properties <prop>... 8 <keepaliveinterval>... 8 Export och import... 9 Visning av spellista... 9 Inställningar... 9 Alternativt innehåll

3 Introduktion Efter installationen av Interactive Scene måste man anpassa vilka mallar som redaktörerna ska kunna använda sig av genom att redigera filen InteractivScene.config som finns i katalogen /Modules/InteractiveScene/Configuration. Det är tre delar man måste anpassa, Scener, SlideTemplates samt GadgetTemplates. Interactive Scene använder sig av globally unique identifier (GUID) som identifierare och varje objekt (xml node) i konfigurationsfilen måste ha ett unikt id, dessa är känsliga för stora och små bokstäver och därför ska alltid små bokstäver användas. InteractiveScene.config InteractiveScene.config är konfigurationsfilen för hela Interactive Scene. Här finns inställningar för vilka element, gadgets, övergångar och typsnitt som ska laddas in och aktiveras i redigeringsgränsnittet. Det är även i den här filen som de olika mallarna skapas för slides och gadgets (se mer SlideTemplate och GadgetTemplate). För att definiera vilka egenskaper redaktörerna skall kunna använda används definitioner (se mer Definitioner). På flera utav noderna i konfigurationen finns attributet label, det är ett beskrivande namn som visas i redigeringsgränssnittet. Alla attribut med namnet label kan språkhanteras med hjälp av EPiServers språkstöd, följande syntax gäller label="#general/playlist" där # anger att man utgår ifrån interactivescene noden i språkfilen Scener <scenes> En scen är en definierad yta som begränsar spellistans bredd och höjd samt vilka mallar man får använda när man skapar slides. Alla spellistor måste tillhöra en scen. Under noden scenes lägger man till och tar bort de scener som en redaktör ska kunna välja på att skapa en spellista under. Varje scen måste ha ett unikt id, en bredd och höjd samt ett namn som identifierar scenen för redaktören. Scenerna visas för redaktörerna i rullistan på startsidan för Interactive Scene. id width height label Ett unikt id för en scen. Bredden för den plats som scenen representerar Höjden för den plats som scenen representerar Namn på scenen Typsnitt <fonts> Här definieras vilka typsnitt som ska finnas tillgängliga i systemet. Observera, för att ett typsnitt ska vara valbart för redaktören måste detta definieras i kontrollen fontface.

4 name Namn på typsnittet. Observera, detta måste matcha det som angivits i samband med skapandet av swf-filen. editorfont Sökväg till den swf-fil som ska användas i redigeringsgränssnittet. rendercss fallback <src> (boolean) Om detta värdet är true kommer InteractiveScene Face css i samband med HTML5-spelaren. Om inget typsnitt men det specificerade namnet kan hittas kommer InteractiveScene att falla tillbaka på det här värdet. Används på samma sätt som font-family i css. Undernod till <font>. Används för att specifiera samma typsnitt i flera format. Tex för HTML5-kompabilitet. Specificera källans typ med hjälp av attributet type. Möjliga värden är flash, ttf, eot, woff, svg. Övergångar <transitions> Här definieras vilka övergångar som ska finnas tillgängliga i systemet. Observera, för att en övergång ska vara valbar för redaktören måste detta definieras i en dropdown kontroll. name src Namn på övergången. Sökvägen till den swf-fil som innehåller kod för övergången.

5 Mall för slide <slidetemplates> En slide template definierar vilka innehållselement som kan användas på en slide. En mall styr också innehållselements placering på en slide. En mall väljs när man skapar en ny slide. Nya mallar kan endast skapas av administratören för webbplatsen. <slidetemplate id="bf490f5c-0e d1d4a56b4" sceneid="fd12c8d0-ac72-4a a b5" label="text to the left with background-image" rendermethod="preload" advancemode="advanceontime" duration="2000"> <transitionin effectname="fade" duration="1000"/> <transitionout effectname="fade" duration="1000"/> <elements> <elementtemplate id="9d96de26-0a98-495c-98e5-c2d625a8c332" label="background image" definitionid="b591a99d-b5b1-424a-8f40-881cab0d0210" left="0" top="0" width="980" height="340"> <src preload="true"></src> <elementtemplate id="cf67fb a0a-3e6b9ad3e8fd" label="mainheading" definitionid="8fe f cd-49fdeeb1ced8" left="64" top="47" width="480"> <text><![cdata[]]></text> <multiline>true</multiline> <autosize>true</autosize> <selectable>false</selectable> <elementtemplate id="5f9b75e8-b83d-4f e6bb51737fb9" label="mainbutton 1" definitionid="a0db66d f2b-ba38-404b866ddfaa" left="77" top="240" width="100" height="70"> <src preload="true"></src> <link></link> <linktarget></linktarget> <elementtemplate id="5daef5b5-a5f b9b1-9c a8b" label="mainbutton 2" definitionid="a0db66d f2b-ba38-404b866ddfaa" left="664" top="282" width="100" height="70"> <src preload="true"></src> <link></link> <linktarget></linktarget> <elementtemplate id="ddc d3d-4843-ba10-b9c91833d61a" label="mainflash" definitionid="715b33c0-823f-464b-852d b439a2" left="473" top="218" width="200" height="70"> <src preload="true"><![cdata[]]></src> <startframe><![cdata[1]]></startframe> <!-- Only used if no startlabel is specified --> </elements> </slidetemplate> id (obligatorisk) sceneid (obligatorisk) label (obligatorisk) rendermethod Unikt id Den scene som mallen skall vara tillgänglig för. Beskrivning av mallen Typ av renderingsmetod som skall användas när sliden skall visas i spelaren. Möjliga värden: preload - Tidigare slide animeras ut, laddningsidikator visas medan den nya sliden laddas in, den nya sliden animeras in. sequence - Den nya sliden laddas in i bakgrunden, Den tidigare sliden animeras ut, Den nya sliden animeras in simultaneous - Den nya sliden laddas in i bakgrunden, Den tidigare animeras ut samtidigt som den nya sliden animeras in.

6 advancemode Typ av interaktions som krävs för att gå vidare till nästa slide Möjliga värden: advanceontime Interactive Scene tar hänsyn till den duration som är satt för sliden och går automatiskt vidare till nästa advanceonaction - En extern interaktion krävs som talar om för Interactive Scene att gå vidare t.ex. en knapp med ett anrop till InteractiveScene.api.gotoNext() duration - Tid som sliden skall visas. Observera, detta värde ignoreras om advancemode är inte är satt till advanceontime. <transitionin>, <transitionout> effectname (obligatorisk) Namnet på övergången duration (obligatorisk) Den tid som övergången får ta <elementtemplate> Undernoder till en elementtemplate är frivilligt. Det är upp till elementet att ta hand om detta. Det kan dock finnas särskilda krav för vissa elementtyper. Undernoderna kan även användas för att sätta värden som redaktören inte ska ha möjlighet att ändra eller för att ge redaktören ett för ifyllt värde. id (obligatorisk) label (obligatorisk) Unikt id för elementet Beskrivning av elementet. Synligt för redaktören i redigeringsgränssnittet. definitionid (obligatorisk) Referens till definition som ska användas för det här elementet. (Se Definitioner) left Antal pixlar som elementet ska justeras från slidens vänstra kant. Observera, InteractiveScene kommer alltid använda left i första hand

7 right top bottom width height Antal pixlar som elementet ska justeras från slidens högra kant. Observera, InteractiveScene kommer alltid använda left i första hand Antal pixlar som elementet ska justeras från slidens övere kant. Observera, InteractiveScene kommer alltid använda top i första hand Antal pixlar som elementet ska justeras från slidens nedre kant. Observera, InteractiveScene kommer alltid använda top i första hand Den maximala bredden som ett element får ha. Det är sedan upp till elementets implementation att förhålla sig till detta. Den maximala höjden som ett element får ha. Det är sedan upp till elementets implementation att förhålla sig till detta. Mall för gadget <gadgettemplates> id (obligatorisk) sceneid (obligatorisk) label (obligatorisk) redigeringsgränssnittet. Unikt id för gadgeten Den scene som mallen skall vara tillgänglig för. Beskrivning av gadgeten. Synligt för redaktören i definitionid (obligatorisk) Referens till definition som ska användas för det här gadgeten. (Se Definitioner) left right top bottom Antal pixlar som elementet ska justeras från spellistans vänstra kant. Observera, InteractiveScene kommer alltid använda left i första hand Antal pixlar som elementet ska justeras från spellistans högra kant. Observera, InteractiveScene kommer alltid använda left i första hand Antal pixlar som elementet ska justeras från spellistans övere kant. Observera, InteractiveScene kommer alltid använda top i första hand Antal pixlar som elementet ska justeras från spellistans nedre kant. Observera, InteractiveScene kommer alltid använda top i första hand

8 Defintioner <elementdefinitions> Definitionsnoder styr vilka egenskaper en redaktör ska ha möjlighet att ändra för det specifika objektet. Egenskaperna byggs upp med hjälp av noderna <prop/> och <group/>. Group styr inte över någon egenskap utan är bara ett sätt att gruppera flera egenskaper. En grupp kan ha en rubrik, denna sätts genom attributet label på <group/> noden. För att skapa en koppling till ett värde på objektet skapar du en prop-nod. id type Unikt id som identifierar definition, detta id refereras i attributet definitionid för en elementtemplate under en slidetemplate. Berättar vilken typ objektet är av. Flera definitioner kan finnas för samma typ men varje definition måste ha ett unikt id. Properties <prop> type Typ av kontroll som ska visas för egenskapen i redigeringsgränssnittet. (Möjliga värden är: string, number, boolean, dropdown, file, fontface, fontsize, fontstyle, fontcolor, textalign, link, position, color) name Namnet på den egenskap som kontrollen ska ändra. label (frivillig) Om en förklaring/rubrik skall visas i samband med kontrollen. <data> Undernod till <prop> om kontrollen behöver ytterligare data för att renderas. Används för kontroller av typen dropdown, color, fontface, fontcolor <editorsrc> Sökvägen till den swf-fil som innehåller koden för redigeringselementet <playersrc> Sökvägen till den swf-fil som innehåller koden för spelarelmentet <keepaliveinterval> Anger i millisekunder hur ofta Interactive Scene skall göra ett anrop för att förhindra automatiskt utloggning av redaktören. Om värdet är noll (0) kommer inget anrop att göras och det finns en risk att redaktören blir automatiskt utloggad och förlorar sina ändringar.

9 Export och import Som standard exporteras alla Interactive Scene spellistor när man använder EPiServer export funktion, likaså importeras alla spellistor när man kör importen. Finns spellistan redan vid import kommer den befintliga spellistan skrivas över. För att stänga av export/import funktionen sätter man inställningen IS_DisableImport under appsettings till true. Visning av spellista Efter installationen av Interactive Scene finns det en ny egenskap som heter InteractiveScenePlaylist, denna används på sidtyperna för att automatiskt rendera ut spellistan i visningsläge för besökaren. Inställningar Egenskapen har inställningar i Admin där man anger vilken eller vilka scener som ska vara valbara i egenskapen för redaktörerna. Alternativt innehåll Egenskapen kräver att det finns en yta som kan visa ett alternativt innehåll om besökaren inte har korrekt version eller ingen flashspelare alls installerad, detta anges med attributet AlternativeContentId Egenskapen har tre olika attribut som kan anpassas efter behov. Namn Typ Beskrivning RenderSwfObject Boolean Anger om javascriptbiblioteket SwfObject ska renderas ut av Interactive Scene. I projekt som redan använder sig av biblioteket kan det vara lämpligt att stänga av detta. WMode String Anger hur flashen ska renderas i förhållande till övrigt innehåll på sidan. Ett typiskt exempel är när en meny eller htmlinnehåll behöver visas ovanpå spellistan, i detta fall sätter man WMode= opaque eller transparent. AlternativeContentId String Anger id:et på html objektet där det alternativa innehållet ska visas.