Skip to content

threadi/easy-language

Repository files navigation

Easy Language

About

This repository provides the features of the free version of the WordPress plugin Easy Language. The repository is used as a basis for deploying the plugin to the WordPress repository. It is not intended to run as a plugin as it is, even if that is possible for development.

Usage

After checkout go through the following steps:

  1. copy build/build.properties.dist to build/build.properties.
  2. modify the build/build.properties file - note the comments in the file.
  3. execute the command in build/: ant init
  4. after that the plugin can be activated in WordPress

Release

  1. increase the version number in build/build.properties.
  2. execute the following command in build/: ant build
  3. after that you will finde in the release directory a zip file which could be used in WordPress to install it.

Translations

I recommend to use PoEdit to translate texts for this plugin.

generate pot-file

Run in main directory:

wp i18n make-pot . languages/easy-language.pot --exclude=classes/multilingual-plugins/easy-language/blocks/navigation-switcher/src/,classes/multilingual-plugins/easy-language/blocks/switcher/src/,svn/

update translation-file

  1. Open .po-file of the language in PoEdit.
  2. Go to "Translate > "Update from POT-file".
  3. After this the new entries are added to the language-file.

export translation-file

  1. Open .po-file of the language in PoEdit.
  2. Go to File > Save.
  3. Upload the generated .mo-file and the .po-file to the plugin-folder languages/

generate json-translation-files

Run in main directory:

wp i18n make-json languages

OR use ant in build/-directory: ant json-translations

Requirements

npm install

Run for development

npm start

Run for release

npm run build

Hint: will be called by ant-command mentioned above.

Check for WordPress Coding Standards

Initialize

composer install

Run

vendor/bin/phpcs --extensions=php --ignore=*/vendor/*,*/doc/*,*/svn/*,*/node_modules/*,*/gettext-helper.php,*/classes/multilingual-plugins/easy-language/pagebuilder/divi/build/,*/classes/multilingual-plugins/easy-language/blocks/*/build/,*translatepress* --standard=ruleset.xml .

Repair

vendor/bin/phpcbf --extensions=php --ignore=*/vendor/*,*/doc/*,*/svn/*,*/node_modules/*,*/gettext-helper.php,*/classes/multilingual-plugins/easy-language/pagebuilder/divi/build/,*/classes/multilingual-plugins/easy-language/blocks/*/build/,*translatepress* --standard=ruleset.xml .

Generate documentation

vendor/bin/wp-documentor parse classes --format=markdown --output=doc/hooks.md --prefix=easy_language