S530 List of Champion Funds

Use the S530 Tag to create a list of champion funds. If the current user is a champion, the links go to the champion home page for that fund. If the current user is not a champion, the links go to the pages for the current user and no funds are listed.

Application

Personal Fundraising

How to Enter Using the Content Editor Toolbar

This S-Tag cannot be added using the Content Editor toolbar. Add the S-Tag code to the HTML using the Plain Text View.

Luminate CMS Compatible?

No, this S-Tag cannot be added using the Luminate CMS Content Editor.

Format

• Standard[[S530:champ_cons_id:campaign_id:display_option]]
• XML<convio:session name="530" param="champConsId:campaignId:display_option"/>

Parameters

• champ_cons_id - The champions constituent ID.  If there is none, then the session user is used.
• campaign_id - The campaign ID (fr_id) used to limit the results.  If not supplied (or zero), then all enabled funds across all campaigns are shown for the champion.
• display_option - Optional parameter used to influence the layout of the results.
• list-by-campaign (default option) - Renders a set of lists.  The current Campaign will be listed first, followed by other campaigns.  Each campaign name will be followed by a list of funds in that campaign.
• list - Renders a standard HTML list
• list-include-campaign - Renders a standard HTML list.  The fund name is preceded by the campaign name plus a colon.

Sample Code

User 123 has fund A-100 and B-100 in campaign 100 and fund C-200 in campaign 200.

• If 123 is logged in, the links lead to the champion center.
• If 123 is not logged in, the links lead to the fund page.

  Note: Decide if current campaign should be rendered instead of campaign name when rendering for a campaign.

  [[S530]]

  Renders all funds for the logged in user
  Renders all of 123's funds ONLY if 123 is logged in

  [[S530:123]]

  Renders all of 123's funds.

  [[S530:123:200]]

  Renders only C-200

  [[S530:200]]

  Renders all campaign 200 funds for the logged in user
  Renders C200 ONLY if 123 is logged in

  [[S530:123::list-include-campaign]]

  Renders all of 123's funds with a campaign name prefix:

     * 100: A-100
     * 100: B-100
     * 200: C-200

  [[S530:123:l:ist-by-campaign]]

  Renders all of 123's funds by campaign:

  *100 Funds*
     * A-100
     * B-100

  *200 Funds*
     * C-200

  [[S530:123::list-by-campaign]]

  Renders all of 123's funds by campaign when 200 is the current campaign:

  *200 Funds*
     * C-200

  *100 Funds*
     * A-100
     * B-100

  [[S530:123:100:list-by-campaign]]

  *100 Funds*
     * A-100
     * B-100
  [[S530:123:200:list-by-campaign]]

  Where 200 is not the current campaign

  *200 Funds*
     * C-200

CSS and Template Customization

CSS styles are used as follows for each display type:

• list (default option) - Renders as standard HTML list using <ul> and <li> with <ul> within a div.  The div uses a space-separated list of CSS classes:
• pf-champ-fund-list pf-champ-fund-list-display-list
• list-include-campaign - Renders as standard HTML list using <ul> and <li> with <ul> within a div.  The div will use a space-separated list of CSS classes:
• pf-champ-fund-list pf-champ-fund-list-display-list-include-campaign
• list-by-campaign - Renders as a set of lists.  Each campaign name is a standard HTML <h3>. It also has a standard HTML list using <ul> and <li> enclosed within a div (<div>).  Each div uses a space-separated list of CSS classes:
• pf-champ-fund-list pf-champ-fund-list-display-list-by-campaign

Template customization is possible by updating the following:

• row template

  friendraiser/tributes/component/champion_fund_list_component_row.tpt

• campaign/list container template

  friendraiser/tributes/component/champion_fund_list_component.tpt.