WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#9687 closed task (blessed) (invalid)

Please : Documentation about new pomo sub-folder in wp-includes folder

Reported by: michelwppi Owned by:
Milestone: Priority: high
Severity: normal Version:
Component: Inline Docs Keywords: needs-patch
Focuses: Cc:

Description

As developer of plugins for multilingual website, by chance, I discover new pomo sub-folder in wp-includes. If these enhancements are definitive, because each file is very poorly documented, where is the main doc and where is it possible to read some infos about the new introduced architecture ?
Thanks for your answer that can help for future plugin's dev and choices of libraries to use.
M

Change History (12)

comment:1 hakre5 years ago

  • Keywords reporter-feedback added

what kind of information do you want to have documented? please clarify. what should a plugin developer be able to read about? what does a plugin developer needs to know.

maybe that information is useable? #9686

comment:2 Denis-de-Bernardy5 years ago

  • Component changed from General to Inline Docs
  • Milestone Unassigned deleted
  • Resolution set to invalid
  • Status changed from new to closed
  • Type changed from feature request to task (blessed)

seems php-doc'ed already. please re-open with feedback

comment:3 michelwppi5 years ago

  • Resolution invalid deleted
  • Status changed from closed to reopened

The inline docs explains each class and function but not : why and general architecture. What I need : it is why this library was added ? I imagine that before adding this, team exchanges some posts or docs about general purposes of this addition and his future uses - are there in a development blog URL ? - which category, which post ?.

One example, this POMO library contain a non used PO class (MO class is used). To not re-invent the wheel, I hope to reuse it (i.e. in xili-dictionary - http://wordpress.org/extend/plugins/xili-dictionary/ - release for WP2.8) to create via Admin UI po file (for wp 2.7, I use code add in the plugin).

Hope this feedback is useful..

comment:4 hakre5 years ago

your feedback is useful, but i hate to say that with wordpress you do not get documentation on the silverplate.

the route i can suggest is to go with reading the source and the phpdoc comments in there if codex is way too much misleading.

for development topics stuff is blogged here and there on blogs around the net, i don't get it as well.

and at least: i can not tell you wether or not this library is in use for everytime. normally wp folks create a functional wrapper around it sothat you can use that one. this will not break your plugin so fast because these functions are normally adopted if libraries change.

comment:5 Denis-de-Bernardy5 years ago

  • Keywords needs-patch added; reporter-feedback removed
  • Milestone set to Future Release

personally, suggesting that you bring this up in the hackers list and add the needed patch

comment:8 hakre5 years ago

free for all to enter?

comment:9 michelwppi5 years ago

Docs about taxonomies since 2.3 were a good reference...
When version 1 of xili-dictionary and xili-language plugins (for version 2.8 wordpress) will be ready, I hope, if I decide to use this POMO library, to provide my observations and notes on a silver platter! ;)
M.

comment:10 nbachiyski5 years ago

The old gettext library was messy, didn't have clear interface (in order to get all translations we used a private method) and didn't support gettext contexts. Here comes pomo. WordPress 2.8 uses it, instead of the old gettext library. The old one is still distributed with WordPress for backwards compatibility.

comment:11 michelwppi5 years ago

to nbachiyski : thank you for that clarification on this library and his history. After some reading of the scripts, I see it is possible to read .mo files but also to read and write .po files. Do you plan to add sub-library to write .mo file ? (so, it will possible to replace the libraries included inside the plugin in beta tests.
What are the next purposes of using po files ?

Thanks

comment:12 ryan5 years ago

  • Milestone Future Release deleted
  • Resolution set to invalid
  • Status changed from reopened to closed
Note: See TracTickets for help on using tickets.