web client: update description of receipt template include library settings

Bug #1705302 reported by Kathy Lussier
10
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Evergreen
Fix Released
Low
Unassigned
3.1
Won't Fix
Low
Unassigned
3.2
Won't Fix
Low
Unassigned
3.3
Won't Fix
Low
Unassigned
3.5
Fix Released
Low
Unassigned

Bug Description

The following settings:

circ.staff_client.receipt.alert_text
circ.staff_client.receipt.event_text
circ.staff_client.receipt.footer_text
circ.staff_client.receipt.header_text
circ.staff_client.receipt.notice_text

contain a description like the one below:

"Text/HTML/Macros to be inserted into receipt templates in place of %INCLUDE(header_text)%"

With the addition of bug 1680110, these settings can now be called in the web client, but the syntax is a bit different. The description should be updated to reflect the new method for including this text:

{{includes.alert_text}}
{{includes.event_text}}
{{includes.footer_text}}
{{includes.header_text}}
{{includes.notice_text}}

Also, receipt templates are now called Print Templates in the web client, and the description should be updated accordingly.

The change should be fairly easy to make, but the question is when we should make the change. Should it only be added to 3.0, when the xul client will be deprecated? Or should it be changed when the xul client is totally removed?

Changed in evergreen:
status: New → Confirmed
importance: Wishlist → Low
Revision history for this message
Terran McCanna (tmccanna) wrote :

I changed the Importance from Wishlist to Low since presenting incorrect information is a bug that will need to be fixed. I think it should be changed beginning with 3.0.

Mike Risher (mrisher)
Changed in evergreen:
assignee: nobody → Mike Risher (mrisher)
Revision history for this message
Mike Risher (mrisher) wrote :
Changed in evergreen:
assignee: Mike Risher (mrisher) → nobody
Kyle Huckins (khuckins)
tags: added: pullrequest
Remington Steed (rjs7)
Changed in evergreen:
milestone: none → 3.4-beta1
Galen Charlton (gmc)
Changed in evergreen:
milestone: 3.4-beta1 → 3.4-beta2
Galen Charlton (gmc)
Changed in evergreen:
milestone: 3.4-beta2 → 3.4.1
Changed in evergreen:
milestone: 3.4.1 → 3.4.2
Revision history for this message
Terran McCanna (tmccanna) wrote :

The New Devs Working Group tested this patch and it does work well, except HTML and Macros no longer work in the web client, so it should just be read 'Text to be inserted into Print Templates in place of ...'

(That issue has been reported at: https://bugs.launchpad.net/evergreen/+bug/1801143 )

tags: added: needsrepatch
Revision history for this message
Mike Risher (mrisher) wrote :

I pushed a branch with the text adjustment. I have not been able to visually confirm my changes are showing up. I'm having difficulties figuring out where the text in question is in the UI. I searched all through the Work station admin section and within "Print Templates" with no luck so far.

https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/mrisher/lp1705302-description-text-update

Revision history for this message
Mike Risher (mrisher) wrote :

Update: Found out how where this text lives and was able to confirm the changes are there. We're good to go!

Changed in evergreen:
milestone: 3.4.2 → 3.4.3
Revision history for this message
Jessica Woolford (jwoolford) wrote :

It looks to me like the description is still referring to the way receipts used to work in XUL. I think it's meant to read this way (for example):

Text to be inserted into Print Templates in place of {{includes.alert_text}}

Revision history for this message
Terran McCanna (tmccanna) wrote :

I can confirm what Jessica reported. The branch in comment 2 fixed the format so it references the curly braces now, but the branch in comment 4 lost that fix and fixed the HTML/Macro part.

Mike, can you please combine the two fixes into a single branch?

Revision history for this message
Mike Risher (mrisher) wrote :

Terran, I just did this. Changes in branches 2 & 4 are both here now:

https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/mrisher/lp1705302-update-template-description

Thanks for pointing this out!

Revision history for this message
Terran McCanna (tmccanna) wrote :
tags: added: signedoff
Changed in evergreen:
milestone: 3.4.3 → 3.4.4
Revision history for this message
Jane Sandberg (sandbergja) wrote :

Committed to master, rel_3_5, and rel_3_4. Thanks, Mike and Terran!

Changed in evergreen:
status: Confirmed → Fix Committed
Changed in evergreen:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.