[weld-commits] Weld SVN: r4548 - doc/trunk/reference.

[weld-commits at lists.jboss.org]

Author: dan.j.allen
Date: 2009-11-02 14:14:34 -0500 (Mon, 02 Nov 2009)
New Revision: 4548

Added:
   doc/trunk/reference/README.txt
Modified:
   doc/trunk/reference/Makefile
Log:
add note about IcedTea bug
update name in Makefile


Modified: doc/trunk/reference/Makefile
===================================================================
--- doc/trunk/reference/Makefile	2009-11-02 17:17:25 UTC (rev 4547)
+++ doc/trunk/reference/Makefile	2009-11-02 19:14:34 UTC (rev 4548)
@@ -3,8 +3,8 @@
 #Copyright Red Hat Inc. 2006
 
 XML_LANG	= en-US
-DOCNAME		= WebBeans_Reference_Guide
-PRODUCT		= Web_Beans
+DOCNAME		= Weld_Reference_Guide
+PRODUCT		= Weld_Beans
 BRAND		= JBoss
 
 TRANSLATIONS    = $(XML_LANG)

Added: doc/trunk/reference/README.txt
===================================================================
--- doc/trunk/reference/README.txt	                        (rev 0)
+++ doc/trunk/reference/README.txt	2009-11-02 19:14:34 UTC (rev 4548)
@@ -0,0 +1,33 @@
+NOTE TO EDITORS
+===============
+
+Please honor the formatting that has been applied to these documents so that it is easy to track the changes that are
+made between commits. The formatting is described using VIM modelines, which appear in a comment before the final end
+tag in each document:
+
+<!--
+vim:et:ts=3:sw=3:tw=120
+-->
+
+They describe the following rules:
+
+ - Expand tabs to spaces
+ - indent size: 3 spaces
+ - max line length: 120
+
+Also, each node generation should be indented from its parent.
+
+Generally, the text in paragraphs should appear on separate lines from the <para> tags, but there are some cases when
+this formatting rule has been relaxed.
+
+Bug in IcedTea
+==============
+
+There appears to be a bug in IcedTea on Ubuntu that causes the docbook transformation to fail when inserting an image
+into the document (there are several in the reference guide). See this bug for more details.
+
+http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=447951
+
+Please use the Sun Java JDK if you encounter this problem.
+
+vim:et:ts=3:sw=3:tw=120