[MIG] website_snippet_filter_views: migration to 17.0

Author: petrus-v

website_snippet_filter_views/README.rst

@@ -28,16 +28,29 @@ Website Snippet Filter Views
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-This module add Website > Configuration > Dynamic snippet > Snippet
-filter and Website > Configuration Dynamic snippet > Snippet filter
-template menus to let website designer to configure dynamic snippets
-(like the dynamic carousel) in website.
+This module expose following menus
+
+- Website > Configuration > Dynamic snippet > Snippet filter
+- Website > Configuration Dynamic snippet > Snippet filter template
+
+This let website designer to configure dynamic snippets (like the
+dynamic carousel used to display latests blog posts) in website.
 
 **Table of contents**
 
 .. contents::
    :local:
 
+Usage
+=====
+
+- Create a shared filter on any model you want to display on website
+- Create or reuse a tempalte filter
+- Create a snippet filter that use your previous shared filter with
+  field mappings
+- Use dynamic snippet using your new snippet filters and templates
+- Make sure model access right/rules are properly configured
+
 Bug Tracker
 ===========
 

website_snippet_filter_views/__manifest__.py

@@ -3,7 +3,7 @@
 {
     "name": "Website Snippet Filter Views",
     "summary": "Add website.snippet.filter backend views",
-    "version": "14.0.1.0.0",
+    "version": "17.0.1.0.0",
     "category": "Website",
     "website": "https://github.com/OCA/website",
     "author": "Pierre Verkest <[email protected]>, "

website_snippet_filter_views/readme/DESCRIPTION.md

@@ -1,4 +1,8 @@
-This module add Website \> Configuration \> Dynamic snippet \> Snippet
-filter and Website \> Configuration Dynamic snippet \> Snippet filter
-template menus to let website designer to configure dynamic snippets
-(like the dynamic carousel) in website.
+This module expose following menus
+* Website > Configuration > Dynamic snippet > Snippet filter
+* Website > Configuration Dynamic snippet > Snippet filter template 
+
+
+This let website designer to configure dynamic snippets
+(like the dynamic carousel used to display latests blog posts)
+in website.

website_snippet_filter_views/readme/USAGE.md

@@ -0,0 +1,6 @@
+* Create a shared filter on any model you want to display
+   on website
+* Create or reuse a tempalte filter
+* Create a snippet filter that use your previous shared filter with field mappings
+* Use dynamic snippet using your new snippet filters and templates
+* Make sure model access right/rules are properly configured

website_snippet_filter_views/readme/USEAGE.rst

@@ -370,46 +370,61 @@ <h1 class="title">Website Snippet Filter Views</h1>
 !! source digest: sha256:d173bc20e11e5303357f68ba060bf755c485d1f2748725c8c0106c61c1de1b63
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/website/tree/17.0/website_snippet_filter_views"><img alt="OCA/website" src="https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/website-17-0/website-17-0-website_snippet_filter_views"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/website&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
-<p>This module add Website &gt; Configuration &gt; Dynamic snippet &gt; Snippet
-filter and Website &gt; Configuration Dynamic snippet &gt; Snippet filter
-template menus to let website designer to configure dynamic snippets
-(like the dynamic carousel) in website.</p>
+<p>This module expose following menus</p>
+<ul class="simple">
+<li>Website &gt; Configuration &gt; Dynamic snippet &gt; Snippet filter</li>
+<li>Website &gt; Configuration Dynamic snippet &gt; Snippet filter template</li>
+</ul>
+<p>This let website designer to configure dynamic snippets (like the
+dynamic carousel used to display latests blog posts) in website.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-1">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-2">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-3">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-4">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-5">Maintainers</a></li>
+<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
+<div class="section" id="usage">
+<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
+<ul class="simple">
+<li>Create a shared filter on any model you want to display on website</li>
+<li>Create or reuse a tempalte filter</li>
+<li>Create a snippet filter that use your previous shared filter with
+field mappings</li>
+<li>Use dynamic snippet using your new snippet filters and templates</li>
+<li>Make sure model access right/rules are properly configured</li>
+</ul>
+</div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/website/issues">GitHub Issues</a>.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/OCA/website/issues/new?body=module:%20website_snippet_filter_views%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h1><a class="toc-backref" href="#toc-entry-2">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-3">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
 <ul class="simple">
 <li>Pierre Verkest &lt;<a class="reference external" href="mailto:pierreverkest84&#64;gmail.com">pierreverkest84&#64;gmail.com</a>&gt;</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-4">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
 <ul class="simple">
 <li>Pierre Verkest &lt;<a class="reference external" href="mailto:pierreverkest84&#64;gmail.com">pierreverkest84&#64;gmail.com</a>&gt;</li>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org">
 <img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />

website_snippet_filter_views/static/description/index.html

@@ -70,7 +70,7 @@
         <field name="name">Snippet filter</field>
         <field name="model">website.snippet.filter</field>
         <field name="arch" type="xml">
-            <tree string="Snippet filter">
+            <tree>
                 <field name="name" />
                 <field name="filter_id" />
                 <field name="website_id" />

website_snippet_filter_views/views/snippet_filter.xml

@@ -13,10 +13,12 @@
         <field name="inherit_id" ref="base.view_view_form" />
         <field name="priority">75</field>
         <field name="arch" type="xml">
-            <field name="key" position="before">
+            <field name="website_id" position="after">
                 <div class="alert alert-warning" role="alert" colspan="2">
-                    To be availaible as dynamic snippet template key  value
-                    must contains <b>'.dynamic_filter_template_'</b>.
+                    To be available as dynamic snippet template key  value
+                    must contains <b>'.dynamic_filter_template_&lt;model_name&gt;_'</b>.
+                    <br />
+                    Where &lt;model_name&gt; is the technical model name (with underscores).
                 </div>
             </field>
         </field>
@@ -44,7 +46,9 @@
               Snippet filter template are used by dynamic snippet to render
               any object field on the website.
 
-              view key name must contains '.dynamic_filter_template_'
+              view key name must contains '.dynamic_filter_template_&lt;model_name&gt;_'
+
+              where &lt;model_name&gt; is the technical name of the model (with underscores)
           </p>
         </field>
     </record>