You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avalon.apache.org by ha...@apache.org on 2001/03/11 17:42:05 UTC

cvs commit: jakarta-avalon-cornerstone/src/xdocs demo-helloworld.xml demo-httpproxy.xml demo-simpleserver.xml book.xml

hammant     01/03/11 08:42:05

  Modified:    src/xdocs book.xml
  Added:       src/xdocs demo-helloworld.xml demo-httpproxy.xml
                        demo-simpleserver.xml
  Log:
  start of documentation on demo apps
  
  Revision  Changes    Path
  1.2       +7 -2      jakarta-avalon-cornerstone/src/xdocs/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-cornerstone/src/xdocs/book.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- book.xml	2001/03/02 04:25:58	1.1
  +++ book.xml	2001/03/11 16:42:03	1.2
  @@ -1,7 +1,7 @@
   <?xml version="1.0"?>
   
  -<book software="Cornerstone" 
  -      title="Cornerstone Documentation" 
  +<book software="Cornerstone"
  +      title="Cornerstone Documentation"
         copyright="@year@ The Apache Software Foundation">
   
     <project label="Back to Avalon" href="@AVALON_BASE@" />
  @@ -16,6 +16,11 @@
   -->
       <menu-item type="changes" label="Changes" source="changes.xml"/>
       <menu-item type="external" id="api-docs" label="API Docs" href="api/index.html"/>
  +  </menu>
  +  <menu label="Demo Components">
  +    <menu-item label="Hello World" source="demo-helloworld.xml"/>
  +    <menu-item label="HTTP Proxy" source="demo-httpproxy.xml"/>
  +    <menu-item label="Simple Server" source="demo-simpleserver.xml"/>
     </menu>
   
   </book>
  
  
  
  1.1                  jakarta-avalon-cornerstone/src/xdocs/demo-helloworld.xml
  
  Index: demo-helloworld.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
  
  <document>
    <header>
      <title>Cornerstone Developer Documentation</title>
      <subtitle>The 'Hello World' Example Application</subtitle>
      <authors>
        <person name="Paul Hammant" email="Paul_Hammant@yahoo.org"/>
      </authors>
    </header>
    <body>
      <s1 title="Introduction">
        <p>
          The 'Hello World' demo server component is a socket listener app that replies 'Hello World' to client applications that open the port.  The reply is in HTML form so can be viewed by a Browser.  The HTTP headers are missing, but it still works.  Telnet is another client that can view the message.
        </p>
      </s1>
      <s1 title="Relevant source modules">
        <p>
          The Helloworld demo copiles as part of the build process for cornerstone.  The important modules that contribute to the demo are listed here.  All are within the src directory
        </p>
        <ol>
          <li>
            <strong>org.apache.cornerstone.demos.helloworldserver package</strong> This package contains the Java source for 'Hello World' and the xinfo block descriptor.
          </li>
          <li>
            <strong>manifest/helloworld-demo.mf</strong> This contains a manifest for use in the bar file that details what's inside the block archive 'demo-helloworld.bar'
          </li>
        </ol>
      </s1>
    </body>
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2001/03/11 16:42:03 $
      </legal>
    </footer>
  </document>
  
  
  
  1.1                  jakarta-avalon-cornerstone/src/xdocs/demo-httpproxy.xml
  
  Index: demo-httpproxy.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
  
  <document>
    <header>
      <title>Cornerstone Developer Documentation</title>
      <subtitle>The 'HTTP Proxy' Example Application</subtitle>
      <authors>
        <person name="Paul Hammant" email="Paul_Hammant@yahoo.org"/>
      </authors>
    </header>
    <body>
      <s1 title="Introduction">
        <p>
          TODO-PH
        </p>
      </s1>
    </body>
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2001/03/11 16:42:03 $
      </legal>
    </footer>
  </document>
  
  
  
  1.1                  jakarta-avalon-cornerstone/src/xdocs/demo-simpleserver.xml
  
  Index: demo-simpleserver.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
  
  <document>
    <header>
      <title>Cornerstone Developer Documentation</title>
      <subtitle>The 'Simple Server' Example Application</subtitle>
      <authors>
        <person name="Charles?" email="todo"/>
      </authors>
    </header>
    <body>
      <s1 title="Introduction">
        <p>
          TODO
        </p>
      </s1>
    </body>
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2001/03/11 16:42:04 $
      </legal>
    </footer>
  </document>
  
  
  

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