The RemoteInclude component allows you to include content from a remote location. A common use of this is to include the header content of an existing site in a new Newzulu Platform powered site.
<fm:RemoteInclude cache="10" src="http://www.google.com/" type="safeHTML" />
This example will embed the HTML of the Google homepage in your template at the location of the RemoteInclude component. Note that we've marked this requested content as being safe HTML as we want to ensure we get valid XHTML in our page no matter what Google may send.
Name | Required | Default | Description |
---|---|---|---|
cache | Required | N/A | Seconds to keep response in cache; use 0 to disable caching. |
displaycode | Optional | This will return HTML/XML as formatted code, works only for type html | |
src | Required | N/A | Complete URL of remote content. |
timeout | Optional | 2 | Seconds to wait for response; if this time passes without a response the request will be considered a failure. |
type | Optional | stl | Type of content being including. Controls how content will be handled before being sent to client.
|
This component defines no template variables.
If the request for remote content fails (ie: timeout period expired) then either an exception will be thrown or the RemoteInclude's inner content will be rendered. It is highly recommended that you always provide inner content to ensure the user gets a reasonable page displayed.
<fm:RemoteInclude cache="10" src="http://www.google.com/" type="safeHTML">
Looks like Google might be down. How that happened, it is a mystery.
</fm:RemoteInclude>