[Yanel-commits] rev 37920 - in public/yanel/trunk/src/realms/yanel-website/content: . e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/1218580446662

simon at wyona.com simon at wyona.com
Wed Aug 13 00:28:39 CEST 2008


Author: simon
Date: 2008-08-13 00:28:39 +0200 (Wed, 13 Aug 2008)
New Revision: 37920

Added:
   public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/
   public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/
   public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/1218580446662/
   public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/1218580446662/content
   public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/1218580446662/meta
Log:
content of BasicXMLResource documentation added

Added: public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/1218580446662/content
===================================================================
--- public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/1218580446662/content	                        (rev 0)
+++ public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/1218580446662/content	2008-08-12 22:28:39 UTC (rev 37920)
@@ -0,0 +1,36 @@
+<?xml version="1.0"?><html xmlns="http://www.w3.org/1999/xhtml"><head>  <title>BasicXMLResource</title>  <link rel="neutron-introspection" type="application/neutron+xml" href="?yanel.resource.usecase=introspection"/></head><body>  <h1>BasicXMLResource</h1>BasicXMLResource is a base class for resources that generate XML. you can extend this class if you want to develop a resource-type which will proced xml.<br/>It already has implemented a bunch of nice thing which you could like. e.g. XSLT, <a shape="rect" href="i18n.html">i18n</a>, XInclude, ConfigurableViewDescriptor. <br/>At the moment folowing resource-types extending BasicXMLResource: xml, user-mgmt (via ExecutableUsecaseResource).<br/><br/><h2>Resource Configuration Properties:</h2><tt>&lt;yanel:property name=&quot;i18n-catalogue&quot; value=&quot;VALUE&quot;/&gt;</tt> see: <a href="i18n.html">i18n</a><br/><tt>&lt;yanel:property name=&quot;xslt&quot; value=&quot;VALUE&quot;/&gt;</tt><br/><br/><h3>
+</h3><h4>
+</h4><h5>
+</h5>
+<h2> Custom Resource Configuration (ConfigurableViewDescriptor)</h2><br/><table width="561" height="244" cellspacing="0" cellpadding="0" border="1" bgcolor="#dddddd">
+  <tbody><tr>
+    <td>yanel:custom-config</td>
+    <td/><td valign="top"/><td valign="top"/><td valign="top">
+  </td></tr>
+  <tr>
+    <td><br/></td>
+    <td>views</td><td valign="top"/><td valign="top"/><td valign="top">
+  </td></tr><tr><td valign="top"/><td valign="top"/><td valign="top">view</td><td valign="top">id<br/></td><td valign="top">(Attribute) 'default' and 'source' are built in. 
+ A view is accessed through a request parameter <b>yanel.resource.viewid</b></td></tr><tr><td valign="top"/><td valign="top"/><td valign="top"/><td valign="top">mime-type</td><td valign="top">(Element) E.g. text/html, application/xhtml+xml ...</td></tr><tr><td valign="top"/><td valign="top"/><td valign="top"/><td valign="top">xslt</td><td valign="top">(Element) Path to xslt. absolute data-repo path.</td></tr><tr><td valign="top"/><td valign="top"/><td valign="top"/><td valign="top">serializer</td><td valign="top">
+ (Element) If no serializer is specified for a view, the serializer will be chosen depending
+ on the mime-type, whereas the default serializer is XHTML_STRICT<br/>Possible Serializers:<br/>HTML_TRANSITIONAL,TEXT,XHTML_STRICT, XML<br/><br/></td></tr>
+</tbody></table><br/><h3>Example:</h3><tt>&lt;yanel:custom-config&gt;<br/> &lt;views&gt;<br/>  &lt;!-- No parameter needed for getting this view --&gt;<br/>  &lt;view id=&quot;default&quot;&gt;<br/>      &lt;mime-type&gt;text/html&lt;/mime-type&gt;<br/>      &lt;xslt&gt;/xslt/global.xsl&lt;/xslt&gt;<br/>      &lt;serializer key=&quot;HTML_TRANSITIONAL&quot;&gt;<br/>      &lt;/serializer&gt;<br/>  &lt;/view&gt;<br/>  <br/>  &lt;view id=&quot;beautiful&quot;&gt;<br/>      &lt;mime-type&gt;application/xhtml+xml&lt;/mime-type&gt;<br/>      &lt;xslt&gt;/xslt/global.xsl&lt;/xslt&gt;<br/>      &lt;serializer key=&quot;XHTML_STRICT&quot;&gt;<br/>      &lt;/serializer&gt;<br/>  &lt;/view&gt;<br/>  <br/>   &lt;view id=&quot;atom&quot;&gt;<br/>      &lt;mime-type&gt;application/atom+xml&lt;/mime-type&gt;<br/>      &lt;serializer key=&quot;XML&quot;&gt;<br/>      &lt;/serializer&gt;<br/>   &lt;/view&gt;<br/>   <br/>   &lt;view id=&quot;json&quot;&gt;<br/>      &lt;mime-type&gt;applicat!
 ion/json&lt;/mime-type&gt;<br/>      &lt;serializer key=&quot;TEXT&quot;&gt;<br/>      &lt;/serializer&gt;<br/>   &lt;/view&gt;<br/>   <br/>   &lt;!-- Skips any provided XSLT--&gt;<br/>   &lt;view id=&quot;source&quot;&gt;<br/>      &lt;mime-type&gt;application/xhtml+xml&lt;/mime-type&gt;<br/>      &lt;serializer key=&quot;XML&quot;&gt;<br/>      &lt;/serializer&gt;<br/>   &lt;/view&gt;<br/>&lt;/views&gt;<br/>&lt;/yanel:custom-config&gt;</tt><br/><br/>   <h2>XSLT</h2><h3>Built-in XSLT-Properties:</h3><table cellspacing="0" cellpadding="0" border="1" bgcolor="#dddddd">
+  <tbody><tr><th valign="top">Property-name</th><th valign="top">Explanation:</th></tr><tr>
+    <td>yanel.path.name</td>
+    <td><br/></td>
+  </tr>
+  <tr>
+    <td>yanel.path</td>
+    <td>Requested path<br/></td>
+  </tr><tr><td valign="top">yanel.back2context</td><td valign="top">Path prefix for yanel root.<br/></td></tr><tr><td valign="top">yanel.globalHtdocsPath</td><td valign="top">Path prefix for accessing content from globalHtocsPath.</td></tr><tr><td valign="top">yanel.resourcesHtdocsPath</td><td valign="top">Path prefix for accessing content of this resources HtdocsPath.</td></tr><tr><td valign="top">yanel.back2realm</td><td valign="top">Path prefix for realm root.<br/></td></tr><tr><td valign="top">yarep.back2realm<br/></td><td valign="top">(Deprecated) Same as: yanel.back2realm. For backwards compatibility only.<br/></td></tr><tr><td valign="top">os</td><td valign="top">User-agent operating-system</td></tr><tr><td valign="top">client</td><td valign="top">User-agent (At the moment it just shows msie or firefox)</td></tr><tr><td valign="top">language</td><td valign="top">Requested Language</td></tr><tr><td valign="top">content-language</td><td valign="top">language of content!
 </td></tr><tr><td valign="top">username</td><td valign="top">Username of the loged in user.</td></tr><tr><td valign="top">yanel.reservedPrefix</td><td valign="top">Reserved Prefix of yanel (ATM hardcoeded (yanel))</td></tr><tr><td valign="top">yanel.toolbar-status</td><td valign="top">on or off. status of tollbar.</td></tr>
+</tbody></table> <h3>Built-in Schemes:</h3><table cellspacing="0" cellpadding="0" border="1" bgcolor="#dddddd">
+  <tbody><tr>
+    <th>Protocol</th>
+    <th valign="top">Explanation</th><th>Example</th><th valign="top">Source</th>
+  </tr>
+  <tr><td valign="top">http</td><td valign="top">Accessing content proceded by yanel as configured in the requested path resource config. <br/></td><td valign="top">http://.../yanel/myrealm/index.html</td><td valign="top">rc-repo/index.html.yanel-rc <br/></td></tr><tr><td valign="top">yanelresource</td><td valign="top">Accessing content proceded by yanel as configured in the requested path resource config. Allows to bypass HTTP </td><td valign="top">yanelresource:/index.html</td><td valign="top">rc-repo/ index.html.yanel.rc</td></tr><tr><td valign="top">yanelrepo</td><td valign="top">Accessing content in data-repo of curent realm.<br/></td><td valign="top">yanelrepo:/index.html</td><td valign="top"> data-repo/index.html</td></tr><tr><td valign="top">yanelrepo:REALM_ID</td><td valign="top">Accessing content in data-repo of realm test-realm.</td><td valign="top">yanelrepo:test-realm:/index.html</td><td valign="top"> data-repo/index.html</td></tr><tr>
+    <td>yanelrepo:REALM_ID:REPO_ID<br/></td>
+    <td valign="top">Accessing content in repo with id test-repo of realm test-realm.</td><td>yanelrepo:test-realm:test-repo:/index.html</td><td valign="top">test-repo/index.html</td></tr><tr><td valign="top">
+ rthtdocs</td><td valign="top">Accessing resource-type specific content in the resource-types htdocs direcotry<br/></td><td valign="top">
+ rthtdocs:/foo/bar.xml</td><td valign="top">resource-type/htdocs/foo/bar.xml</td></tr><tr><td valign="top">rtyanelhtdocs</td><td valign="top">Accessing yanel specific content in the resource-types yanel-htdocs direcotry</td><td valign="top">rtyanelhtdocs:/foo/bar.xml</td><td valign="top">resource-type/yanel-htdocs/foo/bar.xml</td></tr></tbody></table> </body>
+</html>

Added: public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/1218580446662/meta
===================================================================
--- public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/1218580446662/meta	                        (rev 0)
+++ public/yanel/trunk/src/realms/yanel-website/content/e41b0c5c-4ebc-4ced-8b6c-5946a67fee91.yarep/revisions/1218580446662/meta	2008-08-12 22:28:39 UTC (rev 37920)
@@ -0,0 +1,12 @@
+yarep_revisionComment<string>:updated
+yarep_type<string>:resource
+yarep_isCheckedOut<boolean>:false
+yarep_revisionCreator<string>:lenya
+workflow-date<date>:2008-08-12T23:34:06+0100
+yarep_size<long>:7379
+yarep_checkoutDate<date>:2008-08-12T23:33:30+0100
+yarep_checkoutUserID<string>:lenya
+yarep_lastModifed<long>:1218580446000
+workflow-state<string>:draft
+yarep_checkinDate<date>:2008-08-12T23:28:05+0100
+yarep_revisionCreationDate<date>:2008-08-12T23:34:06+0100



More information about the Yanel-commits mailing list