Cyclone3 Skin

130-form.lite.mdl

From Cyclone3 Wiki

Standard article list with paging

Contents

Input parameters

sender.email[.languagecode]

  • description: E-mail address displayed as sender, languagecode is a 2-character language code - en, sk, de, ... Field with languagecode suffix overrides the default field, when languagecode corresponds with current webpage language
  • format: valid e-mail address
  • default: no-reply@$tom::Hm

sender.name[.languagecode]

  • description: Name displayed as sender
  • format: string
  • default:

sender.host[.languagecode]

  • description:
  • format: web domain
  • default: $tom::H_www

sender.service[.languagecode]

  • description:
  • format: string
  • default: cyclone3-webform

recipient.email[.languagecode]

  • description: E-mail address of recipient
  • format: valid e-mail address
  • default:

recipient.name[.languagecode]

  • description: Name of recipient
  • format: string
  • default:

recipient.name[.languagecode]

  • description:
  • format:
  • default: $tom::H_www

recipient.cc[.languagecode]

  • description: Carbon-copy recipient addresses
  • format: Comma-separated list of valid e-mail addresses
  • default:

recipient.bcc[.languagecode]

  • description: Blind-copy recipient addresses
  • format: Comma-separated list of valid e-mail addresses
  • default:

message.subject[.languagecode]

  • description: E-mail subject
  • format: string (national characters not recommended)
  • default: [$tom::Hm] Web Form

message.priority[.languagecode]

  • description: Priority of the sent e-mail, the higher the number, the higher the importance for the automatic cron (applies only for webforms, error e-mails have always the highest priority)
  • format: 1-90
  • default: 1

check.repeated

  • description: Check repeated sending of the form to avoid duplicates or flooding
  • format: 1/0
  • default: 1

required

  • description: Variables that need to be filled out for the form to be sent
  • format: Comma-separated list of field names (without the f_type_ prefix)
  • default:

action

  • description: Form action, the default form module allows only 'send' as valid action
  • format: string
  • default:

captcha.chars

  • description: Count of captcha characters
  • format: integer
  • default: 4

captcha.width

  • description: Actual captcha image width in pixels
  • format: integer
  • default: 90

captcha.height

  • description: Actual image height in pixels
  • format: integer
  • default: 30

captcha.color.bg

  • description: Background colour
  • format: color in #nnnnnn format or valid HTML color name
  • default: gray

captcha.color.fg

  • description: Foreground (text) colour
  • format: color in #nnnnnn format or valid HTML color name
  • default: black

captcha.noise1

  • description: Primary noise color
  • format: color in #nnnnnn format or valid HTML color name
  • default: captcha.color.fg

captcha.noise2

  • description: Secondary noise color
  • format: color in #nnnnnn format or valid HTML color name
  • default: captcha.color.bg

Output templates

TMP

  • definition: Default output
  • description: mandatory.
  • example 
<DEFINITION id="TMP">
  Contact us!<br />
  
  <form encoding="multipart/form-data" method="post" action="?|?|">
    <input type="hidden" name="action" value="send" />
    
    <label for="name">Name:</label><br />
    <input id="name" name="f_text_name" value="<%name%>" <#fieldfailure.f_text_name#> />
    <label for="surname">Surname:</label><br />
    <input id="surname" name="f_text_surname" value="<%surname%>" <#fieldfailure.f_text_name#> />
  </p>
  
  <p>
    <label for="email">E-mail address:</label><br />
    <input id="email" name="f_email_email" value="<%email%>" <#fieldfailure.f_email_email#> />
    <label for="phonenumber">Phone number:</label><br />
    <input id="phonenumber" name="f_text_phonenumber" value="<%phonenumber%>" <#fieldfailure.f_text_phonenumber#> />
  </p>
  
  <p>
    <label for="message">Message:</label><br />
    <textarea id="message" name="f_multiline_message"><%message%></textarea>
  </form>
</DEFINITION>
Replaced gateways and variables
<#fieldfailure_variablename#> Placeholder for failure.data or failure.format templates, when variable is required but not filled, or not in correct format
<%variable%> Submitted form variable value. The form variable names need to be specified using f_type[_subtype]_variablename format. Currently processed variable types include text, checkbox, radio, select, email, www and multiline. Currently processed subtypes include multiple (used for multiselect checkboxes, selects and radios). Variable names are recommended to be a-z0-9.

TMP.success

  • description: mandatory.
  • example 
<DEFINITION id="TMP">
  Thank you!<br />
  The form has been successfully sent, we'll contact you as soon as possible.
</DEFINITION>
Replaced gateways and variables

email

  • description: mandatory.
  • example 
<DEFINITION id="email">
  <p>
    Web page user has filled out the contact form:
  </p>
  
  <p>
    Name: <%name%><br />
    Surname: <%surname%>
  </p>
  
  <p>
    E-mail address: <%email%><br />
    Phone number: <%phonenumber%>
  </p>
  
  <p>
    Message:<br />
    <%message%>
  <p>
  
  <p>
    <$tom::H_www> support team
  </p>
</DEFINITION>
Replaced gateways and variables

email.sender

  • description: message sent to the form sender if a sender e-mail is defined
  • example 
<DEFINITION id="email">
  <p>
    This e-mail confirms, that you've successfully sent a web form with these entered values:
  </p>
  
  <p>
    Name: <%name%><br />
    Surname: <%surname%>
  </p>
  
  <p>
    E-mail address: <%email%><br />
    Phone number: <%phonenumber%>
  </p>
  
  <p>
    Your message:<br />
    <%message%>
  <p>
  
  <p>
    <$tom::H_www> support team
  </p>
</DEFINITION>
Replaced gateways and variables

result.repeated

  • description: message sent to the form sender if a sender e-mail is defined
  • example 
<DEFINITION id="result.repeated">
  <p>
    The form could not be sent, because it has at least once sent before with the same values.
  </p>
</DEFINITION>

result.failure

  • description: Replaced into the default template, when something goes wrong with sending the form (unfilled required fields, incorrectly entered values, ...)
  • example 
<DEFINITION id="result.failure">
  <p>
    The form could not be sent. You did not fill in all mandatory fields, or you did not enter correct values. Check the form for red and orange marked fields.
  </p>
</DEFINITION>

fieldfailure.data

  • description: Replaced into fieldfailure.f_type_variable placeholders, when the variable is mandatory and empty
  • example 
<DEFINITION id="fieldfailure.data">class="red"</DEFINITION>

fieldfailure.format

  • description: Replaced into fieldfailure.f_type_variable placeholders, when the entered variable is not correctly formatted as type (currently used only for checking e-mail address and webdomain format checking)
  • example 
<DEFINITION id="fieldfailure.format">class="orange"</DEFINITION>

Examples and notes

Retrieved from "http://wiki.cyclone3.org/index.php/130-form.lite.mdl"