Tidied up documentation file a bit (not yet sufficiently)

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

695
adl_user_doc.html Executable file → Normal file

File diff suppressed because it is too large Load diff

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
a:link
{ {
text-align: left; color: rgb( 64, 64, 64);
vertical-align: top;
padding: 0.1em 0.5em;
} }
.documentation a:hover, a:active
{ {
font-style: italic; background: silver;
} }
.odd a:visited
{ {
color: Black; color: rgb( 128,128,192);
background-color: rgb( 240, 240, 256);
} }
.even blockquote
{ {
color: Black; font-family: 'URW Chancery L', 'Monotype Corsiva', 'Apple Chancery', 'ITC Zapf Chancery', cursive;
background-color: rgb( 240, 256, 240); 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>

View file

@ -78,15 +78,15 @@ that we can allow HTML block level entities within content elements -->
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
@ -96,20 +96,20 @@ that we can allow HTML block level entities within content elements -->
<!-- <!--
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" >
@ -209,12 +209,12 @@ 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