avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dona...@apache.org
Subject cvs commit: jakarta-avalon-phoenix/src/schema blockinfo.dtd
Date Sat, 15 Dec 2001 04:53:14 GMT
donaldp     01/12/14 20:53:14

  Modified:    src/schema blockinfo.dtd
  Log:
  Update BlockInfo DTD to be more accurate and add some comments in about format.
  
  Revision  Changes    Path
  1.3       +74 -23    jakarta-avalon-phoenix/src/schema/blockinfo.dtd
  
  Index: blockinfo.dtd
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-phoenix/src/schema/blockinfo.dtd,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- blockinfo.dtd	2001/09/20 14:30:00	1.2
  +++ blockinfo.dtd	2001/12/15 04:53:14	1.3
  @@ -1,26 +1,77 @@
  +<!--
   
  -<!-- top-level element -->
  +   This is the DTD defining the Phoenix BlockInfo 1.0
  +   descriptor (XML) file format/syntax.
  +
  +   Author: Peter Donald <peter@apache.org>
  +
  +   A BlockInfo is an XML file used to describe Blocks and located side-by-side with
  +   the Block .class file. It describes the services the Block requires to operate,
  +   the services the Block is capable of offerring other Blocks and other support
  +   meta data.
  +
  +   Copyright (C) The Apache Software Foundation. All rights reserved.
  +
  +   This software is published under the terms of the Apache Software License
  +   version 1.1, a copy of which has been included  with this distribution in
  +   the LICENSE.txt file.
  +
  +  -->
  +
  +<!--
  +The blockinfo is the document root, it defines:
  +
  +block	     the specifc details about this block
  +services     the services offered by this block
  +dependencies the services that this block require to operate
  +-->
   <!ELEMENT blockinfo (block, services?, dependencies?)>
  +<!ATTLIST blockinfo id ID #IMPLIED
  +          xmlns CDATA #FIXED "http://jakarta.apache.org/phoenix/blockinfo_1_0.dtd" >
  +
  +<!--
  +The block element describes the block, it defines:
   
  -  <!-- annotation elements are used for documentation purposes -->
  -  <!ELEMENT annotation  (#PCDATA) >
  -    <!ATTLIST annotation  language  CDATA #REQUIRED >
  -
  -  <!-- element to describe a block -->  
  -  <!ELEMENT block          (annotation*, version)>
  -    <!--!ELEMENT classname     (#PCDATA)-->
  -    <!ELEMENT version       (#PCDATA) >
  -
  -  <!-- elements to describe a service -->  
  -  <!ELEMENT service   EMPTY >
  -    <!ATTLIST service   name      CDATA  #REQUIRED >
  -    <!ATTLIST service   version   CDATA  #REQUIRED >
  -
  -  <!-- elements to describe the services a block offers -->  
  -  <!ELEMENT services    (service*)>
  -
  -  <!-- elements to describe the services a block requires -->  
  - <!ELEMENT dependencies    (dependency*)>
  -    <!ELEMENT dependency  (annotation*,role?,service,signers?) >    
  -      <!ELEMENT role        (#PCDATA) >
  -      <!ELEMENT signers     (#PCDATA) >
  +version	     the version of the block in (in the format #.#.#, #.# or # where
  +             # is a integer
  +-->
  +<!ELEMENT block          (version)>
  +  <!ELEMENT version       (#PCDATA) >
  +
  +<!--
  +The service element describes a service that the block
  +can provide to other blocks, or this block depends upon.
  +It defines:
  +
  +name         the name of the service. This must be equal to the class name of the
  +             interface that defines the service.
  +version	     the version of the block in (in the format #.#.#, #.# or # where
  +             # is a integer
  +-->
  +<!ELEMENT service   EMPTY >
  +  <!ATTLIST service   name      CDATA  #REQUIRED >
  +  <!ATTLIST service   version   CDATA  #REQUIRED >
  +
  +<!--
  +The service dependency describes a service that the block
  +requires. It defines:
  +
  +role         the role of the service. This is the value that is used to lookup the
  +             service in the ComponentManager. If not provided it defaults to the
  +             value specified in the name attribute of service element
  +service	     the service that is required
  +-->
  +<!ELEMENT dependency  (role?,service) >
  +  <!ELEMENT role        (#PCDATA) >
  +
  +<!--
  +The services element contains a list of services that this Block supports.
  +It contains service elements.
  +-->
  +<!ELEMENT services    (service*)>
  +
  +<!--
  +The dependencies element contains a list of services that this Block requires.
  +It contains dependency elements.
  +-->
  +<!ELEMENT dependencies    (dependency*)>
  
  
  

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


Mime
View raw message