https://github.com/onthegosystems/wpml-config
Remote repository for WPML language configuration files
https://github.com/onthegosystems/wpml-config
Last synced: about 1 year ago
JSON representation
Remote repository for WPML language configuration files
- Host: GitHub
- URL: https://github.com/onthegosystems/wpml-config
- Owner: OnTheGoSystems
- Created: 2018-02-23T08:50:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T08:38:38.000Z (over 1 year ago)
- Last Synced: 2024-10-23T12:39:57.641Z (over 1 year ago)
- Language: PHP
- Size: 639 KB
- Stars: 30
- Watchers: 25
- Forks: 41
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: newsletter/wpml-config.xml
Awesome Lists containing this project
README
# Remote repository for WPML language configuration files
This is the repository that the WPML plugin uses to keep the list of language configuration files always up to date.
## Language configuration files
Each plugin / theme can have a language configuration file that will tell WPML how to translate its data. You have more information about creating language configuration files over here:
https://wpml.org/documentation/support/language-configuration-files/
Language configuration files can be stored directly in the root folder of the plugin / theme where they belong or they can be added to this repository. The WPML plugin will periodically read this repository to keep up to date.
## Repository structure
The language configuration repository has:
- An index file to keep items organized under plugins and themes: [config-index.xml](config-index.xml)
- A folder for each entry in the index file with a `wpml-config.xml` file inside.
## Index file format
There are a couple of requisites:
- The XML entry has to be inside one of these elements: `` or ``
- The id attribute in the index file corresponds to the folder name and must match the folder name of the plugin or theme.
- The name of the plugin has to match the name of the plugin in its header.
For example:
`WPML Multilingual CMS`
## Validating XML files
Run `composer install --no-autoloader` to validate XML files.
## Testing Instructions
1. **Clone the Repository:**
Clone into the WordPress root directory:
```
git clone [repository-url] /path/to/wordpress/wpml-config/
```
2. **Run Update Script:**
Navigate to the `/wpml-config/` folder and run the update script:
```
cd /path/to/wordpress/wpml-config/ && php bin/update.php
```
3. **Configure WordPress:**
In `wp-config.php`, add:
```
define( 'ICL_REMOTE_WPML_CONFIG_FILES_INDEX', 'http://your-wordpress-url/' );
```
Replace `http://your-wordpress-url/` with your WordPress installation URL.
4. **Test:**
Verify functionality in your WordPress environment.
Report any issues or bugs encountered during the testing process.
## Contributing
- Fork the project or create a new branch
- Make your changes, test them and push
- Create a merge request for your branch to be merged into master
- The changes will be reviewed and, if approved, merged