Return-Path: Delivered-To: apmail-forrest-site-svn-archive@locus.apache.org Received: (qmail 11540 invoked from network); 18 Apr 2007 08:12:40 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 18 Apr 2007 08:12:40 -0000 Received: (qmail 82010 invoked by uid 500); 18 Apr 2007 08:12:47 -0000 Delivered-To: apmail-forrest-site-svn-archive@forrest.apache.org Received: (qmail 81990 invoked by uid 500); 18 Apr 2007 08:12:47 -0000 Mailing-List: contact site-svn-help@forrest.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@forrest.apache.org Delivered-To: mailing list site-svn@forrest.apache.org Received: (qmail 81966 invoked by uid 99); 18 Apr 2007 08:12:47 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 18 Apr 2007 01:12:47 -0700 X-ASF-Spam-Status: No, hits=-99.5 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 18 Apr 2007 01:12:35 -0700 Received: by eris.apache.org (Postfix, from userid 65534) id 00DD61A9881; Wed, 18 Apr 2007 01:11:27 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r529910 [18/22] - in /forrest/site: docs_0_90/ docs_0_90/howto/ docs_0_90/howto/cvs-ssh/ docs_0_90/howto/multi/ docs_0_90/images/ pluginDocs/plugins_0_90/ Date: Wed, 18 Apr 2007 08:11:05 -0000 To: site-svn@forrest.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20070418081128.00DD61A9881@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: forrest/site/docs_0_90/skin-package.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/skin-package.html?view=auto&rev=529910 ============================================================================== --- forrest/site/docs_0_90/skin-package.html (added) +++ forrest/site/docs_0_90/skin-package.html Wed Apr 18 01:10:58 2007 @@ -0,0 +1,403 @@ + + + + + + + +Skin packaging, provision, and use (v0.9-dev) + + + + + + + + + +
+ +
+apache > forrest +
+ +
+ + + + + + + +
+
+  + +
+
+ + + + +
+
+
+
+ + + + +
+ +
+ +   +
+ + + + + +
+
+PDF -icon
+ PDF +
+
Font size: +   +   +   +
+

Skin packaging, provision, and use

+

Automated distributed skin packages

+
+ This is documentation for development version v0.9-dev + (More)
+
+ +
+ + +

Overview

+
+

+ Skins are standard zip archives with a *.zip extension. This enables + them to be unpacked and installed automatically. +

+

+ To publish a skin: +

+
+1 - forrest package-skin
+The skin package will be made in the skin dir, next to the custom skin.
+2 - place the file in a directory on a web server
+3 - ask forrest-dev to add the url and the skin name to the list of skins
+
+

+ To use a custom skin with automatic download: +

+
+1 - set the skin property in forrest.properties to the name of the skin
+2 - forrest install-skin
+3 - forrest
+
+

+ Currently there are two test skins: "testskin" and "testskin2" +

+

+ To see the names of the remote skins: +

+
forrest available-skins
+
+ + +

Notes

+
+

+ The skin will get blown away by the next 'build clean' in forrest. But + that is okay because it is so quick to go get another copy. Also it may + be preferable to get a fresh copy. If the user wanted to keep the skin + and perhaps enhance it, then they can copy it to their project. +

+
+ +
+ +
 
+
+ + + Propchange: forrest/site/docs_0_90/skin-package.html ------------------------------------------------------------------------------ svn:eol-style = native Added: forrest/site/docs_0_90/skin-package.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/skin-package.pdf?view=auto&rev=529910 ============================================================================== Binary file - no diff available. Propchange: forrest/site/docs_0_90/skin-package.pdf ------------------------------------------------------------------------------ svn:mime-type = application/pdf Added: forrest/site/docs_0_90/skins.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/skins.html?view=auto&rev=529910 ============================================================================== --- forrest/site/docs_0_90/skins.html (added) +++ forrest/site/docs_0_90/skins.html Wed Apr 18 01:10:58 2007 @@ -0,0 +1,475 @@ + + + + + + + +Default skins (v0.9-dev) + + + + + + + + + +
+ +
+apache > forrest +
+ +
+ + + + + + + +
+
+  + +
+
+ + + + +
+
+
+
+ + + + +
+ +
+ +   +
+ + + + + +
+
+PDF -icon
+ PDF +
+
Font size: +   +   +   +
+

Default skins

+
+ This is documentation for development version v0.9-dev + (More)
+ + + +

Introduction

+
+

+ Forrest supplies a collection of default skins which are configurable + and so should meet the needs of most projects. The aim is to provide + many capabilities so that extra skins are not needed. +

+

+ Note that the new Dispatcher capability will be a better solution. See + Status of Themes: Skins and Dispatcher. +

+
+ + +

Convention for choosing skin names

+
+

+ The skin names are based on playing with the word "skin". See our + technique for + choosing + skin names. A name with "-dev" extension signifies that it is under + development. There is no concept of versions of default skins. New skins + have new names. +

+
+ + +

Skin descriptions and examples

+
+ +

pelt

+

+ Uses CSS "div" and no HTML tables. +

+

+ Examples: Apache Forrest | + Apache Lenya + +

+ +

tigris

+

+ This skin is based on version 1.1 of the + style.tigris.org project. (It + deliberately contravenes our skin naming convention.) +

+

+ Examples: Core Computer Security + Group + +

+ +

plain-dev

+

+ This is a very minimal skin to produce plain HTML documents. Such + capability might be useful to generate a collection of documents for + some off-line product's user help system. +

+

+ Examples: snapshot + +

+
+ + +

Old and deprecated skins

+
+

+ The following skins are retained for a little while longer, but are + deprecated, so please move to one of the other skins. +

+ +

forrest-site

+

+ This is the old skin that we have been dragging around since early + days. Uses HTML tables. +

+

+ Examples: Apache XML + +

+ +

krysalis-site

+

+ Uses HTML tables. +

+

+ Examples: +

+
+ +
+ +
 
+
+ + + Propchange: forrest/site/docs_0_90/skins.html ------------------------------------------------------------------------------ svn:eol-style = native Added: forrest/site/docs_0_90/skins.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/skins.pdf?view=auto&rev=529910 ============================================================================== Binary file - no diff available. Propchange: forrest/site/docs_0_90/skins.pdf ------------------------------------------------------------------------------ svn:mime-type = application/pdf Added: forrest/site/docs_0_90/status-themes.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/status-themes.html?view=auto&rev=529910 ============================================================================== --- forrest/site/docs_0_90/status-themes.html (added) +++ forrest/site/docs_0_90/status-themes.html Wed Apr 18 01:10:58 2007 @@ -0,0 +1,413 @@ + + + + + + + +Status of Themes: Skins and Dispatcher (v0.9-dev) + + + + + + + + + +
+ +
+apache > forrest +
+ +
+ + + + + + + +
+
+  + +
+
+ + + + +
+
+
+
+ + + + +
+ +
+ +   +
+ + + + + +
+
+PDF -icon
+ PDF +
+
Font size: +   +   +   +
+

Status of Themes: Skins and Dispatcher

+
+ This is documentation for development version v0.9-dev + (More)
+ + + +

Skins

+
+

+ "Skins" is the term used to describe the current method for adding + navigation and menu information to the content of a page and applying a + consistent theme for layout, colours, etc. The + "pelt" skin is the only one that the + Forrest project is maintaining. It is configurable enough to meet many + purposes. The main configuration file for skins is the skinconf.xml + file. There is an ability for users to create their own skins, although + we have not encouraged that. +

+

+ For the Forrest-0.8 release, skins are still available and are still the + main mechanism. No effort has been made to enhance skins. +

+
+ + +

Dispatcher

+
+

+ "Dispatcher" is the term used to describe a new method which aims to be + a more flexible and complete solution to build a reliable common + structure for documents, incorporate other content, and provide hooks + for applying themes. Themes get configured by structurer definitions (a + wee bit like the skinconf.xml). Although strong progress has been made, + it is still under development. We encourage developers to use Dispatcher + and contribute to its development. See the + + plugin documentation for more information. +

+
+ + +

Plan for future framework

+
+

+ The desired direction is to use xhtml2 as the internal format, move the + current "skins" into a plugin, and develop input plugins for xdoc and + html sources. This would enable any theme engine to be used, whether + that be Skins or Dispatcher or some other. +

+

+ See the development discussion: + Re: + status of skins and dispatcher. This is planned for immediately + following the 0.8 release. New developers please help. +

+
+ +
+ +
 
+
+ + + Propchange: forrest/site/docs_0_90/status-themes.html ------------------------------------------------------------------------------ svn:eol-style = native Added: forrest/site/docs_0_90/status-themes.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/status-themes.pdf?view=auto&rev=529910 ============================================================================== Binary file - no diff available. Propchange: forrest/site/docs_0_90/status-themes.pdf ------------------------------------------------------------------------------ svn:mime-type = application/pdf Added: forrest/site/docs_0_90/tab-index.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/tab-index.html?view=auto&rev=529910 ============================================================================== --- forrest/site/docs_0_90/tab-index.html (added) +++ forrest/site/docs_0_90/tab-index.html Wed Apr 18 01:10:58 2007 @@ -0,0 +1,18 @@ + +0.80 (current)0.90-dev (under development)0.70 (past) Propchange: forrest/site/docs_0_90/tab-index.html ------------------------------------------------------------------------------ svn:eol-style = native Added: forrest/site/docs_0_90/upgrading_09.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/upgrading_09.html?view=auto&rev=529910 ============================================================================== --- forrest/site/docs_0_90/upgrading_09.html (added) +++ forrest/site/docs_0_90/upgrading_09.html Wed Apr 18 01:10:58 2007 @@ -0,0 +1,372 @@ + + + + + + + +Upgrading to Apache Forrest 0.9-dev (v0.9-dev) + + + + + + + + + +
+ +
+apache > forrest +
+ +
+ + + + + + + +
+
+  + +
+
+ + + + +
+
+
+
+ + + + +
+ +
+ +   +
+ + + + + +
+
+PDF -icon
+ PDF +
+
Font size: +   +   +   +
+

Upgrading to Apache Forrest 0.9-dev

+
+ This is documentation for development version v0.9-dev + (More)
+
+ +
+ + +

Introduction

+
+
+
Note
+
+ This is the development version of Apache Forrest. + Developers can obtain it from the Subversion + repository. + See the notes for obtaining and Building + Forrest. +
+
+

This is a placeholder document for the new version.

+
+ + +
+ +
 
+
+ + + Propchange: forrest/site/docs_0_90/upgrading_09.html ------------------------------------------------------------------------------ svn:eol-style = native Added: forrest/site/docs_0_90/upgrading_09.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/upgrading_09.pdf?view=auto&rev=529910 ============================================================================== Binary file - no diff available. Propchange: forrest/site/docs_0_90/upgrading_09.pdf ------------------------------------------------------------------------------ svn:mime-type = application/pdf