Field Trek Documentation
- Requirements
- Installation
- Cloning a field group
- Exporting a field group
- Importing a field group
- Some notes on FieldFrame support
- Some notes on Gypsy support
Requirements
- This module will not work on ExpressionEngine versions prior to 1.6.8.
- To import / export field groups a folder named field_trek is created below your themes directory. This folder must be read-/writeable by EE. In case the module fails to create the folder appropriately on its own it will ask you to grant permissions manually.
Installation
- Unzip the file.
- Upload the folder field_trek and the contained files to the modules-folder inside your EE system directory.
- In your Control Panel navigate to CP Home › Modules, find the Field Trek module and click Install.
- Now you can click on Field Trek in the modules list to access its Control Panel.
Cloning a field group
Step 1:
In the Field Trek Control Panel choose Clone a field-group in this installation.
Step 2:
To the left you are presented with a list of all currently existing field groups (from all sites if you have MSM installed). Select the field group you wish to clone.
To the right you have to choose the target site (if more than one) and a new name for the cloned field group.
Click the “Continue”-button.
Step 3:
In Step 3 you may optionally remove and / or add prefixes to your fields. As field names must be unique within a site you need prefixes if you clone a group to the same site.
If your source field names already contain a prefix specify it to the left if you want it removed prior to cloning. You can specify a prefix for the target field names on the right hand side.
Whatever you do, the module will ensure that your action will neither result in any duplicate field names within a site nor in field names that are reserved words.
If you want to exclude some fields from cloning you can do this by ticking the corresponding checkboxes in the field list to the left.
Click the “Continue”-button.
That’s it. Your field group has been cloned.
Exporting a field group
Step 1:
In the Field Trek Control Panel choose Export a field group to a file.
Step 2:
You are presented with a list of all currently existing field groups (from all sites if you have MSM installed). Select the field group you wish to export.
Click the “Continue”-button.
Step 3:
Your field group will be exported to a file and saved into the /themes/field_trek-folder. You may download it right away using the link provided.
Importing a field group
Importing a field group is almost identical to clonig a field group.
Step 1:
In the Field Trek Control Panel choose Import a field group from a file.
Step 2:
To the left you can select a file to import from those currently present in your field_trek-folder. You can also dircetly upload files using the file-field below. Select the field group file you wish to import.
To the right you have to choose the target site (if more than one) and a new name for the imported field group.
Click the “Continue”-button to proceed.
Step 3:
In Step 3 you may optionally remove and / or add prefixes to your fields.
If your source field names already contain a prefix specify it to the left if you want it removed prior to cloning. You can specify a prefix for the target field names on the right hand side.
Whatever you do, the module will ensure that your action will neither result in any duplicate field names within a site nor in field names that are reserved words.
If you want to exclude some fields from importing you can do this by ticking the corresponding checkboxes in the field list to the left.
Click the “Continue”-button.
That’s it. Your field group has been imported.
Some notes on FieldFrame support
Field Trek supports Brandon Kelly’s FieldFrame extension, meaning that all fieldtype-settings will be duplicated as well. There are however some things you need to be aware of:
- If you try to import a field group from an installation that has FieldFrame to an installation without FieldFrame a warning will be issued. You can then either install FieldFrame on the target site prior to importing or you proceed without doing so. In the latter case any fieldtype settings will be ignored.
- If your fieldtype settings contain site- or installation-specific data (e.g.path or URL information) you need to manually adjust that in your new field group.
- When exporting/importing between different ExpressionEngine installations it is of course beneficial if you have the same fieldtypes installed in both of them.
Some notes on Gypsy support
Field Trek supports Brandon Kelly’s Gypsy extension, meaning that fields marked as gypsy-fields will be marked as gypsy-fields after import as well. Gypsy’s weblog assignment setting will be resetted on the imported site though because it’s unlikely that the weblog IDs match on both sites.
- If you try to import a field group from an installation that uses Gypsy to an installation without Gypsy a warning will be issued. You can then either install Gypsy on the target site prior to importing or you proceed without doing so. In the latter case any Gypsy settings will be ignored.
