EKM Tag Documentation - ekm:securearea

This tag is used to output the login form for the customer login feature. This allows customers to login and see recent orders they have made.

You must enable the "Customer Login" feature on your shop before this tag will output.

You may also want to customise the "Secure Area Contact Form" or the "Secure Area Show Orders" section to be more inline with your colour scheme.

Tag Information
Styles
Nesting This Tag

Basic Use

In its basic use the tag will output the numeric value of the stock level.


[ekm:securearea_login]style='style1';[/ekm:securearea_login]

This outputs the following.

Advanced Use

The advanced use of the tag allows you to specify your own HTML and layout for the securearea_login tag including showing additional fields


[ekm:securearea_login]
    style='style1';
    output_start='';
    output_form='[email][password][submit][link]';
    output_end='';
    output_links_start='';
    output_link='[link] | ';
    output_links_end='';
[/ekm:securearea_login]

Tag Attributes

Style

style='style1';

Define the layout for the securearea_login to be displayed. View All Styles Here

Value

Description

style1

Uses layout 1 from the predefined styles. View Styles

style2

Uses layout 2 from the predefined styles. View Styles

style3

Uses layout 3 from the predefined styles. View Styles

style4

Uses layout 4 from the predefined styles. View Styles

Output Start

output_start='<div id="my-account">';

Specify any HTML or Text you want to output before the signin area. This will only be output if the customer login feature is enabled. Typically here you would output any opening HTML tags and headers.

Value

Description

{user defined}

Specify any custom HTML or text to output.

Output Form

output_form='[email][signup_button]';

Specify the layout for the form's content. Here you can insert HTML or Text to define the layout of the fields and submit button.

Value

Description

{user defined}

Specify your own HTML and Text to be output. You will also need to define the attribute tags for the fields.

To output the securearea_login fields and a forgotten password field you will need to include these attribute tags.

Value

Description

[email]

Outputs the email address field for customer login

[email-name]

Outputs the name of the email address field for customer login

[password]

Outputs the password field for customer login.

[password-name]

Outputs the name of password field for customer login.

[submit]

Outputs the submit/login button.

[link]

Outputs the forgot password link and text.

[link-urlonly]

Outputs the forgot password URL. This is useful for definig your own "Forgot Password" text.

Output End

output_end='</div>';

Specify any HTML or Text you would like to output when the my account form has finished outputting. Typically here you would close any opened divs from the output_start attribute.

Value

Description

{user defined}

Specify any HTML or Text to be output.

Output Links Start

output_links_start='<div id="my-account-links">';

Displayed only when the user is logged in

Specify any HTML or Text you want to output before the logged in links. This will only be output if the customer is logged in. Typically here you would output any opening HTML tags and headers.

Value

Description

{user defined}

Specify any custom HTML or text to output.

Output Link

output_link='[link] | ';

Displayed only when the user is logged in

Specify the HTML to be output with each link when the user is logged in.

Value

Description

{user defined}

Specify any custom HTML or text to output.

To specify how the links will output you need to include attribute tags.

Value

Description

[link]

Outputs the link whole

[link-name]

Outputs the name of the link only

[link-urlonly]

Outputs only the URL of the link

Output Links End

output_links_end='</div>';

Displayed only when the user is logged in

Specify any HTML or Text you would like to output after the logged in links are displayed. Typically here you would close any opened divs from the output_links_start attribute.

Value

Description

{user defined}

Specify any HTML or Text to be output.

This tag has a number of predefined layout styles. Below are examples for each of the styles and how they will look on your website.

STYLE 1

When the securearea_login tag is set to style style1 the form style will output like the example below.


[ekm:securearea_login]style='style1';[/ekm:securearea_login]

This would output something like...

STYLE 2

When the securearea_login tag is set to style style2 the form style will output like the example below.


[ekm:securearea_login]style='style2';[/ekm:securearea_login]

This would output something like...

STYLE 3

When the securearea_login tag is set to style style3 the form style will output like the example below.


[ekm:securearea_login]style='style3';[/ekm:securearea_login]

This would output something like...

STYLE 4

When the securearea_login tag is set to style style4 the form style will output like the example below.


[ekm:securearea_login]style='style4';[/ekm:securearea_login]

This would output something like...

The EKM system allows for some tags to be nested within other tags.

This tag cannot be nested within other tags

Email:
Password:

	Forgotten your password? Click here

EKM Tag: [ekm:securearea_login]