{"id":26014,"date":"2010-01-12T21:00:23","date_gmt":"2010-01-13T01:00:23","guid":{"rendered":"https:\/\/www.bu.edu\/tech\/?page_id=26014"},"modified":"2024-02-08T23:19:47","modified_gmt":"2024-02-09T04:19:47","slug":"directives","status":"publish","type":"page","link":"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/marconi\/directives\/","title":{"rendered":"Marconi Directives List"},"content":{"rendered":"<p>This page contains a list of all generally-available Marconi directives. How these directives are used varies depending on the directive type, standard or special. Standard directives are available to any user; special directives are designed for specific contexts and are included mainly for reference purposes. To see these directives in use, see our <a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/\">Marconi Examples<\/a> section.<\/p>\n<h3>Standard Directives<\/h3>\n<p>A standard directive is used with the basic tag format <strong>&lt;directive action=&#8221;[directive name]&#8221; <\/strong><strong>\/&gt;<\/strong>.<\/p>\n<p style=\"padding-left: 30px;\">Example:<br \/>\n<code> &lt;directive action=\"email\" to=\"fred@flintstone.edu\" \/&gt;<\/code><\/p>\n<p>Depending on the directive, additional parameters may be included in the <a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/marconi\/first\/xml\/\">XML tag<\/a>.<\/p>\n<table border=\"0\">\n<tbody>\n<tr>\n<th>Directive Name<\/th>\n<th>Purpose<\/th>\n<th>Details<\/th>\n<\/tr>\n<tr>\n<td>captcha<\/td>\n<td>Adds a <a href=\"http:\/\/www.captcha.net\/captchas\/\">captcha<\/a> to reduce form spamming.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#captcha\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/captcha\/\">How-to<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#contact-captcha\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>conditional-field<\/td>\n<td>Changes some form values based on form input.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#conditional-field\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#credit-card\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>download-file<\/td>\n<td>Attempts to force a download when the form has finished processing.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#download\">Parameters<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>email<\/td>\n<td>Sends an email to a specified address.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#email\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/send-email\/\">How-to<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#contact\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<p><!--tr>\n\n\n<td>encrpyt<\/td>\n\n\n\n\n<td>Sends a PGP-encrypted email to a specified address.<\/td>\n\n\n\n\n<td>\n\n\n<ul>\n\t\n\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#encrypt\">Parameters<\/a><\/li>\n\n\n\t\n\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/send-email\/#pgp\">How-to<\/a><\/li>\n\n\n\t\n\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#contact-pgp\">Examples<\/a><\/li>\n\n\n<\/ul>\n\n\n<\/td>\n\n\n<\/tr-->\n<tr>\n<td>field<\/td>\n<td>Adds new fields based on user input, <a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/date-time\/\">server time<\/a>, or <a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/profile-info\/\">profile information<\/a>.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#field\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/profile-info\/\">How-to<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#credit-card\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>file<\/td>\n<td>Writes to a file (<a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/templated-file\/\">template-based<\/a> or <a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/spreadsheet\/\">spreadsheet<\/a> output).<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#file\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/templated-file\/\">How-to<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#contact-csv\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>imperius<\/td>\n<td>Displays form validation errors on the original webpage.<\/td>\n<td>\n<ul>\n<li><a href=\"\/tech\/services\/cccs\/websites\/www\/non-wordpress\/start\/telegraph\/how-to\/validation\/#imperius\">How-to<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#imperius\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#contact-imperius\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>match<\/td>\n<td>Checks that two fields&#8217; input matches.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/validation\/#require-match\">How-to<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#match\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#contact-match\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>output<\/td>\n<td>Specifies error and thank you pages.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#output\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#contact-output\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>redirect<\/td>\n<td>Specifies a web page to display after form submission.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#redirect\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#contact\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>redirect-template<\/td>\n<td>Specifies error and thank you pages, but prevents a form from resubmitting if someone refreshes their browser after completing and submitting the form. It is important to use this directive while creating a form for credit card processing.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#redirect-template\">Parameters<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>require<\/td>\n<td>Requires that a field contain content and\/or follow a specific format.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#require\">Parameters<\/a><\/li>\n<li><a href=\"\/tech\/services\/cccs\/websites\/www\/non-wordpress\/start\/telegraph\/how-to\/validation\/\">How-to<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#contact-pgp\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>subscribe<\/td>\n<td>Subscribes an email address to a Majordomo mailing list.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#subscribe\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/majordomo\/#subscribe\">How-to<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>sum<\/td>\n<td>Add, subtract, or multiply numbers to produce a total amount. This directive is great for order forms that need to calculate a total cost.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#sum\">Parameters<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>unset<\/td>\n<td>Prevents a form field&#8217;s contents from displaying in a web browser.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#unset\">Parameters<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>unsubscribe<\/td>\n<td>Unsubscribes an email address from a Majordomo mailing list.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#unsubscribe\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/majordomo\/#unsubscribe\">How-to<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>upload<\/td>\n<td>Uploads a file to the web server.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#upload\">Parameters<\/a><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3>Special Directives<\/h3>\n<p>A special directive is used with a variation of the the basic tag format <strong>&lt;directive special=&#8221;[directive name]&#8221; \/&gt;<\/strong>.<strong> <\/strong>Special directives are created to extend Telegraph functions and solve specialized problems.<\/p>\n<p style=\"padding-left: 30px;\">Example:<br \/>\n<code>&lt;directive special=\"bumc\" \/&gt;<\/code><\/p>\n<table border=\"0\">\n<tbody>\n<tr>\n<th>Directive Name<\/th>\n<th>Description<\/th>\n<th>Details<\/th>\n<th>Notes<\/th>\n<\/tr>\n<tr>\n<td>one-help-only<\/td>\n<td>Used to send data to the One Help database.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#one-help\">Parameters<\/a><\/li>\n<\/ul>\n<\/td>\n<td>Used by forms that output to One Help.<\/td>\n<\/tr>\n<tr>\n<td>bumc<\/td>\n<td>Used by Telegraph forms on the <a href=\"http:\/\/www.bumc.bu.edu\/\">BUMC web server<\/a>.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#bumc\">Parameters<\/a><\/li>\n<\/ul>\n<\/td>\n<td>Used by some forms on <a href=\"http:\/\/www.bumc.bu.edu\/\">BUMC<\/a> WordPress sites. Existing forms should be converted to use the <a href=\"\/tech\/services\/cccs\/websites\/www\/non-wordpress\/start\/telegraph\/directives\/\">standard Telegraph directives<\/a> or <a href=\"\/tech\/services\/cccs\/websites\/www\/wordpress\/how-to\/create-online-forms\/\">Gravity Forms<\/a>.<\/td>\n<\/tr>\n<tr>\n<td>nelnet<\/td>\n<td>Used to send credit card data to the Nelnet online system for processing.<\/td>\n<td>\n<ul>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/how-to\/parameters\/#nelnet\">Parameters<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/credit-cards\/\">How-to<\/a><\/li>\n<li><a href=\"https:\/\/www.bu.edu\/tech\/services\/cccs\/websites\/www\/non-wordpress\/telegraph\/examples\/#credit-card\">Examples<\/a><\/li>\n<\/ul>\n<\/td>\n<td>Requires special setup and financial training by the <a href=\"mailto:cashier@bu.edu\">Cashier&#8217;s Office<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>Additional special directives can be created for a specific department or function; however, only the special directives listed above are available for general use.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>This page contains a list of all generally-available Marconi directives. How these directives are used varies depending on the directive type, standard or special. Standard directives are available to any user; special directives are designed for specific contexts and are included mainly for reference purposes. To see these directives in use, see our Marconi Examples&#8230;<\/p>\n","protected":false},"author":1282,"featured_media":0,"parent":26049,"menu_order":3,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/www.bu.edu\/tech\/wp-json\/wp\/v2\/pages\/26014"}],"collection":[{"href":"https:\/\/www.bu.edu\/tech\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.bu.edu\/tech\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.bu.edu\/tech\/wp-json\/wp\/v2\/users\/1282"}],"replies":[{"embeddable":true,"href":"https:\/\/www.bu.edu\/tech\/wp-json\/wp\/v2\/comments?post=26014"}],"version-history":[{"count":50,"href":"https:\/\/www.bu.edu\/tech\/wp-json\/wp\/v2\/pages\/26014\/revisions"}],"predecessor-version":[{"id":150352,"href":"https:\/\/www.bu.edu\/tech\/wp-json\/wp\/v2\/pages\/26014\/revisions\/150352"}],"up":[{"embeddable":true,"href":"https:\/\/www.bu.edu\/tech\/wp-json\/wp\/v2\/pages\/26049"}],"wp:attachment":[{"href":"https:\/\/www.bu.edu\/tech\/wp-json\/wp\/v2\/media?parent=26014"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}