cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bugzi...@apache.org
Subject DO NOT REPLY [Bug 6435] New: - [PATCH] Updates to the idiots guide
Date Wed, 13 Feb 2002 19:56:32 GMT
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://nagoya.apache.org/bugzilla/show_bug.cgi?id=6435>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://nagoya.apache.org/bugzilla/show_bug.cgi?id=6435

[PATCH]  Updates to the idiots guide

           Summary: [PATCH]  Updates to the idiots guide
           Product: Cocoon 2
           Version: Current CVS
          Platform: All
        OS/Version: All
            Status: UNCONFIRMED
          Severity: Enhancement
          Priority: Other
         Component: core
        AssignedTo: cocoon-dev@xml.apache.org
        ReportedBy: jez@pigbite.com


I have changed the name of "ctwig" on the menu to the more descriptive "Idiots 
Guide" plus made some minor documentation changes, including the addition of 
Mac OS X installation instructions contributed by Are D. Gulbrandsen and some 
more links to other Cocoon resources.

The diffs follow and the last bit is the new file ( 
src/documentation/xdocs/ctwig/ctwig-installing-osx.xml).  I'm not sure this is 
exactly the best way to submit multiple mods and a new file (especially as 
bugzilla can do attachments and I'm not sure how the formatting will come out) 
but it seems the encouragement is to use bugzilla rather than the list.  If a 
committer would like me to do it different (e.g. seperate .diff files to the 
list) then that's no problem.  

Regards
jez
jez@pigbite.com


Index: src/documentation/xdocs/book.xml
===================================================================
RCS file: /home/cvspublic/xml-cocoon2/src/documentation/xdocs/book.xml,v
retrieving revision 1.4
diff -r1.4 book.xml
18c18
<     <menu-item label="cTwIG" href="ctwig/index.html"/>
---
>     <menu-item label="Idiots Guide" href="ctwig/index.html"/>

Index: src/documentation/xdocs/ctwig/ctwig-installing.xml
===================================================================
RCS file: /home/cvspublic/xml-cocoon2/src/documentation/xdocs/ctwig/ctwig-
installing.xml,v
retrieving revision 1.2
diff -r1.2 ctwig-installing.xml
14a15
>         <p><strong>I'm really sorry, but at the moment these examples relate

to the latest distribution, Tomcat 3.2.3 and Apache 1.3.19 on Windows 
2000.</strong>  Are D. Gulbrandsen has contributed some <strong>instructions 
for Mac OS X</strong> <link href="ctwig-installing-osx.html">here</link>.
 It 
is probably all the same for any operating system (remember, that is the 
promise of Java and XML). I would like to do TC4/Unix notes but do not have the 
time at the momement.  If you can help then please <link href="ctwig-
contributing.html">contribute</link>.</p>
18d18
< 				<p><strong>I'm really sorry, but at the moment 
these examples relate to the latest distribution, Tomcat 3.2.3 and Apache 
1.3.19 on Windows 2000.</strong> It is probably all the same for any operating 
system (remember, that is the promise of Java and XML). I would like to do 
TC4/Unix notes but do not have the time at the momement.  If you can help then 
please <link href="ctwig-contributing.html">contribute</link>.</p>

Index: src/documentation/xdocs/ctwig/ctwig-resources.xml
===================================================================
RCS file: /home/cvspublic/xml-cocoon2/src/documentation/xdocs/ctwig/ctwig-
resources.xml,v
retrieving revision 1.2
diff -r1.2 ctwig-resources.xml
28c28,30
< 					<li><link 
href="mailto:lmocz@galatea.com">Lajos Moczar</link> has developed some more 
advanced hints and tips at his <fork 
href="http://www.galatea.com/flashguides/cocoon-tips-2.xml">flashguides</fork> 
site.</li>
---
> 					<li><link 
href="mailto:lmocz@galatea.com">Lajos Moczar</link> has developed some more 
advanced hints and tips at his <fork 
href="http://www.galatea.com">flashguides</fork> site.</li>
>           <li><link href="mailto:durdina@asset.sk">Michal Durdina</link>
is 
building some "How To" pages at his site.  His examples include some database 
work.  You can find more at <fork 
href="http://durdo.miesto.sk/Cocoon2HowTo/index.html">http://durdo.miesto.sk/Coc
oon2HowTo/index.html</fork>.</li>
>           <li><link href="mailto:t-rex@dinobase.de">Andreas Hartmann</link>

has done a really good tutorial at <fork 
href="http://www.cocooncenter.de/cocooncenter/tutorials/navigation/tutorial.html
">http://www.cocooncenter.de/cocooncenter/tutorials/navigation/tutorial.html</fo
rk>.  Hopefully he shall be able to add to it very soon!</li>
32c34
< 				<p>Although I have constructed these pages, the 
basic information I have presented is thanks to users of the above mailing 
list, particuarly Giacomo Pati, Thomas Hofer and Michael Bierenfeld.  If you 
have anything to add then please do <link href="ctwig-
contributing.html">contribute</link>!</p>
---
> 				<p>Although I have constructed these pages, the 
basic information I have presented is thanks to users of the above mailing 
list, particuarly Giacomo Pati, Thomas Hofer, Derek Hohls and Michael 
Bierenfeld.  If you have anything to add then please do <link href="ctwig-
contributing.html">contribute</link>!</p>

Index: src/documentation/xdocs/ctwig/index.xml
===================================================================
RCS file: /home/cvspublic/xml-cocoon2/src/documentation/xdocs/ctwig/index.xml,v
retrieving revision 1.1
diff -r1.1 index.xml
14c14
< 			<p>Welcome to cTwIG - the Cocoon Two Idiots Guide.  
These pages are the result of organically pulling together my experiences of 
installing, using and developing for Apache Cocoon 2 (C2).  It is intended to 
provide a quick guide for other new users of C2 so that they can get up and 
running without needing to trouble the more experienced users out there.  More 
than that, I want to support and repay in a practical way the spirit of the 
user community that indulges my sometimes very dim questions.  For any further 
background please see the <link href="ctwig-why.html">why?</link> page</p>
---
> 			<p>Welcome to the Cocoon Two Idiots Guide.  These pages 
are the result of organically pulling together my experiences of installing, 
using and developing for Apache Cocoon 2 (C2).  It is intended to provide a 
quick guide for other new users of C2 so that they can get up and running 
without needing to trouble the more experienced users out there.  More than 
that, I want to support and repay in a practical way the spirit of the user 
community that indulges my sometimes very dim questions.  For any further 
background please see the <link href="ctwig-why.html">why?</link> page</p>


<----START OF LISTING: ctwig-installing-osx.xml----->
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation 
V1.0//EN" "../dtd/document-v10.dtd">

<document>
<header>
	<title>cTwIG - Installing on Mac OS X</title>
	<authors>
		<person name="Are D. Gulbrandsen" 
email="a.d.gulbrandsen@usit.uio.no"/>
	</authors>
</header>

<body>
<s1 title="Getting started with Cocoon on Mac OS X in X easy steps">
	<s2 title="Introduction">
		<p>The easiest way to run Cocoon Under Mac OS X is using the 
Tomcat servlet engine. Tomcat has a built-in webserver, so we won't bother 
using the Apache webserver in this getting started guide.</p><p>This guide is

written for Mac OS 10.1.</p>
	</s2>
		
	<s2 title="I. Download and unzip Tomcat">
		<p>Download and unzip a binary version of the latest production 
quality release (release build) of Tomcat: <link 
href="http://jakarta.apache.org/tomcat/">http://jakarta.apache.org/tomcat/</link
></p>
<p>(Feb 2002 this was <code>jakarta-tomcat-4.0.1.zip)</code></p>
<p>With a stardard install of Mac OS X just download the zip-file, and 
  the unzipping should start automagically with Stuffit Expander.</p>
	</s2>

	<s2 title="II. Download and unzip Cocoon 2">
		<p>Download and unzip a binary version of The latest 
distribution of Cocoon: <link 
href="http://xml.apache.org/cocoon/dist/">http://xml.apache.org/cocoon/dist/</li
nk></p>
		<p>(Feb 2002 this was <code>cocoon-2.0.1-bin.zip</code>)</p>

	</s2>

	<s2 title="III. Where to put it?">
		<p>Start a terminal window and move both the tomcat folder and 
the cocoon folder to <br /><code>/usr/local/</code></p>
		<p>You will need administrator privileges for this.</p>
	</s2>

	<s2 title="IV. Make a Tomcat symlink">
		<p>It can be handy to make a symbolic link <code>tomcat</code> 
to the jakarta-tomcat folder:  <br />
		<code>cd /usr/local/</code> <br />
  		<code>ln -s jakarta-tomcat-4.0.1 tomcat</code></p>
  		<p>You can then later always refer to the 
path /usr/local/tomcat and just change this link if you install newer versions 
of Tomcat.</p>
<p>We will later refer to this path as {CATALINA_HOME} (Catalina is the  
  codename for version 4 of Tomcat).</p>
	</s2>


	<s2 title="V. Setting environment variables">
		<p>You need to set the two environment variables 
<code>JAVA_HOME</code> and <code>CATALINA_HOME</code>. 
   Tomcat will use this to find your Java installation and want to know where
   it is installed itself.</p>
   <p>If you use the default shell in Mac OS X, the tcsh, you can put this in 
your ~/.login file: <br />
  	<code>setenv 
JAVA_HOME /System/Library/Frameworks/JavaVM.framework/Home</code> <br />
  	<code>setenv CATALINA_HOME /usr/local/tomcat</code></p>
  	<p>If you use bash (Bourne Again SHell), put this in 
your ".bash_profile"-file: <br />
  	 <code>export 
JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Home</code><br />
  	 <code>export CATALINA_HOME=/usr/local/tomcat</code></p>
	</s2>


	<s2 title="VI. Install Cocoon on Tomcat">
		<p>Copy the <code>cocoon.war</code> file to <code>
{CATALINA_HOME}/webapps/</code>
  (in my case the same path as <br /> <code>/usr/local/tomcat/webapps/</code>)
</p>
	</s2>


	<s2 title="VII. Start Tomcat">
		<p>Run the startup script for Tomcat (Write this in your 
terminal window): <br />
		<code>/usr/local/tomcat/bin/startup.sh</code></p>
	</s2>

	<s2 title="VIII. Check that Tomcat is running">
		<p>Point your browser to this URL: <link 
href="http://localhost:8080/">http://localhost:8080/</link></p>
  		<p>If everything is OK you will see the Tomcat welcome page.</p>
	</s2>

	<s2 title="IX. Check that Cocoon is running">
		<p>Point your browser to this URL: <link 
href="http://localhost:8080/">http://localhost:8080/cocoon/</link></p>
  		<p>Now you should be able to enjoy the Cocoon welcome page (the 
startup may be a little slow the first time).</p><p>Test some of the Cocoon 
examples and play around a little.</p>
	</s2>


	<s2 title="X. Stop Tomcat">
		<p>When you are finished playing you can run the shutdown 
script for Tomcat:<br />
   <code>/usr/local/tomcat/bin/shutdown.sh</code>
</p>
	</s2>

			
	<s2 title="Yes! This seems to be working, - and now what?">
		<p>Congratulations! You have now completed the installation and 
testdrive of a  servlet engine, a webserver and a servlet under Mac OS X. Need 
a break? - Take 5, you deserve it! &nbsp; :-)</p>
		<p>You are now ready to take a closer look at the examples and 
start doing some <link href="ctwig-transformations.html">basic 
transformations</link>.</p>

		<p>Have fun!</p> <p>Best regards,<br /> 
		Are D. Gulbrandsen<br />
		The XML-group, <br />
		Center for Information Technology Services<br />
		University of Oslo, Norway</p>
	</s2>

	</s1>
</body>
</document>
<--------END OF LISTING ---------->

---------------------------------------------------------------------
To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
For additional commands, email: cocoon-dev-help@xml.apache.org


Mime
View raw message