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 2006/10/04 08:28:24 UTC
svn commit: r452758 - in /myfaces/tobago/trunk/src/site: apt/demo.apt
apt/download.apt apt/roadmap.apt apt/themes.apt fml/faq.fml
Author: idus
Date: Tue Oct 3 23:28:23 2006
New Revision: 452758
URL: http://svn.apache.org/viewvc?view=rev&rev=452758
Log:
tried to improve the documentation
Modified:
myfaces/tobago/trunk/src/site/apt/demo.apt
myfaces/tobago/trunk/src/site/apt/download.apt
myfaces/tobago/trunk/src/site/apt/roadmap.apt
myfaces/tobago/trunk/src/site/apt/themes.apt
myfaces/tobago/trunk/src/site/fml/faq.fml
Modified: myfaces/tobago/trunk/src/site/apt/demo.apt
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/src/site/apt/demo.apt?view=diff&rev=452758&r1=452757&r2=452758
==============================================================================
--- myfaces/tobago/trunk/src/site/apt/demo.apt (original)
+++ myfaces/tobago/trunk/src/site/apt/demo.apt Tue Oct 3 23:28:23 2006
@@ -6,4 +6,4 @@
A life demo can be found at: {{http://tobago.atanion.net/tobago-example-demo/}}
- The current snapshot of the demo war can downloaded at: {{http://people.apache.org/repo/m2-snapshot-repository/org/apache/myfaces/tobago/tobago-example-demo/}}
\ No newline at end of file
+ The current snapshot of the demo war can be downloaded at: {{http://people.apache.org/repo/m2-snapshot-repository/org/apache/myfaces/tobago/tobago-example-demo/}}
\ No newline at end of file
Modified: myfaces/tobago/trunk/src/site/apt/download.apt
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/src/site/apt/download.apt?view=diff&rev=452758&r1=452757&r2=452758
==============================================================================
--- myfaces/tobago/trunk/src/site/apt/download.apt (original)
+++ myfaces/tobago/trunk/src/site/apt/download.apt Tue Oct 3 23:28:23 2006
@@ -5,7 +5,7 @@
Download MyFaces Tobago
- Use the links below to download a distribution of Apache MyFaces from
+ Use the links below to download a distribution of MyFaces Tobago from
one of our mirrors. It is good practice to verify the integrity of the
distribution files.
@@ -13,7 +13,7 @@
hours to reach all mirrors.
Apache MyFaces Tobago is distributed as a <<<zip>>> archive (for Windows) and
- as a <<<tar.gz>>> archive (for UNIX). The contents are the same. Please note
+ as a <<<tar.gz>>> archive (for UNIX). The content is the same. Please note
that the <<<tar.gz>>> archives contain file names longer than 100 characters and have been
created using GNU tar extensions. Thus they must be untarred with a GNU compatible
version of tar.
@@ -49,19 +49,19 @@
Archive of old releases
Older releases are available in the {{{http://archive.apache.org/dist/myfaces/} archive}}. Those
- releases are only provided as historical artefacts. We strongly
- recommend to not use those releases, but upgrade to the most recent release.
+ releases are only provided as historical artifacts. We strongly
+ recommend not to use those releases, but upgrade to the most recent release.
Verifying checksums
It is essential that you verify the integrity of the downloaded
- files using the PGP and MD5 signatures. MD5 verification ensures the
- file was not corrupted during the download process. PGP verification
+ files using the PGP and MD5 signatures. MD5 verification ensures the
+ file was not corrupted during the download process. PGP verification
ensures that the file came from a certain person.
To verify the MD5 signature on the files, you need to use a program
called <<<md5>>> or <<<md5sum>>>, which is
- included in many unix distributions. It is also available as part of
+ included in many UNIX distributions. It is also available as part of
{{{http://www.gnu.org/software/textutils/textutils.html}GNU Textutils}}.
Windows users can get binary md5 programs from {{{http://www.fourmilab.ch/md5/}here}},
{{{http://www.pc-tools.net/win32/freeware/console/}here}}, or
Modified: myfaces/tobago/trunk/src/site/apt/roadmap.apt
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/src/site/apt/roadmap.apt?view=diff&rev=452758&r1=452757&r2=452758
==============================================================================
--- myfaces/tobago/trunk/src/site/apt/roadmap.apt (original)
+++ myfaces/tobago/trunk/src/site/apt/roadmap.apt Tue Oct 3 23:28:23 2006
@@ -4,4 +4,4 @@
Roadmap
- If you'd like to follow the current progress please check out the {{{http://issues.apache.org/jira/browse/TOBAGO?report=com.atlassian.jira.plugin.system.project:roadmap-panel}jira roadmap.}}
+ If you'd like to follow the current progress please check out the {{{http://issues.apache.org/jira/browse/TOBAGO?report=com.atlassian.jira.plugin.system.project:roadmap-panel}JIRA roadmap.}}
Modified: myfaces/tobago/trunk/src/site/apt/themes.apt
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/src/site/apt/themes.apt?view=diff&rev=452758&r1=452757&r2=452758
==============================================================================
--- myfaces/tobago/trunk/src/site/apt/themes.apt (original)
+++ myfaces/tobago/trunk/src/site/apt/themes.apt Tue Oct 3 23:28:23 2006
@@ -4,46 +4,46 @@
Theme Handling
- You have 2 possibilities:
+ You have two possibilities:
[[1]] For easy development:
- [[a]] Put the theme jar in the classpath
+ [[a]] Put the theme JAR into the classpath
[[b]] Define a ResourceServlet in the <<<web.xml>>>
- and bind it to the url-pattern of the theme-path
+ and bind it to the URL pattern of the theme path
[]
- You can see the use in the {{{http://svn.apache.org/repos/asf/myfaces/tobago/trunk/example/blank/}tobago-example-blank}}
+ You can see an example in {{{http://svn.apache.org/repos/asf/myfaces/tobago/trunk/example/blank/}tobago-example-blank}}
[[1]] For production:
- [[a]] Put the theme jar in the classpath
+ [[a]] Put the theme JAR into the classpath
[[b]] Unpack the resources (no classes and no properties)
- of the theme into the war. You may use the maven-theme-plugin
+ of the theme into the WAR. You can use the maven-theme-plugin to achieve this.
[]
- You can see the use in the {{{http://svn.apache.org/repos/asf/myfaces/tobago/trunk/example/demo/}tobago-example-demo}}
+ You can see an example in {{{http://svn.apache.org/repos/asf/myfaces/tobago/trunk/example/demo/}tobago-example-demo}}
[]
Note:
The <<<tobago-theme-\<name\>-\<version\>-THEME.jar>>> is no longer needed.
- You need only the <<<tobago-theme-\<name\>-\<version\>.jar>>>
- So you may remove some tags in the pom, if you are using maven2:
+ You only need the <<<tobago-theme-\<name\>-\<version\>.jar>>>.
+ So you may have to remove some tags in the POM if you are using Maven 2:
+------------------------------------------+
<classifier>THEME</classifier>
<scope>provided</scope>
+------------------------------------------+
- And the <<<\<resource-dir\>>>> in the <<<tobago-config.xml>>> has changed from
+ Additionally the <<<\<resource-dir\>>>> in the <<<tobago-config.xml>>> has changed from
+------------------------------------------+
<resource-dir>tobago</resource-dir>
+------------------------------------------+
- to :
+ to:
+------------------------------------------+
<resource-dir>org/apache/myfaces/tobago/renderkit</resource-dir>
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=452758&r1=452757&r2=452758
==============================================================================
--- myfaces/tobago/trunk/src/site/fml/faq.fml (original)
+++ myfaces/tobago/trunk/src/site/fml/faq.fml Tue Oct 3 23:28:23 2006
@@ -14,7 +14,7 @@
</answer>
</faq>
<faq id="hello-world">
- <question>Where I can find a Hello World example and a list of needed
+ <question>Where can I find a Hello World example and a list of needed
jars?
</question>
<answer>
@@ -35,11 +35,11 @@
</answer>
</faq>
<faq id="tobago/myfaces extension">
- <question>Can I mix Tobago and MyFaces extensions in the same webapp?
+ <question>Can I mix Tobago and MyFaces extensions in the same web application?
</question>
<answer>
- <p>Jsf only supports one renderkit (renderkitId) per page (f:view).
- Because Tobago has it's own renderkitId you can't use any none Tobago
+ <p>JSF only supports one renderkit (renderkitId) per page (f:view).
+ Because Tobago has it's own renderkitId you cannot use any non-Tobago
components that need a renderer.
</p>
</answer>
@@ -48,32 +48,29 @@
<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>
- Fixed means a theme dependent height of one row. (i.e. in speyside
- 20px), in this height all one height high elements find their place
+ 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 needed for some elements
- (like box, sheet and so on...)
+ Using px heights is at your own risk, but somtimes needed for elements like box or sheet.
</p>
<p>
- Alternativly you can give a proportion of elements (thats what you do
- with the * notation).<br/>
- For example rows="1*;2*" gives the first row 1/3 space and 2/3 for the
- second row. This works fine for columns, too.
+ Alternatively you can give elements a proportion with the * notation.<br/>
+ For example rows="1*;2*" gives the first row 1/3 of the available vertical space and the
+ second row 2/3. This works fine for columns, too.
</p>
<p>
- For grouping elements to give them an slightliy different
- layout you can use the tc:panel element (this is interpreted as one
- element), which can have it's own layout for multiple elements inside
+ You can group elements with a tc:panel element. Such a panel is interpreted as one
+ element regarding layout. The panel itself can have its own layout for multiple elements inside
the panel.
</p>
</answer>
</faq>
<faq id="tobago/form">
- <question>Why I don't need a form tag in a normal case in Tobago?</question>
+ <question>Why do I not need a form tag in a normal case in Tobago?</question>
<answer>
<p>The page tag is a form tag. You need a form tag for partial validation of your data.
Please look at the forms example in the
@@ -83,30 +80,30 @@
</faq>
<faq id="tobago/browser">
- <question>Which webbrowser are currently supported by Tobago?</question>
+ <question>Which web browsers are currently supported by Tobago?</question>
<answer>
<p>Firefox 1.5, IE 6 (TODO more details)</p>
</answer>
</faq>
<faq id="tobago/container">
- <question>On which container Tobago was tested?</question>
+ <question>In which containers was Tobago tested?</question>
<answer>
<p>Tomcat 5.5, Websphere 6.0, 6.1, Weblogic 8.1, 9.2. Feel free to post your own experiences.</p>
</answer>
</faq>
<faq id="tiles/sitemesh">
- <question>Can Tobago replace tiles? Can I ignore tiles and sitemesh in the
+ <question>Can Tobago replace tiles? Can I ignore Tiles and Sitemesh in the
favor of Tobago or not?
</question>
<answer>
- <p>Tobago can not replace it. But sometimes you may not need it, when
+ <p>Tobago cannot replace it. But sometimes you may not need it, when
you are using Tobago.
If you want to position and size your components automatically, you
- can do that with a Tobago LayoutManager.
- If you want your header and sidebar rendered without writing dublicate
- code, you may use JSP 2.0 tag files or tiles/sitemesh.
+ can do this with a Tobago LayoutManager.
+ If you want your header and sidebar rendered without writing duplicate
+ code, you may use JSP 2.0 tag files or Tiles/Sitemesh.
</p>
</answer>
</faq>
@@ -114,16 +111,15 @@
<question>How to configure a maven mirror?</question>
<answer>
<p>
- If you want to set a different mirror for some reason, you can use
- your
- settings.xml and add the following lines:
+ If you want to set up a different mirror for some reason, you can use
+ your ~/.m2/settings.xml and add the following lines:
</p>
<source>
<mirrors>
<mirror>
- <id>mirrorID</id>
+ <id>mirror ID</id>
<name>Give it a name</name>
- <url>The url of the mirror</url>
+ <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>
@@ -142,17 +138,17 @@
</answer>
</faq>
<faq id="offline-build">
- <question>How to configure an offline build?</question>
+ <question>How do I configure an offline build?</question>
<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 allready in your local repository:
+ the ones already in your local repository:
</p>
<source>
- <settings>
+ <settings>
<offline/>
</settings>
</source>