C-Tags: Custom Component Tags

Warning: We recommend C-Tag use for internal Blackbaud employees only. These tags work with templates that can change causing potentially unexpected changes in variable values.

C-Tags are custom component tags used with customizable components to provide edit, view, preview, and display for TeamRaiser pages.

Note: C-Tags should not be used within other tags that evaluate nested tags, such as E and T. They can be used within a conditional expression.

Format

  • Standard

    [[Cnn:component_label{:parameters}]]

  • XML

    <convio:custom type="nn" customid="component_label" {overrides="parameters"} {title="description"}>

C-Tags are controlled by XML files in the /custom directory. The sub-directories under /custom are named by the application ID of the pages they control.

TeamRaiser

AppID 26

XML file location /custom/26/

Each individual TeamRaiser event has a subdirectory named with the event ID. Changes to the root XML file (For example, fr_info.xml rather than 1001/1001.fr_info.xml) will be inherited by new events created after the change is loaded to production. Existing events will ignore changes to the root XML and must be changed manually.

The following C-tags can be accessed from templates. Unless otherwise noted, the String in each case is a unique identifier for each item defined in an associated Custom Page XML file. Each item will render in editable mode depending on the current view. Administrators and TeamRaiser captains will be able to edit. Others will not.

Tag Purpose Tag Syntax XML Syntax Notes
C0 Content block

[[C0:String]]

Valid values for String are:

  • style_block - Returns the content of the style sheet associated with the page by the user. The style definitions are rendered within a style block.

  • style_link - Returns a link element appropriate for use in the head element.

  • view_help - Returns the template file defined by UserHelpTpt in the associated custom/app_id/*.xml template.

  • edit_help - Returns the template file defined by AdminHelpTpt in the associated custom/app_id/*.xml template.

 

Valid values for String are:

C1 Text field [[C1:field_name]]
\  &lt;Component ctag=&quot;C1:heading&quot;&gt;\ &lt;Default key=&quot;field_size&quot;&gt;50&lt;/Default&gt;\ &lt;Default key=&quot;field_max_length&quot;&gt;128&lt;/Default&gt;\ &lt;Default key=&quot;field_required&quot;&gt;true&lt;/Default&gt;\ &lt;Default key=&quot;field_key&quot;&gt;heading_field&lt;/Default&gt;\ &lt;Default key=&quot;field_bundle&quot;&gt;f2flayouts&lt;/Default&gt;\ &lt;/Component&gt;\
Though this tag has many options, it's best not to change the defaults.
C2 Text area [[C2:String]]    
C3 Combo box (texte field heading input with text area body input) [[C3:String]]    
C4 Graphic [[C4:String]]    
C5 Status indicator [[C5:String]]    
C6 Editable HTML area \ WYSIWYG editor [[C6:editable_area_name]]
\ &lt;Component ctag="C6:editable_area_name"&gt;\ &lt;/Component&gt;\
No particular features. The XML for a specific event will contain the content entered by the client.
C7 Progress bar [[C7:String]]    

TeamRaiser C-Tags

In the TeamRaiser setup process, when you set up the Greeting Page, you can set the Common Text for All TeamRaiser Pages. To pull that code into other TeamRaiser pages, use C-Tags. If you use C-Tags, then you can change event reference information (such as event title, event date/time, location,etc) in one place instead of changing it on every page in the TeamRaiser setup.

Event Title: [[C1:event_title]]

Event Date/Time: [[C1:event_date]]

Event Schedule: [[C1:event_schedule]]

Event State: [[C1:event_location_state]]

Event City: [[C1:event_ location_city]]

Event Location: [[C1:event_location]]

Link to Event Directions: [[C1:map_link]]

Event Coordinator Name: [[C1:coordinator_name]]

Event Coordinator Phone: [[C1: coordinator_phone]]

Event Coordinator Email: [[C1: coordinator_email]]

Sponsor name or image filename (1): [[C1: sponsor_1]]

Sponsor name or image filename (2): [[C1: sponsor_2]]

Sponsor name or image filename (3): [[C1: sponsor_3]]

Sponsor name or image filename (4): [[C1: sponsor_4]]

Sponsor name or image filename (5): [[C1: sponsor_5]]

For example, to insert the chapter president’s name into the greeting page, place the information in the space for Sponsor name, and use [[C1:sponsor_1]] to pull that info in.