[izpack-changes] r1994 - izpack-src/trunk/src/doc-reST

noreply at berlios.de noreply at berlios.de
Sun Jan 20 19:50:02 CET 2008


Author: jponge
Date: 2008-01-20 19:49:57 +0100 (Sun, 20 Jan 2008)
New Revision: 1994

Added:
   izpack-src/trunk/src/doc-reST/html4css1.css
   izpack-src/trunk/src/doc-reST/izpack.css
   izpack-src/trunk/src/doc-reST/preambule.txt
Modified:
   izpack-src/trunk/src/doc-reST/apache-license.txt
   izpack-src/trunk/src/doc-reST/build.py
   izpack-src/trunk/src/doc-reST/cc-license.txt
   izpack-src/trunk/src/doc-reST/index.txt
   izpack-src/trunk/src/doc-reST/pdf-version.txt
Log:
Documentation work:
- improved build process
- filled the licenses contents
- added some forewords
- HTML version: support for a customized stylesheet that makes it look much better.


Modified: izpack-src/trunk/src/doc-reST/apache-license.txt
===================================================================
--- izpack-src/trunk/src/doc-reST/apache-license.txt	2008-01-20 18:06:49 UTC (rev 1993)
+++ izpack-src/trunk/src/doc-reST/apache-license.txt	2008-01-20 18:49:57 UTC (rev 1994)
@@ -1,4 +1,214 @@
 Apache License, Version 2.0
 --------------------------------
 
-(to be replaced with an up-to-date text)
\ No newline at end of file
+IzPack is license under the terms of the **Apache License version 2.0**.
+
+Please note that IzPack may use some third-party libraries that are not released under the same conditions (see the **legal/** directory of an IzPack source or binary distribution).
+
+Finally, note that IzPack is not affiliated to the Apache Software Foundation.
+
+
+::
+
+  
+                                Apache License
+                          Version 2.0, January 2004
+                       http://www.apache.org/licenses/
+
+  TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+  1. Definitions.
+
+     "License" shall mean the terms and conditions for use, reproduction,
+     and distribution as defined by Sections 1 through 9 of this document.
+
+     "Licensor" shall mean the copyright owner or entity authorized by
+     the copyright owner that is granting the License.
+
+     "Legal Entity" shall mean the union of the acting entity and all
+     other entities that control, are controlled by, or are under common
+     control with that entity. For the purposes of this definition,
+     "control" means (i) the power, direct or indirect, to cause the
+     direction or management of such entity, whether by contract or
+     otherwise, or (ii) ownership of fifty percent (50%) or more of the
+     outstanding shares, or (iii) beneficial ownership of such entity.
+
+     "You" (or "Your") shall mean an individual or Legal Entity
+     exercising permissions granted by this License.
+
+     "Source" form shall mean the preferred form for making modifications,
+     including but not limited to software source code, documentation
+     source, and configuration files.
+
+     "Object" form shall mean any form resulting from mechanical
+     transformation or translation of a Source form, including but
+     not limited to compiled object code, generated documentation,
+     and conversions to other media types.
+
+     "Work" shall mean the work of authorship, whether in Source or
+     Object form, made available under the License, as indicated by a
+     copyright notice that is included in or attached to the work
+     (an example is provided in the Appendix below).
+
+     "Derivative Works" shall mean any work, whether in Source or Object
+     form, that is based on (or derived from) the Work and for which the
+     editorial revisions, annotations, elaborations, or other modifications
+     represent, as a whole, an original work of authorship. For the purposes
+     of this License, Derivative Works shall not include works that remain
+     separable from, or merely link (or bind by name) to the interfaces of,
+     the Work and Derivative Works thereof.
+
+     "Contribution" shall mean any work of authorship, including
+     the original version of the Work and any modifications or additions
+     to that Work or Derivative Works thereof, that is intentionally
+     submitted to Licensor for inclusion in the Work by the copyright owner
+     or by an individual or Legal Entity authorized to submit on behalf of
+     the copyright owner. For the purposes of this definition, "submitted"
+     means any form of electronic, verbal, or written communication sent
+     to the Licensor or its representatives, including but not limited to
+     communication on electronic mailing lists, source code control systems,
+     and issue tracking systems that are managed by, or on behalf of, the
+     Licensor for the purpose of discussing and improving the Work, but
+     excluding communication that is conspicuously marked or otherwise
+     designated in writing by the copyright owner as "Not a Contribution."
+
+     "Contributor" shall mean Licensor and any individual or Legal Entity
+     on behalf of whom a Contribution has been received by Licensor and
+     subsequently incorporated within the Work.
+
+  2. Grant of Copyright License. Subject to the terms and conditions of
+     this License, each Contributor hereby grants to You a perpetual,
+     worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+     copyright license to reproduce, prepare Derivative Works of,
+     publicly display, publicly perform, sublicense, and distribute the
+     Work and such Derivative Works in Source or Object form.
+
+  3. Grant of Patent License. Subject to the terms and conditions of
+     this License, each Contributor hereby grants to You a perpetual,
+     worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+     (except as stated in this section) patent license to make, have made,
+     use, offer to sell, sell, import, and otherwise transfer the Work,
+     where such license applies only to those patent claims licensable
+     by such Contributor that are necessarily infringed by their
+     Contribution(s) alone or by combination of their Contribution(s)
+     with the Work to which such Contribution(s) was submitted. If You
+     institute patent litigation against any entity (including a
+     cross-claim or counterclaim in a lawsuit) alleging that the Work
+     or a Contribution incorporated within the Work constitutes direct
+     or contributory patent infringement, then any patent licenses
+     granted to You under this License for that Work shall terminate
+     as of the date such litigation is filed.
+
+  4. Redistribution. You may reproduce and distribute copies of the
+     Work or Derivative Works thereof in any medium, with or without
+     modifications, and in Source or Object form, provided that You
+     meet the following conditions:
+
+     (a) You must give any other recipients of the Work or
+         Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices
+         stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works
+         that You distribute, all copyright, patent, trademark, and
+         attribution notices from the Source form of the Work,
+         excluding those notices that do not pertain to any part of
+         the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its
+         distribution, then any Derivative Works that You distribute must
+         include a readable copy of the attribution notices contained
+         within such NOTICE file, excluding those notices that do not
+         pertain to any part of the Derivative Works, in at least one
+         of the following places: within a NOTICE text file distributed
+         as part of the Derivative Works; within the Source form or
+         documentation, if provided along with the Derivative Works; or,
+         within a display generated by the Derivative Works, if and
+         wherever such third-party notices normally appear. The contents
+         of the NOTICE file are for informational purposes only and
+         do not modify the License. You may add Your own attribution
+         notices within Derivative Works that You distribute, alongside
+         or as an addendum to the NOTICE text from the Work, provided
+         that such additional attribution notices cannot be construed
+         as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and
+     may provide additional or different license terms and conditions
+     for use, reproduction, or distribution of Your modifications, or
+     for any such Derivative Works as a whole, provided Your use,
+     reproduction, and distribution of the Work otherwise complies with
+     the conditions stated in this License.
+
+  5. Submission of Contributions. Unless You explicitly state otherwise,
+     any Contribution intentionally submitted for inclusion in the Work
+     by You to the Licensor shall be under the terms and conditions of
+     this License, without any additional terms or conditions.
+     Notwithstanding the above, nothing herein shall supersede or modify
+     the terms of any separate license agreement you may have executed
+     with Licensor regarding such Contributions.
+
+  6. Trademarks. This License does not grant permission to use the trade
+     names, trademarks, service marks, or product names of the Licensor,
+     except as required for reasonable and customary use in describing the
+     origin of the Work and reproducing the content of the NOTICE file.
+
+  7. Disclaimer of Warranty. Unless required by applicable law or
+     agreed to in writing, Licensor provides the Work (and each
+     Contributor provides its Contributions) on an "AS IS" BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+     implied, including, without limitation, any warranties or conditions
+     of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+     PARTICULAR PURPOSE. You are solely responsible for determining the
+     appropriateness of using or redistributing the Work and assume any
+     risks associated with Your exercise of permissions under this License.
+
+  8. Limitation of Liability. In no event and under no legal theory,
+     whether in tort (including negligence), contract, or otherwise,
+     unless required by applicable law (such as deliberate and grossly
+     negligent acts) or agreed to in writing, shall any Contributor be
+     liable to You for damages, including any direct, indirect, special,
+     incidental, or consequential damages of any character arising as a
+     result of this License or out of the use or inability to use the
+     Work (including but not limited to damages for loss of goodwill,
+     work stoppage, computer failure or malfunction, or any and all
+     other commercial damages or losses), even if such Contributor
+     has been advised of the possibility of such damages.
+
+  9. Accepting Warranty or Additional Liability. While redistributing
+     the Work or Derivative Works thereof, You may choose to offer,
+     and charge a fee for, acceptance of support, warranty, indemnity,
+     or other liability obligations and/or rights consistent with this
+     License. However, in accepting such obligations, You may act only
+     on Your own behalf and on Your sole responsibility, not on behalf
+     of any other Contributor, and only if You agree to indemnify,
+     defend, and hold each Contributor harmless for any liability
+     incurred by, or claims asserted against, such Contributor by reason
+     of your accepting any such warranty or additional liability.
+
+  END OF TERMS AND CONDITIONS
+
+  APPENDIX: How to apply the Apache License to your work.
+
+     To apply the Apache License to your work, attach the following
+     boilerplate notice, with the fields enclosed by brackets "[]"
+     replaced with your own identifying information. (Don't include
+     the brackets!)  The text should be enclosed in the appropriate
+     comment syntax for the file format. We also recommend that a
+     file or class name and description of purpose be included on the
+     same "printed page" as the copyright notice for easier
+     identification within third-party archives.
+
+  Copyright [yyyy] [name of copyright owner]
+
+  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.
\ No newline at end of file

Modified: izpack-src/trunk/src/doc-reST/build.py
===================================================================
--- izpack-src/trunk/src/doc-reST/build.py	2008-01-20 18:06:49 UTC (rev 1993)
+++ izpack-src/trunk/src/doc-reST/build.py	2008-01-20 18:49:57 UTC (rev 1994)
@@ -47,12 +47,12 @@
 def scan_files():
 	print('Scanning files...')
 	rest_files = [ f[0:(len(f) - 4)] for f in glob('*.txt') if f != 'pdf-version.txt' ]
-	pictures   = glob('*.jpg') + glob('*.png')
-	return rest_files, pictures
+	resources   = glob('*.jpg') + glob('*.png') + glob('*.css')
+	return rest_files, resources
 
-def copy_files(pictures):
-	print('Copying pictures...')
-	for pic in pictures:
+def copy_files(resources):
+	print('Copying resources...')
+	for pic in resources:
 		print('    ' + pic)
 		shutil.copyfile(pic, 'html/' + pic)
 		shutil.copyfile(pic, 'pdf/' + pic)
@@ -61,7 +61,14 @@
 	print('Generating html...')
 	for rest_file in rest_files:
 		print('    ' + rest_file)
-		publish(writer_name='html', argv=['%s.txt' % rest_file, 'html/%s.html' % rest_file])
+		args = [
+		    '--link-stylesheet',
+		    '--stylesheet-path=izpack.css',
+		    '--cloak-email-addresses',
+		    '%s.txt' % rest_file,
+		    'html/%s.html' % rest_file
+		]
+		publish(writer_name='html', argv=args)
 
 def generate_latex():
 	print('Generating LaTeX for PDF output...')
@@ -81,11 +88,12 @@
                   	default=True, help="don't call pdflatex")
 	options, args = parser.parse_args()
 	
-	rest_files, pictures = scan_files()
+	rest_files, resources = scan_files()
 	create_dirs()
-	copy_files(pictures)
+	copy_files(resources)
 	generate_html(rest_files)
-	generate_latex()
-	if options.pdflatex: compile_latex()
+	if options.pdflatex:
+	    generate_latex()
+	    compile_latex()
 	
 	print('Done')

Modified: izpack-src/trunk/src/doc-reST/cc-license.txt
===================================================================
--- izpack-src/trunk/src/doc-reST/cc-license.txt	2008-01-20 18:06:49 UTC (rev 1993)
+++ izpack-src/trunk/src/doc-reST/cc-license.txt	2008-01-20 18:49:57 UTC (rev 1994)
@@ -1,4 +1,6 @@
-The Commons Creative Attribution-NonCommercial-ShareAlike License
-===================================================================
+Documentation license
+=====================
 
-(to be replaced with an up-to-date text)
\ No newline at end of file
+This documentation is licensed under the terms of the **Creative Commons Attribution-ShareAlike 3.0 Unported License**.
+
+The details can be found at http://creativecommons.org/licenses/by-sa/3.0/, with the complete license terms being available from http://creativecommons.org/licenses/by-sa/3.0/legalcode
\ No newline at end of file

Added: izpack-src/trunk/src/doc-reST/html4css1.css
===================================================================
--- izpack-src/trunk/src/doc-reST/html4css1.css	2008-01-20 18:06:49 UTC (rev 1993)
+++ izpack-src/trunk/src/doc-reST/html4css1.css	2008-01-20 18:49:57 UTC (rev 1994)
@@ -0,0 +1,279 @@
+/*
+:Author: David Goodger
+:Contact: goodger at users.sourceforge.net
+:Date: $Date: 2005-12-18 01:56:14 +0100 (Sun, 18 Dec 2005) $
+:Revision: $Revision: 4224 $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin-left: 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left {
+  clear: left }
+
+img.align-right {
+  clear: right }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font-family: serif ;
+  font-size: 100% }
+
+pre.literal-block, pre.doctest-block {
+  margin-left: 2em ;
+  margin-right: 2em ;
+  background-color: #eeeeee }
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+tt.docutils {
+  background-color: #eeeeee }
+
+ul.auto-toc {
+  list-style-type: none }

Modified: izpack-src/trunk/src/doc-reST/index.txt
===================================================================
--- izpack-src/trunk/src/doc-reST/index.txt	2008-01-20 18:06:49 UTC (rev 1993)
+++ izpack-src/trunk/src/doc-reST/index.txt	2008-01-20 18:49:57 UTC (rev 1994)
@@ -1,36 +1,36 @@
-////////////////////////
+/////////////////////
 IzPack documentation
-////////////////////////
+/////////////////////
 
-.. WARNING:: This is a work in progress and should not be used as a reference...
+.. include:: preambule.txt
 
 Chapters
 ========
 
-- introduction_
-- getting-started_
-- installation-files_
-- panels_
-- advanced-features_
-- desktop-shortcuts_
-- creating-panels_
-- user-input_
-- custom-actions_
-- izpack-utils_
-- apache-license_
-- cc-license_
-- cookbooks_
+- `Introduction`_
+- `Getting started`_
+- `Writing installation files`_
+- `Available panels`_
+- `Advanced features`_
+- `Desktop shortcuts`_
+- `Creating panels`_
+- `User input`_
+- `Custom actions`_
+- `IzPack utilities`_
+- `IzPack license`_
+- `Documentation license`_
+- `Cookbooks`_
 
-.. _introduction: introduction.html
-.. _getting-started: getting-started.html
-.. _installation-files: installation-files.html
-.. _panels: panels.html
-.. _advanced-features: advanced-features.html
-.. _desktop-shortcuts: desktop-shortcuts.html
-.. _creating-panels: creating-panels.html
-.. _user-input: user-input.html
-.. _custom-actions: custom-actions.html
-.. _izpack-utils: izpack-utils.html
-.. _apache-license: apache-license.html
-.. _cc-license: cc-license.html
-.. _cookbooks: cookbooks.html
+.. _Introduction: introduction.html
+.. _Getting started: getting-started.html
+.. _Writing installation files: installation-files.html
+.. _Available panels: panels.html
+.. _Advanced features: advanced-features.html
+.. _Desktop shortcuts: desktop-shortcuts.html
+.. _Creating panels: creating-panels.html
+.. _User input: user-input.html
+.. _Custom actions: custom-actions.html
+.. _IzPack utilities: izpack-utils.html
+.. _IzPack license: apache-license.html
+.. _Documentation license: cc-license.html
+.. _Cookbooks: cookbooks.html

Added: izpack-src/trunk/src/doc-reST/izpack.css
===================================================================
--- izpack-src/trunk/src/doc-reST/izpack.css	2008-01-20 18:06:49 UTC (rev 1993)
+++ izpack-src/trunk/src/doc-reST/izpack.css	2008-01-20 18:49:57 UTC (rev 1994)
@@ -0,0 +1,26 @@
+ at import url(html4css1.css);
+
+body {
+    padding: 50px;
+    background-color: #dedede;
+    
+    font-family: helvetica, sans-serif;
+    font-size: 16px;
+}
+
+.document {
+    padding: 2em;
+    
+    background-color: white;
+    border: solid 1px #aaaaaa;
+}
+
+h1.title {
+    padding: 0.5em;
+    background-color: #dedede;
+    border: solid 1px #aaaaaa;
+}
+
+h1 {
+    border-bottom: solid 3px #aaaaaa;
+}
\ No newline at end of file

Modified: izpack-src/trunk/src/doc-reST/pdf-version.txt
===================================================================
--- izpack-src/trunk/src/doc-reST/pdf-version.txt	2008-01-20 18:06:49 UTC (rev 1993)
+++ izpack-src/trunk/src/doc-reST/pdf-version.txt	2008-01-20 18:49:57 UTC (rev 1994)
@@ -1,8 +1,8 @@
-////////////////////////
+/////////////////////
 IzPack documentation
-////////////////////////
+/////////////////////
 
-.. WARNING:: This is a work in progress and should not be used as a reference...
+.. include:: preambule.txt
 
 .. contents::
 

Added: izpack-src/trunk/src/doc-reST/preambule.txt
===================================================================
--- izpack-src/trunk/src/doc-reST/preambule.txt	2008-01-20 18:06:49 UTC (rev 1993)
+++ izpack-src/trunk/src/doc-reST/preambule.txt	2008-01-20 18:49:57 UTC (rev 1994)
@@ -0,0 +1,8 @@
+Forewords
+=========
+
+This documentation is a collective work that received many inputs over the years from many people, notably Julien Ponge, Elmar Grom, Fabrice Mirabile, Tino Schwarze, Klaus Bartz and many more.
+
+We tried to keep it as up-to-date as possible despite a few source format changes and many times where we did not check that new features were properly documented.
+
+If you believe that some portions could be enhanced, fixed, or if you find that some features are not properly documented, feel-free to help us!



More information about the izpack-changes mailing list