org.zkoss.zk.ui.sys.SEORenderer.class"

From Documentation
(Created page with "{{ZKConfigurationReferencePageHeader}} '''Preference:''' org.zkoss.zk.ui.sys.SEORenderer.class Default: ''none'' [since 5.0.6] It specifies the class name of the applicati...")
 
Line 7: Line 7:
 
  [since 5.0.6]
 
  [since 5.0.6]
  
It  specifies the class name of the application-specific renderer. It must implement <javadoc type="interface">org.zkoss.zk.ui.sys.SEORenderer</javadoc>.
+
It  specifies the class name of the application-specific SEO renderer. A SEO renderer is used to generate application-specific SEO content that will be indexed by the search engine, but not visible to the end users.
 +
 
 +
Notice that the class must implement <javadoc type="interface">org.zkoss.zk.ui.sys.SEORenderer</javadoc>.  <javadoc type="interface" method="render(org.zkoss.zk.ui.Page, java.io.Writer)">org.zkoss.zk.ui.sys.SEORenderer</javadoc> will be invoked each time the main page of a desktop has been rendered and sent to the client<ref>It also means it won't be called in AU requests.</ref>.
  
 
For example, assume you have an implementation called <code>foo.MySEORenderer</code>, then
 
For example, assume you have an implementation called <code>foo.MySEORenderer</code>, then
Line 17: Line 19:
 
     <value>foo.MySEORenderer</value>
 
     <value>foo.MySEORenderer</value>
 
</preference>
 
</preference>
</source>=Version History=
+
</source>
 +
 
 +
Also notice that, if specified, this class will be instantiated and invoked even if [[ZK Configuration Reference/zk.xml/The system-config Element/The crawlable Element|the crawlable option]] is not enabled.
 +
 
 +
<blockquote>
 +
----
 +
<references/>
 +
</blockquote>
 +
 
 +
=Version History=
 
{{LastUpdated}}
 
{{LastUpdated}}
 
{| border='1px' | width="100%"
 
{| border='1px' | width="100%"

Revision as of 10:59, 21 February 2011


org.zkoss.zk.ui.sys.SEORenderer.class


Preference:

org.zkoss.zk.ui.sys.SEORenderer.class
Default: none
[since 5.0.6]

It specifies the class name of the application-specific SEO renderer. A SEO renderer is used to generate application-specific SEO content that will be indexed by the search engine, but not visible to the end users.

Notice that the class must implement SEORenderer. SEORenderer.render(Page, Writer) will be invoked each time the main page of a desktop has been rendered and sent to the client[1].

For example, assume you have an implementation called foo.MySEORenderer, then

<!-- in WEB-INF/zk.xml -->
<preference>
    <name>org.zkoss.zk.ui.sys.SEORenderer.class</name>
    <value>foo.MySEORenderer</value>
</preference>

Also notice that, if specified, this class will be instantiated and invoked even if the crawlable option is not enabled.


  1. It also means it won't be called in AU requests.

Version History

Last Update : 2011/02/21


Version Date Content
5.0.6 Feburary, 2011 Introduced



Last Update : 2011/02/21

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.