Listing template tags
From Open-Realty Wiki
Each tag in the template system looks like this {tag_name}. The Following tags are available from the listing templates.
| Tag | Description |
| listingid | Displays the listing ID on the listing view page. |
| headline | Displays all listing fields set to show in the headline area from the listing template editor. |
| featured_listings_vertical | Inserts the featured listings in a vertical layout. |
| featured_listings_horizontal | Inserts the featured listings in a horizontal layout. |
| vtour_button | Places a link to display the listings virtual tours. Link will only display if there is a virtual tour. |
| listing_images | Places the listing images on the page. |
| listing_images_nocaption | Places the listing images on the page without the image captions. |
| top_left | Displays all listing fields set to show in the top left area from the listing template editor. |
| top_right | Displays all listing fields set to show in the top right area from the listing template editor. |
| center | Displays all listing fields set to show in the center area from the listing template editor. |
| feature1 | Displays all listing fields set to show in the feature1 area from the listing template editor. |
| feature2 | Displays all listing fields set to show in the feature2 area from the listing template editor. |
| bottom_left | Displays all listing fields set to show in the bottom left area from the listing template editor. |
| bottom_right | Displays all listing fields set to show in the bottom right area the listing template editor. |
| contact_agent_link | This places a link to "Contact Agent". The link will open a popup window with the contact agent form. |
| contact_agent_link_url | This provides the raw html address for the "Contact Agent". This can be used to create your own link to the Contact agent page using Html. |
| link_calc | This places a link to the calculators. |
| link_calc_url | This provides the raw html address for the calculators. This can be used to create your own link to the calculators using HTML. For example: <a href="{link_calc_url}">Calculator Link</a> (The raw html address does not contain ANY popup, size or other code found in the normal link tag) |
| link_add_favorites | This places a link to allow members to add the listing to there favorites list. |
| link_add_favorites_url | This provides the raw html address for the add to favorites. This can be used to create your own link to add to favorites using HTML. For example: <a href="{link_add_favorites_url}">Add Favorites Link</a> (The raw html address does not contain ANY popup, size or other code found in the normal link tag) |
| link_printer_friendly | This places a link to show the listing in the printer friendly template. |
| link_printer_friendly_url | This provides the raw html address for the printer friendly page. This can be used to create your own link to the printer friendly page using HTML. For example: <a href="{link_printer_friendly_url}">Printer Friendly Link</a> (The raw html address does not contain ANY popup, size or other code found in the normal link tag) |
| link_email_friend | This places a link to allow visitors to email their friends about the listing. |
| link_email_friend_url | This provides the raw html address for the email friend form. This can be used to create your own link to the email friend form using HTML. For example: <a href="{link_email_friend_url}">Email Friend Link</a> (The raw html address does not contain ANY popup, size or other code found in the normal link tag) |
| link_map | This places a link to the map system defined in the site configuration. |
| link_map_url | This provides the raw html address for the map link. This can be used to create your own link to the map using HTML. For example: <a href="{link_map_url}">View Map</a> (The raw html address does not contain ANY popup, size or other code found in the normal link tag) |
| link_yahoo_school | This places a link to the yahoo school information for the listing area. |
| link_yahoo_school_url | This provides the raw html address for the yahoo school information link. This can be used to create your own link to the yahoo school information using HTML. For example: <a href="{link_yahoo_school_url}">View School Information</a> (The raw html address does not contain ANY popup, size or other code found in the normal link tag) |
| link_yahoo_neighborhood | This places a link to the yahoo neighorhood information for the listing area. |
| link_yahoo_neighborhood_url | This provides the raw html address for the yahoo neighborhood information link. This can be used to create your own link to the yahoo neighborhood information using HTML. For example: <a href="{link_yahoo_neighborhood_url}">View Neighborhood Information</a> (The raw html address does not contain ANY popup, size or other code found in the normal link tag) |
| link_edit_listing | This places a link to edit the listing on the listing detail page if the agent is logged in and is the owner of the listing, or if the logged in agent is an admin or has permissions to edit all listings. |
| link_edit_listing_url | This provides the raw html address to the edit listing page on the listing detail page if the agent is logged in and is the owner of the listing, or if the logged in agent is an admin or has permissions to edit all listings. |
| listing_agent_name | This places the listing agent's name. |
| listing_agent_link | This places a link to the listing agent's information |
| listing_agent_listings | The places a link to the search results to view other listings from the listing agent. |
| listing_agent_id | The places the listing agents id on the page. |
| listing_title | This places the listing's title on the page. |
| hitcount | This places the number of time the listing has been viewed. |
| slideshow_images | Places Images into a slideshow. |
| main_image | Places a large main listing image on the page. |
| main_image_nodesc | Places a large main listing image on the page. This version of the tag does not display the image description below the main image. |
| image_thumb_# | Displays a listing's thumbnail image. The number corresponds to the to the image order defined in the listing image editor. |
| raw_image_thumb_# | Same as image_thumb_# except it returns the image url to be used in an image tag. |
| main_image_java | Places the main listing image on the page for the java image switch. |
| main_image_java_nodesc | Places the main listing image on the page for the java image switch. This version of the tag does not display the image description below the main image. |
| listing_images_java | Places the listing images in a vertical column, when clicked, the image will replace the current main image on the page. Requires main_image_java also be on page. |
| listing_images_java_caption | Places the listing images in a vertical column with the image caption below each image, when clicked, the image will replace the current main image on the page. Requires main_image_java also be on page. |
| listing_images_java_rows | Places the listing images in a row, when clicked it the image will replace the current main image on the page. Requires main_image_java also be on page. |
| listing_images_mouseover_java | Places the listing images in a vertical column, when the mouse is over the image, the image will replace the current main image on the page. Requires main_image_java also be on page. |
| listing_images_mouseover_java_caption | Places the listing images in a vertical column with the image caption below each image, when the mouse is over the image, the image will replace the current main image on the page. Requires main_image_java also be on page. |
| listing_images_mouseover_java_rows | Places the listing images in a row, when the mouse is over the image it the image will replace the current main image on the page. Requires main_image_java also be on page. |
| image_full_X | Displays the specified main/full image where X = the number of the order of the main image specified in the image editor. |
| raw_image_full_X | Displays the specified main/full image NAME ONLY, where X = the number of the order of the main image specified in the image editor. |
| image_full_fullurl_X | Displays the specified main/full image URL ONLY, where X = the number of the order of the main image specified in the image editor. |
| listing_field_FIELDNAME | by using the name of a listing field defined in the listing template editor, you can call the individual field and place it on the page. For example to call the "address" field you would insert {listing_field_address} into your template, which would result in both the field caption and value being placed in your template, eg. "Address: 1600 Penn Ave." |
| listing_field_FIELDNAME_value | Works the same listing_field_FIELDNAME, except you only get the field value. eg. "1600 Penn Ave." |
| listing_field_FIELDNAME_caption | Works the same listing_field_FIELDNAME, except you only get the field caption. eg. "Address" |
| listing_field_FIELDNAME_rawvalue | Works the same listing_field_FIELDNAME, except you only get the raw field value. For example when calling the price field instead of getting "$150,000" you would simply get "150000". |
| next_prev | Displays the next - prev options on the Listing Detail page. To use you will need to place the tag on the listing detail template AND turn on "Show NextPrev Bar On Listing Page" in Configuration_listing_settings . WARNING: This will cause a performance hit on sites with large databases that might yield large search results. |
| listing_pclass | Displays the name of the property class the listing is assigned to. In cases where the listing is part of multiple classes it will show a the names separated by a comma. |
| listing_agent_last_name | Displays the listing agent's last name. |
| listing_agent_first_name | Displays the listing agent's first name. |
| listing_agent_thumbnail_# | Displays the listing agent's thumbnail image that is specfied in the # place. Whatever number is specified will display the thumbnail that falls in that order. note: first image is 0, NOT 1 |
| listing_agent_field_FIELDNAME | by using the name of an agent field defined in the user template editor, you can call the individual field and place it on the page. For example to call the "phone" field you would insert {listing_agent_field_phone} into your template, which would result in both the field caption and value being placed in your template, eg. "Phone: 555-1234" |
| listing_agent_field_FIELDNAME_value | Works the same listing_agent_field_FIELDNAME, except you only get the field value. eg. "555-1234" |
| listing_agent_field_FIELDNAME_rawvalue | Works the same listing_agent_field_FIELDNAME, except you only get the raw, unformatted field value. For example when calling the price field instead of getting "$150,000" you would simply get "150000". |
| listing_agent_field_FIELDNAME_caption | Works the same listing_agent_field_FIELDNAME, except you only get the field caption. eg. "Phone" |
| show_vtour | Embeds the VTour on your listing page. This will use the selected VTour template to display the VTour in your listing page. You should use the vtour_tab_block template block around this tag to hide the vtour if there is not a supported vtour uploaded for that listing. |
| fulllink_to_listing | absolute link to the listing instead of the relative link, for use with the RSS Newsfeeds. |
| get_creation_date | Displays the listing's creation date in the configured Open-Realty date format. |
| get_modified_date | Displays the listing's creation date in the configured Open-Realty date format. |
| listing_files_select | Places a simple drop down file selection list onto the template for users to select the file they wish to download. |
| files_listing_vertical | Places the vertical templated listing files list on the template for users to view and select the files they wish to download. |
| files_listing_horizontal | Places the horizontal templated listing files list on the template for users to view and select the files they wish to download. |
| get_featured | Adds "featured" to listing details or search results if listing is featured otherwise does nothing. Useful for CSS templating purposes or just letting people know this is a featured listing. |
| get_featured_raw | Adds "yes" or "no" to the template depending on if the listing is featured or not. Primarily used in CSS for templating purposes. |
| money_sign | Adds the configured money sign to the template. |
| Blocks | |
| All code contained on the template inside a block will be controlled according to the block it is contained inside. This is for template designers to control the display of many fields or code by enclosing it in one simple template tag block. A STARTING block will look like a normal template tag but that block must be closed with {/TEMPLATE_TAG} The following template tags are blocks: | |
| hide_printer_friendly | Hides the content contained inside this block when the printer friendly page is being displayed. You must close this block with /hide_printer_friendly |
| show_printer_friendly | Shows the content contained inside this block when the printer friendly page is being displayed. You must close this block with /show_printer_friendly |
| show_listed_by_admin_block | Creates a block for listed by admin data. Uses the "Show Listedby Link For Admin's Listings" setting in the Configuration_listing_settings . You must close this block with /show_listed_by_admin_block |
| !show_listed_by_admin | Creates a block to be displayed if this is an admin listing and if we have the Show Listedby Admin option disabled. Uses the "Show Listedby Link For Admin's Listings" setting in the Configuration_listing_settings . You must close this block with /!show_listed_by_admin |
| vtour_tab_block | Hides the content contained inside this block if there is no supported vtour uploaded for a listing. This tag is primarily for use on the tabbed template but can be used around the show_vtour tag if embedding a vtour on your listing page. You must close this block with /vtour_tab_block |
| listing_field_FIELDNAME_block | To be placed around listing_field_FIELDNAME tags to prevent display of any code contained inside this block into the template if the field is not to be shown. You must close this block with /listing_field_FIELDNAME_block |
| listing_agent_field_FIELDNAME_block | To be placed around listing_agent_field_FIELDNAME tags to prevent display of any code contained inside this block into the template if the field is not to be shown. You must close this block with /listing_agent_field_FIELDNAME_block |
