You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by er...@apache.org on 2006/08/29 20:58:24 UTC

svn commit: r438163 - in /incubator/cxf/trunk: STATUS docs/src/docs/styleguide/exclude.xml docs/src/docs/styleguide/general.xml

Author: ericjohnson
Date: Tue Aug 29 11:58:24 2006
New Revision: 438163

URL: http://svn.apache.org/viewvc?rev=438163&view=rev
Log:
Added:
Incubator STATUS file
Updated:
parts of XML doc guide how to

Added:
    incubator/cxf/trunk/STATUS
Modified:
    incubator/cxf/trunk/docs/src/docs/styleguide/exclude.xml
    incubator/cxf/trunk/docs/src/docs/styleguide/general.xml

Added: incubator/cxf/trunk/STATUS
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/STATUS?rev=438163&view=auto
==============================================================================
--- incubator/cxf/trunk/STATUS (added)
+++ incubator/cxf/trunk/STATUS Tue Aug 29 11:58:24 2006
@@ -0,0 +1,83 @@
+##
+## $Rev: 46019 $ $Date: 2004-09-14 02:56:06 -0700 (Tue, 14 Sep 2004) $
+##
+
+Exit Criteria
+(put an X next to item when it is complete):
+
+Copyrights & Licensing
+
+  -- Do all the software in the codebase has its copyright assigned to The
+     Apache Software Foundation?
+
+  -- Do All the software in the codebase, are licensed (or multi-licensed) under the
+     Apache licence?
+
+  -- Do all the software in the codebase,are compliant with the
+     Specifications set by Java Community Process?(Wherever applicable)
+     * This criteria has been superceded by the Exit Milestone below
+
+Distribution rights
+
+  -- For all code included with the distribution that is not under the
+     Apache license, do we have the right to combine with Apache-licensed
+     code and redistribute?
+
+  -- Is all source code distributed by the project covered by one or more
+     of the following approved licenses:  Apache, BSD, Artistic, MIT/X,
+     MIT/W3C, MPL 1.1, or something with essentially the same terms?
+
+Infrastructure
+
+X -- SVN modules created and committers added to avail file?
+     Yes:       https://svn.apache.org/repos/asf/incubator/cxf
+
+  -- Are the developer,commit and user mailing lists set up and archived?
+
+  -- Bug tracking system enabled?
+     Yes:       https://issues.apache.org/jira/browse/CXF
+
+  -- wiki based documentation site enabled?
+
+  -- Has the project migrated to our infrastructure?
+
+Committers:
+
+  -- Have all of the active long-term volunteers been identified
+     and acknowledged as committers on the project?
+
+  -- Have all the commiters signed the CLA?
+
+  -- Do they have accounts on svn.apache.org?
+
+  -- Are there three or more independent committers?
+     Yes
+
+Collaborative Development:
+
+  -- Are project decisions being made in public by the committers?
+
+  -- Are the decision-making guidelines published and agreed to by
+     all of the committers?
+
+  -- Does the documentation site has enough information on the architecure, design decisions and
+     modules?
+
+  -- Has the community, the graduation/new PMC of the project to which the codebase and community
+     will move at the end of incubation (if any), and the Incubator PMC, decided the
+     expected time frame of stay in incubator?
+
+  -- Has the community adopted the Apache voting rules and is otherwise following the Apache
+     guidelines?
+
+Exit Milestone:
+
+organisational acceptance:
+
+  -- Has the board accepted moving to a existing/new PMC?
+
+
+Incubator sign-off:
+
+  -- Has the Incubator decided that the project has accomplished all
+     of the above tasks?

Modified: incubator/cxf/trunk/docs/src/docs/styleguide/exclude.xml
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/docs/src/docs/styleguide/exclude.xml?rev=438163&r1=438162&r2=438163&view=diff
==============================================================================
--- incubator/cxf/trunk/docs/src/docs/styleguide/exclude.xml (original)
+++ incubator/cxf/trunk/docs/src/docs/styleguide/exclude.xml Tue Aug 29 11:58:24 2006
@@ -23,7 +23,6 @@
         simplification, the following elements are excluded from the set used:</para>
 	<itemizedlist>
 	  <listitem><para><sgmltag class="element">ackno</sgmltag></para></listitem>
-	  <listitem><para><sgmltag class="element">acronym</sgmltag></para></listitem>
 	  <listitem><para><sgmltag class="element">address</sgmltag></para></listitem>
 	  <listitem><para><sgmltag class="element">affiliation</sgmltag></para></listitem>
 	  <listitem><para><sgmltag class="element">appendixinfo</sgmltag></para></listitem>

Modified: incubator/cxf/trunk/docs/src/docs/styleguide/general.xml
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/docs/src/docs/styleguide/general.xml?rev=438163&r1=438162&r2=438163&view=diff
==============================================================================
--- incubator/cxf/trunk/docs/src/docs/styleguide/general.xml (original)
+++ incubator/cxf/trunk/docs/src/docs/styleguide/general.xml Tue Aug 29 11:58:24 2006
@@ -43,6 +43,156 @@
 			 <sgmltag class="attribute">role</sgmltag> attribute to 
 			 <sgmltag class="attrvalue">strong</sgmltag>.</seg>
 	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">literallayout</sgmltag></seg>
+		<seg>Specifies that the content of the element is to be reproduced with all of the 
+		     whitespace preserved.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">subscript</sgmltag></seg>
+		<seg>Specifies that the content of the element is a subscript as in  
+		     H<subscript>2</subscript>O.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">superscript</sgmltag></seg>
+		<seg>Specifies that the content of the element is a superscript as in  
+		     E=MC<superscript>2</superscript>.</seg>
+	  </seglistitem>
+    </segmentedlist>
+  </section>	
+  <section>
+    <title>General Computing Elements</title>
+	<para>The following are elements used when dealing with computer technology:</para>
+	<segmentedlist>
+	  <segtitle>Element</segtitle>
+	  <segtitle>Description</segtitle>
+	  <seglistitem>
+	    <seg><sgmltag class="element">action</sgmltag></seg>
+		<seg>Specifies that content describes a response to some user initiated action.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">application</sgmltag></seg>
+		<seg>Specifies that the content is the name of a piece of software.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">computeroutput</sgmltag></seg>
+		<seg>Specifies that the content is text printed on a computer display.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">database</sgmltag></seg>
+		<seg>Specifies that the content is the name of a database, or part of a database.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">email</sgmltag></seg>
+		<seg>Specifies that the content is an e-mail address.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">envar</sgmltag></seg>
+		<seg>Specifies that the content is the name of an environment variable.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">errorcode</sgmltag></seg>
+		<seg>Specifies that the content is an error code.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">errorname</sgmltag></seg>
+		<seg>Specifies that the content is the name of an error.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">errortext</sgmltag></seg>
+		<seg>Specifies that the content is the text generated whan an error occurs.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">filename</sgmltag></seg>
+		<seg>Specifies that the content is the name of a file.</seg>
+      </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">hardware</sgmltag></seg>
+		<seg>Specifies that the content is a piece of computer hardware.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">option</sgmltag></seg>
+		<seg>Specifies that the content is an option to a command.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">prompt</sgmltag></seg>
+		<seg>Specifies that the content is the string used as a prompt for data on a computer screen.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">userinput</sgmltag></seg>
+		<seg>Specifies that the content is data a user enters into a computer system.</seg>
+	  </seglistitem>
+    </segmentedlist>
+  </section>	
+  <section>
+    <title>Other General Elements</title>
+	<para>The following are other general use elements used in Docbook:</para>
+	<segmentedlist>
+	  <segtitle>Element</segtitle>
+	  <segtitle>Description</segtitle>
+	  <seglistitem>
+	    <seg><sgmltag class="element">abbrev</sgmltag></seg>
+		<seg>Specifies that the content is an abbreviation.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">acronym</sgmltag></seg>
+		<seg>Specifies that the content is an acronym.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">firstterm</sgmltag></seg>
+		<seg>Specifies that the content is the first occurence of a new term or is a term that 
+		     is used a context specific manner.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">literal</sgmltag></seg>
+		<seg>Specifies that the content is a literal value.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">optional</sgmltag></seg>
+		<seg>Specifies that the content is optional information. It is typically used in command 
+		     synopsis.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">replaceable</sgmltag></seg>
+		<seg>Specifies that the content represents a value that wil lbe replaced by the user in 
+		     using the product.</seg>
+	  </seglistitem>
+    </segmentedlist>
+  </section>	
+  <section>
+    <title>GUI Elements</title>
+	<para>The following are Docbook elements used in documenting a GUI:</para>
+	<segmentedlist>
+	  <segtitle>Element</segtitle>
+	  <segtitle>Description</segtitle>
+	  <seglistitem>
+	    <seg><sgmltag class="element">accel</sgmltag></seg>
+		<seg>Specifies that the content is a keyboard shortcut.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">guibutton</sgmltag></seg>
+		<seg>Specifies that the content is the label on a GUI button.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">guilabel</sgmltag></seg>
+		<seg>Specifies that the content is a lable on a GUI element other than a button.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">guimenu</sgmltag></seg>
+		<seg>Specifies that the content is the name of a menu.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">guimenuitem</sgmltag></seg>
+		<seg>Specifies that the content is a selectable item on a menu.</seg>
+	  </seglistitem>
+	  <seglistitem>
+	    <seg><sgmltag class="element">guisubmenu</sgmltag></seg>
+		<seg>Specifies that the content is the name of a submenu.</seg>
+	  </seglistitem>
+      <seglistitem>
+	    <seg><sgmltag class="element">mousebutton</sgmltag></seg>
+	    <seg>Specifies that the content is the name of a mousebutton.</seg>
+	  </seglistitem>
     </segmentedlist>
   </section>	
 </chapter>