Hide

YetaWF Documentation

Display
Print

YetaWF.Basics Package

Overview

This package implements modules that offer basic support for YetaWF, such as alerts, mailto: obfuscation, module skin information, captcha and message display.

Alerts

YetaWF offers a built-in Alert that can be displayed to each site visitor to alert them of noteworthy items (maintenance, outages, etc.). A test page is provided at Tests > Alert (standard YetaWF site).

mailto: Obfuscation

By referencing the Mailto Obfuscator (Skin) Module site-wide or per page, special <a> tags can be used to generate mailto: links. This will stop basic website crawlers from scraping your email address. While it won't defeat more sophisticated crawlers that allow JavaScript to run, it works well for most crawlers.

<a class="YGenMailTo" data-domain="softelvdm.com" data-name="support">(email)</a>

The CSS class YGenMailTo can be added to an <a> tag, along with data-domain and data-name attributes. At runtime, the mailto: link will be generated. The above example generates a mailto:support@softelvdm.com link.

Modules

Module NameDescription
Alert Message (Skin) ModuleCan be referenced by sites, pages or modules. Once referenced, an Alert will be displayed (once or until dismissed, depending on Alert Settings).
Alert Settings ModuleThe Alert Settings Module allows configuring the Alert displayed to site visitors and can be accessed using Admin > Settings > Alert Settings (standard YetaWF site).
Mailto Obfuscator (Skin) ModuleSkin module implementing mailto: obfuscation using JavaScript. Can be enabled by referencing it site-wide or per page.
Message (Page) ModuleDisplays an error message (used when no page/module context is available).
Module Skin Info ModuleDisplays a test sample with most HTML elements and tags commonly used. It can be used to verify a skin. It also displays average character height/width, which is used when creating new skins (in a skin's Skin.txt file). Module Skin Info can be accessed using Tests > Module Skin Info (standard YetaWF site).
RecaptchaV2 Settings ModuleCaptcha support using Google's https://www.google.com/recaptcha. The Recaptcha configuration can be accessed using Admin > Settings > RecaptchaV2 Settings (standard YetaWF site). Recaptcha is a service provided by Google. Key information can be obtained at https://www.google.com/recaptcha/admin#createsiteRemote. You need a Google account to obtain key information. The settings defined using the RecaptchaV2 Settings Module are used by the RecaptchaV2 component.

License

The YetaWF.Basics package is part of YetaWF, an open source product licensed under the GNU General Public License, version 3 (GPL-3.0) - Copyright - Softel vdm, Inc.