[Rt-commit] rt branch 5.0/query-builder-doc-update created. rt-5.0.3-247-g1e7e642b72

BPS Git Server git at git.bestpractical.com
Fri Feb 17 21:06:43 UTC 2023


This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "rt".

The branch, 5.0/query-builder-doc-update has been created
        at  1e7e642b721ccf8a0fcdf2a39523cd379b5ddfb3 (commit)

- Log -----------------------------------------------------------------
commit 1e7e642b721ccf8a0fcdf2a39523cd379b5ddfb3
Author: Ronaldo Richieri <ronaldo at bestpractical.com>
Date:   Fri Feb 17 18:04:27 2023 -0300

    Update Query Builder documentation with Dynamic Filtering and Sorting
    
    Includes in Query Builder documentation the new features of Dynamic
    Filtering and Sorting, with a few images to ilustrate the news features.
    
    Also replaced the old images of the search results with the new ones
    where new arrows and filters appears.

diff --git a/docs/images/query-builder-dynamic-filter-priority.png b/docs/images/query-builder-dynamic-filter-priority.png
new file mode 100644
index 0000000000..18a460343b
Binary files /dev/null and b/docs/images/query-builder-dynamic-filter-priority.png differ
diff --git a/docs/images/query-builder-dynamic-filter-results.png b/docs/images/query-builder-dynamic-filter-results.png
new file mode 100644
index 0000000000..98ff0b74a1
Binary files /dev/null and b/docs/images/query-builder-dynamic-filter-results.png differ
diff --git a/docs/images/query-builder-dynamic-sort-combined.png b/docs/images/query-builder-dynamic-sort-combined.png
new file mode 100644
index 0000000000..e989e8c30f
Binary files /dev/null and b/docs/images/query-builder-dynamic-sort-combined.png differ
diff --git a/docs/images/query-builder-dynamic-sort.png b/docs/images/query-builder-dynamic-sort.png
new file mode 100644
index 0000000000..9f76c06c1f
Binary files /dev/null and b/docs/images/query-builder-dynamic-sort.png differ
diff --git a/docs/images/search-results.png b/docs/images/search-results.png
index 8387815324..c460d8521c 100644
Binary files a/docs/images/search-results.png and b/docs/images/search-results.png differ
diff --git a/docs/images/with-newline.png b/docs/images/with-newline.png
index 9a9826f4db..ed21d764d9 100644
Binary files a/docs/images/with-newline.png and b/docs/images/with-newline.png differ
diff --git a/docs/images/without-newline.png b/docs/images/without-newline.png
index 8bc7d83e22..9e4284c4d0 100644
Binary files a/docs/images/without-newline.png and b/docs/images/without-newline.png differ
diff --git a/docs/query_builder.pod b/docs/query_builder.pod
index bed320905f..285a5e3c8a 100644
--- a/docs/query_builder.pod
+++ b/docs/query_builder.pod
@@ -82,6 +82,64 @@ src="images/search-results.png">
 
 =for :man [Search Results F<docs/images/search-results.png>]
 
+=head1 Dynamic Filtering and Sorting
+
+Search results can be filtered and sorted dynamically by clicking on the column
+headers.
+
+=head2 Dynamic Filtering
+
+For filtering the results dynamically, click on the filter icon next to the
+column header you want to filter by. For example, if you click on filter icon
+next to the 'Priority' column header, you will see a set of options to filter
+by.
+
+=for html <img alt="Dynamic Filter"
+src="images/query-builder-dynamic-filter-priority.png">
+
+=for :text [Dynamic Filter Results F<docs/images/query-builder-dynamic-filter-priority.png>]
+
+=for :man [Dynamic Filter Results F<docs/images/query-builder-dynamic-filter-priority.png>]
+
+After you select an option, click on the 'Apply' button and the results
+will be updated to show only the tickets with the selected criteria.
+
+=for html <img alt="Dynamic Filter Results"
+src="images/query-builder-dynamic-filter-results.png">
+
+=for :text [Dynamic Filter Results F<docs/images/query-builder-dynamic-filter-results.png>]
+
+=for :man [Dynamic Filter Results F<docs/images/query-builder-dynamic-filter-results.png>]
+
+=head2 Dynamic Sorting
+
+For sorting the results dynamically, click on the column header you want to
+sort by. For example, if you click on the 'Priority' column header, the results
+will be sorted by priority. Clicking on the same column header again will
+reverse the sort order. Clicking on the same column header a third time will
+remove the sort order from that field. A blue arrow will appear next to the
+column header to indicate the sort order (up or down).
+
+=for html <img alt="Dynamic Sort"
+src="images/query-builder-dynamic-sort.png">
+
+=for :text [Dynamic Sort F<docs/images/query-builder-dynamic-sort.png>]
+
+=for :man [Dynamic Sort F<docs/images/query-builder-dynamic-sort.png>]
+
+If your results are already sorted by a particular field, clicking on a second
+field will sort the results by that field, and then by the first field. For
+example, if you sort by 'Priority' and then click on 'Queue', the results
+will be sorted by queue, and then by priority.
+
+=for html <img alt="Dynamic Sort Combined"
+src="images/query-builder-dynamic-sort-combined.png">
+
+=for :text [Dynamic Sort Combined F<docs/images/query-builder-dynamic-sort-combined.png>]
+
+=for :man [Dynamic Sort Combined F<docs/images/query-builder-dynamic-sort-combined.png>]
+
+
 =head1 Customizing Search Result Fields
 
 This is the default view of your results. However, like nearly everything in RT,

-----------------------------------------------------------------------


hooks/post-receive
-- 
rt


More information about the rt-commit mailing list