Stepvars (Sitestepper vervangvariabelen).
Doelstelling van deze Steples
- Uitleggen wat Stepvars zijn en waarom zij binnen Sitestepper zo een belangrijke rol spelen.
Steplessen die best gevolgd zijn vooraleer deze Steples te starten
Voorkennis
Logische vervolg
Wat zijn Stepvars ?
Een Stepvar (afkorting van 'Sitestepper-variabele') is een woord dat tijdens de verwerking van de bronpagina's vervangen zal worden door een waarde die pas gekend is op het moment van aanmaken van de pagina (en dus niet als vaste tekst kan worden ingevoerd).
Een voorbeeld hiervan is de tijd en datum van het moment dat de webpagina wordt aangemaakt.
Uiteraard is deze informatie niet bekend bij het invoeren van de bronpagina. De effectieve waarde die moeten getoond is variabel en ze zal veranderen telkens de pagina wordt aangemaakt.
In plaats van de tijd en/of datum manueel te moeten veranderen telkens de website opnieuw wordt aangemaakt, kunnen respectievelijk de stepvars {@Rundate} en {@Runtime} worden gebruikt.
|
<font class="footer"><u>Deze pagina</u><br> laatst aangepast op {@RunDate} - {@RunTime}<br> door StepGen - 5.0.0.11241<br> |
|
Zoals te zien in voorgaande html-code en afbeelding, zullen de {@Rundate} en {@Runtime}-variabelen vervangen worden door de datum en tijd telkens de webpagina wordt aangemaakt.
Tip: Beide stepvars zijn dan ook perfect op hun plaats in één van de bronpagina's die via een skeleton op elke pagina worden ingevoegd.
Waar kunnen Stepvars worden gebruikt?
Stepvars kunnen worden gebruikt in:
- de bronteksten van de pagina's (dus in alle teksten die kunnen worden ingevoerd vanaf de projectboom)
- de skeletons
- de programmacode in de Steplib programmabibliotheek
- de programmacode in de Dev-Code programmabibliotheek
- de javascripts
- de stylesheets
Syntax van een Stepvar
Normale syntax
Een Stepvar dient tussen accolades te worden geplaatst {...}.
Alternatieve syntax
Op sommige plaatsen zijn de accolades betekenisvolle karakters. Dit is, bijvoorbeeld, het geval in javascripts. Accolades die daar zouden worden gebruikt als start en einde van een stepvar zouden verkeerd worden geïnterpreteerd. Deze karakters kunnen dan ook niet worden gebruikt, maar dienen vervangen te worden door de alternatieve syntax: «...»-karakters.
Opmerkingen:
- De « en » zijn afzonderlijke karakters, geen dubbele groter- of kleiner-dan tekens (<< of >>).
- Ze kunnen worden ingevoerd op een QWERTY-klavier door de Alt-[ en Alt-] toetscombinaties of door het invoeren van Alt-0171 en Alt-0187 (met de cijfers ingevoerd op het numeriek klavier).
Welke Stepvar-syntax wordt waar gebruikt ?
Sitestepper zal zelf bepalen welke syntax standaard wordt ingesteld.
|
Type syntax |
Waar gebruikt |
|---|---|
|
{...} - normale syntax |
bronpagina's, skeletons, programmacode |
|
«...» - alternatieve syntax |
javascripts, stylesheets |
Het gebruik van een bepaalde Stepvar-syntax forceren
Door middel van een html-commentaarlijn, geformatteerd volgens een bepaalde Sitestepper-syntax, kan het gebruik van één van beide Stepvars-syntaxen geforceerd worden.
<!--DELIM=EXTRA-->
<!--DELIM=NORMAL-->
HTMLcode 8: Html commentaarlijnen die van stepvar-syntax veranderenSyntax van deze Stepvar-stuurlijnen:
- Start van normale html-commentaar: <!--
- De gereserveerde tekst: DELIM=EXTRA of DELIM=NORMAL.
- Einde van normale html-commentaar -->
Beide lijnen dienen alleen op een lijn voor te komen, zonder andere karakters, tekst of html-codes op de lijnen en worden bij voorkeur vooraan een lijn geplaatst.
Zodra Sitestepper de stuurlijn: DELIM=EXTRA tegenkomt, worden vanaf dat moment de alternatieve karakters «...» gebruikt.
Zodra Sitestepper de stuurlijn DELIM=NORMAL tegenkomt, worden vanaf de lijn volgend op de stuurlijn de normale karakters {...} gebruikt.
Waarom van Stepvar-syntax veranderen?
Het veranderen van de normale stepvar-syntax naar de alternatieve syntax (en weer terug), dient, bijvoorbeeld, te worden uitgevoerd indien in een brontekst (die normale html-code zal bevatten ) ofwel de definitie van enkele html-stijlen of javascript-code dienen ingevoerd te worden.
Beide gebruiken immers de {...}-tekens voor een ander doeleinde. Bij styles zijn beide karakters de begin- en eindkarakters voor de definitie van een html-stijl. Bij javascripts worden beide karakters gebruikt als begin en einde van blokken aan programmacode.
<!--DELIM=EXTRA-->
<script language="JavaScript">
<!--
steplogo_off=new Image();
steplogo_off.src = "«#ImageRoot»/sitestepper-powered.gif";
steplogo_on=new Image();
steplogo_on.src = "«#ImageRoot»/sitestepper-powered-kleur.gif";
function SteprollOut(imgName)
function SteprollIn(imgName)
// -->
</script>
<!--DELIM=NORMAL-->
<a href="http://www.sitestepper.be"
onMouseOver="SteprollIn('steplogo_');return true;"
onMouseOut="SteprollOut('steplogo_');return true;">
<img src="{#ImageRoot}/sitestepper-powered.gif" width="75" height="45"
border="0" alt="Sitestepper" name="steplogo_"></a>
...
HTMLcode 9: Voorbeeldcode met gebruik van verandering van Stepvar-syntax
De voorgaande html-code zal het 'powered-by-Sitestepper' logo toevoegen op de webpagina (waarbij het logo van kleur veranderd indien de muis over het logo wordt bewogen).
Vermits het veranderen van de kleur van het logo wordt bewerkstelligd door het laden van een tweede afbeelding (de blauweversie) in plaats van de originele afbeelding (de grijze versie), en dit enkel mogelijk is door het gebruik van javascript-code, dienen rond het ingevoerde javascript-codeblok de lijnen te worden geplaatst om van Stepvar-syntax te veranderen.
In de javascript-code wensen we immers de Stevar http://www.sitestepper.be/images te gebruiken (die aanduidt waar de afbeeldingen zich bevinden op de website) – lijnen 6 en 8.
Vermits javascript de -karakters gebruikt als begin en einde van een programmablok (zie de opgelichte karakters op de lijnen 9 tot en met 12), dient te worden aangegeven dat de alternatieve stepvar-syntax actief moet worden (zie lijn 2).
Na het stukje javascript-code kan worden aangegeven dat terug de normale Stepvar-syntax van toepassing is door het invoeren van de lijn die de normale stepvar-syntax activeert (zie lijn 15). Dit maakt dat, indien we vanaf dat moment de stepvar http://www.sitestepper.be/images wensen toe te gebruiken, we terug de normale syntax kunnen toevoegen (zie lijn 19).
Tip: Bovenstaande code kan worden toegevoegd aan een webpagina door het kiezen van de menu-optie: 'Sitestepper – insert Sitestepper powered by logo' in het StepEdit-programma2.
Toevoegen van de Stepvar-lijnen die van syntax wisselen
Uiteraard kunnen beide lijnen (zoals alle lijnen en tekst in Sitestepper), worden ingevoerd vanaf het toetsenbord.
Vermits beide lijnen echter in de meeste gevallen als paar worden ingevoegd in de html-code (rond stijldefinities of javascriptcode), is de menu-optie 'Sitestepper – insert Javascript delim lines' toegevoegd aan de menu's van StepEdit. Het uitvoeren van deze menu-optie, zal de lijnen in HTMLcode 8: Html commentaarlijnen die van stepvar-syntax veranderen op pagina 68 invoegen.
Stepvar-waardes
Telkens een stepvar wordt gevonden in de brontekst, javascriptcode of stylesheet, zal het woord tussen de op dat moment geldende stepvar-syntax-karakters worden opgezocht in een interne lijst die door Sitestepper wordt opgebouwd bij de start van de verwerking van dat bestand.
Deze interne lijst bestaat uit een lijst van stepvar-namen, gevolgd door de waarde van die Stepvar.
Wordt de stepvar gevonden in deze lijst, dan zal de stepvar worden vervangen door de overeenkomstige waarde in de lijst.
Wordt de stepvar niet gevonden, dan zal Sitestepper de stepvar verwijderen zonder een waarde in de plaats te plaatsen.
De volgende html-code:
<h1>Enkele testen ...</h1> #ImageRoot=<b>{#ImageRoot}</b><br> NietBestaandeStepvar=<b>{NietBestaandeStepvar}</b>HTMLcode 10: Voorbeeldcode met bestaande en niet-bestaande stepvar
De stepvar op lijn 2 zal bestaan, de stepvar op lijn 3 niet.
Deze code zal de volgende pagina genereren:
De {#ImageRoot}-stepvar wordt vertaald naar de ingevoerde waarde voor de plaats waar de afbeeldingen staaan op de website (ingevoerd in de projectparameters).
De {NietBestaandeStepVar} stepvar wordt niet gevonden, en daarvan kan dan ook geen waarde worden getoond op de webpagina.
Hoe stepvars invoeren in de bronteksten ?
Stepvars zijn normale woorden die worden geplaatst tussen, ofwel de -karakters, ofwel de «...»-karakters.
Ze kunnen derhalve gewoon worden ingetypt tussen de andere teksten in de StepEdit editor.
Voor de vaste stepvars (zie Type Stepvars op pagina 72) is in StepEdit een speciale handeling ingebouwd.
Zodra ofwel het '{ '-karakter, ofwel hetÿ '«'-karakter wordt ingetypt, wordt een lijst van aanwezigeÿ vaste stepvars getoond.
ÿ
ÿ ÿ
De volgende mogelijkheden zijn aanwezig om deÿ vaste stepvar toe te voegen:ÿ
ÿ- ÿ
- Voer de naam van de stepvars gewoon verder in. Sitestepper zal automatisch de eerste stepvar selecteren die begint met de reeds ingevoerde karakters. ÿ
-
Gebruik de pijltjestoetsen om één van de getoonde stepvars te selecteren.
Het indrukken van de 'enter' of 'return'-toets zal de geselecteerde stepvar invoegen in de tekst.
Indien de lijst van stepvars werd gestart met het intypen van ''-karakter. Werd de lijst van stepvars gestart met het intypen van een '«'-karakter, dan zal de stepvar automatisch worden afgesloten met een '»'-karakter.
Opmerking:
- Sommige vaste stepvars beginnen met een '@'-karakter of een '#'-karakter. Deze twee karakters worden gebruikt om sommige stepvars logisch bij elkaar te plaatsen. Bij het opzoeken van de stepvars (via het intypen van '{ ' of '«')ÿ moeten deze karakters niet worden ingegegeven (zoals te zien in deÿ voorgaande schermafdrukken). Bij het intypen van 'return' ofÿ 'enter' zullen beide karakters toch en automatisch wordenÿ toegevoegd. ÿ
Type Stepvars
ÿDe interne lijst van Stepvars zal wordenÿ opgebouwd uit verschillende sets aan waardes:
ÿ- ÿ
- Vaste stepvars: dit zijn stepvars dieÿ ingebouwd zijn in Sitestepper en dus steeds kunnen worden gebruikt.ÿ We onderscheiden hier: ÿ
- ÿ
- Systeem-stepvars: deze zullen waardes krijgen onafhankelijk van de actieve build target. ÿ
- Project-stepvars: deze zullen waardes krijgen afhankelijk van het actieve project en de actieveÿ build target. ÿ
ÿ - Stepcollect-stepvars: deze ontvangen hun waardes tijdens het generen van de stepcollect-pagina's. ÿ
- Gebruiker-stepvars: dit zijn stepvars (door de gebruiker in te voeren via de menu-optie: 'Project –ÿ Editeer extra buildvariabelen'. We onderscheiden hier: ÿ
- ÿ
- Gebruiker-stepvars die afhankelijk zijn vanÿ het project. ÿ
- Gebruiker-stepvars die afhankelijk zijn vanÿ de build-target. ÿ
ÿ - Message-stepvars: dit zijn stepvars (door de gebruiker aan te maken via de menu-optie: 'Project –ÿ start StepMsgs') om op een centrale manier vertalingen in te kunnenÿ voeren zodanig dat bepaalde bronbestanden (en programmacode)ÿ generiek kunnen worden ontwikkeld en dus slechts éénmaalÿ dienen te voor te komen (in plaats van éénmaal inÿ elke taal). ÿ
Vaste of gereserveerde stepvars
ÿDe vaste of gereserveerde stepvars zijn veruit de meest gebruikte stepvars en dienen om de broncode van het projectÿ zodanig op te kunnen bouwen dat dezelfde code kan worden gebruikt in verschillende build targets.
ÿHierdoor zal, bijvoorbeeld, het effectieve adresÿ van de gegenereerde website, niet in de bronteksten of de skeletonsÿ geplaatst dienen te worden. In de plaats daarvan wordt een stepvarÿ gebruikt (in dit geval is dit {#WebRoot}), die pas een waarde krijgt bij het effectief aanmaken van de te genereren website.
Het voordeel is dat dezelfde brontekst kan worden gebruikt om (bijvoorbeeld):
- een versie van de site te kunnen genereren op de ontwikkelings-PC (naar de zogenaamde localhost)
- een online-versie van de site te kunnen genereren naar de webserver toe, maar die zal dienen als een testversie, en dan ook in een online folder wordt geplaatst die de normale bezoekers van de site niet kennen
- een online-versie van de site te kunnen genereren naar de webserver toe die als 'echte' website zal dienen (en die dus zal worden bezocht door de bezoekers van uw site).
Zie Waarom een testsite maken ? op pagina 86 voor een beschrijving hoe een testsite kan worden aangemaakt.
Opsomming systeem stepvars
|
Naam van de vaste stepvar |
Toegekende waarde |
Voorbeeldwaarde |
|---|---|---|
|
@UserName |
Naam waaronder u bent aangelogd aan de Windows omgeving |
Erik |
|
@ComputerName |
De naam van de PC waarop de website wordt aangemaakt. |
BusinessPC1 |
|
@RegName |
De naam onder dewelke Sitestepper werd geregistreerd (ingevoerd in het 'registratienaam'-veld van de Sitestepper registratiegegevens. |
E.De.L.Com bvba |
|
@RunDate |
De datum waarop de webpagina wordt aangemaakt (in het formaat: dd mmm yyyy3) |
01-mei-2006 |
|
@RunTime |
De tijd waarop de webpagina wordt aangemaakt (in het formaat: hh:mm:ss4) |
11:18:23 |
|
@ProgramVersion |
De naam en huidige versie van Sitestepper. |
Sitestepper – 1.7.0.6070 |
|
@ProgramVersionUrl |
De naam en huidige versie van Sitestepper, met de naam Sitestepper als link naar de Sitestepper-website. |
Sitestepper – 1.7.0.6070 |
|
@SitestepperWeb |
De naam Sitestepper als link naar de Sitestepper-website. |
Sitestepper |
Tabel 3: Opsomming systeem stepvars
Project-stepvars (folders en URL's)
Normale en secure webpagina's
Sommige van de stepvars in de volgende tabel zullen driemaal in de lijst voorkomen:
- zonder prefix
- met de Normal-prefix
- met de Secure-prefix
De 'Normal-' en 'Secure-' varianten zullen steeds de waardes bevatten van de overeenkomstige tabulatie ('Website folders' voor 'Normal' en 'Secure website folders' voor 'Secure').
De stepvars zonder prefix zullen de waardes van de 'Website folders' bevatten indien de gegenereerde pagina een gewone (non-secure) webpagina betreft, en de waardes van de 'Secure website folders' indien de gegenereerde webpagina een secure webpagina betreft.
Met andere woorden: de stepvars zonder prefix kunnen worden gebruikt als generieke stepvars (zij zullen automatisch de correcte waardes ontvangen (secure of non-secure).
De stepvars met de 'Normal'- of 'Secure'-prefix kunnen worden gebruikt om steeds een verwijzing te forceren naar non-secure of secure wegpagina's (onafhankelijk van de op dat moment gegenereerde wegpagina).
Enkele opmerking in verband met de tabel met folders en URL-stepvars:
- Als slash-karakter wordt steeds de voorwaartse slash gebruikt ('/'), óók in foldernamen die waardes teruggeven van de Windows-folders.
- Indien de waarde van een stepvar een url of een foldernaam voorstelt, dan zal Sitestepper steeds de waarde gebruiken die niet is afgesloten met een slash ('/') of backslash ('\')-karakter. Dus ook al wordt, bijvoorbeeld, als website: http://www.sitestepper.com/ ingevoerd (dus met een afsluitend '/'-karakter), toch zal de overeenkomstige stepvar #Webroot de waarde http://www.sitestepper.com bevatten (dus zonder afsluitende '/'-karakter).
- Veel van de waardes van de project-stepvars
zijn ingevoerd in (of worden afgeleid van) de velden in de
websiteparameters. Na de beschrijving zal steeds een voorbeeld
worden getoond en zal worden aangeduid in welk veld en in welke
tabulatie van de websiteparameters de waarde kan worden
ingevoerd:
naam van de tabulatie: veldnaam - De voorbeelden en velden voor de non-secure pagina's zullen worden voorafgegaan door [norm], de voorbeelden en velden van secure pagina's door [sec].
|
Naam vaste stepvar |
Omschrijving / voorbeeld / gehaald uit |
|---|---|
|
#WebRoot
#SecureWebRoot #NormalWebRoot |
De URL van de gegenereerde website. |
|
[Norm] http://www.sitestepper.be [Sec] http://www.sitestepper.be/secure |
|
|
[Norm] web site folders: webroot [Sec] secure web site folders: webroot |
|
|
#WebRootOS |
De folder waar de site in (naar) wordt gegenereerd. |
|
[Norm]:c:/inetpub/wwwroot/sitestepper [Sec]:c:/inetpub/wwwroot/sitestepper/secure |
|
|
[Norm] lokale folders: website folder [Sec] lokale folders: secure web site |
|
|
#ImageRoot
#SecureImageRoot #NormalImageRoot |
De URL waar de afbeeldingen zullen worden gezocht op de website. |
|
[Norm] http://www.sitestepper.be/images [Sec] http://www.sitestepper.be/secure/images |
|
|
[Norm] Web site folders: Image root [Sec] Secure web site folders: Image root |
|
|
#ImageRootOS |
De folder waar de afbeeldingen naar toe worden gekopieerd. |
|
[Norm] c:/inetpub/wwwroot/sitestepper/images [Sec] c:/inetpub/wwwroot/sitestepper/secure/images |
|
|
[Norm] path uit [web site folders: Image root] achteraan de [Lokale website: website folder] geplaatst. [Sec] path uit [Secure web site folders: Image root] achteraan de [Lokale website: secure website] geplaatst. |
|
|
#ImageLang
#SecureImageLang #NormalImageLang |
Waarde van #ImageRoot indien gestart vanuit de WebRoot of DynamicRoot sectie, de waarde van #ImageRoot + de huidige taalcode indien gestart vanuit de Web of Dynamic sectie. |
|
[Norm] http://www.sitestepper.be/images en http://www.sitestepper.be/images/nl [Sec] http://www.sitestepper.be/secure/images en http://www.sitestepper.be/secure/images/nl |
|
|
#JavaScriptFolder
#SecureJavaScriptFolder #NormalJavaScriptFolder |
De URL waar de website de javascripts zal zoeken. |
|
[Norm] http://www.sitestepper.be/_js [Sec] Non-secure: http://www.sitestepper.be/secure/_js |
|
|
[Norm] Web site folders: Javascript [Sec] Secure web site folders: Javascript |
|
|
#JavaScriptFolderOS |
De folder waar de afbeeldingen naar toe worden gekopieerd. |
|
[Norm]: c:/inetpub/wwwroot/sitestepper/_js [Sec] c:/inetpub/wwwroot/sitestepper/secure/_js |
|
|
[Norm] path uit [web site folders: Javascript] achteraan de [Lokale website: website folder] geplaatst. [Sec] path uit [Secure web site folders: Javascript] achteraan de [Lokale website: secure website] geplaatst. |
|
|
#CookieDomain |
De domeinnaam van de gegenereerde site. Deze stepvar is in het correct formaat om bij het lezen en schrijven van cookies te worden gebruikt als domeinnaam. |
|
sitestepper.be |
|
|
#CookiePath |
De foldernaam van de gegenereerde site. Deze stepvar is in het correct formaat om bij het lezen en schrijven van cookies te worden gebruikt als domeinpath. |
|
/
of voor een testversie van de site: /testversie/ |
Tabel 4: Opsomming folder en URL stepvars
Project stepvars
|
Naam van de vaste stepvar |
Toegekende waarde |
|---|---|
|
#StoreName |
Naam van de actieve build target. |
|
eerste-website of eerste-website (TEST VERSIE) |
|
![]() |
|
|
#StoreDescription |
Omschrijving van de huidige buildtarget |
|
website van eerste-website |
|
|
Eerste tabulatie: Omschrijving |
|
|
#StoreTree |
Naam van de projectboom. |
|
eerste-website |
|
|
Eerste tabulatie: Treenaam |
|
|
#EmailContact |
Generiek emailadres dat op de website kan worden getoond als contactinformatie. |
|
info@eerste-website.be |
|
|
Email: Contactadres voor info |
|
|
#EmailShop |
Emailadres dat kan worden gebruikt als tweede contactadres (veelal gebruikt als emailadres voor informatie voor aankopen e.d.)5 |
|
sales@eerste-website.be |
|
|
Email: Contactadres 2 (shop) |
|
|
AspLib |
Subfolder waarheen de aanwezige asp-library wordt gebuild. |
|
steplib |
|
|
Dev-code library: Virtual name |
|
|
TableBorderColor |
Buiten gebruik – gebruik Color1 |
|
BGColorRsrvYou |
Buiten gebruik – gebruik Color2 |
|
BGColorRsrvElse |
Buiten gebruik – gebruik Color 3 |
|
TriangleBlackAsp |
Buiten gebruik |
|
TriangleBlack |
Buiten gebruik |
|
Color1 Color2 Color3 |
Drie kleurwaardes die in de websiteparaters kunnen worden geselecteerd teneinde deze éénduidig te kunnen gebruiken op de website. |
|
Alle kleuren weggeschreven in html-kleurcodering. |
|
|
Kleuren: Kleur 1 – Kleur 2 en Kleur 3 |
|
|
SourceFilename |
Naam van de webpagina die wordt gegenereerd zoals deze voorkomt in de projectboom. |
|
Lijst van aanwezige stepvars in 'Web' |
|
|
WebFilename |
Naam de webpagina zoals deze door Sitestepper zal worden gegenereerd met alle spaties en karakters die problemen kunnen opleveren (zoals quotes) vervangen door '-'-tekens. Tevens zijn alle karakters naar kleine karakters vertaald. |
|
lijst-van-aanwezige-stepvars-in—web- |
|
|
Filename |
gelijk aan webfilename |
|
IncludedSourceFilename |
Naam van het stepincl-bestand dat wordt tussengevoegd in de skeleton (zie StepIncl-lijnen op pagina 46 voor een volledige beschrijving van de stepincl-lijn). Indien de bronpagina wordt verwerkt (de stepincl @self-lijn), dan is IncludedSourceFileName gelijk aan Sourcefilenaam. |
|
Footer met adres |
|
|
IncludedFilename |
Naam van de IncludedSourceFileName met alle spaties en karakters die problemen kunnen opleveren (zoals quotes) vervangen door '-'-tekens. |
|
footer-met-adres |
|
|
Lang |
De taalcode van de webpagina die momenteel wordt gegenereerd. Deze stepvar is leeg indien pagina's worden gegenereerd uit de WebRoot en DynamicRoot sectie van de projectboom. |
|
NL, FR of DE |
|
|
LangSlash |
De taalcode van de webpagina die momenteel wordt gegenereerd, gevolgd door een voorwaartse slash. Enkel een voorwaartse slash indien pagina's worden gegenereerd uit de WebRoot en DynamicRoot sectie van de projectboom. |
|
NL/, FR/ of DE/ of / |
|
|
SkeletonName |
Naam van de gekoppelde skeleton. |
|
Default |
Tabel 5: Opsomming rest vaste stepvars
Stepcollect-stepvars
De stepvars zijn stepvars die worden aangemaakt telkens de optie: 'Genereer – Genereer Stepcollect pagina's' wordt uitgevoerd.
We onderscheiden twee soorten stepcollect-stepvars
- Tijdelijke
- Permanente
Tijdelijke stepcollect-stepvars
Tijdelijke stepvars zijn enkel actief bij het effectief uitvoeren van de optie: 'Genereer – Genereer Stepcollect pagina's'. Zij dienen om de waardes uit de gekoppelde stepcollectie te gebruiken om één of meerdere bronpagina's aan te maken.
Permanente stepcollect-stepvars
Permanente stepvars worden ook aangemaakt bij het effectief uitvoeren van de optie: 'Genereer – Genereer Stepcollect pagina's', maar, in tegenstelling tot de tijdelijke stepvars, worden deze permanente stepcollect-stepvars bewaard in het project.
Met andere woorden:indien het project een volgende keer wordt opgestart (met keuzen van één van de aanwezige build targets), dan hebben de permanente stepcollect-stepvars nog steeds de waarde van de laatste keer dat de stepcollection-bronpagina's werden gegenereerd.
De permanente stepvars bevatten o.a.een aanduiding van het aantal gegevens in de gekoppelde stepcollectie.
Gebruiker stepvars
Gebruiker stepvars zijn stepvars waarvan de naam door de gebruiker kan worden gekozen, en waarbij elke stepvar een waarde kan krijgen.
De waarde kan afhankelijk worden gemaakt van de actieve build target en is niet taal-afhankelijk. Met andere woorden: de ingevoerde stepvar wordt gebruikt op elke pagina die wordt gegenereerd, of het nu pagina's zijn uit de secties WebRoot of Dynamicroot – dus niet taalgebonden, of pagina's uit de secties Web en Dynamic – en dus wél taalgebonden)..
Intypen van de gebruiker-stepvars
Gebruiker stepvars kunnen worden ingevoerd in StepEdit door het kiezen van de menu-optie: 'Project – Editeer extra buildvariabelen'.
Als alternatief kan het
-icoon
worden gebruikt (zoals hiernaast afgebeeld).
De lijst van gebruiker-stepvars is een normaal tekstbestand (net zoals de bronpagina's).
De lijst dient te worden ingevoerd rekening houdende met de volgende regels.
- Elke stepvar dient op een aparte lijn te staan
- De naam en de waarde van de stepvar moeten op één lijn staan, de naam van de stepvar vooraan, gescheiden van de waarde door middel van een '='-teken.
- Spaties vooraan of achteraan de lijn worden niet behouden.
- Spaties onmiddellijk rond het '-'-teken worden niet behouden.
- Commentaar kan in de lijst worden geplaatst door de lijn te laten beginnen met een ';'-teken.
- Elke stepvar mag slechts éénmaal voorkomen in de lijst6.
- Gereserveerde stepvars (ook vaste stepvars genoemd) mogen niet worden gebruikt.
Ter info: De eerste maal dat de gebruikers-stepvar-lijst wordt opgestart om te worden aangepast, zal een (Engelstalige) helptekst worden toegevoegd aan de lijst die wat informatie verschaft over hoe deze stepvars dienen ingevoerd te worden. Deze helptekst is opgevat als commentaar en mag derhalve behouden blijven of worden verwijderd.
Syntax van een gebruiker-stepvar
Zoals eerder vernoemd dient een lijn waarop een gebruiker-stepvar wordt gedefinieerd, te bestaan uit:
- De naam van de stepvar: de naam dient
aangeduid te worden zonder ''
of '«...»'
karakters.
Gemakkelijk te onthouden: indien we de waarde van de stepvar wensen te gebruiken op de plaats waar we de stepvar invoeren, dienen we de stepvar te omringen '' of '«...»'. Vermits we hier niet de waarde aan het gebruiken zijn, maar de waarde aan het instellen zijn, mogen op deze plaats geen '' of '«...»' worden gebruikt. - een '='-teken
- de waarde van de stepvar: de vaste of gereserveerde stepvars mogen voorkomen in de waarde van de gebruiker stepvar (zie het voorbeeld 1 voor een mooie toepassing van deze mogelijkheid)..
Enkele praktijkvoorbeelden van hoe gebruiker-stepvars worden gebruikt, zullen duidelijk maken wat de kracht van deze optie is en zullen meteen de correcte syntax tonen..
Voorbeeld 1: Een gebruiker-stepvar voor de aanduiding van een speciale foldernaam
Stel dat de website een sectie zal bevatten over boekbesprekingen, en dat de afbeeldingen geplaatst zijn in de folder boekbesprekingen onder de folder aangeduid door de vaste stepvars #ImageRoot.
In plaats van overal op de website de constructie: http://www.sitestepper.be/images/boekbesprekingen te gebruiken, kan door middel van een gebruiker-stepvar een eigen (kortere) folderbenaming worden ingesteld.
ImageBoeken=http://www.sitestepper.be/images/boekbesprekingen
Zodanig dat de volgende stepvars kunnen worden gebruikt:
{#ImageRoot} http://www.sitestepper.be/images {#ImageRoot}/boekbesprekingenHTMLcode 11: Voorbeeld 1: een gebruiker stepvar voor de aanduiding van een speciale foldernaam
http://www.sitestepper.be/images/boekbesprekingen {#ImageBoeken} http://www.sitestepper.be/images/boekbesprekingen
Het gebruik van bespaart wat typewerk, vermindert daardoor de kans op fouten, en – zeker zo belangrijk – maakt het mogelijk om nadien gemakkelijk de foldernaam te veranderen.
Voorbeeld 2: Een gebruiker-stepvar voor de aanduiding van een externe website of externe url
Stel dat op de website veelvuldig een verwijzing moet worden geplaatst naar een externe website. Dit kan, bijvoorbeeld:
- een persoonlijke website zijn naar waar wordt gelinkt vanaf de site van je bedrijf
- een tweede website zijn die je onderhoudt7
- een externe site zijn naar waar moet gelinkt worden (bijvoorbeeld, een game site waarnaar wordt gelinkt vanaf je game-pagina)
- een pagina op een site waar je het appartement dat je hebt te huur aanbiedt
- je feedback-pagina zijn op een veilingsite zoals Ebay
In bijna alle gevallen:
- is deze externe link zeer lang
- heeft ze een zeer speciale syntax
- kan de effectieve pagina op elk moment veranderen
- of kunnen de parameters die achter de pagina komen, op elk moment veranderen.
Ook hier is het gebruik van een gebruiker-stepvar aangewezen.
De 5 voorbeelden hiervoor aangehaald, zullen even, ter illustratie, via een gebruiker-stepvar worden aangemaakt.
mijnsite=http://www.erikdelaet.be starwars=http://www.kevinwankenobi.com templates=http://www.designload.net/list/website-templates/ huurapp=http://www.immoweb.be/NL/Rent.Estate.cfm?IdBien=730325&xpage=1 feedback=
http://my.benl.ebay.be/ws/eBayISAPI.dll?MyeBay&LogUID=vinikia&CurrentPage=MyeBayFeedback&ssPageName=STRK:ME:LNLK& PageTime=7547&TimedPage=MyEbaySummary
HTMLcode 12: Voorbeeld 2: een gebruiker stepvar voor de aanduiding van een externe foldernaam
Overal waar nu op de webite kunnen nu de variabelen , , , en worden gebruikt.
Tijdens het builden of genereren van de pagina's zullen deze automatisch door Sitestepper worden vervangen door hun respectievelijke (en veel langere) url.
En wat meer is: op het moment dat de url van één van de externe websites verandert (niet zo waarschijnlijk bij de eerste twee voorbeelden, maar meer dan waarschijnlijk bij de laatste drie), dan dient slechts op één plaats de url te worden aangepast. Na het opnieuw builden van de site, zijn automatisch alle linken en teksten veranderd in de nieuwe versie.
Voorbeeld 3: een gebruiker-stepvar ter vervaning van een woord met accentkarakters
In html dienen accentkarakters (zoals é , à , û en ï) te worden ingevoerd met een speciale syntax8.
Deze syntax bestaat uit:
- het &-teken
- een afgesproken afkorting (in kleine letters;
- een ';'-teken
Een volledig lijst kan worden bekeken in Opsomming speciale en accentkarakters op pagina 296.
Zo zal het woordje één dienen ingevoerd te worden als ëën.
Ook hier komen de gebruikers-stepvars van pas. Want in plaats van ontelbare keren ëën in te typen, kan een stepvar worden gedefinieerd als volgt:
een=ëën
HTMLcode 13: Voorbeeld 3: een gebruiker stepvar ter vervanging van een woord met accentkarakters
Overal waar in de webpagina's één dient voor te komen, kan nu één worden ingevoerd.
Voorbeeld 4: een smiley of elk andere kleine afbeelding
Iedereen kent de smiley-karakters die (te pas en
te onpas) worden gebruikt op websites
Ook afbeeldingen met pijlen komen veelvuldig voor
op verschillende pagina's van websites
.
De syntax om deze kleine afbeeldingen op de site te plaatsen is redelijk lang. Om deze meerdere keren en op verschillende pagina's te plaatsten, kan ook hier zeer gemakkelijk een gebruiker-stepvar worden gebruikt.
smiley=<img src='{#ImageRoot}/smiley-smile.gif' border='0' width='16' height='16' alt='smiley-smile'>
pijlrechts=<img src='{#ImageRoot}/icons/blue-arrow.png' border='0' width='16' height='16' alt='' align='absmiddle'>
HTMLcode 14: Voorbeeld 4: een gebruiker stepvar ter vervanging van kleine afbeeldingen
Overal op de website waar nu een smiley of een
pijltje dient voor te komen, kan respectievelijk
en
worden ingevoerd in plaats van de lange <img
...>-syntax.
Als ooit een mooiere smiley, of een andere pijltje wordt gevonden, dient deze slechts op één plaats angepast te worden!
Voorbeeld 5: vastgelegde moeilijk in te voeren of veranderlijke gegevens
Als laatste voorbeeld worden hier nog enkele gebruiker-stepvars opgesomt ter illustratie (ter vervanging van moeilijk in te voeren woorden, lange teksten of veranderlijke gegevens).
firma=De Betere Woning BVBA zaakvoerders=Ronny Step, Wendy Vandekastele en Pieter R. Pubers adres=Voortgangstraat 123a – bus 1 – 2060 Antwerpen Luchtbal
HTMLcode 15: Voorbeeld 5: enkele andere gebruiker stepvars
Gebruiker stepvars afhankelijk van de build target
Gebruiker-stepvars kunnen een waarde krijgen die afhangt van de gekozen build target.
Dit gebeurt door de stepvar in een aparte sectie te vermelden in de lijst van de stepvars (zie Intypen van de gebruiker-stepvars op pagina 78).
Elke sectie moet bestaan uit de naam van de build target zoals deze wordt opgestart in het Sitestepper-programma en wordt getoond in de websiteparameters in het StepGen-programma, geplaatst op een aparte lijn tussen '['en ']' tekens.
Alle stepvars die voorkomen in de sectie van de actieve build target worden opgenomen in de vervanglijst tijdens het genereren van de webpagina's.
Stepvars die voorkomen in andere secties worden genegeerd (en dus niet opgenomen in de vervanglijst).
firma=De Betere Woning BVBA smiley=<img src='{#ImageRoot}/smiley-smile.gif' border='0' width='16' height='16'> [eerste-website] achtergrondkleur=#0000ff opgelettekst= [eerste-website (TEST VERSIE)] achtergrondkleur=#ffff00 opgelettekst=OPGELET: DIT IS EEN TESTVERSIE [eerste-website (NETWERK)] achtergrondkleur=#ffffff opgelettekst=
HTMLcode 16: Gebruiker-stepvars in verschillende build targets
In het voorgaande voorbeeld is het zo ingesteld dat de achtergrondkleur van de 'echte' site blauw is (#0000ff), de achtergrondkleur van de test versie geel is (#ffff00) en de achtergrondkleur van de versie die wordt gebouwd via het netwerk, wit is (#ffffff).
Door op verschillende plaatsen in de bronteksten of de stylesheets de stepvar te plaatsen, kan zeer simpel visueel worden aangeduidt welke site wordt gegenereerd.
Ook de stepvar zal een bepaalde waarde krijgen (leeg in alle build targets behalve in de testversie). Door deze stepvar, als voorbeeld, in de hoofding te plaatsen, is onmiddellijk te zien (op alle gegenereerde pagina's) dat het hier een testversie van de site betreft.
Message-stepvars
Message-stepvars zijn stepvars die allemaal beginnen met de prefix msg# en met als suffix een nummer.
De bedoeling is om unieke stepvars te definiëren zonder telkens een bepaalde naam voor de stepvar te moeten 'verzinnen' én deze stepvars taalgebonden te maken. Eenzelfde stepvar zal worden vervagnen door een waarde afhankelijk van de gegenereerde taal.
Een speciaal programma is aanwezig in de Sitestepper-familie om het invoeren van deze message-stepvars te vergemakkelijken.
Het programma kan worden opgestart door het
kiezen van de menu-optie: 'Project – Start StepMsgs', of door
het aanklikken van
.
De StepMsgs zijn gebonden aan het project wat effectief betekent dat alle build-targets die dezelfde website zullen bouwen naar verschillende plaatsen toe, dezelfde Message-stepvars zullen gebruiken.
StepMsgs
Zowel in de titelbalk van het programma, als in de takenbalk onderaan het scherm, zal het huidige project worden getoond.
In het programma zijn 9 kolommen aanwezig:
- in de eerste kolom kan een getal worden ingevoerd
- in de 8 volgende kolommen kunnen teksten worden ingevoerd in de 8 aanwezige talen van Sitestepper
Sitestepper zal automatisch bij het builden van een pagina in een bepaalde taal, de waarde uit de correcte kolom gebruiken als vervangwaarde.
In de voorgaande afbeelding zal de stepvar msg#1 de waarde 'Welcome visitor' krijgen indien een Engelstalige webpagina wordt aangemaakt, en zal ze de waarde 'Welkom bezoeker' krijgen indien een Nederlandstalige webpagina wordt gegenereerd.
Ter info: Indien een webpagina wordt gegenereerd uit de sectie WebRoot of DynamicRoot, zal de kolom van de gekozen master-language worden gekozen.
2In de huidige versie (1.7.0) van StepEdit, is de lijn op lijnnummer 15 vergeten. Deze dient dan ook manueel te worden toegevoerd. Nog een item voor de to-do-lijst ☺).
3dd = dag in cijfers, mmm = maand in drieletterige afkorting, dddd = jaar inclusief eeuw
4hh – uur in cijfers, mm = minuten in cijfers, ss = seconden in cijfers
5Beide emailadressen zijn gewoon twee plaatsen waar een emailadres kan worden ingevoerd zodanig dat dit op verschillende webpagina's kan worden geplaatst.
6Strikt genomen mag een gebruiker-stepvar wél meerdere malen voorkomen, maar Indien een gebruiker-stepvar meer dan éénmaal voorkomt in de lijst, wordt enkel de eerste waarde genomen.
7Want het is en blijft zeer gemakkelijk om een website met Sitestepper te onderhouden ☺!
8Alhoewel de meeste internetprogramma's de karakters wel correct zullen tonen.


