{"id":880041,"date":"2016-06-17T13:53:32","date_gmt":"2016-06-17T13:53:32","guid":{"rendered":"https:\/\/wpml.org\/?p=880041"},"modified":"2016-06-17T13:53:32","modified_gmt":"2016-06-17T13:53:32","slug":"write-multilingual-ready-tutorial-themeplugin","status":"publish","type":"post","link":"https:\/\/wpml.org\/zh-hans\/compatibility\/2016\/06\/write-multilingual-ready-tutorial-themeplugin\/","title":{"rendered":"How To Write A Multilingual-Ready Tutorial For Your Theme\/Plugin?"},"content":{"rendered":"<h2><img decoding=\"async\" class=\"aligncenter wp-image-888986\" src=\"https:\/\/wpml.org\/wp-content\/uploads\/2016\/05\/How-To-Write-A-Multilingual-Ready-Tutorial-For-Your-Theme-Plugin.png\" alt=\"How To Write A Multilingual-Ready Tutorial For Your Theme-Plugin\" width=\"500\" height=\"188\" srcset=\"https:\/\/wpml.org\/wp-content\/uploads\/2016\/05\/How-To-Write-A-Multilingual-Ready-Tutorial-For-Your-Theme-Plugin.png 545w, https:\/\/wpml.org\/wp-content\/uploads\/2016\/05\/How-To-Write-A-Multilingual-Ready-Tutorial-For-Your-Theme-Plugin-150x56.png 150w, https:\/\/wpml.org\/wp-content\/uploads\/2016\/05\/How-To-Write-A-Multilingual-Ready-Tutorial-For-Your-Theme-Plugin-300x113.png 300w\" sizes=\"(max-width: 500px) 100vw, 500px\" \/><\/h2>\n<p>For a few years now we have been helping authors of plugins and themes to write toturials\u00a0explaining how their products should work in a multilingual way. We discovered that documentation is an essential part of any development cycle and showing your clients how to use your theme or plugin with WPML\u00a0has even more benefits.<\/p>\n<h2>What are the benefits of writing documentation about your theme\/plugin compatibility with WPML?<\/h2>\n<p>The documentation will explain how to build multilingual sites with your theme\/plugin, which will help your clients use your theme\/plugin on multilingual sites and reduce the load on your support forums. It might also help increase your sales, as customers are more likely to purchase your product for producing a multilingual website. A link to your documentation will be added to your theme\/plugin page on wpml.org.<\/p>\n<h2>Theme\/Plugin Documentation suggested points (structure)<\/h2>\n<ul>\n<li>Introduction: A few words about the theme\/plugin and its integration with WPML. You can also include a link to a WPML public test site for that theme (example: <a href=\"http:\/\/uncode.compatibility.wpml.org\/\">http:\/\/YOURTHEME.compatibility.wpml.org\/<\/a>) where clients can see the multilingual theme\/plugin in action.<\/li>\n<\/ul>\n<ul>\n<li>What you will need:\u00a0Theme\/Plugin version and download link, any required plugins (if applicable), WPML plugin version and necessary WPML add-ons.<\/li>\n<\/ul>\n<ul>\n<li>Essential resources: Links to your documentation or any part of the WPML documentation that might be useful for the client.<\/li>\n<\/ul>\n<ul>\n<li>Content: A list of the points that the documentation will include.<\/li>\n<\/ul>\n<ul>\n<li>Getting started: Explain how to activate and set up the theme along with WPML and its add-ons. It might also be useful to include instructions for importing the demo content or sample data (if applicable).<\/li>\n<\/ul>\n<ul>\n<li>Translate: Detailed steps on how to translate the elements of your theme or your plugin output. For themes, you might want to include the following points:<\/li>\n<\/ul>\n<ol>\n<li>Translating the home page.<\/li>\n<li>Translating other pages, posts, custom post types, and custom taxonomies.<\/li>\n<li>Translating the theme options.<\/li>\n<li>Translating other theme text.<\/li>\n<li>Translating menus.<\/li>\n<li>Translating third-party required plugins (e.g., if you use the Revolution Slider in your theme, you might want to refer to its documentation <a href=\"https:\/\/wpml.org\/documentation\/plugins-compatibility\/creating-multilingual-sliders-with-revolution-slider-and-wpml\/\">here<\/a>).<\/li>\n<\/ol>\n<ul>\n<li>Conclusion: the result that can be achieved from the integration of your theme\/plugin and WPML.<\/li>\n<\/ul>\n<p>You might want to refer to some points in WPML\u2019s documentation:<\/p>\n<ul>\n<li><a href=\"https:\/\/wpml.org\/documentation\/getting-started-guide\/\">Getting Started Guide<\/a><\/li>\n<li><a href=\"https:\/\/wpml.org\/documentation\/getting-started-guide\/language-setup\/\">Language Setup<\/a><\/li>\n<li><a href=\"https:\/\/wpml.org\/documentation\/translating-your-contents\/using-the-translation-editor\/\">Using WPML\u2019s Translation Management<\/a><\/li>\n<li><a href=\"\/?page_id=2717\">Theme and Plugin Localization<\/a><\/li>\n<li><a href=\"https:\/\/wpml.org\/documentation\/getting-started-guide\/string-translation\/\">String Translation<\/a><\/li>\n<li><a href=\"https:\/\/wpml.org\/documentation\/getting-started-guide\/translating-menus\/\">Translating Menus<\/a><\/li>\n<li><a href=\"https:\/\/wpml.org\/documentation\/getting-started-guide\/translating-widgets\/\">Translating Widgets<\/a><\/li>\n<li><a href=\"https:\/\/wpml.org\/documentation\/getting-started-guide\/language-setup\/language-switcher-options\/custom-language-switcher\/\">Custom Language Switcher<\/a><\/li>\n<li><a href=\"https:\/\/wpml.org\/documentation\/getting-started-guide\/translating-page-slugs\/\">Translating URL Slugs<\/a><\/li>\n<\/ul>\n<h2>Documentation examples<\/h2>\n<ul>\n<li>Theme Documentation example (<a href=\"https:\/\/wpml.org\/documentation\/theme-compatibility\/using-wpml-with-the-avada-theme\/\">Using WPML with the AVADA theme<\/a>)<\/li>\n<li>Plugin Documentation example (<a href=\"https:\/\/wpml.org\/documentation\/plugins-compatibility\/creating-multilingual-sliders-with-revolution-slider-and-wpml\/\">Creating multilingual sliders using the Revolution Slider and WPML<\/a>)<\/li>\n<\/ul>\n<h2>Multilingual Tools Plugin<\/h2>\n<p>The Multilingual Tools plugin can help you test the multilingual capabilities of your theme\/plugin. It will automatically add language code or custom notices to translated content, allowing you to review what is working correctly and what requires modification to be translated.<\/p>\n<p>With this tool, you can:<\/p>\n<ul>\n<li>Automatically generate strings for translations.<\/li>\n<li>Add language information to duplicated posts.<\/li>\n<li>Generate a WPML configuration file (wpml-config.xml).<\/li>\n<\/ul>\n<p>See our full documentation of the <a href=\"https:\/\/wpml.org\/documentation\/support\/multilingual-tools\/\">Multilingual Tools Plugin<\/a>.<\/p>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>For a few years now we have been helping authors of plu [&hellip;]<\/p>\n","protected":false},"author":76577,"featured_media":888990,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"ep_exclude_from_search":false,"footnotes":""},"categories":[1371,8],"tags":[],"class_list":["post-880041","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-compatibility","category-tutorials"],"_links":{"self":[{"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/posts\/880041","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/users\/76577"}],"replies":[{"embeddable":true,"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/comments?post=880041"}],"version-history":[{"count":7,"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/posts\/880041\/revisions"}],"predecessor-version":[{"id":917045,"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/posts\/880041\/revisions\/917045"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/media\/888990"}],"wp:attachment":[{"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/media?parent=880041"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/categories?post=880041"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/wpml.org\/zh-hans\/wp-json\/wp\/v2\/tags?post=880041"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}