Electrons

Below you'll find a list of all Template Variables (TVs) in the library. TVs define things on template level. If you're looking for a way to control things globally, check out the adjacent Configuration Settings.

e_connections

Connections

contributors_id

Team members that worked on this item. You can only select persons listed on your Team page, so if you want to add external contributors: add them to the team page first (can be unpublished).

organization_id

Connect the related organization(s). If this list is empty, you need to create an Organizations container first and register its ID under System Settings.

person_id

Connect a person to this item. This list is populated with all the persons that are listed on your Team page.

user_id

Connect a MODX user to this item. Only active users will be shown.

e_content

e_contentblocks

e_cta

CTA - Settings

cta_availability

Where would you like to be able to place this CTA?

e_footers

Footer

e_headers

Header

header_background

Select a background for this header. You can define these backgrounds under Content > Global Content > Backgrounds. Will also be inherited by default.

header_background_img

Use an Overview image as background. This overrides the regular Background setting above and will NOT be inherited. If you want to repeat an image on child pages, add it as Global Background.

header_cta

Select a CTA for display in header. CTAs are located in Global Content. If a CTA is selected, all Title values will be ignored but Background settings still apply. Not inherited by default.

header_inheritance

Select which elements to display on child pages of this resource too. NB: Turning inheritance OFF for an element returns it to its default value, but that is not reflected in the manager!

header_subtitle

This will be displayed under the main title. Will also be inherited on child pages by default.

header_title

Title below the navigation bar. The text will automatically be inherited on child pages. You can override this behaviour by entering a new title or by deleting the inherited value.

header_visibility

If you turn this off, the page starts with the content area but the navigation bar will still be visible. Inherited by default, but you can change this with the Inheritance setting below.

e_links

Links

e_purpose

Purpose

content_brief

Try to turn the content purpose into a short summary. What are the main take-aways? Why are they important? And why should people listen to you? Add links to examples if you want.

content_cta

What kind of action do you want the visitor to take after viewing this content? View related content, get in touch, subscribe to your newsletter, buy your product, donate to your cause...

content_outline

Give an overview of the main page structure. Like a table of contents, but feel free to add ideas in between.

content_priority

Zoom out a little and ask yourself: do we really need this page? And do we need it now? If it turns out to be neither urgent nor important, consider deleting it again.

content_purpose

Select the primary function(s) of this content. You can focus on just 1 topic, or create a chain of topics to use as blueprint for your storyline.

content_repurpose_dest

Can you think of ways to reuse this content in other places or scenarios? If the destination doesn't exist yet, just enter Title and Description as an idea.

content_repurpose_src

On which existing sources will this content be based? If the source is already pointing to this page as destination, it will show up automatically.

content_result

Describe the desired effect of this page. How did it help the visitor? And what good will that do for you?

content_tone

Decide what writing style to adopt for this page. Formal, fun, pragmatic, provocative...

e_status

Status

content_owner

Who is responsible for editing and maintaining this page?

status_health

What is the current condition of this page?

status_improvements

How can we make this page better? This is aimed at the content editors team. If you have technical issues, please enter those in 'Help!' below.

status_issues

What kind of problem(s) are you experiencing? This is aimed at the developers. Please create separate items if you have more than 1 issue and include any relevant info (like error messages).

e_timeline

Timeline

project_hub_timeline

Keep track of the project's progress and see what's coming up next. You can also link to related project files and resources from here, so you can find them back more easily.

e_formblocks

Autoresponder

fb_autoresponder_from

Optional. This is the address where the messages appear to be sent from. Can be a non-existing address, like [email protected] Defaults to emailsender system setting.

fb_autoresponder_from_name

Optional. This is the name that will (probably) be visible in the recipients' inbox. Defaults to site_name system setting.

fb_autoresponder_message

The content of the email that will be sent. You can use placeholders here from the form fields with the following syntax: . So with ID prefix and hyphenated field name.

fb_autoresponder_reply_to

Optional. This address will be used when recipient replies to this message directly. Defaults to respectively the client_email and emailsender system setting.

fb_autoresponder_subject

fb_autoresponder_toggle

IMPORTANT! For the autoresponder to know which email address to use, the Input (Email) field needs to be present in the form.

Registration

fb_activation_resource_id

Page containing the ConfirmRegister snippet for email activation. Enter page ID or drag the page from the menu tree to this input field. Defaults to the activation_resource_id system setting.

fb_activation_toggle

Whether or not new users need to activate their account via email. IMPORTANT! For the activation process to know which address to use, the Input (Email) field needs to be present in the form.

fb_activation_ttl

Number of minutes until the activation email expires. Defaults to 3 hours.

fb_extended_toggle

If switched on, any extra fields in the form are added to the extended field in the user profile.

fb_fullname_field

Name of the form field that will receive the full name of the user. Handy when using email address as username. You can use the label name of the CB field here, or the input name in the HTML.

fb_password_field

Name of the form field that will receive a password. If empty, a password will be generated instead. You can use the label name of the CB field here, or the input name in the HTML.

fb_usergroups

Optional. A comma-separated list of user group names or IDs to add the newly-registered user to.

fb_usergroups_field

Optional. The name of the form field that decides which user groups the new user will belong to. You can use the label name of the ContentBlock field here, or the name in the HTML.

fb_username_field

Name of the form field that will receive the username. You can use the label name of the CB field here, or the input name in the HTML. Tip: consider using the email address here..

Settings - Advanced

fb_email_template

Name of the chunk containing your own customized (HTML) email template. Make sure there is a placeholder in there for listing the fields.

fb_email_to_dynamic

Place any snippet / FastField call here that outputs a single email address. WARNING: populating this field will override the default recipient address, so test thoroughly!

fb_email_tpl_prefix

Prefix used by the chunks containing the HTML for the template rows. After this prefix follows an ID (i.e. fbEmailRow_28), connecting that chunk to the correct ContentBlocks field.

fb_hooks

A snippet name (or comma separated list of snippet names), containing the hook(s). These hooks are executed after the form is submitted, but before any emails are sent.

fb_prehooks

A snippet name (or comma separated list of snippet names), containing the hook(s). These hooks are executed before the form is initialised.

fb_redirect_dynamic

Place any element here that is able to decide where to redirect the user after form submission. If the result is empty, it falls back on the ID provided under general settings.

fb_store_data

Store data in a session before redirecting the user to a confirmation / thank you page, or to another form (as part of a multi-page form). Use FormItRetriever to access the data again.

fb_store_time

If 'store data' is switched on, this specifies the number of seconds to store the submitted form data. Defaults to five minutes.

Settings - Email

fb_activation_email

The content of the activation email. Make sure it contains the placeholder for the confirmation link!

fb_email_bcc

Optional.

fb_email_cc

Optional.

fb_email_from

Optional. Defaults to emailsender system setting.

fb_email_from_name

Optional. Defaults to site_name system setting.

fb_email_subject

fb_email_to

Submitted forms will be sent to this address. If you leave this field empty, no emails will be sent. This may be what you want when using a custom hook for processing the form.

Settings - General

fb_form_layout

DEPRECATED. This setting has moved to the CB field that loads the form.

fb_redirect_id

Enter the ID of the page, or drag the page from the menu tree to this input field.

fb_save_form

Save submitted data in the database. You can view this data under Top menu > Extras > FormIt.

fb_submit_button

Defaults to Send.

e_global

Background

background_availability

Where would you like to use this background?

Global - Backgrounds

global_background_img

DEPRECATED - DO NOT USE ANYMORE! Backgrounds in this grid still work, but use the new resource-based backgrounds instead to ensure proper functionality in the future.

e_information

e_info_action

e_info_creativework

About

author_id

Select the author of this article. He or she must be a MODX user. This value is inherited on child pages.

Comments

comments_toggle

Enable or disable comments. This value is inherited on child pages.

Participants

e_info_event

e_info_intangible

Address

address_country

address_house_number

address_locality

address_postal_code

address_region

address_street_name

Contact

contact_email

contact_mobile

contact_phone

Date

date_end

date_published

date_start

Rating

rating_value

How did the user value this product or service?

e_info_organization

Org. - Information

organization_industry

In what field is this organization active?

organization_name

organization_sector

What type of organization is this?

organization_size

How many employees does this organization have?

organization_url

Please fill in the complete URL (including http(s)://).

Org. - Presentation

organization_logo_img

If you can't supply an SVG, don't worry. You can upload an image here instead. The minimum width of their logo is 600px, but to keep your website pretty, aim for at least 900px.

organization_logo_svg

You'll likely get the best (sharpest) results when uploading an SVG. Try to keep the aspect ratio around 16:9 for best results.

e_info_person

Person - Information

person_birthdate

person_firstname

person_gender

person_lastname

person_url

Please fill in the complete URL (including http(s)://).

Person - Presentation

person_image

A headshot of this person.

person_image_loose

A headshot of the same person, but with a loose, personal twist to it. A big smile, or funny expression... This can be used in areas and situations where a little playfulness is allowed.

e_info_place

e_navigation

Navigation

auto_anchors

Give all headings on this page (H1-H6) an ID (if they don't have one already). This allows you (or the ToC menu) to link directly to that heading. This setting is inherited on child pages.

neighbors_visibility

Do you want to display a set of buttons below the content that link to the previous and next article? This setting is inherited on child pages.

pagination_scroll_top

This is enabled by default, to prevent ending up in empty space if the content of the next page is shorter. Disable this if you're using multiple paginated overviews on the same page.

toolbar_visibility

Do you want to display a toolbar on this page? The default toolbar contains breadcrumbs and search functionality. This setting is inherited on every child page.

e_overviews

Overview - Icon

overview_icon_font

Select an icon of the icon font that's being used in this project. Check the style guide for available classes, or use the autocomplete search as you type.

overview_icon_svg

This can be pretty much anything, but please make sure the SVG has a square aspect ratio.

overview_icon_svg_credit

Mention the designer of this icon here, so they are credited appropriately on the site. You need to do this if you're using icons published under a CC license, for example from Noun Project.

Overview - Image

overview_img_free

This image doesn't have a fixed aspect ratio or any minimum dimensions. Use it as you see fit. Cropping is optional. NB! Be aware that images will probably have different sizes in overviews!

overview_img_landscape

This is the default overview image, in a regular 4:3 aspect ratio.

overview_img_pano

This is an image with 21:9 aspect ratio, for use in headers or layout backgrounds.

overview_img_portrait

This is a standing image in 3:4 aspect ratio, best suited for floating left or right of content, or for display on mobile devices.

overview_img_square

This is an image in 1:1 aspect ratio, for use in cards, avatars or circular images.

overview_img_wide

This is an image with widescreen proportions, in 16:9 aspect ratio.

Overview - Settings

overview_img_priority

With this setting, you can indicate which image type you prefer if the system has a choice.

overview_subtitle

When filled in, this value will override the default subtitle (if subtitle is enabled in the Overview CB settings).

e_performance

Performance

critical_css_uri

AUTOGENERATED! This path is used when server pushing the critical CSS. By default a unique file is generated for each page, but templates can also share a single CSS file (see Configuration).

e_presentation

Slider - Settings

slider_behaviour

slider_inverted

slider_pagination

slider_transition

e_social

Social

social_facebook

Please fill in the complete URL (including http(s)://).

social_github

Only fill in the account name (the part after https://github.com/).

social_instagram

Only fill in the account name (the part after https://instagram.com/).

social_linkedin

Please fill in the complete URL (including http(s)://).

social_pinterest

Please fill in the complete URL (including http(s)://).

social_twitter

Only fill in the account name (the part after https://twitter.com/). This way, this setting can be used by other Twitter functionality throughout the site.

social_whatsapp

A mobile phone number connected to an active WhatsApp account. If entered, visitors can start a chat directly from the website. Needs to be formatted as number, without any leading zeros.

social_whatsapp_text

Predefined text for the message that the visitor can send. You can use placeholders here to include some information about the referring page.

social_youtube

Please fill in the complete URL (including http(s)://).

About Electrons

Electrons, according to Wikipedia, are generally thought to be elementary particles because they have no known components or substructure. They play an essential role in numerous physical phenomena, such as electricity. They also function as a bonding mechanism for atomic systems.

Translated to MODX: TVs, Configuration Settings, Context Settings and System Settings can be interpreted as electrons. These elements contain small bits of information that flow through the system (like electricity) to keep things in line with certain values. So in a way, they too bind things together.