You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by ed...@apache.org on 2006/02/28 14:14:37 UTC
svn commit: r381650 - in /incubator/tuscany/site: src/site/xdoc/ target/site/
Author: edwardsmj
Date: Tue Feb 28 05:14:32 2006
New Revision: 381650
URL: http://svn.apache.org/viewcvs?rev=381650&view=rev
Log:
Updated the description of how to create the website
Modified:
incubator/tuscany/site/src/site/xdoc/howtobuildsite.xml
incubator/tuscany/site/target/site/SCA_Java_Tools_documentation.html
incubator/tuscany/site/target/site/architecture.html
incubator/tuscany/site/target/site/bugs.html
incubator/tuscany/site/target/site/dependencies.html
incubator/tuscany/site/target/site/documentation.html
incubator/tuscany/site/target/site/documentationdasjava.html
incubator/tuscany/site/target/site/documentationscacpp.html
incubator/tuscany/site/target/site/documentationscajava.html
incubator/tuscany/site/target/site/documentationsdocpp.html
incubator/tuscany/site/target/site/documentationsdojava.html
incubator/tuscany/site/target/site/download.html
incubator/tuscany/site/target/site/faq.html
incubator/tuscany/site/target/site/getinvolved.html
incubator/tuscany/site/target/site/howtobuildsite.html
incubator/tuscany/site/target/site/index.html
incubator/tuscany/site/target/site/installcpp.html
incubator/tuscany/site/target/site/installjava.html
incubator/tuscany/site/target/site/integration.html
incubator/tuscany/site/target/site/issue-tracking.html
incubator/tuscany/site/target/site/license.html
incubator/tuscany/site/target/site/mail-lists.html
incubator/tuscany/site/target/site/maven-reports.html
incubator/tuscany/site/target/site/navigation.html
incubator/tuscany/site/target/site/news.html
incubator/tuscany/site/target/site/phpproject.html
incubator/tuscany/site/target/site/project-info.html
incubator/tuscany/site/target/site/reference.html
incubator/tuscany/site/target/site/releasescpp.html
incubator/tuscany/site/target/site/releasesdasjava.html
incubator/tuscany/site/target/site/releasesscajava.html
incubator/tuscany/site/target/site/releasessdojava.html
incubator/tuscany/site/target/site/requirements.html
incubator/tuscany/site/target/site/source-repository.html
incubator/tuscany/site/target/site/svn.html
incubator/tuscany/site/target/site/team-list.html
incubator/tuscany/site/target/site/userguidecpp.html
incubator/tuscany/site/target/site/userguidejava.html
incubator/tuscany/site/target/site/wiki.html
Modified: incubator/tuscany/site/src/site/xdoc/howtobuildsite.xml
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/src/site/xdoc/howtobuildsite.xml?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/src/site/xdoc/howtobuildsite.xml (original)
+++ incubator/tuscany/site/src/site/xdoc/howtobuildsite.xml Tue Feb 28 05:14:32 2006
@@ -14,74 +14,128 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<document url="howtobuildsite.xml"><properties> <author email="mgmarum@us.ibm.com">Matthew Marum</author> <title>Apache Tuscany - How To Build Site</title></properties><body>
- <section name="Maven Site Generation Overview">
-<p>Maven provides the capability of developing a default website for a project using only the information specified in project.xml. It includes information about the dependancies listed for the project, also any mailing lists, SCM information, and project contributors, etc. It is possible to override and/or extend the default site and customize the generated content through the use of xdocs, HTML, and other resources.</p>
-
-<p>For example, if you wanted to add a news section that had a link to a PDF. Say that you also wanted to add the News section to the main menu, you would need to do the following.</p>
-
-
-<p>In xdocs/navigation.xml, You can add the "News" item to the "Tuscany" menu.</p>
-
-<pre>
-...
-<menu name="Tuscany">
- ...
- <item name="News" href="news.html" />
-</menu>
-...
-</pre>
-Create xdocs/news.xml, similar to the one below.
-<pre>
-<document url="news.xml">
-<properties>
- <author email="mike_edwards@uk.ibm.com">Mike Edwards</author>
- <title>Apache Tuscany - News</title>
-</properties>
-<body>
- <section name="Tuscany News">
-
-Welcome to the news section. Please, review the <a href="tuscany.pdf">Tuscany PDF</a>.
-
- </section>
-</body>
-</document>
-</pre>
-<p>Then drop "tuscany.pdf" into the same directory as news.xml. When you run the maven site generation the PDF will get copied over and the link will be preserved in the news.html generated from news.xml.</p>
-<p>NOTE: Even though we developed the content in "news.xml" the link needed to point to "news.html".</p>
-
-<p>You can see how other xdocs are structured by looking at the *.xml files in PROJECT_ROOT/xdocs.</p>
-
+<document url="howtobuildsite.xml"><properties>
+ <author email="mike_edwards@uk.ibm.com">Mike Edwards</author>
+ <title>Apache Tuscany - How To Build Site</title></properties><body>
+
+ <section name="Tuscany Site Generation Overview">
+
+ <p>The Tuscany website is built using the site plugin of Maven 2.0. A general guide to
+ the Maven site plugin can be found <a href="http://maven.apache.org/guides/mini/guide-site.html">here</a>.
+ </p>
+ <p>
+ The website is held in the site subproject of Tuscany, with a set of source files in the src/site
+ directory and the final website files held in the target/site directory. The website project has its own POM
+ file, held in the main site directory.
+ The site is generated using the command
+ <pre>
+ mvn site
+ </pre>
+ from the main site directory, which uses the source files to build the final website files in the target/site
+ directory.
+ </p>
+ <p>
+ The actual live website for Tuscany is at
+ <a href="http://incubator.apache.org/tuscany/">http://incubator.apache.org/tuscany/</a>. The files for the live
+ website are transferred from the Tuscany subversion repository to the machine people.apache.org in the directory
+ /www/incubator.apache.org/tuscany, using a subversion extract of the site/target/site directory. So, if you
+ update the site/target directory on SVN and want to make the new version live, you will need to logon to
+ people.apache.org and type in:
+ <pre>
+ cd /www/incubator.apache.org/tuscany
+ svn update
+ </pre>
+ </p>
+
+ </section>
+ <section name="Location and Format of the Source Files">
+
+ <p>The source files for the Tuscany site are held in the site/src/site directory. In that
+ directory there is a special file called site.xml which holds the basic layout for all the
+ pages in the site. In particular, site.xml contains the definitions for the left menu bar
+ and for the overall title on each page. Only edit site.xml if you need to add a new top
+ level page to the site.
+ </p>
+ <p>
+ Most of the pages for the site are held in the xdoc directory. The pages are generally in
+ an XML format, although it is possible to define pages as HTML files. XML files are
+ preferred, since Maven applies a standard layout and style sheet to these pages. If you
+ provide a page as an HTML file, it will appear exactly as you create it - Maven does not
+ modify HTML files as it creates the site.
+ </p>
+ <p>
+ The website landing page is defined by index.xml. The other pages are linked from this
+ page, either via the left sidebar or via explicit links in the body of the page. The
+ following section gives you some details on how to create your own page and link it into
+ the site.
+ </p>
+ <p>
+ Other files are held in the resources directory. These files include things like images
+ (eg. JPEG files) and documents (eg. PDF files). These files can be referenced from the
+ pages in the xdocs directory, without the need for any path - Maven copies the files in
+ the resources directory to the root directory of the website.
+ </p>
+
+ </section>
+ <section name="Creating your own Pages">
+ <p>
+ You can get a good feel for the format of the pages in the Tuscany website by looking at
+ some of the existing files in the xdoc directory. bugs.xml is a good example of a simple
+ page with a reference hyperlink. documentation.xml is an example of a more complex page
+ which has a table. The format of the xml files uses a simple set of elements that
+ approximate to the more common HTML tags. To get a feel for the XML elements, let's use an example
+ of creating a new page called foo.xml.
+ </p>
+ <p>
+ First, create a file called foo.xml in the xdocs directory, similar to the following:
+
+ <pre>
+ <document url="foo.xml">
+ <properties>
+ <author email="your_id@blah.com">Your Name</author>
+ <title>Apache Tuscany - Foo</title>
+ </properties>
+ <body>
+ <section name="Tuscany Foo">
+ <p>
+ Welcome to the foo section.
+ Please review the <a href="tuscany_foo.pdf">Tuscany FOO manual</a>.
+ You can run foo by typing in the command:
+ <pre>
+ foo bar
+ </pre>
+ </p>
+
+ </section>
+ </body>
+ </document>
+ </pre>
+
+ Note the header information with a general title in the properties section - this gets applied to the title line of
+ the browser when the page is displayed. There is a body section, which is the main content
+ of the page. Within the body, each section tag places a heading into the page. Paragraphs
+ are defined using the <p> tags. Hyperlink references can be created using the <a>
+ element. For descriptions of commands and similar text elements, you can use the <pre>
+ element.
+ </p>
+ <p>
+ References like "tuscany_foo.pdf" should be dropped into the site/resources directory.
+ </p>
+ <p>If the foo page needs to be linked from the left bar, then a link to foo must be created in the
+ site.xml file which is in the main src/site directory:
+
+ <pre>
+ ...
+ <menu name="Tuscany">
+ ...
+ <item name="Foo" href="foo.html" />
+ </menu>
+ ...
+ </pre>
+ Note that the link here is to foo.html, not to foo.xml - foo.html is the name of the page
+ in the final website format.
+ </p>
</section>
-<section name="Directory Structure">
-<pre>
-PROJECT_ROOT/xdocs <-- XDocs and other site resources
-PROJECT_ROOT/target/docs <-- Generated HTML and resources
-</pre>
-</section>
-
-<section name="Tuscany XDocs">
-Navigation.xml is the content for the title area and the side menu.
-Linking to site content using XDocs (like index.xml, news.xml) will retain
-the same look, feel, and menus. It is possible to link to a static HTML page or
-a PDF, etc. Just drop those resources into the xdocs directory and add the links to those resources. When the site builds, those resources will be copied to the output directory.
-
-</section>
-
-<section name="Generating the Site">
-<pre>
-> maven site
-</pre>
-<p>The xdocs get converted into HTML and the standard Maven stylesheets are used and placed into the generated PROJECT_ROOT/target/docs directory. Also, any non-xdoc resource in the xdocs directory will get copied into the output directory.</p>
-</section>
-<section name="Generating the multi-project Site">
-<pre>
-> maven multiproject:site
-</pre>
-<p>
-All of the subprojects will have their sites independently generated and copied into the PARENT_PROJECT_ROOT/target/docs/multiproject/ directory. Note, they are not explicitly linked to from the default generated site.
-</p>
-</section>
</body>
</document>
Modified: incubator/tuscany/site/target/site/SCA_Java_Tools_documentation.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/SCA_Java_Tools_documentation.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/SCA_Java_Tools_documentation.html (original)
+++ incubator/tuscany/site/target/site/SCA_Java_Tools_documentation.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:17 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/architecture.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/architecture.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/architecture.html (original)
+++ incubator/tuscany/site/target/site/architecture.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:14 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/bugs.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/bugs.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/bugs.html (original)
+++ incubator/tuscany/site/target/site/bugs.html Tue Feb 28 05:14:32 2006
@@ -33,7 +33,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:15 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/dependencies.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/dependencies.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/dependencies.html (original)
+++ incubator/tuscany/site/target/site/dependencies.html Tue Feb 28 05:14:32 2006
@@ -28,7 +28,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:13 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:42 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/documentation.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/documentation.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/documentation.html (original)
+++ incubator/tuscany/site/target/site/documentation.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:15 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/documentationdasjava.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/documentationdasjava.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/documentationdasjava.html (original)
+++ incubator/tuscany/site/target/site/documentationdasjava.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:15 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/documentationscacpp.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/documentationscacpp.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/documentationscacpp.html (original)
+++ incubator/tuscany/site/target/site/documentationscacpp.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:15 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/documentationscajava.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/documentationscajava.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/documentationscajava.html (original)
+++ incubator/tuscany/site/target/site/documentationscajava.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:15 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/documentationsdocpp.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/documentationsdocpp.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/documentationsdocpp.html (original)
+++ incubator/tuscany/site/target/site/documentationsdocpp.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:15 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/documentationsdojava.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/documentationsdojava.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/documentationsdojava.html (original)
+++ incubator/tuscany/site/target/site/documentationsdojava.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:15 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/download.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/download.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/download.html (original)
+++ incubator/tuscany/site/target/site/download.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:15 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/faq.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/faq.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/faq.html (original)
+++ incubator/tuscany/site/target/site/faq.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:15 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/getinvolved.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/getinvolved.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/getinvolved.html (original)
+++ incubator/tuscany/site/target/site/getinvolved.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:16 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/howtobuildsite.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/howtobuildsite.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/howtobuildsite.html (original)
+++ incubator/tuscany/site/target/site/howtobuildsite.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:16 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
@@ -241,74 +241,105 @@
The actual live website for Tuscany is at
<a href="http://incubator.apache.org/tuscany/">http://incubator.apache.org/tuscany/</a>. The files for the live
website are transferred from the Tuscany subversion repository to the machine people.apache.org in the directory
- /www/incubator.apache.org/tuscany, using a subversion extract of the site/target/site directory.
+ /www/incubator.apache.org/tuscany, using a subversion extract of the site/target/site directory. So, if you
+ update the site/target directory on SVN and want to make the new version live, you will need to logon to
+ people.apache.org and type in:
+ <pre>
+ cd /www/incubator.apache.org/tuscany
+ svn update
+ </pre>
</p>
-<p>For example, if you wanted to add a news section that had a link to a PDF. Say that you also wanted to add the News section to the main menu, you would need to do the following.</p>
-
-
-<p>In xdocs/navigation.xml, You can add the "News" item to the "Tuscany" menu.</p>
-
-<pre>
-...
-<menu name="Tuscany">
- ...
- <item name="News" href="news.html" />
-</menu>
-...
-</pre>
-Create xdocs/news.xml, similar to the one below.
-<pre>
-<document url="news.xml">
-<properties>
- <author email="mike_edwards@uk.ibm.com">Mike Edwards</author>
- <title>Apache Tuscany - News</title>
-</properties>
-<body>
- <section name="Tuscany News">
-
-Welcome to the news section. Please, review the <a href="tuscany.pdf">Tuscany PDF</a>.
-
- </section>
-</body>
-</document>
-</pre>
-<p>Then drop "tuscany.pdf" into the same directory as news.xml. When you run the maven site generation the PDF will get copied over and the link will be preserved in the news.html generated from news.xml.</p>
-<p>NOTE: Even though we developed the content in "news.xml" the link needed to point to "news.html".</p>
+ </div>
+ <div class="section"><h2>Location and Format of the Source Files</h2>
+
+ <p>The source files for the Tuscany site are held in the site/src/site directory. In that
+ directory there is a special file called site.xml which holds the basic layout for all the
+ pages in the site. In particular, site.xml contains the definitions for the left menu bar
+ and for the overall title on each page. Only edit site.xml if you need to add a new top
+ level page to the site.
+ </p>
+ <p>
+ Most of the pages for the site are held in the xdoc directory. The pages are generally in
+ an XML format, although it is possible to define pages as HTML files. XML files are
+ preferred, since Maven applies a standard layout and style sheet to these pages. If you
+ provide a page as an HTML file, it will appear exactly as you create it - Maven does not
+ modify HTML files as it creates the site.
+ </p>
+ <p>
+ The website landing page is defined by index.xml. The other pages are linked from this
+ page, either via the left sidebar or via explicit links in the body of the page. The
+ following section gives you some details on how to create your own page and link it into
+ the site.
+ </p>
+ <p>
+ Other files are held in the resources directory. These files include things like images
+ (eg. JPEG files) and documents (eg. PDF files). These files can be referenced from the
+ pages in the xdocs directory, without the need for any path - Maven copies the files in
+ the resources directory to the root directory of the website.
+ </p>
+
+ </div>
+ <div class="section"><h2>Creating your own Pages</h2>
+ <p>
+ You can get a good feel for the format of the pages in the Tuscany website by looking at
+ some of the existing files in the xdoc directory. bugs.xml is a good example of a simple
+ page with a reference hyperlink. documentation.xml is an example of a more complex page
+ which has a table. The format of the xml files uses a simple set of elements that
+ approximate to the more common HTML tags. To get a feel for the XML elements, let's use an example
+ of creating a new page called foo.xml.
+ </p>
+ <p>
+ First, create a file called foo.xml in the xdocs directory, similar to the following:
-<p>You can see how other xdocs are structured by looking at the *.xml files in PROJECT_ROOT/xdocs.</p>
+ <pre>
+ <document url="foo.xml">
+ <properties>
+ <author email="your_id@blah.com">Your Name</author>
+ <title>Apache Tuscany - Foo</title>
+ </properties>
+ <body>
+ <section name="Tuscany Foo">
+ <p>
+ Welcome to the foo section.
+ Please review the <a href="tuscany_foo.pdf">Tuscany FOO manual</a>.
+ You can run foo by typing in the command:
+ <pre>
+ foo bar
+ </pre>
+ </p>
+
+ </section>
+ </body>
+ </document>
+ </pre>
+
+ Note the header information with a general title in the properties section - this gets applied to the title line of
+ the browser when the page is displayed. There is a body section, which is the main content
+ of the page. Within the body, each section tag places a heading into the page. Paragraphs
+ are defined using the <p> tags. Hyperlink references can be created using the <a>
+ element. For descriptions of commands and similar text elements, you can use the <pre>
+ element.
+ </p>
+ <p>
+ References like "tuscany_foo.pdf" should be dropped into the site/resources directory.
+ </p>
+ <p>If the foo page needs to be linked from the left bar, then a link to foo must be created in the
+ site.xml file which is in the main src/site directory:
+ <pre>
+ ...
+ <menu name="Tuscany">
+ ...
+ <item name="Foo" href="foo.html" />
+ </menu>
+ ...
+ </pre>
+ Note that the link here is to foo.html, not to foo.xml - foo.html is the name of the page
+ in the final website format.
+ </p>
</div>
-<div class="section"><h2>Directory Structure</h2>
-<pre>
-PROJECT_ROOT/xdocs <-- XDocs and other site resources
-PROJECT_ROOT/target/docs <-- Generated HTML and resources
-</pre>
-</div>
-
-<div class="section"><h2>Tuscany XDocs</h2>
-Navigation.xml is the content for the title area and the side menu.
-Linking to site content using XDocs (like index.xml, news.xml) will retain
-the same look, feel, and menus. It is possible to link to a static HTML page or
-a PDF, etc. Just drop those resources into the xdocs directory and add the links to those resources. When the site builds, those resources will be copied to the output directory.
-
-</div>
-
-<div class="section"><h2>Generating the Site</h2>
-<pre>
-> maven site
-</pre>
-<p>The xdocs get converted into HTML and the standard Maven stylesheets are used and placed into the generated PROJECT_ROOT/target/docs directory. Also, any non-xdoc resource in the xdocs directory will get copied into the output directory.</p>
-</div>
-<div class="section"><h2>Generating the multi-project Site</h2>
-<pre>
-> maven multiproject:site
-</pre>
-<p>
-All of the subprojects will have their sites independently generated and copied into the PARENT_PROJECT_ROOT/target/docs/multiproject/ directory. Note, they are not explicitly linked to from the default generated site.
-</p>
-</div>
</div>
Modified: incubator/tuscany/site/target/site/index.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/index.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/index.html (original)
+++ incubator/tuscany/site/target/site/index.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:16 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/installcpp.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/installcpp.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/installcpp.html (original)
+++ incubator/tuscany/site/target/site/installcpp.html Tue Feb 28 05:14:32 2006
@@ -33,7 +33,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:16 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/installjava.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/installjava.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/installjava.html (original)
+++ incubator/tuscany/site/target/site/installjava.html Tue Feb 28 05:14:32 2006
@@ -33,7 +33,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:16 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/integration.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/integration.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/integration.html (original)
+++ incubator/tuscany/site/target/site/integration.html Tue Feb 28 05:14:32 2006
@@ -28,7 +28,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:12 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:42 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/issue-tracking.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/issue-tracking.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/issue-tracking.html (original)
+++ incubator/tuscany/site/target/site/issue-tracking.html Tue Feb 28 05:14:32 2006
@@ -28,7 +28,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:13 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:42 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/license.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/license.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/license.html (original)
+++ incubator/tuscany/site/target/site/license.html Tue Feb 28 05:14:32 2006
@@ -28,7 +28,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:14 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/mail-lists.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/mail-lists.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/mail-lists.html (original)
+++ incubator/tuscany/site/target/site/mail-lists.html Tue Feb 28 05:14:32 2006
@@ -28,7 +28,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:14 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/maven-reports.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/maven-reports.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/maven-reports.html (original)
+++ incubator/tuscany/site/target/site/maven-reports.html Tue Feb 28 05:14:32 2006
@@ -28,7 +28,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:14 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/navigation.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/navigation.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/navigation.html (original)
+++ incubator/tuscany/site/target/site/navigation.html Tue Feb 28 05:14:32 2006
@@ -28,7 +28,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:16 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/news.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/news.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/news.html (original)
+++ incubator/tuscany/site/target/site/news.html Tue Feb 28 05:14:32 2006
@@ -33,7 +33,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:16 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/phpproject.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/phpproject.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/phpproject.html (original)
+++ incubator/tuscany/site/target/site/phpproject.html Tue Feb 28 05:14:32 2006
@@ -32,7 +32,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:16 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/project-info.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/project-info.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/project-info.html (original)
+++ incubator/tuscany/site/target/site/project-info.html Tue Feb 28 05:14:32 2006
@@ -28,7 +28,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:14 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/reference.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/reference.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/reference.html (original)
+++ incubator/tuscany/site/target/site/reference.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:16 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/releasescpp.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/releasescpp.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/releasescpp.html (original)
+++ incubator/tuscany/site/target/site/releasescpp.html Tue Feb 28 05:14:32 2006
@@ -32,7 +32,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:16 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/releasesdasjava.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/releasesdasjava.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/releasesdasjava.html (original)
+++ incubator/tuscany/site/target/site/releasesdasjava.html Tue Feb 28 05:14:32 2006
@@ -32,7 +32,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:17 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/releasesscajava.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/releasesscajava.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/releasesscajava.html (original)
+++ incubator/tuscany/site/target/site/releasesscajava.html Tue Feb 28 05:14:32 2006
@@ -32,7 +32,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:17 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/releasessdojava.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/releasessdojava.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/releasessdojava.html (original)
+++ incubator/tuscany/site/target/site/releasessdojava.html Tue Feb 28 05:14:32 2006
@@ -32,7 +32,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:17 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/requirements.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/requirements.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/requirements.html (original)
+++ incubator/tuscany/site/target/site/requirements.html Tue Feb 28 05:14:32 2006
@@ -33,7 +33,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:17 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/source-repository.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/source-repository.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/source-repository.html (original)
+++ incubator/tuscany/site/target/site/source-repository.html Tue Feb 28 05:14:32 2006
@@ -28,7 +28,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:14 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/svn.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/svn.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/svn.html (original)
+++ incubator/tuscany/site/target/site/svn.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:17 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/team-list.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/team-list.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/team-list.html (original)
+++ incubator/tuscany/site/target/site/team-list.html Tue Feb 28 05:14:32 2006
@@ -28,7 +28,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:14 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:43 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/userguidecpp.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/userguidecpp.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/userguidecpp.html (original)
+++ incubator/tuscany/site/target/site/userguidecpp.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:17 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/userguidejava.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/userguidejava.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/userguidejava.html (original)
+++ incubator/tuscany/site/target/site/userguidejava.html Tue Feb 28 05:14:32 2006
@@ -31,7 +31,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:17 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">
Modified: incubator/tuscany/site/target/site/wiki.html
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/target/site/wiki.html?rev=381650&r1=381649&r2=381650&view=diff
==============================================================================
--- incubator/tuscany/site/target/site/wiki.html (original)
+++ incubator/tuscany/site/target/site/wiki.html Tue Feb 28 05:14:32 2006
@@ -32,7 +32,7 @@
</div>
</div>
<div id="breadcrumbs">
- <div class="xleft">Last Published: Tue Feb 28 10:52:17 GMT 2006</div>
+ <div class="xleft">Last Published: Tue Feb 28 13:09:44 GMT 2006</div>
<div class="xright"> <a href="http://www.apache.org/">Apache</a>
</div>
<div class="clear">