simon/adl
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Tidied up documentation file a bit (not yet sufficiently)

Browse source
This commit is contained in:
Simon Brooke 2018-03-18 13:28:07 +00:00
parent 2fc53be9e7
commit dacc4a6429
4 changed files with 484 additions and 695 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

695
adl_user_doc.html Executable file → Normal file
View file

File diff suppressed because it is too large Load diff

192
documentation.css
View file

@ -1,43 +1,169 @@
/****************************************************** /************************************************************************\
* Application Description Language framework * *
* adl2documentation.xslt * weft.css *
* * *
* (c) 2007 Cygnet Solutions Ltd * Purpose: rational reconstruction of the lost Weft stylesheet. *
* * *
* Produce basic documentation of an ADL file * Author: Simon Brooke *
* * Created: 2nd November 2013 *
* $Author: sb $ * *
* $Revision: 1.2 $ \************************************************************************/
*
******************************************************/ body
BODY
{ {
color: Black; background: white;
background-color: White; color: black;
font-family: Sans-Serif; font-family: helvetica, gill, ariel, sans-serif;
} margin: 3em 20% 5em 20%;
width: 60%;
TD, TH
{
text-align: left;
vertical-align: top;
padding: 0.1em 0.5em;
} }
.documentation
a:link
{ {
font-style: italic; color: rgb( 64, 64, 64);
} }
.odd a:hover, a:active
{ {
color: Black; background: silver;
background-color: rgb( 240, 240, 256);
} }
.even a:visited
{ {
color: Black; color: rgb( 128,128,192);
background-color: rgb( 240, 256, 240); }
}
blockquote
{
font-family: 'URW Chancery L', 'Monotype Corsiva', 'Apple Chancery', 'ITC Zapf Chancery', cursive;
font-weight: lighter;
font-style: italic;
color: rgb( 128,128,192);
margin-left: 0.5em;
margin-right: 1em;
}
footer {
font-size: smaller;
text-align: center;
bottom: 0;
}
header {
top: 0;
}
header, footer {
width: 100%;
position: fixed;
z-index: 149;
background-color: rgba( 255, 255, 255, 0.8);
}
h1 {
text-indent: -3em;
padding-left: 3em;
line-height: 130%;
}
h1, h2, h3, h4, h5, dt
{
font-family: "Arial Black", Impact, sans-serif;
color: rgb( 128, 128, 128);
text-align: left;
margin-left: 0.5em;
margin-right: 1em;
font-weight: 900;
}
h1 em {
font-size: 200%;
vertical-align: top;
}
h1 strong {
font-size: 250%;
}
h1 em, h2 em, h3 em, h4 em, h5 em {
font-family: 'URW Chancery L', 'Monotype Corsiva', 'Apple Chancery', 'ITC Zapf Chancery', cursive;
font-weight: lighter;
font-style: italic;
color: rgb( 128,128,192);
}
h1, h2, h3, h4, h5 {
}
hr
{
margin-left: 1em;
margin-right: 1em;
height: 1px;
}
p
{
margin-left: 1em;
margin-right: 2em;
text-align: justify;
font-family: helvetica, gill, ariel, sans-serif;
}
ul.navbox {
margin: 0;
padding: 0;
list-style: none;
}
.copyright
{
color: rgb( 128,128,192);
font-size: x-small;
text-align: center;
}
.logo
{
color: rgb( 128,128,192);
font-style: normal;
float: left;
}
.help
{
font-style: italic;
background: silver;
}
.daynum
{
color: white;
background: rgb( 128,128,192);
font-weight: bold;
}
#nav {
margin: 0;
padding: 0;
width: 100%;
background:rgba(255,255,255,0.8);
}
#nav ul li {
padding: 0;
margin: 0;
display: inline;
}
#nav ul li a {
text-decoration: none;
font-weight: bold;
padding: 0.1em 0.75em;
margin: 0;
}
#nav ul li.active a { background: silver;}
#nav ul li a:hover { background: silver; }
#nav ul li a:active { background: gray; color: white; }

16
remove-edit-sections.xslt Normal file
View file

@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8" ?>
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output method="xml" indent="yes" encoding="UTF-8" omit-xml-declaration="yes"/>
<xsl:template match="*[@class='editsection']">
</xsl:template>
<!-- just copy anything we can't match -->
<xsl:template match="@* | node()">
<xsl:copy>
<xsl:apply-templates select="@* | node()"/>
</xsl:copy>
</xsl:template>
</xsl:stylesheet>

276
schemas/adl-1.4.dtd
View file

@ -11,7 +11,7 @@
<!-- Copyright: (c) 2007 Cygnet Solutions --> <!-- Copyright: (c) 2007 Cygnet Solutions -->
<!-- --> <!-- -->
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: --> <!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
<!-- <!--
$Revision: 1.5 $ $Revision: 1.5 $
--> -->
@ -24,8 +24,8 @@
<!-- Before we start: some useful definitions --> <!-- Before we start: some useful definitions -->
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: --> <!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
<!-- some basic character entities inherited from HTML. Actually we probably ought to <!-- some basic character entities inherited from HTML. Actually we probably ought to
import all the HTML4 character entity files, and possibly the HTML4 Strict DTD (so import all the HTML4 character entity files, and possibly the HTML4 Strict DTD (so
that we can allow HTML block level entities within content elements --> that we can allow HTML block level entities within content elements -->
<!ENTITY nbsp "&#160;"> <!ENTITY nbsp "&#160;">
<!ENTITY pound "&#163;"> <!ENTITY pound "&#163;">
@ -35,7 +35,7 @@ that we can allow HTML block level entities within content elements -->
<!-- boolean means true or false --> <!-- boolean means true or false -->
<!ENTITY % Boolean "(true|false)" > <!ENTITY % Boolean "(true|false)" >
<!-- <!--
Locale is a string comprising an ISO 639 language code followed by a space Locale is a string comprising an ISO 639 language code followed by a space
followed by an ISO 3166 country code, or else the string 'default'. See: followed by an ISO 3166 country code, or else the string 'default'. See:
<URL:http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt> <URL:http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt>
@ -43,12 +43,12 @@ that we can allow HTML block level entities within content elements -->
--> -->
<!ENTITY % Locale "CDATA" > <!ENTITY % Locale "CDATA" >
<!-- <!--
permissions a group may have on an entity, list, page, form or field permissions a group may have on an entity, list, page, form or field
permissions are deemed to increase as you go right. A group cannot permissions are deemed to increase as you go right. A group cannot
have greater permission on a field than on the form it is in, or have greater permission on a field than on the form it is in, or
greater permission on form than the entity it belongs to greater permission on form than the entity it belongs to
none: none none: none
read: select read: select
insert: insert insert: insert
@ -61,10 +61,10 @@ that we can allow HTML block level entities within content elements -->
<!-- <!--
actions which should be cascaded to dependent objects. All these values except actions which should be cascaded to dependent objects. All these values except
'manual' are taken from Hibernate and should be passed through the adl2hibernate 'manual' are taken from Hibernate and should be passed through the adl2hibernate
mapping transparently. Relevent only for properties with type='entity', type='link' mapping transparently. Relevent only for properties with type='entity', type='link'
and type='list' and type='list'
all : cascade delete, save and update all : cascade delete, save and update
all-delete-orphan : see hibernate documentation; relates to transient objects only all-delete-orphan : see hibernate documentation; relates to transient objects only
delete : cascade delete actions, but not save and update delete : cascade delete actions, but not save and update
@ -74,47 +74,47 @@ that we can allow HTML block level entities within content elements -->
--> -->
<!ENTITY % CascadeActions "all|all-delete-orphan|delete|manual|save-update"> <!ENTITY % CascadeActions "all|all-delete-orphan|delete|manual|save-update">
<!-- <!--
data types which can be used in a typedef to provide validation - data types which can be used in a typedef to provide validation -
e.g. a string can be used with a regexp or a scalar can be used with e.g. a string can be used with a regexp or a scalar can be used with
min and max values min and max values
string: varchar java.sql.Types.VARCHAR string: varchar java.sql.Types.VARCHAR
integer: int java.sql.Types.INTEGER integer: int java.sql.Types.INTEGER
real: double java.sql.Types.DOUBLE real: double java.sql.Types.DOUBLE
money: money java.sql.Types.INTEGER money: money java.sql.Types.INTEGER
date: date java.sql.Types.DATE date: date java.sql.Types.DATE
time: time java.sql.Types.TIME time: time java.sql.Types.TIME
timestamp: timestamp java.sql.Types.TIMESTAMP timestamp: timestamp java.sql.Types.TIMESTAMP
uploadable: varchar java.sql.Types.VARCHAR uploadable: varchar java.sql.Types.VARCHAR
image: varchar java.sql.Types.VARCHAR image: varchar java.sql.Types.VARCHAR
uploadable is as string but points to an uploaded file; image is as uploadable is as string but points to an uploaded file; image is as
uploadable but points to an uploadable graphical image file uploadable but points to an uploadable graphical image file
--> -->
<!ENTITY % DefinableDataTypes "string|integer|real|money|date|time|timestamp|uploadable" > <!ENTITY % DefinableDataTypes "string|integer|real|money|date|time|timestamp|uploadable" >
<!-- <!--
data types which are fairly straightforward translations of JDBC data types data types which are fairly straightforward translations of JDBC data types
boolean: boolean or java.sql.Types.BIT boolean: boolean or java.sql.Types.BIT
char(1) java.sql.Types.CHAR char(1) java.sql.Types.CHAR
text: text or java.sql.Types.LONGVARCHAR text: text or java.sql.Types.LONGVARCHAR
memo java.sql.Types.CLOB memo java.sql.Types.CLOB
--> -->
<!ENTITY % SimpleDataTypes "%DefinableDataTypes;|boolean|text" > <!ENTITY % SimpleDataTypes "%DefinableDataTypes;|boolean|text" >
<!-- <!--
data types which are more complex than SimpleDataTypes... data types which are more complex than SimpleDataTypes...
entity : a foreign key link to another entity (i.e. the 'many' end of a entity : a foreign key link to another entity (i.e. the 'many' end of a
one-to-many link); one-to-many link);
list : a list of some other entity that links to me (i.e. the 'one' end of list : a list of some other entity that links to me (i.e. the 'one' end of
a one-to-many link); a one-to-many link);
link : a many to many link (via a link table); link : a many to many link (via a link table);
defined : a type defined by a typedef. defined : a type defined by a typedef.
--> -->
<!ENTITY % ComplexDataTypes "entity|link|list|defined" > <!ENTITY % ComplexDataTypes "entity|link|list|defined" >
<!-- <!--
data types which require special handling - which don't simply map onto data types which require special handling - which don't simply map onto
common SQL data types common SQL data types
geopos : a latitude/longitude pair (experimental and not yet implemented) geopos : a latitude/longitude pair (experimental and not yet implemented)
image : a raster image file, in jpeg|gif|png format (experimental, not yet implemented) image : a raster image file, in jpeg|gif|png format (experimental, not yet implemented)
@ -142,15 +142,15 @@ that we can allow HTML block level entities within content elements -->
present) present)
user-distinct: all properties which are user-distinct (NOTE: Not yet implemented) user-distinct: all properties which are user-distinct (NOTE: Not yet implemented)
listed: only those properties for which fields are explicitly listed listed: only those properties for which fields are explicitly listed
--> -->
<!ENTITY % PageAttrs <!ENTITY % PageAttrs
"name CDATA #REQUIRED "name CDATA #REQUIRED
properties (all|user-distinct|listed) #REQUIRED" > properties (all|user-distinct|listed) #REQUIRED" >
<!-- Actions for generators (mainly for keyfields - see entity 'generator', below <!-- Actions for generators (mainly for keyfields - see entity 'generator', below
assigned: In manually-maintained code, you contract to assign a value assigned: In manually-maintained code, you contract to assign a value
to this property before it is persisted. to this property before it is persisted.
guid: The system will supply a unique GUid value to this field guid: The system will supply a unique GUid value to this field
before it is persisted. before it is persisted.
mannual: You contract to supply a generatos class in manually maintained mannual: You contract to supply a generatos class in manually maintained
code. code.
@ -163,7 +163,7 @@ that we can allow HTML block level entities within content elements -->
canonical: Whatever the normal canonical ordering for this datatype is - canonical: Whatever the normal canonical ordering for this datatype is -
typically alpha-numeric, except for dates, etc. typically alpha-numeric, except for dates, etc.
reverse-canonical: The reverse of the above reverse-canonical: The reverse of the above
possibly there should be some further values but I have no idea what these are possibly there should be some further values but I have no idea what these are
--> -->
<!ENTITY % Sequences "canonical|reverse-canonical"> <!ENTITY % Sequences "canonical|reverse-canonical">
@ -172,9 +172,9 @@ that we can allow HTML block level entities within content elements -->
<!-- Elements --> <!-- Elements -->
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: --> <!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
<!-- <!--
the application that the document describes: required top level element the application that the document describes: required top level element
name: the name of this application name: the name of this application
version: the version number of this application version: the version number of this application
revision: the revision of the ADL document revision: the revision of the ADL document
@ -182,14 +182,14 @@ that we can allow HTML block level entities within content elements -->
xmlns: XML namespace, in case required xmlns: XML namespace, in case required
--> -->
<!ELEMENT application ( specification*, documentation?, content?, typedef*, group*, entity*)> <!ELEMENT application ( specification*, documentation?, content?, typedef*, group*, entity*)>
<!ATTLIST application <!ATTLIST application
name CDATA #REQUIRED name CDATA #REQUIRED
version CDATA #IMPLIED version CDATA #IMPLIED
revision CDATA #IMPLIED revision CDATA #IMPLIED
currency CDATA #IMPLIED currency CDATA #IMPLIED
xmlns CDATA #IMPLIED> xmlns CDATA #IMPLIED>
<!-- <!--
the definition of a defined type. At this stage a defined type is either the definition of a defined type. At this stage a defined type is either
a string in which case it must have size and pattern, or a string in which case it must have size and pattern, or
a scalar in which case it must have minimum and/or maximum a scalar in which case it must have minimum and/or maximum
@ -208,22 +208,22 @@ that we can allow HTML block level entities within content elements -->
--> -->
<!ELEMENT typedef (documentation?, in-implementation*, help*) > <!ELEMENT typedef (documentation?, in-implementation*, help*) >
<!ATTLIST typedef <!ATTLIST typedef
name CDATA #REQUIRED name CDATA #REQUIRED
type (%DefinableDataTypes;) #IMPLIED type (%DefinableDataTypes;) #IMPLIED
size CDATA #IMPLIED size CDATA #IMPLIED
pattern CDATA #IMPLIED pattern CDATA #IMPLIED
minimum CDATA #IMPLIED minimum CDATA #IMPLIED
maximum CDATA #IMPLIED> maximum CDATA #IMPLIED>
<!-- <!--
information about how to translate a type into types known to different target information about how to translate a type into types known to different target
languages. TODO: Once again I'm not wholly comfortable with the name; I'm not languages. TODO: Once again I'm not wholly comfortable with the name; I'm not
really comfortable that this belongs in ADL at all. really comfortable that this belongs in ADL at all.
target: the target language target: the target language
value: the type to use in that target language value: the type to use in that target language
kind: OK, I confess I don't understand this, but Andrew needs it... kind: OK, I confess I don't understand this, but Andrew needs it...
--> -->
<!ELEMENT in-implementation (documentation?)> <!ELEMENT in-implementation (documentation?)>
@ -232,28 +232,28 @@ that we can allow HTML block level entities within content elements -->
value CDATA #REQUIRED value CDATA #REQUIRED
kind CDATA #IMPLIED> kind CDATA #IMPLIED>
<!-- <!--
a group of people with similar permissions to one another a group of people with similar permissions to one another
name: the name of this group name: the name of this group
parent: the name of a group of which this group is subset parent: the name of a group of which this group is subset
--> -->
<!ELEMENT group (documentation?)> <!ELEMENT group (documentation?)>
<!ATTLIST group <!ATTLIST group
name CDATA #REQUIRED name CDATA #REQUIRED
parent CDATA #IMPLIED> parent CDATA #IMPLIED>
<!-- <!--
an entity which has properties and relationships; maps onto a database an entity which has properties and relationships; maps onto a database
table or a Java serialisable class - or, of course, various other things table or a Java serialisable class - or, of course, various other things
name: obviously, the name of this entity name: obviously, the name of this entity
natural-key: if present, the name of a property of this entity which forms natural-key: if present, the name of a property of this entity which forms
a natural primary key [NOTE: Only partly implemented. NOTE: much of a natural primary key [NOTE: Only partly implemented. NOTE: much of
the present implementation assumes all primary keys will be the present implementation assumes all primary keys will be
integers. This needs to be fixed!] DEPRECATED: remove; replace with the integers. This needs to be fixed!] DEPRECATED: remove; replace with the
'key' element, below. 'key' element, below.
table: the name of the table in which this entity is stored. Defaults to same table: the name of the table in which this entity is stored. Defaults to same
@ -264,13 +264,13 @@ that we can allow HTML block level entities within content elements -->
--> -->
<!ELEMENT entity ( documentation?, prompt*, content?, key?, <!ELEMENT entity ( documentation?, prompt*, content?, key?,
property*, permission*, (form | page | list)*)> property*, permission*, (form | page | list)*)>
<!ATTLIST entity <!ATTLIST entity
name CDATA #REQUIRED name CDATA #REQUIRED
natural-key CDATA #IMPLIED natural-key CDATA #IMPLIED
table CDATA #IMPLIED table CDATA #IMPLIED
foreign %Boolean; #IMPLIED> foreign %Boolean; #IMPLIED>
<!-- <!--
contains documentation on the element which immediately contains it. TODO: contains documentation on the element which immediately contains it. TODO:
should HTML markup within a documentation element be allowed? If so, are should HTML markup within a documentation element be allowed? If so, are
there restrictions? there restrictions?
@ -284,33 +284,33 @@ that we can allow HTML block level entities within content elements -->
<!ELEMENT key (property*)> <!ELEMENT key (property*)>
<!-- <!--
a property (field) of an entity (table) a property (field) of an entity (table)
name: the name of this property. name: the name of this property.
type: the type of this property. type: the type of this property.
default: the default value of this property. There will probably be default: the default value of this property. There will probably be
magic values of this! magic values of this!
typedef: name of the typedef to use, it type = 'defined'. typedef: name of the typedef to use, it type = 'defined'.
distinct: distinct='system' required that every value in the system distinct: distinct='system' required that every value in the system
will be distinct (i.e. natural primary key); will be distinct (i.e. natural primary key);
distinct='user' implies that the value may be used by users distinct='user' implies that the value may be used by users
in distinguishing entities even if values are not formally in distinguishing entities even if values are not formally
unique; unique;
distinct='all' implies that the values are formally unique distinct='all' implies that the values are formally unique
/and/ are user friendly (NOTE: not implemented). /and/ are user friendly (NOTE: not implemented).
entity: if type='entity', the name of the entity this property is entity: if type='entity', the name of the entity this property is
a foreign key link to. a foreign key link to.
if type='list', the name of the entity that has a foreign if type='list', the name of the entity that has a foreign
key link to this entity key link to this entity
farkey: if type='list', the name of farside key in the listed farkey: if type='list', the name of farside key in the listed
entity; if type='entity' and the farside field to join to entity; if type='entity' and the farside field to join to
is not the farside primary key, then the name of that is not the farside primary key, then the name of that
farside field farside field
required: whether this propery is required (i.e. 'not null'). required: whether this propery is required (i.e. 'not null').
immutable: if true, once a value has been set it cannot be changed. immutable: if true, once a value has been set it cannot be changed.
size: fieldwidth of the property if specified. size: fieldwidth of the property if specified.
concrete: if set to 'false', this property is not stored in the concrete: if set to 'false', this property is not stored in the
database but must be computed (manually written code must database but must be computed (manually written code must
be provided to support this) be provided to support this)
cascade: what action(s) on the parent entity should be cascaded to cascade: what action(s) on the parent entity should be cascaded to
@ -319,13 +319,13 @@ that we can allow HTML block level entities within content elements -->
column: name of the column in a SQL database table in which this property column: name of the column in a SQL database table in which this property
is stored. TODO: Think about this. is stored. TODO: Think about this.
unsaved-value: unsaved-value:
of a property whose persistent value is set on first being of a property whose persistent value is set on first being
committed to persistent store, the value which it holds before committed to persistent store, the value which it holds before
it has been committed it has been committed
--> -->
<!ELEMENT property ( documentation?, generator?, (permission|option|prompt|help|ifmissing)*)> <!ELEMENT property ( documentation?, generator?, (permission|option|prompt|help|ifmissing)*)>
<!ATTLIST property <!ATTLIST property
name CDATA #REQUIRED name CDATA #REQUIRED
type (%AllDataTypes;) #REQUIRED type (%AllDataTypes;) #REQUIRED
default CDATA #IMPLIED default CDATA #IMPLIED
@ -334,24 +334,24 @@ that we can allow HTML block level entities within content elements -->
entity CDATA #IMPLIED entity CDATA #IMPLIED
farkey CDATA #IMPLIED farkey CDATA #IMPLIED
required %Boolean; #IMPLIED required %Boolean; #IMPLIED
immutable %Boolean; #IMPLIED immutable %Boolean; #IMPLIED
size CDATA #IMPLIED size CDATA #IMPLIED
column CDATA #IMPLIED column CDATA #IMPLIED
concrete %Boolean; #IMPLIED concrete %Boolean; #IMPLIED
cascade (%CascadeActions;) #IMPLIED> cascade (%CascadeActions;) #IMPLIED>
<!-- <!--
marks a property which is auto-generated by some part of the system. marks a property which is auto-generated by some part of the system.
This is based on the Hibernate construct, except that the Hibernate This is based on the Hibernate construct, except that the Hibernate
implementation folds both its internal generators and custom generators implementation folds both its internal generators and custom generators
onto the same attribute. This separates them onto two attributes so we onto the same attribute. This separates them onto two attributes so we
can police values for Hibernate's 'builtin' generators. can police values for Hibernate's 'builtin' generators.
action: one of the supported Hibernate builtin generators, or action: one of the supported Hibernate builtin generators, or
'manual'. 'native' is strongly recommended in most instances 'manual'. 'native' is strongly recommended in most instances
class: if action is 'manual', the name of a manually maintained class: if action is 'manual', the name of a manually maintained
class conforming to the Hibernate IdentifierGenerator class conforming to the Hibernate IdentifierGenerator
interface, or its equivalent in other languages interface, or its equivalent in other languages
--> -->
<!ELEMENT generator (documentation?, param*)> <!ELEMENT generator (documentation?, param*)>
@ -360,15 +360,15 @@ that we can allow HTML block level entities within content elements -->
class CDATA #IMPLIED> class CDATA #IMPLIED>
<!-- <!--
A parameter passed to the generator. Again, based on the Hibernate A parameter passed to the generator. Again, based on the Hibernate
implementation. TODO: #PCDATA is wrong as the content model, as embedded implementation. TODO: #PCDATA is wrong as the content model, as embedded
markup is definitely not allowed! markup is definitely not allowed!
name: the name of this parameter name: the name of this parameter
TODO: This needs to be renamed or removed because it conflicts with the TODO: This needs to be renamed or removed because it conflicts with the
XHTML element of the same name. In fact it could be simply removed since XHTML element of the same name. In fact it could be simply removed since
our usage is compatible with the XHTML usage, but it might be less our usage is compatible with the XHTML usage, but it might be less
ambiguous to rename it. ambiguous to rename it.
--> -->
<!ELEMENT param (#PCDATA)> <!ELEMENT param (#PCDATA)>
@ -377,40 +377,40 @@ that we can allow HTML block level entities within content elements -->
<!-- <!--
one of an explicit list of optional values a property may have one of an explicit list of optional values a property may have
NOTE: whether options get encoded at application layer or at database layer NOTE: whether options get encoded at application layer or at database layer
is UNDEFINED; either behaviour is correct. If at database layer it's also is UNDEFINED; either behaviour is correct. If at database layer it's also
UNDEFINED whether they're encoded as a single reference data table or as UNDEFINED whether they're encoded as a single reference data table or as
separate reference data tables for each property. separate reference data tables for each property.
value: the value of this option value: the value of this option
TODO: This needs to be renamed or removed because it conflicts with the TODO: This needs to be renamed or removed because it conflicts with the
XHTML element of the same name. In fact it could be simply removed since XHTML element of the same name. In fact it could be simply removed since
our usage is compatible with the XHTML usage, but it might be less our usage is compatible with the XHTML usage, but it might be less
ambiguous to rename it. ambiguous to rename it.
--> -->
<!ELEMENT option (documentation?, prompt*)> <!ELEMENT option (documentation?, prompt*)>
<!-- if the value is different from the prompt the user sees, specify it --> <!-- if the value is different from the prompt the user sees, specify it -->
<!ATTLIST option <!ATTLIST option
value CDATA #IMPLIED> value CDATA #IMPLIED>
<!-- <!--
permissions policy on an entity, a page, form, list or field permissions policy on an entity, a page, form, list or field
group: the group to which permission is granted group: the group to which permission is granted
permission: the permission which is granted to that group permission: the permission which is granted to that group
--> -->
<!ELEMENT permission (documentation?)> <!ELEMENT permission (documentation?)>
<!ATTLIST permission <!ATTLIST permission
group CDATA #REQUIRED group CDATA #REQUIRED
permission (%Permissions;) #REQUIRED> permission (%Permissions;) #REQUIRED>
<!-- <!--
pragmatic advice to generators of lists and forms, in the form of pragmatic advice to generators of lists and forms, in the form of
name/value pairs which may contain anything. Over time some pragmas name/value pairs which may contain anything. Over time some pragmas
will become 'well known', but the whole point of having a pragma will become 'well known', but the whole point of having a pragma
architecture is that it is extensible. architecture is that it is extensible.
@ -420,27 +420,27 @@ that we can allow HTML block level entities within content elements -->
name CDATA #REQUIRED name CDATA #REQUIRED
value CDATA #REQUIRED> value CDATA #REQUIRED>
<!-- <!--
a prompt for a property or field; used as the prompt text for a widget a prompt for a property or field; used as the prompt text for a widget
which edits it. Typically there will be only one of these per property which edits it. Typically there will be only one of these per property
per locale; if there are more than one all those matching the locale may per locale; if there are more than one all those matching the locale may
be concatenated, or just one may be used. be concatenated, or just one may be used.
prompt: the prompt to use prompt: the prompt to use
locale: the locale in which to prefer this prompt locale: the locale in which to prefer this prompt
--> -->
<!ELEMENT prompt (documentation?)> <!ELEMENT prompt (documentation?)>
<!ATTLIST prompt <!ATTLIST prompt
prompt CDATA #REQUIRED prompt CDATA #REQUIRED
locale %Locale; #REQUIRED > locale %Locale; #REQUIRED >
<!-- <!--
helptext about a property of an entity, or a field of a page, form or helptext about a property of an entity, or a field of a page, form or
list, or a typedef. Typically there will be only one of these per property list, or a typedef. Typically there will be only one of these per property
per locale; if there are more than one all those matching the locale may per locale; if there are more than one all those matching the locale may
be concatenated, or just one may be used. be concatenated, or just one may be used.
locale: the locale in which to prefer this prompt locale: the locale in which to prefer this prompt
--> -->
<!ELEMENT help (#PCDATA)> <!ELEMENT help (#PCDATA)>
<!ATTLIST help <!ATTLIST help
@ -448,7 +448,7 @@ that we can allow HTML block level entities within content elements -->
xmlns CDATA #IMPLIED > xmlns CDATA #IMPLIED >
<!-- <!--
helpful text to be shown if a property value is missing, typically when helpful text to be shown if a property value is missing, typically when
a form is submitted. Typically there will be only one of these per property a form is submitted. Typically there will be only one of these per property
per locale; if there are more than one all those matching the locale may per locale; if there are more than one all those matching the locale may
be concatenated, or just one may be used. Later there may be more sophisticated be concatenated, or just one may be used. Later there may be more sophisticated
@ -462,7 +462,7 @@ that we can allow HTML block level entities within content elements -->
<!-- a form through which an entity may be added or edited <!-- a form through which an entity may be added or edited
TODO: This needs to be renamed because it conflicts with the TODO: This needs to be renamed because it conflicts with the
XHTML element of the same name. XHTML element of the same name.
--> -->
<!ELEMENT form (documentation?, ( %PageStuff;)*)> <!ELEMENT form (documentation?, ( %PageStuff;)*)>
<!ATTLIST form %PageAttrs;> <!ATTLIST form %PageAttrs;>
@ -472,7 +472,7 @@ that we can allow HTML block level entities within content elements -->
<!ELEMENT page (documentation?, ( %PageStuff;)*)> <!ELEMENT page (documentation?, ( %PageStuff;)*)>
<!ATTLIST page %PageAttrs;> <!ATTLIST page %PageAttrs;>
<!-- an ordering or records in a list <!-- an ordering or records in a list
property: the property on which to order property: the property on which to order
sequence: the sequence in which to order sequence: the sequence in which to order
--> -->
@ -481,11 +481,11 @@ that we can allow HTML block level entities within content elements -->
property CDATA #REQUIRED property CDATA #REQUIRED
sequence (%Sequences;) #IMPLIED> sequence (%Sequences;) #IMPLIED>
<!-- <!--
a list on which entities of a given type are listed a list on which entities of a given type are listed
onselect: name of form/page/list to go to when onselect: name of form/page/list to go to when
a selection is made from the list a selection is made from the list
--> -->
<!ELEMENT list (documentation?, ( %PageStuff;|order)*)> <!ELEMENT list (documentation?, ( %PageStuff;|order)*)>
<!ATTLIST list %PageAttrs; <!ATTLIST list %PageAttrs;
@ -495,7 +495,7 @@ that we can allow HTML block level entities within content elements -->
<!-- <!--
a subsidiary list, on which entities related to primary a subsidiary list, on which entities related to primary
entities in the enclosing page or list are listed entities in the enclosing page or list are listed
property: the property of the enclosing entity that this property: the property of the enclosing entity that this
list displays (obviously, must be of type='list') list displays (obviously, must be of type='list')
onselect: the form or page of the listed entity to call onselect: the form or page of the listed entity to call
@ -510,7 +510,7 @@ that we can allow HTML block level entities within content elements -->
canadd %Boolean; #IMPLIED> canadd %Boolean; #IMPLIED>
<!-- <!--
a group of fields and other controls within a form or list, which the a group of fields and other controls within a form or list, which the
renderer might render as a single pane in a tabbed display, for example. renderer might render as a single pane in a tabbed display, for example.
--> -->
<!ELEMENT fieldgroup (documentation?, (prompt|permission|%FieldStuff;)*)> <!ELEMENT fieldgroup (documentation?, (prompt|permission|%FieldStuff;)*)>
@ -523,10 +523,10 @@ that we can allow HTML block level entities within content elements -->
property: the property which this field displays/edits property: the property which this field displays/edits
--> -->
<!ELEMENT field (documentation?, (prompt|help|permission)*) > <!ELEMENT field (documentation?, (prompt|help|permission)*) >
<!ATTLIST field <!ATTLIST field
property CDATA #REQUIRED > property CDATA #REQUIRED >
<!-- a verb is something that may be done through a form. Probably the verbs 'store' <!-- a verb is something that may be done through a form. Probably the verbs 'store'
and 'delete' are implied, but maybe they need to be explicitly declared. The 'verb' and 'delete' are implied, but maybe they need to be explicitly declared. The 'verb'
attribute of the verb is what gets returned to the controller --> attribute of the verb is what gets returned to the controller -->
<!ELEMENT verb (documentation?, (prompt|help|permission)*) > <!ELEMENT verb (documentation?, (prompt|help|permission)*) >
@ -539,14 +539,14 @@ that we can allow HTML block level entities within content elements -->
<!ELEMENT content (%Content;)*> <!ELEMENT content (%Content;)*>
<!-- <!--
content to place in the head of the generated document; this is #PCDATA content to place in the head of the generated document; this is #PCDATA
because it will almost certainly belong to a different namespace because it will almost certainly belong to a different namespace
(usually HTML) (usually HTML)
TODO: This needs to be renamed or removed because it conflicts with the TODO: This needs to be renamed or removed because it conflicts with the
XHTML element of the same name. In fact it could be simply removed since XHTML element of the same name. In fact it could be simply removed since
our usage is compatible with the XHTML usage, but it might be less our usage is compatible with the XHTML usage, but it might be less
ambiguous to rename it. ambiguous to rename it.
--> -->
<!ELEMENT head (#PCDATA) > <!ELEMENT head (#PCDATA) >
@ -554,30 +554,30 @@ that we can allow HTML block level entities within content elements -->
xmlns CDATA #IMPLIED> xmlns CDATA #IMPLIED>
<!-- <!--
content to place in the top of the body of the generated document; content to place in the top of the body of the generated document;
this is %Flow; which is any HTML block or inline level element. this is %Flow; which is any HTML block or inline level element.
--> -->
<!ELEMENT top (#PCDATA) > <!ELEMENT top (#PCDATA) >
<!ATTLIST top <!ATTLIST top
xmlns CDATA #IMPLIED> xmlns CDATA #IMPLIED>
<!-- <!--
content to place at the foot of the body of the generated document; content to place at the foot of the body of the generated document;
this is %Flow; which is any HTML block or inline level element. this is %Flow; which is any HTML block or inline level element.
--> -->
<!ELEMENT foot (#PCDATA) > <!ELEMENT foot (#PCDATA) >
<!ATTLIST foot <!ATTLIST foot
xmlns CDATA #IMPLIED> xmlns CDATA #IMPLIED>
<!-- <!--
The 'specification' and 'reference' elements are for documentation only, The 'specification' and 'reference' elements are for documentation only,
and do not contribute to the engineering of the application described. and do not contribute to the engineering of the application described.
A specification element is intended chiefly to declare the reference A specification element is intended chiefly to declare the reference
documents which may be used in documentation elements later in the documents which may be used in documentation elements later in the
document. document.
url: The URL from which the document referenced can be retrieved url: The URL from which the document referenced can be retrieved
name: The full name (title) given to this document name: The full name (title) given to this document
abbr: A convenient abbreviated name abbr: A convenient abbreviated name
@ -589,12 +589,12 @@ that we can allow HTML block level entities within content elements -->
abbr CDATA #REQUIRED abbr CDATA #REQUIRED
> >
<!-- <!--
The 'specification' and 'reference' elements are for documentation only, The 'specification' and 'reference' elements are for documentation only,
and do not contribute to the engineering of the application described. and do not contribute to the engineering of the application described.
A reference element is a reference to a specifying document. A reference element is a reference to a specifying document.
abbr: The abbreviated name of the specification to which this abbr: The abbreviated name of the specification to which this
reference refers reference refers
section: The 'anchor part' (part following a hash character) which, section: The 'anchor part' (part following a hash character) which,