Template Variables

Header and Footer Variables

The header- and footer variables can be used in the regular templates for the homepage and the results pages.

These variables will work in the following files

  • homepage_header_template.htm
  • homepage_footer_template.htm
  • result_header_template.htm
  • result_footer_template.htm
  • {myKeyword}

    Example:

    Test Keyword

    The html-encoded keyword. Use this within the visible part of your website.


    {urlKeyword}

    Example:

    Test_Keyword

    The url-encoded keyword. Use this to link to results pages within your AOS.


    {dashedKeyword}

    Example:

    Test-Keyword

    The url-encoded keyword with all special characters replaced with dashes instead of underscores.


    {fillgquery}

    Example:

    Test+Keyword

    The url-encoded keyword with all blank spaces replaced with plus-signs instead of underscores.


    {q}

    Example:

    Test Keyword

    The unparsed keyword as submitted.


    {metaKeyword}

    Example:

    Test Keyword

    The keyword prepared for use in meta-tags.


    {metaPlainKeyword}

    Example:

    Test Keyword

    The keyword prepared for use in meta-tags with all special characters replaced with blank spaces.


    {titlePrefix}

    Example:

    Your Domain

    A prefix used in the result titles. This can be changed in the rr_conf.php file.


    {titlePostfix}

    Example:

     - Compare Prices and Buy at lowest Price

    A postfix used in the result titles. This can be changed in the rr_conf.php file.


    {titlePage}

    Example:

    Page 2

    Outputs a verbal page number for use after the keyword in your result-titles to avoid duplicate titles for different pages of the same keyword.


    {pureDomain}

    Example:

    yourdomain

    Your pure domain without www and without the top level domain.


    {pureDomainTld}

    Example:

    yourdomain.com

    Your domain without www but with your top level domain.


    {http}

    Example:

    http://

    Either http:// or https://


    {myDomain}

    Example:

    yourdomain.com/aos

    The absolute path to your AOS installation (includnig any subfolder or subdomain if present). There is no trailing slash.


    {refine_search}

    Example:

    0

    Either 0 or 1 depending on the search mode. Will be 1 if search refinements are set by the user. Otherwise it will be 0. This can be used in hidden input fields.


    {languCode}

    Example:

    en

    The language code set up in your rr_config.php file.


    {urlPage}

    Example:

    page2/

    The url adder to reference the current results-page.


    {PHP_SELF}

    Example:

    /index.php

    The exact value of the current $PHP_SELF variable.


    {rssResultButton}

    Example:

    
    


    {topProductClicks}

    Example:

    <div id="aos_product_clicks_top">
    	<p>
    		<strong>Popular products:</strong>
    		<a href="http://yourdomain.com/rss:popular_products/">
    			<img style="border:0;" src="http://yourdomain.com/images/rss.gif" alt="Generate popular products as RSS" title="Generate popular products as RSS" />
    		</a>
    	</p>
    	<ul>
    		<li class="query">
    			<a href="http://yourdomain.com/openeurl/page0/" title="Test-Keyword">
    				Test-Keyword
    			</a>
    		</li>
    	</ul>
    	<div style='clear:both'></div>
    </div>

    Lists the most clicked products and directly links to the lead page of the suiting advertiser.


    {topQueries}

    Example:

    <div id="aos_product_search_queries_top"><p>
    	<strong>Top product queries:</strong>
    	<a href="http://yourdomain.com/rss:top_product_queries/">
    		<img style="border:0;" src="http://yourdomain.com/images/rss.gif" alt="Generate top product queries as RSS" title="Generate top product queries as RSS" />
    	</a>
    	</p>
    	<ul>
    		<li class="query">
    			<a href="http://yourdomain.com/Test-Keyword/" title="find products related to Test-Keyword">
    				Test-Keyword
    			</a>
    		</li>
    	</ul>
    	<div style='clear:both'></div>
    </div>

    Lists your best performing keywords. The order is conversions descending,clicks descending, views descending.


    {lastQueries}

    Example:

    <div id="aos_product_search_queries_last">
    	<p><strong>Last product queries:</strong>
    	<a href="http://yourdomain.com/rss:last_product_queries/">
    		<img style="border:0;" src="http://yourdomain.com/images/rss.gif" alt="Generate top product queries as RSS" title="Generate top product queries as RSS" />
    	</a>
    	</p>
    	<ul>
    		<li class="query">
    			<a href="http://yourdomain.com/Test-Keyword/" title="find products related to Test-Keyword">
    				Test-Keyword
    			</a>
    		</li>
    	</ul>
    	<div style='clear:both'></div>
    </div>

    Lists the last-searched-for keywords in your AOS.


    Single result variables

    The single result variables can be used in the single_result_template.htm file. This file will be used for each product on your results page seperately. So in most cases it will be included 10 times per result page.

    {product_price}

    Example:

    99

    The product price excluding the currency.


    {product_description}

    Example:

    Example <strong>product</strong> description.

    The product description as provided by the advertiser.


    {product_pure_description}

    Example:

    Example product description.

    The product description with all html-tags stripped.


    {product_url}

    Example:

    http://yourdomain.com/aos/openeurl/page2/12345/

    The tracking link to the current product.


    {product_image}

    Example:

    http://some-advertiser.com/absolute-image-url.gif

    The absolute url to the product image.


    {product_name}

    Example:

    Example product

    The product name as provided by the advertiser.


    {product_advertiser}

    Example:

    Some Advertiser

    The business name of the offering advertiser.


    {product_currency}

    Example:

    USD

    The currency of the product.


    {product_compare_price_link}

    Example:

    <a href="http://yourdomain.com/aos/upc:12345/" title="Example Product">Compare Price</a>
    

    A direct link to compare the price of the product. This link will only show if there is a valid upc or isbn for the product. Results will only show if there are at least two matching products.