<!-- $Id: famlDesign.txt,v 1.4 2000/06/05 22:09:57 soumitra Exp $ -->
<!-- ===================================================================== --> 
<!--				famlDesign.txt				   -->
<!--    Design Document for the faml DTD.  Includes modification history   -->
<!--									   -->
<!--    Copyright B-Bop Associates Inc. 1999, 2000                         -->
<!--    It is required to include this copyright notice with this file     -->
<!-- ===================================================================== -->

Structure of the FAML DTD

faml.dtd		-	Main Container
famlMeta.dtd		-	Metadata Container for the FAML DTD
*****************************************************************************
famlEarnings.dtd	-	Earnings Model for the FAML DTD
				Merged in the Market Data Section
				famlMarketData.dtd
				Please delete this
*****************************************************************************
famlMarketData.dtd	-	Market Data Section for the FAML DTD
famlRecommendation.dtd	-	Recommendations and ratings for FAML
famlDocument.dtd	-	The main document container for FAML
famlDocElements.dtd	-	Contains content model for all the elements
***********************************************************************
famlCompany.dtd		-	Model for a Company

famlEntities.dtd	-	Remove famlCompany and insert
				famlEntities as it contains content
				model for Company, Sector and Industry
***********************************************************************
famlSecurity.dtd	-	Model for Security (stock, bond, forex etc.)
famlPerson.dtd		-	Model for a Person (name etc.)
famlAddress.dtd		-	Model  for addresses
famlTable.dtd		-	Cals table model for a dtd
famlFinterm.dtd	-	-	Container for all financial data models
				and terminology
 ===================================================================== -->

<!-- =====================================================================

		Notes on Content Model

	All content must be assigned to the correct element and attribute
espacially market data, earnings data, recommendations.  All these elements
need to be assigned a unique ID or identifier.  For example earnings for
Q1, 2000 can have an ID=Q12000.  If this element appears in any presentation
table, it should be a cals table entry element and have the corresponding 
IDREF=Q12000.  Therefore a table can be created with the correct element
without storing the element twice.  Please note this while writing input
stylesheets to make sure proper ID's and IDREF's are generated.

========================================================================== -->

Design Finalization: 	Any changes after final check has to be done via
			change request Form.

Module		Date		Finalized By		Checked By

famlAddress	May 14, 2000	sen
famlPerson	May 14, 2000	sen
famlRecom...	May 15, 2000	sen
famlTable	May 15, 2000	sen
famlMeta	May 16, 2000	sen
famlDocument	May 16, 2000	sen
famlDocElements May 16, 2000	sen
famlCompany
changed to
famlEntities	May 16, 2000	sen
famlSecurity	May 16, 2000	sen

Modification History

By	Date		Change In	Changes

sen	May 14, 2000    famlAddress	   registeredAddress made non-optional
sen	May 14, 2000	famlPerson	   personGivenName made non-optional
sen	May 14, 2000	famlRecommendation date attribute added to reco
sen	May 14, 2000		"	   removed all date attributes
					   added rating as prefix
sen	May 15, 2000	famlTable	   changed calsTable to famlTable
					   introduces rowlabel attribute to 
					   entry to indicate that the entry 
					   is a label
sen	May 15, 2000	famlDocElements	   Cleaned up some errors
					   Added the displayGraphic and
					   inlineGraphic elements
sen	May 15, 2000	famlMeta	   Content Model for keyvaluepairs
					   Moved metaSection and metaPara
sen	May 16, 2000	famlDocument	                 "
sen	May 16, 2000	famlCompany	   Removed and changed to famlEntities
sen	May 16, 2000	famlEntities	   Completed content model for few elements
					   Converted some to internal parameter
					   entity (name.mdl)
sen	May 16, 2000	famlSecurity	   Completed some models

====================================================================================

			Key Problems with DTD at this time
				as of June 5, 2000
====================================================================================

famlFinterm	:	Models for Balance Sheet, Cashflow Statement,
			Income Statement and Equity Tables need to be
			looked at closely and re-done

			Financial Terms may be missing that would be of
			importance to the community at large

			Stubs for other data items to be included

			These should be corrected by a proper Standards
			body when they meet

famlMarketData :	Earnings Model, Revenues Model may need some
			work

			Should be undertaken by the Standards Body

famlRecommendation :	Should be looked at by the Standards Body

famlDocuments	   :	Stubs for extending the document types to
			be included

			Will be made available later

===================================================================================