grunt-wp-i18n icon indicating copy to clipboard operation
grunt-wp-i18n copied to clipboard

Plugin's meta data

Open marcochiesi opened this issue 10 years ago • 9 comments

Is there a way to control which plugin meta data are included in the .pot file? In example I would like only plugin's description (and maybe name) to be translatable, while plugin's author and URI's not.

marcochiesi avatar Oct 05 '14 09:10 marcochiesi

This looks to be down to makepot.php, not something specific in grunt-wp-i18n. I personally don't think this option should be something that is added here, but @bradyvercher may disagree.

My suggestion would to add a grunt-contrib-replace task that can find and remove bits from the .pot file after it has been generated.

GaryJones avatar Oct 05 '14 21:10 GaryJones

I went for an alternate solution, using the processPot callback:

        processPot: function( pot ) {
            var translation, excluded_meta = [ 'Plugin Name of the plugin/theme', 'Plugin URI of the plugin/theme', 'Author of the plugin/theme', 'Author URI of the plugin/theme' ];
            for ( translation in pot.translations[''] ) {
                if ( typeof pot.translations[''][translation].comments.extracted != 'undefined' ) {
                    if ( excluded_meta.indexOf( pot.translations[''][translation].comments.extracted ) >= 0 ) {
                        delete pot.translations[''][translation];
                        console.log( 'Excluded meta: ' + pot.translations[''][translation].comments.extracted );
                    }
                }
            }
            return pot;
        },

Perhaps it could be added to the documentation as example.

marcochiesi avatar Oct 05 '14 23:10 marcochiesi

Adding it as a Wiki page would be a good start, then do a PR with for the README with this as an advanced example.

GaryJones avatar Oct 06 '14 07:10 GaryJones

I see that currently there are no wiki pages for this project and the docs are in separate files linked from the README. Should I add this at the end of makepot.md?

marcochiesi avatar Oct 06 '14 08:10 marcochiesi

Yes, that seems like the best place :-)

GaryJones avatar Oct 06 '14 11:10 GaryJones

I agree with Gary that an option isn't needed for this, but that's exactly what the processPot callback is for, so I'm glad you found that useful!

Adding an advanced usage section at the bottom of makepot.md should be fine for now, but I'd be all for starting up the wiki with usage examples if someone wanted to take that on.

bradyvercher avatar Oct 06 '14 16:10 bradyvercher

Thanks for the PR, @marcochiesi!

bradyvercher avatar Oct 09 '14 06:10 bradyvercher

:hand: Hey @marcochiesi great work

shivapoudel avatar Jan 10 '15 16:01 shivapoudel

This seems to be a pretty popular option, so I'm reopening for discussion on ways to make it easier to implement.

bradyvercher avatar Oct 12 '15 23:10 bradyvercher