EXT: WEC Site Config¶

What does it do?¶

The Site Config extension aims to simplify administrative tasks for new TYPO3 users by offering easier backend modules and laying the foundation for a simplified backend interface.

The first part of the Site Config extension is a backend module, located at Web->Site Config, that provides three submodules: Edit Site Constants, Select Site Template or Site Skin, and Manage Add-on Features. These modules allow you to set site-wide values such as name, email, and url; select either your site's TemplaVoila template or skins; and quickly install or uninstall extensions, also known as features. Each of these modules are described more fully in the Users Manual sections of this document.

In addition to the backend module, the Site Config extension also provides backend records for creating and editing features and enables TCA-based overrides for default backend behavior. These are described more fully in the Administration and Configuration sections of this document.

What is the Web-Empowered Church?¶

The Web-Empowered Church (WEC) is a ministry of Christian Technology Ministries International ( www.CTMIinc.org ). The mission of WEC is to innovatively apply WEB technology to EMPOWER the worldwide CHURCH for ministry.

WEC will help churches around the world expand evangelism, discipleship, and care through the innovative application of internet technology. WEC web-based tools and training will help make church ministries more efficient and effective, and will extend ministry impact to a world in need of Jesus (See :underline:`www.WebEmpoweredChurch.org/Jesus <http://www.webempoweredchurch.org/Jesus>`_ ). We want to fuel a worldwide movement using the internet to point the world to Jesus Christ, to grow disciples, and to care for those in need. Our desire is to use the web to empower the Church to become a truly 24 hours per day 7 days per week ministry that is not constrained by walls or distance or time.

If you would like to find out more about WEC or our tools, or support us in any way, please go to our website: :underline:`www.WebEmpoweredChurch.org. <http://www.webempoweredchurch.org/>`_

Installation¶

The Site Config extension can be installed through the Extension Manager in the same way as any other TYPO3 extension. Within the installation process, there are two settings that may be configured: Root Page ID and Enable TCA Additions.

mod.web_list.hideTables := addToList(tx_beacl_acl)

Edit Site Constants¶

The first option within the Site Config backend module is “Edit Site Constants”. This submodule relies on the WEC Constants extension; if it is not installed, “Edit Site Constants” will not be present in the menu.

Within this submodule, you can set site-wide values, such as Site Name, Site URL, and Admin Email. When changing the Site Name, you'll see the change reflected in both the frontend of your website through Typoscript templates and in the title of the root page on your site. When you change the WEC Constant for Site Name, the page title for this root page will be updated to match it.

Experienced TYPO3 users may notice that “Edit Site Constants” is very similar to the Constant Editor within Web->Template. “Edit Site Constants” is actually just a simplified version of the Constant Editor. Typoscript constants from the WEC Constants extension are the only values that can be set and changes are always on a site-wide basis, rather than per-page.

Select Site Template or Site Skin¶

The next option within the Site Config backend module is “Select Site Template” or “Select Site Skin” (depending on your templating system). This module is used with the TemplaVoila extension for templating; if TemplaVoila is not installed, then “Select Site Template” will not be a menu option. Within this submodule, you can view the current TemplaVoila template or skin and choose your site's preferred look based on the available records in the Storage folder.

When making template selections, you may notice that some are marked as “fully compatibly with current template” while others are not. This message means that the templates share a common data structure and switching templates will only cause changes in the look of your site, leaving content unchanged. If templates are not marked as being compatible, then some content on your website may not show up after changing templates. This content has not been lost, but it will need to be remapped to a current TemplaVoila content areas.

Manage Add-on Features¶

The final option with the the Site Config backend module is “Manage Add-on Feature.” Unlike the previous two submodules, “Manage Add-on Features” relies on no external extensions. Instead it looks for Feature backend records in the root of a website. If no Features are present in the TYPO3 install, the menu option is hidden.

If Features are available on a TYPO3 install, they'll be separated between those that are currently installed and those that are available to install. Clicking on the install button will enable a new features while uninstalling will remove a feature.

Information about creating new features is available in the Administration section.

Adding New Features¶

It is possible for an administrator to add new features to a site by adding Feature records to the root page of the TYPO3 install. Each feature has a title and description, which are displayed within the Site Config backend module. The “Disabled” field indicates whether the feature is currently installed or not.

The final field, “Records,” is where the actual parts of the feature are defined. These can be any TYPO3 backend record, such as pages, content elements, backend usergroups, etc. When a Feature is installed, these records will be made visible; when a Feature is uninstalled, they will be hidden.

The Configuration section below provides some tips on how to best use Features.

Hiding Site Config Menu Options¶

In some scenarios, you may want to use only a portion of the Site Config backend module. Through TSConfig, it is possible to disable individual menu options. The following Typoscript can be used in Page TSConfig to disable menu options for all users or in User TSConfig to limit it to a particular backend user or group.

mod.web_txwecconfig.menu.function {
 tx_wecconfig_constants = 0
 tx_wecconfig_features = 0
 tx_wecconfig_templates = 0
}

Modifying the Site Constants Editor via User TSConfig¶

The Site Constants submodule has two possibilities for configuration through TSConfig. Like the previous section, these options can be used in Page TSConfig to change options for all users or in User TSConfig to limit it to a particular backend user or group.

mod.web_txwecconfig.tx_wecconfig_constants {
  # This option is on by default and shows both the constant label (Site Name)
  # and the constant name (siteName).  Turning it off shows the label only.
  showConstantName = 0

  # This option is off by default. Turning it on makes the Site Constants Editor
  # behave like the normal TYPO3 Constants Editor with an edit icon and a revert to default icon.
  enableRevertToDefault = 1
}

Modifying the Site Constants Editor via Hooks¶

Two hooks are provided to allow further enhancement of the Site Constants Editor.

The first hook, “afterInitializeTSParserAndTSConfig”, is called immediately after the TypoScript parser is initialized and TSconfig is parsed. This allows a developer to modify TSConfig values on the fly or add his own version of t3lib_tsparser_ext that styles the editing form differently.

The second hook, “postProcessConstantsContent”, is called after the Site Constants Editor is done generating its HTML. This output can be post-processed to add things like additional help text below the editing form.

Best Practices for Features¶

The Features functionality within Site Config is essentially a mass hide/show of backend records. When a feature is disabled, its records are marked as hidden so that they are not shown on the frontend of the website. This does nothing for backend visibility, however, as hidden pages and content elements will still be shown for the backend user.

Within the WEC Starter Package, we work around this limitation by creating a unique backend usergroup for every Feature and assigning it as a record within that Feature. When a Feature is installed, the backend usergroup is enabled. When a Feature is uninstalled, the backend usergroup is disabled.

With this structure, we can embed any backend behavior for that Feature into its own backend group. For example, the ability to create news articles and view the News page in the backend is tied to to the News backend group. When the News feature is installed, the News backend group becomes active, allowing a backend user to view the News page and create news articles. When the News feature is uninstalled, these privileges are removed.

3.3.0¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

3.2.0¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

3.1.1¶

3.1.0¶

((Unknown Property))¶

3.0.0¶

((Unknown Property))¶

((Unknown Property))¶

2.2.0¶

((Unknown Property))¶

2.1.0¶

2.0.2¶

2.0.1¶

2.0.0¶

((Unknown Property))¶

((Unknown Property))¶

1.4.0¶

((Unknown Property))¶

1.3.1¶

1.3.0¶

1.2.2¶

1.2.1¶

((Unknown Property))¶

1.2.0¶

((Unknown Property))¶

1.1.0¶

1.0.0¶

((Unknown Property))¶

0.9.2¶

0.9.1¶

0.9.0¶

EXT: WEC Site Config - 7