1 === xili-dictionary === |
1 === xili-dictionary === |
2 Contributors: MS xiligroup |
2 Contributors: michelwppi, MS dev.xiligroup |
3 Donate link: http://dev.xiligroup.com/ |
3 Donate link: http://dev.xiligroup.com/ |
4 Tags: theme,post,plugin,posts, page, category, admin,multilingual,taxonomy,dictionary, .mo file, .po file, l10n, i18n, language, international |
4 Tags: theme,post,plugin,posts, page, category, admin,multilingual,taxonomy,dictionary, .mo file, .po file, l10n, i18n, language, international,wpmu,plural,multisite |
5 Requires at least: 2.8.0 |
5 Requires at least: 3.3.2 |
6 Tested up to: 2.9.1 |
6 Tested up to: 3.4.2 |
7 Stable tag: 1.0.3 |
7 Stable tag: 2.2.0 |
|
8 License: GPLv2 |
8 |
9 |
9 xili-dictionary is a dictionary storable in taxonomy and terms to create and translate .po files or .mo files and more... |
10 |
|
11 xili-dictionary is a dictionary storable in CPT and terms to create and translate .po files or .mo files and more... |
10 |
12 |
11 == Description == |
13 == Description == |
12 |
14 |
13 **xili-dictionary is a dictionary storable in taxonomy and terms to create, update and translate .po files or .mo files and more...** |
15 **xili-dictionary is a dictionary storable in custom post type (CPT) and terms (custom taxonomy) to create, update and translate .po files or .mo files of current theme folder.** |
14 |
16 |
15 * xili-dictionary is a plugin (compatible with xili-language) to build a multilingual dictionary saved in the taxonomy tables of WordPress. |
17 * xili-dictionary is a plugin (compatible with xili-language) to build a multilingual dictionary saved in the post tables of WordPress as CPT. |
16 * With this dictionary, collecting terms from categories (title, description), from current theme - international terms with ` _e(), __() or _n() ` functions - , it is possible to create and update .mo file in the current theme folder. |
18 * With this dictionary, collecting terms from taxonomies (title, description), from bloginfos, from wp_locale, from current theme - international terms with ` _e(), __() or _n() or _x(), _ex(), _nx(),... ` functions - , it is possible to create and update .mo file in the current theme folder. |
|
19 * By importing .mo files, it is possible to regenerate readable .po files and enrich translation tables. |
17 * xili-dictionary is full compatible with [xili-language](http://wordpress.org/extend/plugins/xili-language/) plugin and [xili-tidy-tags](http://wordpress.org/extend/plugins/xili-tidy-tags/) plugin. |
20 * xili-dictionary is full compatible with [xili-language](http://wordpress.org/extend/plugins/xili-language/) plugin and [xili-tidy-tags](http://wordpress.org/extend/plugins/xili-tidy-tags/) plugin. |
18 |
21 |
19 = 1.0.3 = |
|
20 * fixes some directories issues in (rare) xamp servers and in theme's terms import. |
|
21 * Create .po with empty translations. Helpful if you send the .po file to a translator that uses app like poedit. |
|
22 |
22 |
23 **1.0.2 beta** |
23 = roadmap = |
24 * Create languages list, if xili-language plugin absent, for international themes - see [post](http://dev.xiligroup.com/?p=312 "xili-dictionary for international themes") - to manage or improve current translations. |
24 * code source cleaning |
25 * JS and vars, lot of fixes. |
25 * readme rewritting |
26 * Add a term UI now use dynamic input (with javascript included). |
26 * dictionary for other than theme's .po, .mo files |
27 * Now use POMO translations libraries included in WP since 2.8. |
|
28 * Add features to set and manage plural terms used by `_n()` |
|
29 |
27 |
30 **For previous WP versions (<2.8), please use 0.9.9 release.** |
28 = 2.2.0 (2012-09-22) = |
31 |
29 |
32 **0.9.9** |
30 * fixes issues of 2.1 series (messages, import/export, ctxt, conditions, and more…) - thanks to the adventurers ;-) |
33 some fixes - better log display when importing from theme's files - tested on WP 2.9-rare |
|
34 |
31 |
35 **0.9.8** |
32 = 2.1 = |
36 verified on official WP 2.8 - see Notes |
33 * requires version 2.6 of xili-language if used in multilingual website context. |
37 **0.9.7.1** |
34 * now uses and saves local .po/mo files (named local-xx_XX.mo) (containing local datas of site not saved in theme's .po/mo files as before). |
38 grouping of terms by language now possible, - better import .po - enrich terms more possible (same terms with/without html tags (0.9.7.2 : some refreshing fixes) |
35 * See [xili wiki about XL 2.6 and XD 2.1](http://wiki.xiligroup.org/index.php/Xili-language_v2.6:_what%27s_new_with_xili-dictionary_v2.1). |
|
36 * list of untranslated msgs in edit msg screen. See [xili wiki](http://wiki.xiligroup.org/index.php/Xili-dictionary:_what%27s_new_since_version_2.1.2) |
|
37 * now uses origin taxonomy to share a dictionary between different themes. |
39 |
38 |
40 THESE VERSIONS 1.0.x ARE BETA VERSION (running on our sites and elsewhere) - WE NEED MORE FEEDBACK even if the first from world are good - coded as OOP and new admin UI WP 2.7 features (meta_box, js, screen options,...) |
|
41 |
39 |
42 Some features (importing themes words to fill msgid list) are not totally stable (if coding is crazy - too spacing !)... |
40 = 2.0 - MAJOR UPGRADE = |
|
41 * new way of saving lines in CPT |
|
42 * use as soon as possible wp-admin UI library |
|
43 * now msg lines full commented as in .po |
|
44 * now translated lines (msgstr) attached to same taxonomy as xili-language (> 2.4.1) |
|
45 * VERY IMPORTANT : before upgrading from 1.4.4 to 2.0, export all the dictionary content in .po files and empty the dictionary table. |
|
46 |
|
47 For previous versions, see Changelog and readme in tab Other Versions. |
43 |
48 |
44 == Installation == |
49 == Installation == |
45 |
50 |
46 1. Upload the folder containing `xili-dictionary.php` and language files to the `/wp-content/plugins/` directory, |
51 1. Upload the folder containing `xili-dictionary.php` and language files to the `/wp-content/plugins/` directory, |
47 2. Verify that your theme is international compatible - translatable terms like `_e('the term','mytheme')` and no text hardcoded - |
52 2. Verify that your theme is international compatible - translatable terms like `_e('the term','mytheme')` and no text hardcoded - |
48 3. active and visit the dictionary page in tools menu ... more details soon... [here](http://dev.xiligroup.com/?cat=394&lang=en_us) - |
53 3. Activate and visit the dictionary page in tools menu and docs [here](http://dev.xiligroup.com/xili-dictionary/) - |
|
54 4. To edit a msg, you can start from dictionary list or XD msg list using current WP admin UI library. Don't forget to adapt UI with screen options and moving meta boxes. |
|
55 |
|
56 More infos will be added progressively in a wiki [here](http://wiki.xiligroup.org/index.php/Main_Page). |
49 |
57 |
50 == Frequently Asked Questions == |
58 == Frequently Asked Questions == |
51 |
59 |
52 = Is the term msgid may contain words enriched by html tags ? = |
60 = What about WP multisite (or network - former named WPMU) and the trilogy ? = |
53 like `<em> or <strong>` |
61 [xili-language](http://wordpress.org/extend/plugins/xili-language/), [xili-tidy-tags](http://wordpress.org/extend/plugins/xili-tidy-tags/), [xili-dictionary](http://wordpress.org/extend/plugins/xili-dictionary/) |
54 |
62 |
55 Yes, since version 0.9.7. |
63 Since WP 3.0-alpha, if multisite is activated, the trilogy is compatible and will include progressively some improvements dedicaded especially for WP network context. Future specific docs will be available for registered webmasters to describe where mo files where saved. |
56 |
|
57 ` |
|
58 a <strong>good</strong> word |
|
59 ` |
|
60 |
|
61 can be translated by |
|
62 |
|
63 ` |
|
64 un mot <strong>exact</strong> |
|
65 ` |
|
66 |
|
67 |
64 |
68 = Where can I see websites using this plugin ? = |
65 = Where can I see websites using this plugin ? = |
69 |
66 |
70 dev.xiligroup.com [here](http://dev.xiligroup.com/ "a multi-language site") |
67 More than 3000 websites use xili-language (according peak of version updates in stats). |
|
68 |
|
69 dev.xiligroup.com [here](http://dev.xiligroup.com/ "a multi-language site"), |
|
70 multilingual.wpmu.xilione.com [here](http://multilingual.wpmu.xilione.com/ "a multi-language demo site") |
71 and |
71 and |
72 www.xiliphone.mobi [here](http://www.xiliphone.mobi "a theme for mobile") also usable with mobile as iPhone. |
72 www.xiliphone.mobi [here](http://www.xiliphone.mobi "a theme for mobile") also usable with mobile as iPhone. |
73 |
73 |
74 = What is the difference with msgid and msgtr in .po file ? = |
74 = What is the difference with msgid and msgtr in .po file ? = |
75 The msgid line is equal to the term or sentence hardcoded in the theme functions like ` _e() or __() `. msgstr is the translation in the target language : by instance `fr_FR.po` for a french dictionary. (the compiled file is `fr_FR.mo` saved in the theme folder. |
75 The msgid line is equal to the term or sentence hardcoded in the theme functions like ` _e() or __() `. msgstr is the translation in the target language : by instance `fr_FR.po` for a french dictionary. (the compiled file is `fr_FR.mo` saved in the theme folder. |
76 The root language is in Wordpress currently `en_US`, but with xili-dictionary, it is possible to create a `en_US.mo` containing the only few terms that you want to adapt. |
76 The root language is in Wordpress currently `en_US`, but with xili-dictionary, it is possible to create a `en_US.mo` containing the only few terms that you want to adapt or modify. |
77 |
77 |
78 = Is xili-dictionary usable without xili-language to edit .po or .mo file ? = |
78 = Is xili-dictionary usable without xili-language to edit .po or .mo file ? = |
79 |
79 |
80 With certain conditions, the language must in the default list and if the language files are not in the root of the current theme, you must add this line in functions.php file of this theme (normally set before xili-language is installed) : |
80 Yes and now automatically detected ! For example, to modify the results of a translation for your site with your words. |
81 |
|
82 `define('THEME_LANGS_FOLDER','/nameoflangfolder'); // in Fusion: /lang` |
|
83 |
81 |
84 = What about plural translations ? = |
82 = What about plural translations ? = |
85 Today works with .mo or .po with simple twin msgid msgstr couple of lines and themes with functions like ` _e() or __() ` for localization AND `_n()` which manage singular and plural terms like `msgid, msgid_plural, msgstr[0],...` |
83 Today works with .mo or .po with simple twin msgid msgstr couple of lines and themes with functions like ` _e() or __() ` for localization AND `_n()` which manage singular and plural terms like `msgid, msgid_plural, msgstr[0],...` |
86 |
84 |
87 = What about future WP 2.9 ? = |
85 = What is a po file ? = |
88 Today works... |
86 |
|
87 It is a text file like this (here excerpt) with different types of msgid : |
|
88 |
|
89 ` |
|
90 msgctxt "comments number" |
|
91 msgid "%" |
|
92 msgstr "%" |
|
93 |
|
94 msgid "Leave a reply" |
|
95 msgstr "Laisser une réponse" |
|
96 |
|
97 msgid "One thought on “%2$s”" |
|
98 msgid_plural "%1$s thoughts on “%2$s”" |
|
99 msgstr[0] "Une réflexion au sujet de « %2$s »" |
|
100 msgstr[1] "%1$s réflexions au sujet de « %2$s »" |
|
101 |
|
102 msgctxt "sentence" |
|
103 msgid "comment" |
|
104 msgid_plural "comments" |
|
105 msgstr[0] "commentaire" |
|
106 msgstr[1] "commentaires" |
|
107 |
|
108 ` |
|
109 |
|
110 = What happens if only the .mo is available ? = |
|
111 |
|
112 xili-dictionary is able to import a .mo of the target language and rebuild a .po editable in backend or a text editor. Example: if it_IT is in your language list, it_IT.mo can be imported, completed by webmaster and export as it_IT.po text file in languages sub-folder of the theme (as text backup). |
|
113 |
|
114 |
89 |
115 |
90 == Screenshots == |
116 == Screenshots == |
91 |
117 |
92 1. the admin settings UI and boxes for editing, sub-selection and create or import files (.mo or .po). |
118 1. The admin settings UI: table for sub-selection and create or import files (.mo or .po). |
93 2. Since 1.0.0, plural terms are allowed. |
119 2. Msg edit screen with the msg series dashboard. |
94 3. MsgID with his singular and his plural line. |
120 3. Msg list table screen as designed with WP admin UI library. |
95 4. MsgSTR with separators between occurrences of n plural terms `msgstr[n]` (soon more practical UI). |
121 4. MsgID with his singular and his plural line. |
|
122 5. MsgSTR with his plural. |
96 |
123 |
97 == Upgrade Notice == |
124 == Upgrade Notice == |
98 |
125 |
99 Upgrading can be easily procedeed through WP admin UI or through ftp. |
126 Upgrading can be easily procedeed through WP admin UI or through ftp (delete previous release folder before upgrading via ftp). |
100 |
127 IMPORTANT - Don't forget to backup before. |
|
128 Verify you install latest version of trilogy (xili-language, xili-tidy-tags,…). |
|
129 IMPORTANT - Before updating to xili-dictionary 2.0, export all the dictionary contents in .po files foreach target langs and empty the dictionary table made by 1.4.4. |
101 |
130 |
102 == More infos == |
131 == More infos == |
103 |
132 |
104 This first beta releases are for theme's creator or designer with some knowledges in i18n. |
133 This first beta releases are for theme's creator or designer with some knowledges in i18n. |
105 |
134 |
106 The plugin post is frequently updated [dev.xiligroup.com](http://dev.xiligroup.com/?p=312 "Why xili-dictionary ?") |
135 The plugin post is frequently updated [wiki.xiligroup.org](http://wiki.xiligroup.org/index.php/Category:Xili-dictionary_plugin) |
107 |
136 |
108 See also the [Wordpress plugins forum](http://wordpress.org/tags/xili-language/). |
137 See [dev.xiligroup forum plugins forum](http://forum2.dev.xiligroup.com/forum.php?id=3). |
|
138 |
|
139 See also the [Wordpress plugins forum](http://wordpress.org/tags/xili-dictionary/). |
|
140 |
|
141 © 2009-2012 MS - dev.xiligroup.com |
109 |
142 |
110 == Changelog == |
143 == Changelog == |
111 = 1.0.3 beta = |
144 = 2.2.0 (2012-09-29) = |
112 fixes some directories issues in (rare) xamp servers and in theme's terms import. Create .po with empty translations. |
145 * fixes issues of 2.1 series (messages, import, conditions, and more…). |
113 = 1.0.2 beta = |
146 * 2.1.2 and 2.1.3 removed from repository |
114 Use POMO libraries and classes only in WP > 2.8. Add plural translations. Add edit term dynamic UI |
147 = 2.1.3 (2012-08-20) = |
115 = 0.9.9 = |
148 * fixes |
116 * fixes existing msgid terms - |
149 = 2.1.2 (2012-07-15) = |
117 * better log display in importing theme's terms |
150 * list of untranslated msgs in edit msg screen. |
118 * more html tags in msg str or id |
151 * shortcut in side metabox to update .mo of current lang. See [xili wiki](http://wiki.xiligroup.org/index.php/Xili-dictionary:_what%27s_new_since_version_2.1.2 "Wiki") |
119 = 0.9.8 = |
152 * fixes local-xx_XX import - new icons |
120 * verified on official WP 2.8. |
153 = 2.1.0 (2012-05-08) = |
121 * fixes query error, |
154 * in multilingual website context, requires version 2.6 of xili-language. |
122 * .1 fixe IIS error. |
155 * local datas saved in local-xx_XX .mo/po files. |
|
156 * origin taxonomy used to manage one dictionary with multiple themes. |
|
157 * see [xili wiki](http://wiki.xiligroup.org/) |
123 |
158 |
124 = 0.9.7.2 = some fixes |
159 = 2.0.0 = |
125 = 0.9.7.1 = list of msgid ID at end |
160 * 120417 - repository as current |
126 = 0.9.7 = grouping of terms by language now possible, and more... |
161 * 120405 - pre-tests with WP 3.4: fixes metaboxes columns |
127 = 0.9.6 = W3C - recover compatibility with future wp 2.8 |
162 * 120219 - new way of saving lines in CPT - new UI using WP library |
128 = 0.9.5 = sub-selection of terms in UI, better UI (links as button) |
163 * now msg lines full commented as in .po |
129 = 0.9.4.1 = subfolder for langs file - ` THEME_LANGS_FOLDER ` to define in functions.php with xili-language |
164 * now translated lines (msgstr) attached to same taxonomy as xili-language |
130 = 0.9.4 = second public release (beta) with OOP coding and new admin UI for WP 2.7 |
165 * compatible with theme and language files in sub-sub-folder. |
|
166 * IMPORTANT - before upgrading from 1.4.4 to 2.0, export all the dictionary in .po files and empty the dictionary. |
|
167 |
|
168 = beta 1.4.4 = |
|
169 * 111221 - fixes |
|
170 * between 0.9.3 and 1.4.4 see version 1.4.4 - 20120219 |
131 = 0.9.3 = first public release (beta) |
171 = 0.9.3 = first public release (beta) |
132 |
172 |
133 © 100207 - MS - dev.xiligroup.com |
173 © 20120922 - MS - dev.xiligroup.com |