[Bps-public-commit] rt-extension-inlinehelp branch master updated. 9319aaeb29b58b19663ea3044a07e5ca38b2e49a

[BPS Git Server]

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-extension-inlinehelp".

The branch, master has been updated
       via  9319aaeb29b58b19663ea3044a07e5ca38b2e49a (commit)
       via  90f53ca4ac8da956411c40405ade61965d075f11 (commit)
       via  041b2119bc16acdf862d1b05ebf10e796384edd4 (commit)
       via  c30156a55b4dc20986cb709165a13faa79006a8b (commit)
       via  b689fb018b406c5b88eb4b3e3d8b304016a69944 (commit)
       via  6af44c7fd5c55257776ac3beec708b18c087124a (commit)
       via  8cd20ce6f8e3a96bc4b4669d54882befffb307fe (commit)
       via  63dd8ac9e44dfa17779803992ef57a869814da71 (commit)
       via  313c89f259e5293bd1231b35fbfd0e49f60406e9 (commit)
       via  f6b3841b575a63696a1c410a90cfedc5001e81e6 (commit)
       via  3e2b2d9e686df537df3425172eedc0478e7fdf5e (commit)
       via  9606bd44aa6494655a5aa8234aca1a5b62027170 (commit)
       via  a42eb79259eb75d655147988573425eb5b077437 (commit)
       via  5824094198a312295c79146b213eb34d434391b0 (commit)
       via  408065710cecb4f484208884b474d7a775a5ac01 (commit)
      from  fc3ad68af85dd85cface9d5b6239aac23d5ded5b (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 9319aaeb29b58b19663ea3044a07e5ca38b2e49a
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Fri Oct 29 14:00:15 2021 -0400

    Add some Target examples

diff --git a/README b/README
index c55b08d..2160d23 100644
--- a/README
+++ b/README
@@ -102,10 +102,29 @@ REFERENCE
     *   "JavaScript"
 
   Target Selector
-    With this approach, you won't need to write any Mason/HTML/JS code, all
-    you need to do is to specify the elements(using jQuery selector syntax)
-    in aritlces' Target custom field, and the inline help will show up
-    automatically.
+    With this approach, you don't need to write any Mason/HTML/JS code and
+    you can add new help topics by adding or updating articles via the RT
+    web UI. Articles in the Inline Help class will have a custom field
+    called Target applied to them. To add inline help to some element in RT,
+    specify the HTML elements of that element in the Target field, using
+    jQuery selector syntax. jQuery is very flexible, so you can use many
+    elements in the DOM to target elements including ids, classes, and even
+    text. Once you get the selector to match, the content of that article
+    will show up in the web UI on that location.
+
+   Examples
+    Below are some examples of the Target value you would use to add help
+    text to different parts of RT.
+
+    "Search" in the main top menu
+        Target: #search
+
+    Ticket display page, Status label
+        Target: div.form-row.status div.label
+
+    RT at a glance, Unowned tickets portlet
+        Target: .titlebox .titlebox-title span.left
+        a[href^="/Search/Results.html"]:contains("newest unowned tickets")
 
   Mason Templates
     Add a /Elements/PopupHelp component anywhere in a Mason template:
diff --git a/lib/RT/Extension/InlineHelp.pm b/lib/RT/Extension/InlineHelp.pm
index 11f77fe..0fb74ab 100644
--- a/lib/RT/Extension/InlineHelp.pm
+++ b/lib/RT/Extension/InlineHelp.pm
@@ -239,10 +239,36 @@ L</JavaScript>
 
 =head2 Target Selector
 
-With this approach, you won't need to write any Mason/HTML/JS code, all you
-need to do is to specify the elements(using jQuery selector syntax) in
-aritlces' C<Target> custom field, and the inline help will show up
-automatically.
+With this approach, you don't need to write any Mason/HTML/JS code and
+you can add new help topics by adding or updating articles via the RT web UI.
+Articles in the Inline Help class will have a custom field called Target
+applied to them. To add inline help to some element in RT, specify
+the HTML elements of that element in the Target field, using jQuery
+selector syntax. jQuery is very flexible, so you can use many elements
+in the DOM to target elements including ids, classes, and even text.
+Once you get the selector to match, the content of that article will
+show up in the web UI on that location.
+
+=head3 Examples
+
+Below are some examples of the Target value you would use to add
+help text to different parts of RT.
+
+=over
+
+=item "Search" in the main top menu
+
+Target: C<#search>
+
+=item Ticket display page, Status label
+
+Target: C<div.form-row.status div.label>
+
+=item RT at a glance, Unowned tickets portlet
+
+Target: C<.titlebox .titlebox-title span.left a[href^="/Search/Results.html"]:contains("newest unowned tickets")>
+
+=back
 
 =head2 Mason Templates
 
commit 90f53ca4ac8da956411c40405ade61965d075f11
Merge: fc3ad68 041b211
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Fri Oct 29 13:27:54 2021 -0400

    Merge branch 'target-selector'

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

Summary of changes:
 README                                             | 173 +++++++------------
 etc/initialdata                                    |  53 ++++++
 .../RT-Extensio-InlineHelp/Elements/Footer/Default |   4 +
 .../Elements/JavascriptConfig/Data                 |  29 ++++
 html/Elements/PopupHelp                            |   4 +-
 html/Helpers/HelpTopic                             |   4 +-
 lib/RT/Extension/InlineHelp.pm                     | 186 +++++++++------------
 static/css/inlinehelp.css                          |   4 +
 static/js/inlinehelp.js                            | 155 ++++-------------
 9 files changed, 259 insertions(+), 353 deletions(-)
 create mode 100644 html/Callbacks/RT-Extensio-InlineHelp/Elements/JavascriptConfig/Data


hooks/post-receive
-- 
rt-extension-inlinehelp