Lukee sisään HTML-tiedoston tai vapaamuotoista merkkausta, ja tulostaa syntyneen sisällön sivulle.

Kuvaus

Listoja tulostavilla tageilla on käytössään myös helper-attribuutti, joka toimii hyvin samaan tapaan kuin {Helper}-tagi.

Katso myös ohjeet listojen muotoiluun helper-attribuutin avulla.

Syntaksi

{Helper(
    file: string,
    case: string,
    product: int,
    category: int,
    brand: int,
    campaign: int,
    infopage: int,
    news: int
)}

Näkyvyys

Toimii näkyvyydessä: globaali

Globaalin näkyvyyden tageja on mahdollista käyttää missä tahansa sivupohjassa ja minkä tahansa tagin sisällä.

Sisällön uudelleenkäyttäminen useilla sivuilla {Helper}-tagin avulla

<header>
    <div class="logo">
        {Logo}
    </div>
    <nav>
        {Categories}
    </nav>
</header>                

Yllä oleva tiedosto sisältää teeman jokaisella sivulla käytettävän header-osion, jossa tulostetaan yrityksen logo käyttämällä {Logo}-tagia, sekä tuoteryhmänavigaatio {Categories}-tagilla.

Tiedosto sijaitsee teeman kansiossa helpers nimellä header.html.

{Helper(
    file: 'helpers/header'
)}                  

header.html-tiedosto haetaan yllä näkyvällä merkkauksella. Huomaa että file-attribuutin arvona annettavaan tiedostopolkuun ei ole sisällytetty tiedostopäätettä.

Yksittäisen tuotteen tulostaminen {Helper}-tagin avulla

Kun {Helper}-tagilla halutaan tulostaa yksittäisen tuotteen tiedostot, tallennetaan tulostettavaan tiedostoon tuotetageja, jotka tulostavat tuotteesta halutut tiedot:

<div>
    <h2>{ProductName}</h2>
    <div>
        {ProductPrices}
    </div>
    <div>
        {ProductDescription}
    </div>
</div>                

Yllä näkyvä esimerkkitiedosto sijaitsee teeman kansiossa /helpers nimellä promotuote.html:

{Helper(
    file: 'helpers/promotuote',
    product: 6
)}                

{Helper}-tagille annetaan tällöin product-attribuutin arvoksi halutun tuotteen ID-numero, ja file-attribuutille tulostettavan tiedoston sijainti.

Esimerkissä tulostettavassa tiedostossa olevat tuotetagit tulostavat tietoja tuotteelta, jonka ID-numero on 6.

Tuoteryhmän tuotteiden tulostaminen {Helper}-tagin avulla

Tarvittaessa voit tulostaa {Helper}-tagilla listan haluamasi tuoteryhmän tuotteista. Tällöin tulostettavassa tiedostossa voidaan käyttää esimerkiksi {CategoryProducts}-tagia tulostamaan itse tuotelista.

<div>
    <h2>{CategoryName}</h2>
    <div>{CategoryDescription}</div>
    <div>
        {CategoryProducts(
            helper: 'helpers/listproduct'
        )}
    </div>
</div>               

Yllä näkyvä HTML- ja Interface-merkkaus tallennetaan tiedostoon helpers/promo-category.html.

Esimerkissä käytetään tuotelistan tulostavalla tagilla myös helper-attribuuttia, jonka avulla määritellään, että helpers/listproduct.html-tiedoston sisältö tulostaa yksittäisen listatuotteen merkkauksen.

{Helper(
    file: 'helpers/promo-category',
    category: 7
)}                

Oheisella Interface-merkkauksella tulostetaan siis nimi, kuvaus ja tuotteet tuoteryhmältä, jonka ID-numero on 7.

Sisällön tulostaminen vain tiettyjen asiakasryhmien asiakkaille

Vain halutulle asiakasryhmälle näytettävä sisältö tallennetaan omaan tiedostoonsa verkkokaupan teeman /helpers-kansioon.

<div>
    <h2>Vain jälleenmyyjien silmille</h2>
    <p>Tämä sisältö näytetään vain sisäänkirjautuneille käyttäjille, jotka kuuluvat jälleenmyyjien asiakasryhmään.</p>
</div>                 

Esimerkissä on käytetty vain HTML-sisältöä, mutta tiedostossa voi luonnollisesti käyttää myös Interface-merkkausta.

{Helper(
    file: 'helpers/jalleenmyyjien-sisalto',
    case: 'CustomerGroup-3'
)}                 

Sisältö tulostetaan käyttämällä {Helper}-tagia case-attribuutin arvolla 'CustomerGroup-n', jossa n on halutun asiakasryhmän ID-numero.

Attribuutit

file:

Määrittää tiedoston tai merkkauksen, joka luetaan sisään ja tulostetaan.

Arvo voidaan antaa kahdella tavalla:
  • Tiedostonimi: Anna haluamasi HTML-tiedoston sijainti suhteessa teeman juurikansioon.

    Älä sisällytä tiedostonimeen päätettä.

  • Merkkaus: Sulje antamasi merkkaus kahden aaltosulkeen sisään {{ <!-- HTML- ja Interface-merkkaus tähän --> }}.

Esimerkiksi:
{Helper(
      file: 'helpers/file'
)}

{Helper(
      file: {{
            {ShopName}
      }}
)}
case:

Määrittää ehdot, joiden täyttyessä tagi tulostaa sisältöä.

Sallitut arvot:

  • 'CartNotEmpty': Ostoskori ei ole tyhjä.
  • 'CartEmpty': Ostoskori on tyhjä.
  • 'IsCheckout': Nykyinen sivu on jokin kassasivu.
  • 'IsCategory': Nykyinen sivu on tuoteryhmäsivu.
  • 'IsHomepage': Nykyinen sivu on etusivu.
  • 'IsBrand': Nykyinen sivu on tuotemerkin sivu.
  • 'IsProduct': Nykyinen sivu on tuotesivu. Tuotesivulla ovat lisäksi käytettävissä seuraavat arvot:
    • 'IsNewProduct': Tuote on julkaistu viimeisen kuukauden sisällä.
    • 'IsDiscountProduct': Tuote kuuluu johonkin aktiiviseen alennuskampanjaan.
    • 'IsFeaturedProduct': Tuote on mainostettava.
  • 'IsNews': Nykyinen sivu on uutissivu.
  • 'IsPage': Nykyinen sivu on sisältösivu.
  • 'IsAccount': Nykyinen sivu on jokin asiakastilin sivu.
  • 'AdminLogged': Kävijä on sisäänkirjautunut ylläpitäjä.
  • 'CustomerLogged': Kävijä on sisäänkirjautunut asiakas.
  • 'CustomerNotLogged': Kävijä ei ole sisäänkirjautunut asiakas.
  • 'CustomerGroups': Sisäänkirjautunut asiakas kuuluu johonkin asiakasryhmään.
  • 'CustomerGroup-n': Sisäänkirjautunut asiakas kuuluu asiakasryhmään n (asiakasryhmän ID-numero).
product:

Määrittää, että tagin avulla tulostettavaa sisältöä käsitellään tuotteena, jolloin tulostettavassa sisällössä voidaan käyttää tuotteen tageja.

Arvona annetaan halutun tuotteen ID-numero.

Esim. product: 2

category:

Määrittää, että tagin avulla tulostettavaa sisältöä käsitellään tuoteryhmänä, jolloin tulostettavassa sisällössä voidaan käyttää tuoteryhmien tageja.

Arvona annetaan halutun tuoteryhmän ID-numero.

Esim. category: 2

brand:

Määrittää, että tagin avulla tulostettavaa sisältöä käsitellään tuotemerkkinä, jolloin tulostettavassa sisällössä voidaan käyttää tuotemerkkien tageja.

Arvona annetaan halutun tuotemerkin ID-numero.

Esim. brand: 2

campaign:

Määrittää, että tagin avulla tulostettavaa sisältöä käsitellään kampanjana, jolloin tulostettavassa sisällössä voidaan käyttää kampanjoiden tageja.

Arvona annetaan halutun kampanjan ID-numero.

Esim. campaign: 2

infopage:

Määrittää, että tagin avulla tulostettavaa sisältöä käsitellään sisältösivuna, jolloin tulostettavassa sisällössä voidaan käyttää sisältösivujen tageja.

Arvona annetaan halutun sivun ID-numero.

Esim. infopage: 2

news:

Määrittää, että tagin avulla tulostettavaa sisältöä käsitellään uutissivuna, jolloin tulostettavassa sisällössä voidaan käyttää uutisten tageja.

Arvona annetaan halutun uutisen ID-numero.

Esim. news: 2

after/before:

after- ja before-attribuuteilla voit määritellä sisällön, joka tulostetaan ennen ja/tai jälkeen tagin tulostaman sisällön.

Sallitut arvot: HTML- ja Interface-merkkaus

Esim.:

  • before: '<p>Tämä merkkaus näytetään ennen tagin omaa sisältöä.</p>'
  • after: '<p>Tämä taas lisätään tagin oman sisällön jälkeen</p>'

after- ja before-attribuuttien sisältöä ei tulosteta, jos tagi itse ei tuota mitään sisältöä.

escape:

Asettaa tulostettavassa sisällössä pakomerkin ennen lainausmerkkejä.

Attribuutin tarkoitus on helpottaa tagin palauttaman sisällön käyttämistä JavaScriptin avulla.

Sallitut arvot: true / false. Oletusarvo false.

or:

Määrittää vaihtoehtoisen sisällön, joka näytetään mikäli tagi ei itse tuota mitään sisältöä.

Sallitut arvot: HTML- ja Interface-merkkaus

Esim. or: 'Sisältöä ei löytynyt.'