loco-translate
Last commit date
languages
8 years ago
lib
8 years ago
pub
8 years ago
src
8 years ago
tpl
8 years ago
loco.php
8 years ago
loco.xml
8 years ago
readme.txt
8 years ago
readme.txt
271 lines
| 1 | === Plugin Name === |
| 2 | Contributors: timwhitlock |
| 3 | Tags: translation, translators, localization, localisation, l10n, i18n, Gettext, PO, MO, productivity, multilingual, internationalization |
| 4 | Requires at least: 4.1 |
| 5 | Requires PHP: 5.2.4 |
| 6 | Tested up to: 4.9.4 |
| 7 | Stable tag: 2.1.0 |
| 8 | License: GPLv2 or later |
| 9 | License URI: http://www.gnu.org/licenses/gpl-2.0.html |
| 10 | |
| 11 | Translate WordPress plugins and themes directly in your browser |
| 12 | |
| 13 | |
| 14 | == Description == |
| 15 | |
| 16 | Loco Translate provides in-browser editing of WordPress translation files. |
| 17 | |
| 18 | It also provides localization tools for developers, such as extracting strings and generating templates. |
| 19 | |
| 20 | Features include: |
| 21 | |
| 22 | * Built-in translation editor within WordPress admin |
| 23 | * Create and update language files directly in your theme or plugin |
| 24 | * Extraction of translatable strings from your source code |
| 25 | * Native MO file compilation without the need for Gettext on your system |
| 26 | * Support for PO features including comments, references and plural forms |
| 27 | * PO source view with clickable source code references |
| 28 | * Protected language directory for saving custom translations |
| 29 | * Configurable PO file backups with diff and restore capability |
| 30 | * Built-in WordPress locale codes |
| 31 | |
| 32 | |
| 33 | Official [Loco](https://localise.biz/) WordPress plugin by <a href="//twitter.com/timwhitlock">@timwhitlock</a> / <a rel="author" href="https://plus.google.com/106703751121449519322">Tim Whitlock</a> |
| 34 | |
| 35 | |
| 36 | == Installation == |
| 37 | |
| 38 | = Installing manually: = |
| 39 | |
| 40 | 1. Unzip all files to the `/wp-content/plugins/loco-translate` directory |
| 41 | 2. Log into WordPress admin and activate the 'Loco Translate' plugin through the 'Plugins' menu |
| 42 | 3. Go to *Loco Translate > Home* in the left-hand menu to start translating |
| 43 | |
| 44 | = Basic usage: = |
| 45 | |
| 46 | Translators: To translate a theme into your language, follow these steps: |
| 47 | |
| 48 | 1. Create the protected languages directory at `wp-content/languages/loco/themes` |
| 49 | 2. Ensure this directory writeable by the web server |
| 50 | 3. Find your theme in the list at *Loco Translate > Themes* |
| 51 | 4. Click `+ New language` and follow the on-screen prompts. |
| 52 | |
| 53 | |
| 54 | Developers: To translate your own theme or plugin for distribution, follow these steps: |
| 55 | |
| 56 | 1. Create a `languages` subdirectory in your bundle’s root directory |
| 57 | 2. Ensure this directory writeable by the web server |
| 58 | 3. Find the bundle at either *Loco Translate > Themes* or *Loco Translate > Plugins* |
| 59 | 4. Click `+ Create template` and follow the on-screen prompts to extract your strings. |
| 60 | 5. Click `+ New language` and follow the on-screen prompts to add your own translations. |
| 61 | |
| 62 | |
| 63 | |
| 64 | More information on using the plugin is [available here](https://localise.biz/wordpress/plugin). |
| 65 | |
| 66 | |
| 67 | == Frequently Asked Questions == |
| 68 | |
| 69 | = How do I use it? = |
| 70 | |
| 71 | Try our [Guides and Tutorials](https://localise.biz/wordpress/plugin#guides) and be sure to check the [Most asked questions](https://localise.biz/wordpress/plugin/faqs) if you have a problem. |
| 72 | |
| 73 | = How do I get help? = |
| 74 | |
| 75 | Please see [getting help with Loco Translate](https://localise.biz/wordpress/plugin/support) and note that personal support by email is not available for this plugin. |
| 76 | Help is provided via the [plugin support forum](https://wordpress.org/support/plugin/loco-translate) only. |
| 77 | |
| 78 | |
| 79 | |
| 80 | == Screenshots == |
| 81 | |
| 82 | 1. Translating strings in the browser with the Loco PO Editor |
| 83 | 2. Showing translation progress for theme language files |
| 84 | 3. PO source view with text filter and clickable file references |
| 85 | |
| 86 | |
| 87 | |
| 88 | == Changelog == |
| 89 | |
| 90 | = 2.1.0 = |
| 91 | * Add `fs_protect` setting to avoid overwriting system files |
| 92 | * Fixed bug in connect dialogue where errors not redisplayed |
| 93 | * Minor improvements to inline notices |
| 94 | * Removed downgrade notice under version tab |
| 95 | * Fixed extraction bug where file header confused with comment |
| 96 | * Resolved some inconsistencies between PHP and JS utilities |
| 97 | * Added Restore tab with diff display |
| 98 | * Added `loco_settings` hook |
| 99 | * Prevented editor from changing PO document order |
| 100 | * Added default string sorting to extracted strings |
| 101 | * Added "Languages" section for grouping files by locale |
| 102 | * Fixed bug where translations loaded before user profile language set |
| 103 | * Added loco_locale_plurals filter for customising plural rules |
| 104 | * Allowing PO files to enforce their own Plural-Forms rules |
| 105 | * Added `loco_allow_remote` filter for debugging remote problems |
| 106 | * Updated plural forms from Unicode CLDR |
| 107 | * PHP extractor avoids repeated comments |
| 108 | * Bumped WP compatibility to 4.9.4 |
| 109 | |
| 110 | = 2.0.17 = |
| 111 | * Unofficial languages showing in “Installed” dropdown |
| 112 | * Fixed extraction bug where comment confused with file header |
| 113 | * Fixed issue where src attributes requested from server during HTML strip |
| 114 | * Added loco_admin_init hook into ajax router for consistency |
| 115 | * Added warning on file info page when file is managed by WordPress |
| 116 | * Minor help link and layout tweaks |
| 117 | * Bumped WP compatibility to 4.9.1 |
| 118 | |
| 119 | = 2.0.16 = |
| 120 | * File writer observes wp_is_file_mod_allowed |
| 121 | * Fixed progress bug in editor for locales with nplurals=1 |
| 122 | * Made plural form categories translatable for editor UI |
| 123 | * Sync-from-source raises warning when files are skipped |
| 124 | * Added hack for extracting from .twig as per .php |
| 125 | * Added warning when child themes declare parent text domain |
| 126 | * Added option to control PO line wrapping |
| 127 | * Bumped WP compatibility to 4.8.2 |
| 128 | |
| 129 | = 2.0.15 = |
| 130 | * Permanently removed legacy version 1.x |
| 131 | * Fixed bug where editor code view was not redrawn on resize |
| 132 | * Fixed bug where fuzzy flag caused format flag to be ignored |
| 133 | * Fixed bug where autoloader responded to very long class names |
| 134 | * Purging WP object cache when active plugin list changes |
| 135 | * Added experimental source word count into POT info tab |
| 136 | * Bumped WP compatibility to 4.8.1 |
| 137 | |
| 138 | = 2.0.14 = |
| 139 | * Editor improvements inc. column sorting |
| 140 | * Added warnings that legacy version will be removed |
| 141 | * Added PO source view text filtering |
| 142 | * Added _fs_nonce for 4.7.5 compatibility |
| 143 | * Migrated to canonical text domain |
| 144 | * Removed wp class autoloading |
| 145 | |
| 146 | = 2.0.13 = |
| 147 | * CSS conflict fixes |
| 148 | * Added option for UTF-8 byte order mark |
| 149 | * Printf highlighting observes no-php-format flag |
| 150 | * Fixed issue with translator role losing “read” permission |
| 151 | |
| 152 | = 2.0.12 = |
| 153 | * Minor fix for root path configs |
| 154 | * Added alternative PHP extensions setting |
| 155 | * Bumped WP version to 4.7.3 |
| 156 | * LoadHelper fix for core files |
| 157 | * Allow revoking of permissions from translator role |
| 158 | * Allow network admins to deny access to site admins |
| 159 | |
| 160 | = 2.0.11 = |
| 161 | * Extra debug logging and error diagnostics |
| 162 | * Forcefully clear output buffers before Ajax flush |
| 163 | * Bumped WordPress version to 4.7 |
| 164 | * Experimental wildcard text domain support |
| 165 | |
| 166 | = 2.0.10 = |
| 167 | * Allows missing domain argument in plugin_locale filter |
| 168 | * Reverted editor changes that disabled readonly text |
| 169 | * Added invisibles and coding editor switches |
| 170 | * Added table filtering via text query |
| 171 | * Added Last-Translator user preference |
| 172 | |
| 173 | = 2.0.9 = |
| 174 | * Bumped minimum WordPress version to 4.1 |
| 175 | * Some optimisation of transient caching |
| 176 | * Fixed hash table settings bug |
| 177 | |
| 178 | = 2.0.8 = |
| 179 | * Source refs fix for files in unknown subsets |
| 180 | * Downgrades PO formatting exceptions to PHP warnings |
| 181 | * Renamed function prefixes to avoid PHP 7 warnings |
| 182 | * Better support for php-format and no-php-format flag |
| 183 | * PO source and editor UI tweaks |
| 184 | * Localised strings and implemented in js |
| 185 | |
| 186 | = 2.0.7 = |
| 187 | * Fixed prototype.js conflict |
| 188 | * More Windows file path fixes |
| 189 | * Added loco_current_translator filter |
| 190 | * Fixed false positive in extra files test |
| 191 | |
| 192 | = 2.0.6 = |
| 193 | * PO wrapping bugfix |
| 194 | * Downgraded source code bugfix |
| 195 | * Tolerating headerless POT files |
| 196 | * Core bundle metadata tweaks |
| 197 | |
| 198 | = 2.0.5 = |
| 199 | * Deferred missing tokenizer warning |
| 200 | * Allows editing of files in unconfigured sets |
| 201 | * Added maximum PHP file size for string extraction |
| 202 | * Display of PHP fatal errors during Ajax |
| 203 | |
| 204 | = 2.0.4 = |
| 205 | * Reduced session failures to debug notices |
| 206 | * Added wp_roles support for WP < 4.3 |
| 207 | * Fixed domain listener bugs |
| 208 | |
| 209 | = 2.0.3 = |
| 210 | * Added support for Windows servers |
| 211 | * Removed incomplete config warning on bundle overview |
| 212 | |
| 213 | = 2.0.2 = |
| 214 | * Fixed bug when absolute path used to get plugins |
| 215 | * Added loco_plugins_data filter |
| 216 | * Added theme Template Name header extraction |
| 217 | * Minor copy amends |
| 218 | |
| 219 | = 2.0.1 = |
| 220 | * Added help link in settings page |
| 221 | * Fixed opendir warnings in legacy code |
| 222 | * Catching session errors during init |
| 223 | * Removing meta row link when plugin not found |
| 224 | |
| 225 | = 2.0.0 = |
| 226 | * First release of completely rebuilt version 2 |
| 227 | |
| 228 | |
| 229 | == Upgrade Notice == |
| 230 | |
| 231 | = 2.1.0 = |
| 232 | * Various bug fixes and improvements |
| 233 | |
| 234 | |
| 235 | == More info == |
| 236 | |
| 237 | * [About the plugin](https://localise.biz/wordpress/plugin) |
| 238 | * [User manual](https://localise.biz/wordpress/plugin/manual) |
| 239 | * [Beginner's guide](https://localise.biz/wordpress/plugin/beginners) |
| 240 | * [Customizing translations](https://localise.biz/wordpress/plugin/custom-translations) |
| 241 | * [Translating child themes](https://localise.biz/wordpress/plugin/child-themes) |
| 242 | * [Getting help](https://localise.biz/wordpress/plugin/support) |
| 243 | |
| 244 | == Coming soon == |
| 245 | |
| 246 | These features are on our todo list. There's no particular timeframe for any of them and they're in no particular order: |
| 247 | |
| 248 | * Integration with automatic translation services |
| 249 | * Integration with Loco API for cloud storage and collaboration |
| 250 | * Global search for finding strings across all bundles |
| 251 | * Advanced Merge/Sync screen to replace the basic in-editor sync |
| 252 | * Starred/Favourited bundles for quicker dashboard access |
| 253 | |
| 254 | |
| 255 | == Keyboard shortcuts == |
| 256 | |
| 257 | The PO file editor supports the following keyboard shortcuts for faster translating: |
| 258 | |
| 259 | * Done and Next: `Ctrl ↵` |
| 260 | * Next string: `Ctrl ↓` |
| 261 | * Previous string: `Ctrl ↑` |
| 262 | * Next untranslated: `Shift Ctrl ↓` |
| 263 | * Previous untranslated: `Shift Ctrl ↑` |
| 264 | * Copy from source text: `Ctrl B` |
| 265 | * Clear translation: `Ctrl K` |
| 266 | * Toggle Fuzzy: `Ctrl U` |
| 267 | * Save PO / compile MO: `Ctrl S` |
| 268 | * Toggle invisibles: `Shift Ctrl I` |
| 269 | |
| 270 | Mac users can use ⌘ Cmd instead of Ctrl. |
| 271 |