You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2003/06/04 05:47:08 UTC
cvs commit: avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/attributes navigation.xml index.xml attribute.xml

mcconnell    2003/06/03 20:47:08

  Added:       merlin/merlin-smp/xdocs/meta/info/attributes navigation.xml
                        index.xml attribute.xml
  Log:
  Addition of attributes and attribute documetation to the meta-info doc suite.
  
  Revision  Changes    Path
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/attributes/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <project>
  
   <title>Merlin</title>
  
   <body>
  
       <links>
         <item name="Home" href="http://avalon.apache.org/"/>
         <item name="Framework" href="http://avalon.apache.org/framework/"/>
         <item name="Components" href="http://avalon.apache.org/components"/>
         <item name="Containers" href="http://avalon.apache.org/containers/"/>
         <item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
       </links>
  
      <menu name="About Merlin">
        <item name="Overview" href="/about/index.html"/>
        <item name="Getting Started" href="/starting/index.html"/>
        <item name="Merlin System" href="/merlin/index.html"/>
        <item name="Meta Model" href="/meta/index.html">
          <item name="Meta Info" href="/meta/info/index.html">
            <item name="Type" href="/meta/info/type/index.html"/>
            <item name="Service" href="/meta/info/service.html"/>
            <item name="Attributes" href="/meta/info/attributes/index.html">
              <item name="Attribute" href="/meta/info/attributes/attribute.html"/>
            </item>
          </item>
          <item name="Meta Data" href="/meta/model/index.html"/>
        </item>
        <item name="Tools" href="/tools/index.html"/>
        <item name="Resources" href="/resources/index.html"/>
      </menu>
  
      <menu name="Extensions">
        <item name="JNDI" href="/extensions/jndi/index.html"/>
        <item name="Servlet" href="/extensions/servlet/index.html"/>
      </menu>
  
   </body>
  
  </project>
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/attributes/index.xml
  
  Index: index.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Attributes Descriptor</title>
    </properties>
  
    <body>
      <section name="Attributes">
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td><a href="attribute.html">attribute</a></td><td>0..n</td>
              <td>
               An attribute declartation.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Description">
  <p>
  Declaration of a set of attributes.
  </p>
        </subsection>
  
        <subsection name="Example XML">
  
  <source>
      &lt;attributes&gt;
        &lt;attribute key="size" value="small"/&gt;
        &lt;attribute key="maximum" value="1200"/&gt;
      &lt;/attributes&gt;
  </source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Avalon Apache Project. All rights reserved.
        $Revision: 1.1 $ $Date: 2003/06/04 03:47:08 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/attributes/attribute.xml
  
  Index: attribute.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Stage Descriptors</title>
    </properties>
  
    <body>
      <section name="Attribute Descriptor">
  
        <subsection name="Attributes">
          <table>
            <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
            <tr>
              <td>key</td><td>yes</td>
              <td>
               Declaration of the atttribute key.
              </td>
            </tr>
            <tr>
              <td>value</td><td>yes</td>
              <td>
               Declaration of the atttribute value.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Description">
  <p>
  The attribute descriptor declares the binding of an attribute name and value.  The descriptor is used within the scope of several meta-info structures including tyhe &lt;info&gt;, &lt;logger&gt;, &lt;service&gt;, &lt;dependency&gt;, &lt;stage&gt;, and &lt;extension&gt; descriptors.
  </p>
        </subsection>
  
        <subsection name="Example XML">
  
  <source>
    &lt;info&gt;
      &lt;name&gt;my-component&lt;/name&gt;
      &lt;attributes&gt;
        &lt;attribute key="size" value="small"/&gt;
        &lt;attribute key="maximum" value="1200"/&gt;
      &lt;/attributes&gt;
    &lt;/info&gt;
  </source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/06/04 03:47:08 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org