You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2004/07/18 11:46:59 UTC

svn commit: rev 23021 - forrest/trunk/src/documentation/content/xdocs

Author: crossley
Date: Sun Jul 18 02:46:58 2004
New Revision: 23021

Added:
   forrest/trunk/src/documentation/content/xdocs/mirrors.ihtml
Modified:
   forrest/trunk/src/documentation/content/xdocs/index.xml
   forrest/trunk/src/documentation/content/xdocs/site.xml
Log:
Add the new system for download mirrors.
When we build the Forrest website, a document called "mirrors.html"
is generated from the xdocs/mirrors.ihtml file.
This page contains instructions to be processed by the mirrors.cgi script
to generate an html form for selecting the closest mirror.


Modified: forrest/trunk/src/documentation/content/xdocs/index.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/index.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/index.xml	Sun Jul 18 02:46:58 2004
@@ -214,6 +214,7 @@
         put in, the more you get to define the project's future.  See the
         <link href="site:contrib">"contributing"</link> page for more
         information.
+<link href="site:mirrors"/>
       </p>
     </section>
   </body>

Added: forrest/trunk/src/documentation/content/xdocs/mirrors.ihtml
==============================================================================
--- (empty file)
+++ forrest/trunk/src/documentation/content/xdocs/mirrors.ihtml	Sun Jul 18 02:46:58 2004
@@ -0,0 +1,141 @@
+<?xml version="1.0"?>
+<!--
+  Copyright 2001-2004 The Apache Software Foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<html>
+  <head>
+    <title>Obtain the Forrest distribution</title>
+  </head>
+  <body>
+<h1><a name="how" />How to download</h1>
+<p>Use the links below to download a distribution of Forrest from
+one of our mirrors. It is good practice to 
+<a href="[location]#verify">verify the integrity</a>
+of the distribution files.</p>
+
+<p>Forrest is distributed as <code>zip</code> and <code>tar.gz</code>
+archives - the contents are the same.
+</p>
+
+<h1><a name="closest" />Closest mirror site selected automatically</h1>
+
+<p>You are currently using <b>[preferred]</b>. If you encounter a
+problem with this mirror, then please select another.  If all
+mirrors are failing, there are backup mirrors at the end of the list.
+See <a href="http://www.apache.org/mirrors/">status</a> of mirrors.
+</p>
+
+<form action="[location]" method="get" id="SelectMirror">
+Other mirrors: <select name="Preferred">
+<!--[if-any http] [for http]-->
+<option value="[http]">[http]</option>
+<!--[end] [end]-->
+<!--[if-any ftp] [for ftp]-->
+<option value="[ftp]">[ftp]</option>
+<!--[end] [end]-->
+<!--[if-any backup] [for backup]-->
+<option value="[backup]">[backup] (backup)</option>
+<!--[end] [end]-->
+</select>
+<input type="submit" value="Change" />     
+</form>
+
+<p>The current release is Apache Forrest 0.5.1 (see the
+<a href="[preferred]/forrest/README.html">release notes</a>).</p>
+
+<ul>
+<li>source distribution: 
+<a href="[preferred]/forrest/apache-forrest-0.5.1-src.tar.gz">apache-forrest-0.5.1-src.tar.gz</a>
+[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.5.1-src.tar.gz.asc">PGP</a>]
+[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.5.1-src.tar.gz.md5">MD5</a>]</li>
+
+<li>source distribution: 
+<a href="[preferred]/forrest/apache-forrest-0.5.1-src.zip">apache-forrest-0.5.1-src.zip</a>
+[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.5.1-src.zip.asc">PGP</a>]
+[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.5.1-src.zip.md5">MD5</a>]</li>
+
+<li>binary distribution: 
+<a href="[preferred]/forrest/apache-forrest-0.5.1-bin.tar.gz">apache-forrest-0.5.1-bin.tar.gz</a>
+[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.5.1-bin.tar.gz.asc">PGP</a>]
+[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.5.1-bin.tar.gz.md5">MD5</a>]</li>
+
+<li>binary distribution: 
+<a href="[preferred]/forrest/apache-forrest-0.5.1-bin.zip">apache-forrest-0.5.1-bin.zip</a>
+[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.5.1-bin.zip.asc">PGP</a>]
+[<a href="http://www.apache.org/dist/forrest/apache-forrest-0.5.1-bin.zip.md5">MD5</a>]</li>
+
+</ul>
+
+<h1><a name="svn" />Head SVN repository and snapshots</h1>
+
+<p>If you want to use the latest Forrest features, the source code is under
+version control with Subversion (read how to
+<a href="site:getting-involved/build">obtain</a> your working copy). There are
+also compressed source 
+<a href="http://cvs.apache.org/snapshots/forrest/">snapshots</a> that are
+built every 6 hours.
+</p>
+
+<h1><a name="archive" />Archive of old releases</h1>
+
+<p>Older releases are available in the <a
+href="http://archive.apache.org/dist/forrest/">archive</a>.  Those
+releases are only provided as historical artefacts. We strongly
+recommend to not use those releases, but upgrade to the most recent release.
+</p>
+
+<h1><a name="verify" />Verify releases</h1>
+
+<p>It is essential that you verify the integrity of the downloaded
+files using the PGP or MD5 signatures.</p>
+
+<p>The PGP signatures can be verified using
+<a href="http://www.pgpi.org/">PGP</a> or
+<a href="http://www.gnupg.org/">GPG</a>.
+First download the Forrest
+<a href="http://www.apache.org/dist/forrest/KEYS">KEYS</a>
+as well as the <code>asc</code> signature file for the particular
+distribution. It is important that you get these files from the ultimate
+trusted source - the main ASF distribution site, rather than from a mirror.
+Then verify the signatures using ...</p>
+
+<p><code>
+% pgpk -a KEYS<br />
+% pgpv apache-forrest-0.5.1-src.tar.gz.asc<br />
+</code>
+<em>or</em><br />
+<code>
+% pgp -ka KEYS<br />
+% pgp apache-forrest-0.5.1-src.tar.gz.asc<br />
+</code>
+<em>or</em><br />
+<code>
+% gpg --import KEYS<br />
+% gpg --verify apache-forrest-0.5.1-src.tar.gz.asc
+</code></p>
+
+<p>Alternatively, you can verify the MD5 signature on the files.  A
+unix program called <code>md5</code> or <code>md5sum</code> is
+included in many unix distributions.  It is also available as part of
+<a href="http://www.gnu.org/software/textutils/textutils.html">GNU
+Textutils</a>.  Windows users can get binary md5 programs from <a
+href="http://www.fourmilab.ch/md5/">here</a>, <a
+href="http://www.pc-tools.net/win32/freeware/console/">here</a>, or
+<a href="http://www.slavasoft.com/fsum/">here</a>.</p>
+
+<p>We strongly recommend to verify the signature.</p>
+
+</body>
+</html>

Modified: forrest/trunk/src/documentation/content/xdocs/site.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/site.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/site.xml	Sun Jul 18 02:46:58 2004
@@ -19,7 +19,8 @@
   <about label="About">
     <index label="Index" href="index.html"/>
     <license label="License" href="license.html"/>
-    <download label="Download" href="http://www.apache.org/dyn/closer.cgi/xml/forrest/"/>
+    <download label="Download" href="http://forrest.apache.org/mirrors.cgi"/>
+    <mirrors href="mirrors.html"/>
     <who label="Who we are" href="who.html"/>
     <faq label="FAQs" href="faq.html">
       <docbook href="#docbook"/>

Re: include a document but not show in menu (Was: svn commit: rev 23021)

Posted by David Crossley <cr...@apache.org>.
Scherler, Thorsten wrote:
> David Crossley wrote:
> 
> > I must be missing it. Would someone show me how to
> > include a document in the processing, but not listed
> > in the left-hand navigation panel and not have a link
> > to it in any other page.
> > 
> > We need to get the "mirrors.html" page generated but
> > not linked to. It is an extra page that needs to be
> > generated into the home directory.
> > 
> just place it in
> documentation/content/mirrors.html

No, that is for raw un-processed documents. This one needs
to get processed and have the skin applied to it.




Re: include a document but not show in menu (Was: svn commit: rev 23021)

Posted by "Scherler, Thorsten" <th...@apache.org>.
David Crossley wrote:

> I must be missing it. Would someone show me how to
> include a document in the processing, but not listed
> in the left-hand navigation panel and not have a link
> to it in any other page.
> 
> We need to get the "mirrors.html" page generated but
> not linked to. It is an extra page that needs to be
> generated into the home directory.
> 
just place it in
documentation/content/mirrors.html

HTH
thorstem

-- 
<thorsten>
  <name>Thorsten Scherler</name>
  <country>Spain</country>
  <@m...@mail>
  <@cocoon-WIKI>
http://wiki.apache.org/cocoon/Scherler
</...@cocoon-WIKI>
  <acronymfinder>
http://www.acronymfinder.com/af-query.asp?String=exact&Find=Find&Acronym=
  </acronymfinder>
  <motto>
    "My task which I am trying to achieve is,
     by the power of the written word,
     [...] to make you see."
     *Joseph Conrad (1857-1924)*
  </motto>
</thorsten>



Re: include a document but not show in menu

Posted by Clay Leeds <cl...@medata.com>.
On Jul 20, 2004, at 3:35 AM, David Crossley wrote:
> I was missing it - using the Cocoon cli.xconf incorrectly.
> All that is needed to do was to add a <uri> element.
> That is the appropriate way to process any additional
> non-linked files.

Does an example of this exist on the web site?  Not just an 
explanation, but a clear example :-D. As I understand it, to add a page 
that is not linked from the navigation structure:

How do I(tm) add a file/page to a Forrest web site without linking it 
from navigation?
1. Add a file to the src/documentation/xdocs/path/example.html
2. In the page which links it, add a URI/link to 
src/documentation/xdocs/path/example.html
3. There is no step 3

It might also be nice to be able to add it in such a way, and still 
have it linkable from a Site Map (which leads me to the question: Can 
Forrest build a Site Map? I don't think I've ever seen one built with 
Forrest.)

Cheers,

Web Maestro Clay


Re: include a document but not show in menu

Posted by Thorsten Scherler <th...@juntadeandalucia.es>.
David Crossley wrote:

>(hey Thorsten, LOL ... we can use me now to "learn by example".)
>
>  
>
Hehe, LOL!

...welcome to the club ;-)

thorsten

-- 
Thorsten Scherler




Re: include a document but not show in menu

Posted by David Crossley <cr...@apache.org>.
David Crossley wrote:
> David Crossley wrote:
> > I must be missing it. Would someone show me how to
> > include a document in the processing, but not listed
> > in the left-hand navigation panel and not have a link
> > to it in any other page.
> > 
> > We need to get the "mirrors.html" page generated but
> > not linked to. It is an extra page that needs to be
> > generated into the home directory.
> > 
> > Tried using cli.xconf to specify a file to be included,
> > but that caused errors (will go back and investigate).
> > 
> > Anyway, i found a workaround which adds an invisible
> > link in index.html as below.
> 
> I was missing it - using the Cocoon cli.xconf incorrectly.
> All that is needed to do was to add a <uri> element.
> That is the appropriate way to process any additional
> non-linked files.

Uh'oh ... i busted the build.

(hey Thorsten, LOL ... we can use me now to "learn by example".)

The addition of the <uri>mirrors.html</uri> to the
main cli.xconf file, means that for every project
that gets built on my system, the default config injects
that uri into their build too.

I should have run 'build test' before commit.

-- 
David Crossley


Re: include a document but not show in menu

Posted by David Crossley <cr...@apache.org>.
David Crossley wrote:
> I must be missing it. Would someone show me how to
> include a document in the processing, but not listed
> in the left-hand navigation panel and not have a link
> to it in any other page.
> 
> We need to get the "mirrors.html" page generated but
> not linked to. It is an extra page that needs to be
> generated into the home directory.
> 
> Tried using cli.xconf to specify a file to be included,
> but that caused errors (will go back and investigate).
> 
> Anyway, i found a workaround which adds an invisible
> link in index.html as below.

I was missing it - using the Cocoon cli.xconf incorrectly.
All that is needed to do was to add a <uri> element.
That is the appropriate way to process any additional
non-linked files.

-- 
David Crossley


include a document but not show in menu (Was: svn commit: rev 23021)

Posted by David Crossley <cr...@apache.org>.
I must be missing it. Would someone show me how to
include a document in the processing, but not listed
in the left-hand navigation panel and not have a link
to it in any other page.

We need to get the "mirrors.html" page generated but
not linked to. It is an extra page that needs to be
generated into the home directory.

Tried using cli.xconf to specify a file to be included,
but that caused errors (will go back and investigate).

Anyway, i found a workaround which adds an invisible
link in index.html as below.

> Author: crossley
> New Revision: 23021
> 
> Added:
>    forrest/trunk/src/documentation/content/xdocs/mirrors.ihtml
> Modified:
>    forrest/trunk/src/documentation/content/xdocs/index.xml
>    forrest/trunk/src/documentation/content/xdocs/site.xml
> Log:
> Add the new system for download mirrors.
> When we build the Forrest website, a document called "mirrors.html"
> is generated from the xdocs/mirrors.ihtml file.
> This page contains instructions to be processed by the mirrors.cgi script
> to generate an html form for selecting the closest mirror.
>
> Modified: forrest/trunk/src/documentation/content/xdocs/index.xml
> ==============================================================================
> --- forrest/trunk/src/documentation/content/xdocs/index.xml	(original)
> +++ forrest/trunk/src/documentation/content/xdocs/index.xml	Sun Jul 18 02:46:58 2004
> @@ -214,6 +214,7 @@
>          put in, the more you get to define the project's future.  See the
>          <link href="site:contrib">"contributing"</link> page for more
>          information.
> +<link href="site:mirrors"/>
>        </p>
>      </section>
>    </body>
<snip/>