You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by id...@apache.org on 2007/03/05 21:56:55 UTC

svn commit: r514862 - /myfaces/tobago/trunk/src/site/fml/faq.fml

Author: idus
Date: Mon Mar  5 12:56:55 2007
New Revision: 514862

URL: http://svn.apache.org/viewvc?view=rev&rev=514862
Log:
fixed link and made additional minor improvements

Modified:
    myfaces/tobago/trunk/src/site/fml/faq.fml

Modified: myfaces/tobago/trunk/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/src/site/fml/faq.fml?view=diff&rev=514862&r1=514861&r2=514862
==============================================================================
--- myfaces/tobago/trunk/src/site/fml/faq.fml (original)
+++ myfaces/tobago/trunk/src/site/fml/faq.fml Mon Mar  5 12:56:55 2007
@@ -24,11 +24,13 @@
       <question>Documentation or HowTo for using Tobago?</question>
       <answer>
         <p>
-          <a href="http://tobago.atanion.net/tobago-example-demo/faces/mini-howto/intro.jsp">
-            Mini Howto
+          <a href="http://tobago.atanion.net/tobago-example-demo/">Demo</a>
+        </p>
+        <p>
+          <a href="http://tobago.atanion.net/tobago-example-demo/faces/best-practice/intro.jsp">
+            Best Practices
           </a>
         </p>
-        <a href="http://tobago.atanion.net/tobago-example-demo/">Demo</a>
       </answer>
     </faq>
     <faq id="hello-world">
@@ -39,15 +41,13 @@
         <p>
           Please look at
           <a href="http://svn.apache.org/repos/asf/myfaces/tobago/trunk/example/blank/">
-            tobago-example-blank
-          </a>
-           . Or download the myfaces-tobago-example from the
-          <a href="http://people.apache.org/builds/myfaces/nightly/" >nightly build dir.</a>
+            tobago-example-blank</a> or download the myfaces-tobago-example from the
+          <a href="http://people.apache.org/builds/myfaces/nightly/" >nightly builds directory</a>.
         </p>
       </answer>
     </faq>
     <faq id="tobago/RI">
-      <question>Does Tobago run with the Sun RI?</question>
+      <question>Does Tobago run with the Sun reference implementation (RI)?</question>
       <answer>
         <p>Tobago should run with Sun RI and with MyFaces.</p>
       </answer>
@@ -66,13 +66,12 @@
       <question>How do I use GridLayout in Tobago?</question>
       <answer>
         <source>
-   <tc:gridLayout rows="fixed;100px;1*;2*"/>
-        </source>
+  <tc:gridLayout rows="fixed;100px;1*;2*" /></source>
         <p>
           The attribute 'fixed' means a theme dependent height of one row (i.e. in Speyside
           a row is typically 20px high.) In a 'fixed' row all one height unit high elements find their place
           (like buttons, input fields, one row of text...).<br/>
-          Using px heights is at your own risk, but somtimes needed for elements like box or sheet.
+          Using px heights is at your own risk, but it is sometimes needed for elements like box or sheet.
         </p>
         <p>
           Alternatively you can give elements a proportion with the * notation.<br/>
@@ -88,24 +87,24 @@
     </faq>
 
     <faq id="tobago/fileupload">
-      <question>How do I configure fileupload in Tobago?</question>
+      <question>How do I configure file upload in Tobago?</question>
       <answer>
         <p>You have two options.</p>
         <p>Add a TobagoMultipartFormdataFilter to your web.xml.
-          <a href="http://myfaces.apache.org/tobago/apidocs/org/apache/myfaces/tobago/webapp/TobagoMultipartFormdataFilter.html">Javadoc Description</a>
+          <a href="http://myfaces.apache.org/tobago/apidocs/org/apache/myfaces/tobago/webapp/TobagoMultipartFormdataFilter.html">JavaDoc Description</a>
         </p>
         <p>Add the tobago-fileupload.jar to your project.
            The tobago-fileupload.jar contains a FacesContextFactory that wraps the
             multipart-formdata request inside the FacesContext.
-          <a href="http://myfaces.apache.org/tobago/apidocs/org/apache/myfaces/tobago/fileupload/FileUploadFacesContextFactoryImpl.html">Javadoc Description</a>
+          <a href="http://myfaces.apache.org/tobago/apidocs/org/apache/myfaces/tobago/fileupload/FileUploadFacesContextFactoryImpl.html">JavaDoc Description</a>
         </p>
       </answer>
     </faq>
 
     <faq id="tobago/form">
-      <question>Why I don't need a form tag in a normal case in Tobago?</question>
+      <question>Do I need a form tag in a normal Tobago page?</question>
       <answer>
-        <p>The page tag is a form tag. You need a form tag for partial validation of your data.
+        <p>The page tag already acts like a form tag. You only need a explicit form tag for partial validation of your data.
         Please look at the forms example in the
         <a href="http://tobago.atanion.net/tobago-example-demo/faces/overview/form.jsp" >Tobago demo</a>
         </p>
@@ -115,33 +114,33 @@
     <faq id="tobago/browser">
       <question>Which web browsers are currently supported by Tobago?</question>
       <answer>
-        <p>Firefox 1.5, IE 6 (TODO more details)</p>
+        <p>Firefox 2, IE 6 (TODO more details)</p>
       </answer>
     </faq>
 
     <faq id="tobago/owntheme">
-      <question>How to create a own theme?</question>
+      <question>How do I create my own theme?</question>
       <answer>
         <p>
-          Define a new name for the theme in the META-INF/tobago-theme.xml.
+          You have to define a new name for the theme in the META-INF/tobago-theme.xml.
           Choose a fallback theme in the tobago-theme.xml.
           Put the modified resources under the resource-path + theme-name.
-          A example for this is the charlotteville theme.(TODO more details resource handling)
-          Example layout of a theme jar:
+          An example for this is the charlotteville theme. (TODO more details resource handling)
           </p>
+        <p>
+        Example layout of a theme jar:
+        </p>
          <source>
-           /META-INF/tobago-theme.xml
-           (resource-path/html/theme-name)
-           /org/apache/myfaces/tobago/renderkit/html/xxxxx/standard/style/style.css (standard styles)
-           /org/apache/myfaces/tobago/renderkit/html/xxxxx/standard/style/tobago-menu.css (menu styles)
-           /org/apache/myfaces/tobago/renderkit/html/xxxxx/standard/style/tobago-sheet.css (sheet styles)
-           /org/apache/myfaces/tobago/renderkit/html/xxxxx/msie/style/style.css (different styles for msie)
-            </source>
+  /META-INF/tobago-theme.xml
+  (resource-path/html/theme-name)
+  /org/apache/myfaces/tobago/renderkit/html/xxxxx/standard/style/style.css (standard styles)
+  /org/apache/myfaces/tobago/renderkit/html/xxxxx/standard/style/tobago-menu.css (menu styles)
+  /org/apache/myfaces/tobago/renderkit/html/xxxxx/standard/style/tobago-sheet.css (sheet styles)
+  /org/apache/myfaces/tobago/renderkit/html/xxxxx/msie/style/style.css (different styles for msie)</source>
 
-           Property and resource loading and Renderer loading is done in following order
+           Property and resource loading and renderer loading is done in the following order
            <source>
-           resource-path/content-type/theme/client/[tag(for renderer)|property|style|script|image]_locale.(class|property|property.xml|css|js| gif|png...]
-           </source>
+  resource-path/content-type/theme/client/[tag(for renderer)|property|style|script|image]_locale.(class|property|property.xml|css|js| gif|png...]</source>
 
            for example OutRenderer<br/>
 
@@ -149,8 +148,6 @@
 
            OutRenderer is getRendererType() + "Renderer"<br/>
 
-
-
         The locale handling is handled like the Properties Class.<br/>
 
         You have not define everything because the ResourceManager is asking the fallback theme for missing resources<br/>
@@ -171,14 +168,14 @@
     </faq>
 
     <faq id="tobago/custommarkup">
-      <question>How to use and extend the markup attribute?</question>
+      <question>How do I use and extend the markup attribute?</question>
       <answer>
-        <p>UIBox, UIInput and UIOutput supports custom markup with the markup attribute.
+        <p>UIBox, UIInput and UIOutput support custom markup with the markup attribute.
           The supported markup is defined in the tobago-theme.xml.
           The standard markup is defined in tobago-theme.xml of the tobago-theme-standard.
           This can be extended in your own theme.
-          The markup attribute is rendered as a css class tobago- &lt; renderer-name.toLowerCase &gt; -markup- &lt; markup &gt; .
-          For an example please look at the markup number and the css class tobago-in-markup-number for UIInput in theme/scarborough/src/main/resources/org/apache/myfaces/tobago/renderkit/html/scarborough/standard/style/style.css
+          The markup attribute is rendered as a CSS class tobago-[renderer-name.toLowerCase]-markup-[markup].
+          For an example please look at the markup number and the CSS class tobago-in-markup-number for UIInput in theme/scarborough/src/main/resources/org/apache/myfaces/tobago/renderkit/html/scarborough/standard/style/style.css
           </p>
       </answer>
     </faq>
@@ -191,8 +188,8 @@
     </faq>
 
     <faq id="tiles/sitemesh">
-      <question>Can Tobago replace tiles? Can I ignore Tiles and Sitemesh in the
-        favor of Tobago or not?
+      <question>Can Tobago replace tiles? Can I ignore Tiles and Sitemesh in
+        favor of Tobago?
       </question>
       <answer>
         <p>Tobago cannot replace it. But sometimes you may not need it, when
@@ -212,19 +209,18 @@
           your ~/.m2/settings.xml and add the following lines:
         </p>
         <source>
-        <mirrors>
-          <mirror>
-            <id>mirror ID</id>
-            <name>Give it a name</name>
-            <url>The URL of the mirror</url>
-            <mirrorOf>The server ID of the repository being mirrored. 
-              This must not match the mirror ID</mirrorOf>
-          </mirror>
-        </mirrors>
-         </source>
+  <mirrors>
+    <mirror>
+      <id>mirror ID</id>
+      <name>Give it a name</name>
+      <url>The URL of the mirror</url>
+      <mirrorOf>The server ID of the repository being mirrored.
+        This must not match the mirror ID</mirrorOf>
+    </mirror>
+  </mirrors></source>
         <p>See:
           <a href="http://maven.apache.org/guides/mini/guide-mirror-settings.html">
-            Guide mirror settings
+            Guide to mirror settings
           </a>
         </p>
         <p>Mirrors:
@@ -239,18 +235,14 @@
       <answer>
         <p>
           If you run into problems with fetching jars from the online
-          repository,
-          in the settings.xml you can configure maven not to fetch them but to
-          use
-          the ones already in your local repository:
+          repository, you can configure Maven not to fetch them but use
+          the ones already in your local repository by adding the following to your ~/.m2/settings.xml:
         </p>
         <source>
-       <settings>
-          <offline/>
-        </settings>
-        </source>
-        <p>or use the mvn -o switch</p>
-
+  <settings>
+    <offline/>
+  </settings></source>
+        <p>or use the mvn -o switch.</p>
       </answer>
     </faq>
   </part>