diff --git a/docs/_images/utilities-cache.png b/docs/_images/utilities-cache.png new file mode 100644 index 000000000..a0664baa5 Binary files /dev/null and b/docs/_images/utilities-cache.png differ diff --git a/docs/_images/utilities-communicate.png b/docs/_images/utilities-communicate.png new file mode 100644 index 000000000..da4c61cd4 Binary files /dev/null and b/docs/_images/utilities-communicate.png differ diff --git a/docs/_images/utilities-debug-fieldtypes.png b/docs/_images/utilities-debug-fieldtypes.png new file mode 100644 index 000000000..cb4574e40 Binary files /dev/null and b/docs/_images/utilities-debug-fieldtypes.png differ diff --git a/docs/_images/utilities-debug-tags.png b/docs/_images/utilities-debug-tags.png new file mode 100644 index 000000000..f71d0e7c9 Binary files /dev/null and b/docs/_images/utilities-debug-tags.png differ diff --git a/docs/_images/utilities-extensions.png b/docs/_images/utilities-extensions.png new file mode 100644 index 000000000..55a8d0527 Binary files /dev/null and b/docs/_images/utilities-extensions.png differ diff --git a/docs/_images/utilities-query.png b/docs/_images/utilities-query.png new file mode 100644 index 000000000..9bee8f486 Binary files /dev/null and b/docs/_images/utilities-query.png differ diff --git a/docs/_images/utilities-sandr.png b/docs/_images/utilities-sandr.png new file mode 100644 index 000000000..cac97fae2 Binary files /dev/null and b/docs/_images/utilities-sandr.png differ diff --git a/docs/_images/utilities-sent.png b/docs/_images/utilities-sent.png new file mode 100644 index 000000000..096ccd2d9 Binary files /dev/null and b/docs/_images/utilities-sent.png differ diff --git a/docs/_images/utilities-stats.png b/docs/_images/utilities-stats.png new file mode 100644 index 000000000..de8079a18 Binary files /dev/null and b/docs/_images/utilities-stats.png differ diff --git a/docs/_images/utilities-sync-conditional-fields.png b/docs/_images/utilities-sync-conditional-fields.png new file mode 100644 index 000000000..a5cbb5a7b Binary files /dev/null and b/docs/_images/utilities-sync-conditional-fields.png differ diff --git a/docs/_images/utilities-translation-edit.png b/docs/_images/utilities-translation-edit.png new file mode 100644 index 000000000..8346c5558 Binary files /dev/null and b/docs/_images/utilities-translation-edit.png differ diff --git a/docs/_images/utilities-translation-list.png b/docs/_images/utilities-translation-list.png new file mode 100644 index 000000000..823e31267 Binary files /dev/null and b/docs/_images/utilities-translation-list.png differ diff --git a/docs/control-panel/utilities.md b/docs/control-panel/utilities.md index 4ac1368e4..70a91fc9c 100755 --- a/docs/control-panel/utilities.md +++ b/docs/control-panel/utilities.md @@ -11,153 +11,35 @@ **Control Panel Location: `Tools > Utilities`** -[TOC] - -## Communicate - -**Control Panel Location: `Tools > Utilities > Communicate`** - -The Communicate tab in the Control Panel provides access to the email sending part of the system. Email can be sent in plain text or HTML format, and supported email sending protocols are [SMTP](https://www.webopedia.com/TERM/S/SMTP.html), [Sendmail](https://www.sendmail.org/), and PHP [mail](https://us2.php.net/manual/en/function.mail.php). - -NOTE: **Note:** In the Settings area of the Control Panel you'll find the [Outgoing Email](control-panel/settings/email.md) page. - -### Sent Emails - -**Control Panel Location: `Tools > Utilities > Sent`** - -This section of the Control Panel shows a table of all the previously sent emails. It lists the email title (subject), when it was sent, number of recipients, a re-send link, and a delete checkbox. - -## Language Files - -**Control Panel Location: `Tools > Utilities > CP Translate`** - -This Translation Utility page of the Control Panel allows you to translate the core language files into other languages. - -When you use this utility it will create a copy of any file you have translated and put it into the following folder: `system/user/language` - -In order to be able to create translation files, the `system/user/language` folder must be writable. See [File Permissions](troubleshooting/general.md#file-permissions) for details. - -The main Translation Utility screen shows a list of all the language files currently installed. - -### Translation - -**Control Panel Location: `Tools > Utilities > CP Translate > Edit`** - -Once you have translated all the text for a particular file you will click the Save Changes button and ExpressionEngine will create the new translated file inside the translations folder. - -You can also Save Changes at any point you like; you don't have to complete the translation before saving. - -## PHP Info - -**Control Panel Location: `Tools > Utilities > PHP Info`** - -The PHP Info page of the Control Panel allows you to see the configuration details of your PHP installation, via the standard [phpinfo()](https://www.php.net/phpinfo) command. - -The page will show a great deal of information about your server, server configuration, PHP installation, etc., which can be very useful if you are trying to troubleshoot a problem or determine whether your server supports a certain feature. - -## Manage Add-on Extensions - -**Control Panel Location: `Tools > Utilities > Manage Extensions`** - -Since Extensions are calling code within the ExpressionEngine code there is a chance that an extension will interfere with how your site is working. If you are unsure of which extension might be causing a problem you can either turn them off one by one until the problem disappears. - -## Member Import File Converter - -**Control Panel Location: `Tools > Utilities > File Converter`** - -The Convert Delimited Data to XML utility enables you to take member information from a third party application that exports a delimited data file and create an XML file in ExpressionEngine’s Member XML Format. Nearly all delimited formats are accepted, such as the common tab-delimited, comma-delimited, and quote-enclosed formats. - -The utility itself contains the instructions needed to assist you with the XML creation, and you should read each area carefully as you proceed. Username, Screen Name, and Email are required, and all standard member database fields are available to you. It is recommended that you do not use member_id, so ExpressionEngine can automatically generate unique Member IDs when the members are later imported from the XML file. - -NOTE: **Note:** Many applications export field headings as the first line of a delimited data file. You must delete this row, or it will be included as a member element. Field assignment takes place during the conversion process, so those field headings will not be necessary to define your file’s structure. - -## Mass Notification Export - -**Control Panel Location: `Tools > Utilities > Mass Notification Export`** - -The Mass Notification Export utility enables you to export a CSV file of the ID, screen name, username, and email address for all your Members. This action will be logged to the `/cp/logs/cp`. - -This can be used to notify users in the unfortunate event of a data breach, such as is required by the . We recommend to validating the email addresses before sending any mass notification emails, otherwise your server could end up blocked. Any of the following services will validate email addresses: - -- [Email Verifier App](https://www.emailverifierapp.com) -- [VerifyEmailAddress.org](https://www.verifyemailaddress.org) -- [Hunter](https://hunter.io/email-verifier) - -Options: - -- **Validate email addresses?** -- When enabled each email address will be checked to ensure it matches the syntax specified in [RFC 822](https://tools.ietf.org/html/rfc822). Additionally the domain will be checked to ensure it exists. This will produce two CSV files, one for all the valid addresses, and another for the invalid addresses. - -## Database Backup Utility - -**Control Panel Location: `Tools > Utilities > Backup Utility`** - -This utility allows you to make simple SQL dump backups of your ExpressionEngine database. For file backups, or more robust and automated database backup options, please refer to [Back-up your ExpressionEngine database and files](general/database-backup.md). - -When you click "Backup Database", a SQL dump will be created and stored in your `system/user/cache/` folder, named based on the date and time of the backup, e.g.: `my_database_2017-10-20_09h20mPDT.sql` - -## SQL Manager - -**Control Panel Location: `Tools > Utilities > SQL Manager`** - -This section of the Control Panel allows you to manage your database. You can view information about the database, run queries, optimize your tables, and more. - -The main SQL Manager screen shows a table of your basic database information. - -## SQL Query Form - -**Control Panel Location: `Tools > Utilities > Query Form`** - -This section presents a form that you can use to submit any standard database query. This feature is intended for **advanced** users since any changes you may make with a query are permanent. - -Buttons at the bottom of the form can be used to provide you with a base query for many commonly used queries. - -By default MySQL query errors are displayed. - -## Cache Manager - -**Control Panel Location: `Tools > Utilities > Cache Manager`** - -This section of the Control Panel allows you clear the cached data for the different types of [caching](optimization/caching.md) that are available. - -## Manage Statistics - -**Control Panel Location: `Tools > Utilities > Statistics`** - -This section of the Control Panel allows you to force the system to recount different types of statistics. This section is rarely necessary, but every once in a while a statistic can become out of sync or otherwise not reflect the correct data. This section will allow you to make the system update the information. - -## Data Search and Replace - -**Control Panel Location: `Tools > Utilities > Search and Replace`** - -This section of the Control Panel allows you to search for text within your site and replace it with another piece of text. This search and replace operation can be performed on your entry titles, within any of the entry fields, or within your Templates. - -- **Search for this text** -- Here you can input the text for which you would like to search. You must be very careful about what text you search for. If you input "car", then words such as "carnivore" and "cartoon" will also be matched. If you want to make sure you match only the word "car" then you must place spaces on each side of the term, like " car ". In those cases you need to make sure that your replacement term also contains the spaces in a similar fashion or else you won't get the results you expect. -- **Replace with this text** -- Here you specify what text you would like to replace the text for which you are searching. Be sure that the syntax you uses matches the "search" text. For instance, if your search text is for a specific word or phrase and uses spaces on either side of the search term, then your replacement text also needs to include those spaces on either side so that the resulting text has the correct format. -- **Search and replace in** -- This setting consists of a drop-down list of the possible database areas for which you can perform the search and replace. The list includes: - - **Site Preferences**: Select a site to search and replace text within the site's preferences (including such prefs as those for Channels and Upload Directories). - - **Channel Entry Titles**: Select this to search and replace text within the entry titles. - - **Channel Fields**: Under this heading, each of the available [Fields](control-panel/field-manager/field-manager-settings.md) is listed. - - **Templates**: Select this to search and replace text within all of your Templates. - -## Member Import - -**Control Panel Location:** `Tools > Utilities > Member Import` - -The Member Import Utility enables you to import members from other systems utilizing ExpressionEngine's [special Member Import XML format](general/member-import-xml-format.md). - -## Search Reindex - -**Control Panel Location:** `Tools > Utilities > Search Reindex` - -Search reindexing refreshes the searchable words stored by Grid and Fluid fields that are used by the search module when performing a search. Reindexing is needed when: - -- a Grid field's search setting changes -- the search settings for columns in a Grid field change -- fields are removed from a Fluid field -- the Search and Replace tool acted on a Grid or Fluid field - -This tool will cycle through all Channel Entries that have a Grid or Fluid field assigned to them and re-index the entry data in those fields. - -### Permission Restrictions - -- Access Tools sections: Utilities +ExpressionEngine provides a number of useful tools and utilities to make managing your website easier. + +**[Communicate Tool](control-panel/utilities/communicate.md)** +- [Sent Emails](control-panel/utilities/communicate.md#sent-emails) + +**[Translation Tool](control-panel/utilities/translation.md)** + +**[General Utilities](control-panel/utilities/general.md)** + - [PHP Info](control-panel/utilities/general.md#php-info) + - [Manage Extensions](control-panel/utilities/general.md#manage-add-on-extensions) + +**[Debug Tools](control-panel/utilities/debug.md)** + - [Debug Template Tags](control-panel/utilities/debug.md#debug-template-tags) + - [Debug Fieldtypes](control-panel/utilities/debug.md#debug-fieldtypes) + +**[Member Tools](control-panel/utilities/member-tools.md)** + - [File Converter](control-panel/utilities/member-tools.md#member-import-file-converter) + - [Member Import](control-panel/utilities/member-tools.md#member-import) + - [Mass Notification Export](control-panel/utilities/member-tools.md#mass-notification-export) + +**[Database Tools](control-panel/utilities/database.md)** + - [Database Backup Utility](control-panel/utilities/database.md#database-backup-utility) + - [SQL Manager](control-panel/utilities/database.md#sql-manager) + - [SQL Query Form](control-panel/utilities/database.md#sql-query-form) + +**[Data Operation Tools](control-panel/utilities/data-operations.md)** + - [Cache Manager](control-panel/utilities/data-operations.md#cache-manager) + - [Search Reindex](control-panel/utilities/data-operations.md#search-reindex) + - [Sync Conditional Logic](control-panel/utilities/data-operations.md#sync-conditional-fields) + - [Update File Usage Information](control-panel/utilities/data-operations.md#update-file-usage-information) + - [Manage Statistics](control-panel/utilities/data-operations.md#manage-statistics) + - [Data Search and Replace](control-panel/utilities/data-operations.md#data-search-and-replace) \ No newline at end of file diff --git a/docs/control-panel/utilities/communicate.md b/docs/control-panel/utilities/communicate.md new file mode 100644 index 000000000..25a297e80 --- /dev/null +++ b/docs/control-panel/utilities/communicate.md @@ -0,0 +1,31 @@ + + +# Communicate Tools + +**Control Panel Location: `Tools > Utilities > Communicate`** + +The Communicate tab in the Control Panel provides access to the email sending part of the system. + +Here you can compose email message that will be sent to email addresses entered, or to all members in the roles that you select. + +Email can be sent in plain text or HTML format, and supported email sending protocols are [SMTP](https://www.webopedia.com/TERM/S/SMTP.html), [Sendmail](https://www.sendmail.org/), and PHP [mail](https://us2.php.net/manual/en/function.mail.php) (as defined in [Outgoing Email](control-panel/settings/email.md) preferences). + +![Communicate](_images/utilities-communicate.png) + + +## Sent Emails + +**Control Panel Location: `Tools > Utilities > Sent`** + +This section of the Control Panel shows a table of all the previously sent emails. It lists the email title (subject), when it was sent, number of recipients, a re-send link, and a delete checkbox. + +You can view the text of email previously sent by clicking on the "view" icon, or you can use it as a template for a new message by clicking the "resend" icon. + +![Communicate](_images/utilities-sent.png) \ No newline at end of file diff --git a/docs/control-panel/utilities/data-operations.md b/docs/control-panel/utilities/data-operations.md new file mode 100644 index 000000000..16428d4e4 --- /dev/null +++ b/docs/control-panel/utilities/data-operations.md @@ -0,0 +1,89 @@ + + +# Data Operation Tools + +[TOC] + +## Cache Manager + +**Control Panel Location: `Tools > Utilities > Cache Manager`** + +This section of the Control Panel allows you clear the cached data for the different types of [caching](optimization/caching.md) that are available. + +![Manage Add-on Extensions](_images/utilities-cache.png) + +TIP: **Tip:** To quickly access this section, press `Ctrl / cmd` + `J` to invoke the Jump Menu and pick "Cache Manager" + +## Search Reindex + +**Control Panel Location:** `Tools > Utilities > Search Reindex` + +Search reindexing refreshes the searchable words stored by Grid and Fluid fields that are used by the search module when performing a search. Reindexing is needed when: + +- a Grid field's search setting changes +- the search settings for columns in a Grid field change +- fields are removed from a Fluid field +- the Search and Replace tool acted on a Grid or Fluid field +- a new Toggle field was added + +This tool will cycle through all Channel Entries that have a Grid or Fluid field assigned to them and re-index the entry data in those fields. + +ExpressionEngine is capable of determining whether updating search indexes is needed in most cases. + +## Sync Conditional Fields + +**Control Panel Location: `Tools > Utilities > Sync Conditional Fields`** + +When a [condition](/control-panel/field-manager/conditional-fields.md) is added or updated for field, the entries that are using that field need to be synchronized for field to behave properly. + +This utility syncs the conditional logic for each of the channels. You will be redirected to this page automatically after a change in field conditions sets is made, but you can choose to do this only once after making all the updates to the fields, should you need multiple of those. + +![Sync Conditional Logic](_images/utilities-sync-conditional-fields.png) + +NOTE: **Note:** You can also use `php eecli.php sync:conditional-fields` [CLI command](cli/built-in-commands/sync-conditional-fields.md) + +## Update File Usage Information + +**Control Panel Location: `Tools > Utilities > Update File Usage`** + +NOTE: **Note:** This utility is only needed for sites that have been upgraded from ExpressionEngine versions below 7 and generally only needs to be run once, though re-running the update is not problematic. + +Run this utility to convert all files stored in the database from sites previous to ExpressionEngine 7 to the new ExpressionEngine 7 file format. This must be completed before newer File Manager features may be used. + +It is recommended that you make sure all installed add-ons are compatible with ExpressionEngine 7 and newer, and that you have made a backup of your database before running the utility. + +After the update operation is completed, visit `Content & Design Settings` to disable [Compatibility Mode](control-panel/file-manager/file-manager.html#compatibility-mode) for File Manager. + +## Manage Statistics + +**Control Panel Location: `Tools > Utilities > Statistics`** + +This section of the Control Panel allows you to recount different types of statistics. This section is rarely necessary, but every once in a while a statistic can become out of sync or otherwise not reflect the correct data. This section will allow you to make the system update the information. + +![Manage Statistics](_images/utilities-stats.png) + +## Data Search and Replace + +**Control Panel Location: `Tools > Utilities > Search and Replace`** + +This section of the Control Panel allows you to search for text within your site and replace it with another piece of text. This search and replace operation can be performed on your entry titles, within any of the entry fields, or within your Templates. + +- **Search for this text** -- Here you can input the text for which you would like to search. You must be very careful about what text you search for. If you input "car", then words such as "carnivore" and "cartoon" will also be matched. If you want to make sure you match only the word "car" then you must place spaces on each side of the term, like " car ". In those cases you need to make sure that your replacement term also contains the spaces in a similar fashion or else you won't get the results you expect. +- **Replace with this text** -- Here you specify what text you would like to replace the text for which you are searching. Be sure that the syntax you uses matches the "search" text. For instance, if your search text is for a specific word or phrase and uses spaces on either side of the search term, then your replacement text also needs to include those spaces on either side so that the resulting text has the correct format. +- **Search and replace in** -- This setting consists of a drop-down list of the possible database areas for which you can perform the search and replace. The list includes: + - **Site Preferences**: Select a site to search and replace text within the site's preferences (including such prefs as those for Channels and Upload Directories). + - **Channel Entry Titles**: Select this to search and replace text within the entry titles. + - **Channel Fields**: Under this heading, each of the available [Fields](control-panel/field-manager/field-manager-settings.md) is listed. + - **Templates**: Select this to search and replace text within all of your Templates, or in certain template groups. + - **Template Partials**: Select this to search and replace text within reusable dynamic Template Partials. + - **Template Variables**: Select this to search and replace text within static Template Variables. + - **System Templates**: Select this to search and replace text within System Templates. + +![Search and Replace Utility](_images/utilities-sandr.png) diff --git a/docs/control-panel/utilities/database.md b/docs/control-panel/utilities/database.md new file mode 100644 index 000000000..05bb9d42f --- /dev/null +++ b/docs/control-panel/utilities/database.md @@ -0,0 +1,42 @@ + + +# Database Tools + +[TOC] + +## Database Backup Utility + +**Control Panel Location: `Tools > Utilities > Back Up Database`** + +This utility allows you to make simple SQL dump backups of your ExpressionEngine database. For file backups, or more robust and automated database backup options, please refer to [Back-up your ExpressionEngine database and files](general/database-backup.md). + +When you click "Back Up Database", a SQL dump will be created and stored in your `system/user/cache/` folder, named based on the date and time of the backup, e.g.: `my_database_2017-10-20_09h20mPDT.sql` + +## SQL Manager + +**Control Panel Location: `Tools > Utilities > SQL Manager`** + +This section of the Control Panel allows you to manage your database. The main SQL Manager screen shows a table of your basic database information and a list of tables. + +By selecting the checkbox next to a table and picking an option from the dropdown at the bottom a table can be optimized or repaired, if necessary. + +Click the "eye" icon to browse the table. From there, you can search the table for the content you are interested in viewing. + +## SQL Query Form + +**Control Panel Location: `Tools > Utilities > Query Form`** + +This section presents a form that you can use to submit any standard database query. This feature is intended for **advanced** users since any changes you may make with a query are permanent. + +Buttons at the bottom of the form can be used to provide you with a base query for many commonly used queries. + +By default MySQL query errors are displayed. + +![SQL Query Form](_images/utilities-query.png) diff --git a/docs/control-panel/utilities/debug.md b/docs/control-panel/utilities/debug.md new file mode 100644 index 000000000..3866a5fea --- /dev/null +++ b/docs/control-panel/utilities/debug.md @@ -0,0 +1,38 @@ + + +# Debug Tools + +This section presents set of useful utilities designed to diagnose potential issues with your site. + +The check are being run automatically when you visit the utility pages and also they are executed in the background when ExpressionEngine is being updated. + +[TOC] + +## Debug Template Tags + +**Control Panel Location: `Tools > Utilities > Debug Template Tags`** + +![Debug Template Tags](_images/utilities-debug-tags.png) + +This tool scans the site templates and then lists the add-on [template tags](templates/language.md) used. + +If it finds a tag that corresponds to the add-on that is missing or not installed, it indicates that. + +Clicking on the tag name shows the list of templates where it is found. + +### Debug Fieldtypes + +**Control Panel Location: `Tools > Utilities > Debug Fieldtypes`** + +![Debug Fieldtypes](_images/utilities-debug-fieldtypes.png) + +This page shows the fieldtypes that are being used as custom fields, that have their corresponding add-on missing or not installed. + +It also lists all the fieldtypes installed, indicating what is currently in use and what is not in use. diff --git a/docs/control-panel/utilities/general.md b/docs/control-panel/utilities/general.md new file mode 100644 index 000000000..d15ddf5e4 --- /dev/null +++ b/docs/control-panel/utilities/general.md @@ -0,0 +1,30 @@ + + +# General Utilities + +[TOC] + +## PHP Info + +**Control Panel Location: `Tools > Utilities > PHP Info`** + +The PHP Info page of the Control Panel allows you to see the configuration details of your PHP installation, via the standard [phpinfo()](https://www.php.net/phpinfo) command. + +The page will show a great deal of information about your server, server configuration, PHP installation, etc., which can be very useful if you are trying to troubleshoot a problem or determine whether your server supports a certain feature. + +## Manage Add-on Extensions + +**Control Panel Location: `Tools > Utilities > Manage Extensions`** + +Since Extensions are calling code within the ExpressionEngine code there is a chance that an extension will interfere with how your site is working. If you are unsure of which extension might be causing a problem you can either turn them off one by one until the problem disappears. + +![Manage Add-on Extensions](_images/utilities-extensions.png) + +TIP: **Tip:** If you want to temporary disable _all_ extensions, you can set `$config['allow_extensions'] = 'n';` [configuration override](general/system-configuration-overrides.md#allow_extensions) in `config.php` file. diff --git a/docs/control-panel/utilities/member-tools.md b/docs/control-panel/utilities/member-tools.md new file mode 100644 index 000000000..341f663e2 --- /dev/null +++ b/docs/control-panel/utilities/member-tools.md @@ -0,0 +1,44 @@ + + +# Member Tools + +[TOC] + +## Member Import File Converter + +**Control Panel Location: `Tools > Utilities > File Converter`** + +The Convert Delimited Data to XML utility enables you to take member information from a third party application that exports a delimited data file and create an XML file in ExpressionEngine’s Member XML Format. Nearly all delimited formats are accepted, such as the common tab-delimited, comma-delimited, and quote-enclosed formats. + +The utility itself contains the instructions needed to assist you with the XML creation, and you should read each area carefully as you proceed. Username, Screen Name, and Email are required, and all standard member database fields are available to you. It is recommended that you do not use member_id, so ExpressionEngine can automatically generate unique Member IDs when the members are later imported from the XML file. + +NOTE: **Note:** Many applications export field headings as the first line of a delimited data file. You must delete this row, or it will be included as a member element. Field assignment takes place during the conversion process, so those field headings will not be necessary to define your file’s structure. + +## Mass Notification Export + +**Control Panel Location: `Tools > Utilities > Mass Notification Export`** + +The Mass Notification Export utility enables you to export a CSV file of the ID, screen name, username, and email address for all your Members. This action will be logged to the `/cp/logs/cp`. + +This can be used to notify users in the unfortunate event of a data breach. We recommend validating the email addresses before sending any mass notification emails, otherwise your server could end up blocked. Any of the following services will validate email addresses: + +- [Email Verifier App](https://www.emailverifierapp.com) +- [VerifyEmailAddress.org](https://www.verifyemailaddress.org) +- [Hunter](https://hunter.io/email-verifier) + +Options: + +- **Validate email addresses?** -- When enabled each email address will be checked to ensure it matches the syntax specified in [RFC 822](https://tools.ietf.org/html/rfc822). Additionally the domain will be checked to ensure it exists. This will produce two CSV files, one for all the valid addresses, and another for the invalid addresses. + +## Member Import + +**Control Panel Location:** `Tools > Utilities > Member Import` + +The Member Import Utility enables you to import members from other systems utilizing ExpressionEngine's [special Member Import XML format](general/member-import-xml-format.md). diff --git a/docs/control-panel/utilities/translation.md b/docs/control-panel/utilities/translation.md new file mode 100644 index 000000000..1cd7a0457 --- /dev/null +++ b/docs/control-panel/utilities/translation.md @@ -0,0 +1,34 @@ + + +# Translation Tool + +## Language Files + +**Control Panel Location: `Tools > Utilities > CP Translations`** + +This Translation Utility page of the Control Panel allows you to translate the core language files into other languages. + +![Translation Tool Files List](_images/utilities-translation-list.png) + +When you use this utility it will create a copy of any file you have translated and put it into the following folder: `system/user/language/` + +In order to be able to create translation files, the `system/user/language` folder must be writable. See [File Permissions](troubleshooting/general.md#file-permissions) for details. + +The main Translation Utility screen shows a list of all the language files currently installed. + +### Translation + +**Control Panel Location: `Tools > Utilities > CP Translations > Edit`** + +![Translation Tool Editing](_images/utilities-translation-edit.png) + +Once you have translated all the text for a particular file you will click the Save Changes button and ExpressionEngine will create the new translated file inside the translations folder. + +You can also Save Changes at any point you like; you don't have to complete the translation before saving. diff --git a/docs/general/database-backup.md b/docs/general/database-backup.md index db250325e..fffcdd20b 100755 --- a/docs/general/database-backup.md +++ b/docs/general/database-backup.md @@ -143,7 +143,7 @@ With AutoMySQLBackup, you just take a few minutes to set it up, and then simply ### ExpressionEngine SQL Manager Backups -ExpressionEngine also comes with a [simple database backup utility](control-panel/utilities.md#database-backup-utility) that can be used if you don't have access to create your own backups from your web host. +ExpressionEngine also comes with a [simple database backup utility](control-panel/utilities/database.md#database-backup-utility) that can be used if you don't have access to create your own backups from your web host. ## Third-Party Add-Ons diff --git a/docs/general/system-configuration-overrides.md b/docs/general/system-configuration-overrides.md index 414d05a2b..23fe13c65 100755 --- a/docs/general/system-configuration-overrides.md +++ b/docs/general/system-configuration-overrides.md @@ -76,8 +76,6 @@ Example Usage: $config['allow_extensions'] = 'y'; -**Also found in CP:** `Utilities --> Debug Extensions`: [Disable Extensions? ](control-panel/utilities.md#manage-add-on-extensions) - ### `allow_member_localization` Set whether dates and times are localized to each members' own localization preferences. @@ -906,7 +904,7 @@ Example Usage: ### `db_backup_row_limit` -When using the [Database Backup Utility](control-panel/utilities.md#database-backup-utility), some databases and PHP configurations may cause the backup utility to run out of memory while creating the backup. This config sets the maximum number of rows that will be queried and written to the backup file at a time. If you run into an out-of-memory error, try setting this to a lower number than the default to have the utility work in smaller batches. +When using the [Database Backup Utility](control-panel/utilities/database.md#database-backup-utility), some databases and PHP configurations may cause the backup utility to run out of memory while creating the backup. This config sets the maximum number of rows that will be queried and written to the backup file at a time. If you run into an out-of-memory error, try setting this to a lower number than the default to have the utility work in smaller batches. | Value | Description | | -------- | ------------------------------- | diff --git a/docs/localization/languages.md b/docs/localization/languages.md index 735875f4c..c465a823e 100644 --- a/docs/localization/languages.md +++ b/docs/localization/languages.md @@ -43,6 +43,6 @@ All of our language packs are hosted as repositories on [GitHub](https://github. If you want to contribute to a language pack, find the language pack you want to modify, [fork the repository](https://help.github.com/articles/fork-a-repo), make sure you're working from the correct branch, work on your changes [inside of a feature branch](https://help.github.com/articles/fork-a-repo), push your changes to your fork of the repository, and [send us a pull request](https://help.github.com/articles/using-pull-requests). Then, we'll take a look at your pull request, make sure everything looks alright, and merge it in. -(The [Language Files](control-panel/utilities.md#language-files) can help create new a language pack or update an existing one.) +(The [Language Files](control-panel/utilities/translation.md#language-files) can help create new a language pack or update an existing one.) If you want to provide us with a translation we don't already have, the best way is to [email](mailto:team@ellislab.com) us a zip file containing the language pack so we can make sure it fits in with the rest. After that, any time you want to make adjustments you can just follow the steps above to send us a pull request. diff --git a/docs/optimization/caching.md b/docs/optimization/caching.md index 750453510..8e0f27d91 100755 --- a/docs/optimization/caching.md +++ b/docs/optimization/caching.md @@ -141,4 +141,4 @@ Caches are cleared automatically when certain actions occur: - Opening or closing a Wiki Revision (clears db cache) - Deleting a Category Group (clears all caches) -You may also [manually clear caches](control-panel/utilities.md#cache-manager) through the control panel. +You may also [manually clear caches](control-panel/utilities/data-operations.md#cache-manager) through the control panel. diff --git a/docs/toc_sections/_the_fundamentals_toc.yml b/docs/toc_sections/_the_fundamentals_toc.yml index 0fde0c06e..df9528b0c 100644 --- a/docs/toc_sections/_the_fundamentals_toc.yml +++ b/docs/toc_sections/_the_fundamentals_toc.yml @@ -34,7 +34,7 @@ - name: File Editing href: control-panel/file-manager/file-edit.md - name: Watermarks - href: control-panel/file-manager/watermarks.md + href: control-panel/file-manager/watermarks.md - name: Field Manager items: - name: Settings @@ -52,7 +52,23 @@ - name: Categories href: control-panel/categories.md - name: Utilities - href: control-panel/utilities.md + items: + - name: Overview + href: control-panel/utilities.md + - name: Communicate Tool + href: control-panel/utilities/communicate.md + - name: Translation Tool + href: control-panel/utilities/translation.md + - name: General Utilities + href: control-panel/utilities/general.md + - name: Debug Tools + href: control-panel/utilities/debug.md + - name: Member Tools + href: control-panel/utilities/member-tools.md + - name: Database Tools + href: control-panel/utilities/database.md + - name: Data Operations + href: control-panel/utilities/data-operations.md - name: System Logs href: control-panel/system-logs.md - name: System Settings @@ -105,7 +121,7 @@ href: control-panel/settings/branding.md - name: CP Navigation href: control-panel/navigation.md - + - name: Templates items: - name: Overview @@ -295,4 +311,4 @@ href: comment/subscriptions.md - name: Control Panel href: comment/control-panel.md - +