Improve formatting for recurring contributions in user dashboard #25058

webmaster-cses-org-uk · 2022-11-26T13:56:34Z

Overview

Fixes a few minor issues in the formatting of recurring contribution information on the user dashboard. Intended to close https://lab.civicrm.org/dev/core/-/issues/4005.

Before

Some specific and minor issues with the display of recurring contributions on the user dashboard:

No handling for if (installments == 0), i.e. the recurring contribution is open-ended. Just leaves a blank string which is confusing to users.
No spacing between clauses in 'Terms' - makes difficult to read. Also untranslated strings.
Unnecessary colon after 'Terms' in table header (doesn't match other header cells).

Screenshot below shows issues.

After

The above issues resolved.

"for X instalments" omitted from 'Terms' and "/X" omitted from instalments counter if open-ended (X is blank).
spacing corrected by use of {ts}...{/ts} in Smarty template.
colon removed from table header cell.

Screenshot below shows example.

Technical Details

Minor tweaks to Smarty file to implement these improvements.

Comments

Tested on CiviCRM 5.55.2.

civibot · 2022-11-26T13:56:36Z

(Standard links)

If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

webmaster-cses-org-uk · 2022-11-27T13:59:07Z

OK strange one - got a failed test but nothing to do with the proposed change.

E2E\Core\AssetBuilderTest::testInvalid
GuzzleHttp\Exception\ConnectException: cURL error 28: Operation timed out after 2001 milliseconds with 0 bytes received (see https://curl.haxx.se/libcurl/c/libcurl-errors.html)

Seems to be related to an issue spotted prevously in a19ebbf.

Looks like an intermittent issue. Can't see how to force a rebuild?

seamuslee001 · 2022-11-27T21:22:54Z

Jenkins re test this please

demeritcowboy · 2022-12-02T02:22:11Z

I think I agree with everything here except I'm not sure the meaning of - is clearer. Do you think 1/∞ is too geeky? I suppose it could be a word like {ts}Unlimited{/ts}.

Also can you squash commits?

webmaster-cses-org-uk · 2022-12-05T23:16:16Z

Hi @demeritcowboy thanks for your feedback.

Yes I too deliberated over this somewhat (and arrived at the same conclusion about 1/∞). I'd be happy with "unlimited" or similar - very open to suggestions here.

Let's allow a little longer to see what others think, then I'll make any final changes and squash commits.

webmaster-cses-org-uk · 2022-12-10T23:59:41Z

@demeritcowboy Further to the above comments, I have removed the "/..." completely for open-ended contributions in the same vein as for the "Terms" column. So now an unlimited contribution simply shows the number of payments:

Before:

After:

I have been unable to squash commits. GitHub online doesn't seem to have a facility for this (?) so I tried desktop, but it required me to first sync with the master, then said I can't squash commits because there is a merge commit in the history. I will contact GitHub support.

demeritcowboy · 2022-12-11T01:12:11Z

Yeah I'm not familiar with github desktop - you might need command line. An alternative is:

Create a new branch in your fork by reapplying all your changes to master.
Create a new PR and just link back to this one.
Close this PR.
Your old changes will still be available online as part of this PR.

- "for X instalments" omitted from 'Terms' and "/X" omitted from instalments counter if open-ended (X is blank). - Spacing corrected by use of {ts}...{/ts} in Smarty template. - Colon removed from table header cell.

webmaster-cses-org-uk · 2022-12-17T12:44:51Z

OK commits now squashed successfully.

This is thanks to GitHub support, who kindly provided me with the necessary command line procedure to do this!

demeritcowboy · 2022-12-17T23:47:36Z

templates/CRM/Contribute/Page/UserDashboard.tpl

+                                {ts 1=$recurRows.$id.frequency_interval 2=$recurRows.$id.frequency_unit} every %1 %2{/ts}
+                                {if !empty($recurRows.$id.installments)}
+                                    {ts 1=$recurRows.$id.installments} for %1 installments{/ts}
+                                {/if}


Nice on the rebase.

Just noticing the {ts} - there's been a trend to replace these with something more translation-friendly even though it means more code. When broken up like this and without much context and where part of it is a translatable option value with plurals (e.g. every %1 %2) it's harder to translate. Here's an example:

civicrm-core/templates/CRM/Contribute/Form/Contribution/Confirm.tpl

Lines 101 to 132 in d497396

{if $installments}

{if $frequency_interval > 1}



{ts 1=$frequency_interval 2=$frequency_unit 3=$installments}I want to contribute this amount every %1 %2s for %3 installments.{/ts}



{else}



{ts 1=$frequency_unit 2=$installments}I want to contribute this amount every %1 for %2 installments.{/ts}



{/if}

{else}

{if $frequency_interval > 1}

{if $frequency_unit eq 'day'}

{ts 1=$frequency_interval}I want to contribute this amount every %1 days.{/ts}

{elseif $frequency_unit eq 'week'}

{ts 1=$frequency_interval}I want to contribute this amount every %1 weeks.{/ts}

{elseif $frequency_unit eq 'month'}

{ts 1=$frequency_interval}I want to contribute this amount every %1 months.{/ts}

{elseif $frequency_unit eq 'year'}

{ts 1=$frequency_interval}I want to contribute this amount every %1 years.{/ts}

{/if}

{else}

{if $frequency_unit eq 'day'}

{ts}I want to contribute this amount every day.{/ts}

{elseif $frequency_unit eq 'week'}

{ts}I want to contribute this amount every week.{/ts}

{elseif $frequency_unit eq 'month'}

{ts}I want to contribute this amount every month.{/ts}

{elseif $frequency_unit eq 'year'}

{ts}I want to contribute this amount every year.{/ts}

{/if}

{/if}

civicrm-builder · 2023-01-15T07:26:27Z

Can one of the admins verify this patch?

colemanw · 2023-10-17T14:37:24Z

@webmaster-cses-org-uk thanks for your work on this PR.

Unfortunately it hasn't received attention in nearly a year, and at this point we have a new extension which provides an updated version of the User Dashboard via SearchKit: #27792

If possible, please test out that new extension & give any feedback (or pull-requests, ideally!) to help improve it.

Thanks again.

webmaster-cses-org-uk · 2023-10-29T23:17:21Z

@colemanw Thank you for the updates. Sounds like this will fix the specific issues and design out a load of other legacy things too :)

Could you please advise where / how I can download this extension? Doesn't appear on the CiviCRM Extensions page in the admin area and can't find it on the CiviCRM extensions website? Currently running 5.66.1.

colemanw · 2023-10-30T01:09:39Z

@webmaster-cses-org-uk that extension is actually bundled with CiviCRM itself, but won't be available until 5.68 is released. There will be a beta version available on Nov 1.

civibot bot added the master label Nov 26, 2022

webmaster-cses-org-uk force-pushed the patch-4 branch from af5c671 to ae3883e Compare December 10, 2022 23:55

webmaster-cses-org-uk force-pushed the patch-4 branch from ae3883e to becd3ac Compare December 17, 2022 12:34

Improve formatting for recurring contributions

1adf6cc

- "for X instalments" omitted from 'Terms' and "/X" omitted from instalments counter if open-ended (X is blank). - Spacing corrected by use of {ts}...{/ts} in Smarty template. - Colon removed from table header cell.

webmaster-cses-org-uk force-pushed the patch-4 branch from becd3ac to 1adf6cc Compare December 17, 2022 12:40

demeritcowboy reviewed Dec 17, 2022

View reviewed changes

colemanw closed this Oct 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve formatting for recurring contributions in user dashboard #25058

Improve formatting for recurring contributions in user dashboard #25058

webmaster-cses-org-uk commented Nov 26, 2022 •

edited

civibot bot commented Nov 26, 2022

webmaster-cses-org-uk commented Nov 27, 2022

seamuslee001 commented Nov 27, 2022

demeritcowboy commented Dec 2, 2022

webmaster-cses-org-uk commented Dec 5, 2022

webmaster-cses-org-uk commented Dec 10, 2022

demeritcowboy commented Dec 11, 2022

webmaster-cses-org-uk commented Dec 17, 2022

demeritcowboy Dec 17, 2022

civicrm-builder commented Jan 15, 2023

colemanw commented Oct 17, 2023

webmaster-cses-org-uk commented Oct 29, 2023

colemanw commented Oct 30, 2023

	{if $installments}
	{if $frequency_interval > 1}
	<p>
	<strong>{ts 1=$frequency_interval 2=$frequency_unit 3=$installments}I want to contribute this amount every %1 %2s for %3 installments.{/ts}</strong>
	</p>
	{else}
	<p>
	<strong>{ts 1=$frequency_unit 2=$installments}I want to contribute this amount every %1 for %2 installments.{/ts}</strong>
	</p>
	{/if}
	{else}
	{if $frequency_interval > 1}
	{if $frequency_unit eq 'day'}
	<p><strong>{ts 1=$frequency_interval}I want to contribute this amount every %1 days.{/ts}</strong></p>
	{elseif $frequency_unit eq 'week'}
	<p><strong>{ts 1=$frequency_interval}I want to contribute this amount every %1 weeks.{/ts}</strong></p>
	{elseif $frequency_unit eq 'month'}
	<p><strong>{ts 1=$frequency_interval}I want to contribute this amount every %1 months.{/ts}</strong></p>
	{elseif $frequency_unit eq 'year'}
	<p><strong>{ts 1=$frequency_interval}I want to contribute this amount every %1 years.{/ts}</strong></p>
	{/if}
	{else}
	{if $frequency_unit eq 'day'}
	<p><strong>{ts}I want to contribute this amount every day.{/ts}</strong></p>
	{elseif $frequency_unit eq 'week'}
	<p><strong>{ts}I want to contribute this amount every week.{/ts}</strong></p>
	{elseif $frequency_unit eq 'month'}
	<p><strong>{ts}I want to contribute this amount every month.{/ts}</strong></p>
	{elseif $frequency_unit eq 'year'}
	<p><strong>{ts}I want to contribute this amount every year.{/ts}</strong></p>
	{/if}
	{/if}

Improve formatting for recurring contributions in user dashboard #25058

Improve formatting for recurring contributions in user dashboard #25058

Conversation

webmaster-cses-org-uk commented Nov 26, 2022 • edited

Overview

Before

After

Technical Details

Comments

civibot bot commented Nov 26, 2022

webmaster-cses-org-uk commented Nov 27, 2022

seamuslee001 commented Nov 27, 2022

demeritcowboy commented Dec 2, 2022

webmaster-cses-org-uk commented Dec 5, 2022

webmaster-cses-org-uk commented Dec 10, 2022

demeritcowboy commented Dec 11, 2022

webmaster-cses-org-uk commented Dec 17, 2022

demeritcowboy Dec 17, 2022

Choose a reason for hiding this comment

civicrm-builder commented Jan 15, 2023

colemanw commented Oct 17, 2023

webmaster-cses-org-uk commented Oct 29, 2023

colemanw commented Oct 30, 2023

webmaster-cses-org-uk commented Nov 26, 2022 •

edited