]> git.saurik.com Git - wxWidgets.git/blame - wxPython/demo/paper.xml
better __docfilter__ and other epydoc tweaks
[wxWidgets.git] / wxPython / demo / paper.xml
CommitLineData
8bf5d46e
RD
1<?xml version="1.0"?>
2<!DOCTYPE gcapaper SYSTEM "gcapap-X.dtd" [
3<!ENTITY footprint SYSTEM "footprint.tif" NDATA tiff >
4<!ENTITY footprint SYSTEM "footprint.eps" NDATA eps >
5<!ENTITY shoes SYSTEM "shoes.tif" NDATA tiff >
9d8bd15f 6<!ENTITY super1 "&#90;">
8bf5d46e
RD
7]>
8
9<gcapaper><front><title>Using SGML to make footprints in the sand
10</title><keyword>footprints</keyword><keyword>sand</keyword>
11<author><fname>Jane</fname><surname>Doe</surname>
12<jobtitle>Empress</jobtitle>
13<address><affil>Universe Corporation</affil>
14<aline>1 Main Street</aline>
15<city>Perfect City</city>
16<province>Dorado</province>
17<cntry>Neutral</cntry><postcode>999999</postcode>
18<phone>+55 555 555 5550</phone>
19<fax>+55 555 555 5555</fax>
20<email>jane@universe.com</email>
21<web>www.universe.com</web>
22</address>
23<bio><para>Jane Doe is the Empress of the Universe <bibref refloc="jd000"/>, a position to which she has always aspired.</para></bio>
24</author>
25<author><fname>Fred</fname><surname>Bloggs</surname>
26<jobtitle>Designer</jobtitle>
27<address><affil>Fred (The Shoe) Bloggs Ltd</affil>
28<aline>1 Shoe Lane</aline>
29<city>Perfect City</city>
30<province>Dorado</province>
31<cntry>Neutral</cntry><postcode>999999</postcode>
32<phone>+55 555 555 1122</phone>
33<fax>+55 555 555 1133</fax>
34<email>fred@shoebloggs.com</email>
35<web>www.shoebloggs.com</web></address>
36<bio><para>Fred has always wanted to create the perfect shoe for making footprints in the sand. Now with SGML and XML, he has been able to document his design.</para></bio>
37</author>
38<abstract>
39<para><keyword>ease</keyword><keyword>documentation</keyword>It's not easy being an Empress of the Universe (<a href="http://www.universe.com"/>), but with the right pair of shoes and the right documentation on how to make footprints in the sand of life, it's easier than it was. Since the introduction of <acronym.grp><acronym>SGML</acronym><expansion>Standard Generalized Markup Language</expansion></acronym.grp> and <acronym.grp><acronym>XML</acronym><expansion>Extensible Markup Language</expansion></acronym.grp> it is now possible to identify and manage the key bits of information on this process.</para>
40</abstract>
41</front>
42<body><section id="jd001"><title>Introduction</title>
43<para><keyword>documentation</keyword>Since its inception, the Universe has always had sand, now it has an Empress, a good shoe design, and <acronym>SGML</acronym> / <acronym>XML</acronym> documentation. The time is now ripe for making <highlight style="ital">footprints</highlight> in the sand.</para></section>
44<section id="jd002"><title>Footprints - truly a push technology</title><keyword>push</keyword>
45<para>One could safely say that making footprints is a push technology. This is even more true when the footprint maker is the Empress of the Universe. </para>
46<subsec1 id="jd003"><title>The sands of time</title><keyword>time</keyword>
47<para>The 1<super>st</super> think to remember about the Universe is the time/space continuum to which it conforms. This then confuses the sands of time to be something more like the sands of time/space continuum because if you wait on those sands long enough they may be somewhere else - not necessarily because of the time/space continuum but because the winds will <highlight style="ital">push</highlight> them down the beach.</para></subsec1>
48<subsec1 id="jd004"><title>Identifying the footprints</title>
49<para>In order to truly understand who has walked on the sands and left the footprints, it is important to identify the <keyword>characteristics</keyword>characteristics of the footprint. In the graphic <xref refloc="jd005" type="title"/>, we can see the footprints are large, well shaped, and evenly distributed from front to back and side to side.</para>
50<figure id="jd005"><title>Footprint in Sand</title><caption><para>Note the evenly distributed shape and indention</para></caption><graphic figname="footprint"/></figure>
51<para>This footprint begs the question, 'What kind of remarkable <keyword>shoe</keyword>shoe could make such a wonderful footprint?'</para>
52<table id="t1">
53<tgroup cols="2">
54<thead><row><entry>Shoe Type</entry><entry>Remarkability Rating</entry></row></thead>
55<tbody><row><entry>Acme Shoe</entry><entry>Unremarkable</entry></row>
56<row><entry>Budget Shoe</entry><entry>Not worth remarking on</entry></row>
57<row><entry>Super Duper Shoe</entry><entry>Absolutely Remarkable</entry></row></tbody>
58</tgroup></table></subsec1>
59<subsec1 id="jd006"><title>The Shoe What Made the Footprint</title>
60<para>The remarkable footprint is made by a combination of a terrific shoe worn on a fantastic foot propelled by a one-of-a-kind Empress. As can be seen in Figure <xref refloc="jd007" type="number"/>, the shoe is worthy of an Empress.</para>
61<figure id="jd007"><title>The Terrific Shoe</title><graphic figname="shoes"/></figure>
62<para>The design goals of the shoe were:
63<randlist style = "bulleted">
64<li><para>to minimize time-consuming manual tasks such as shoelace tying;</para></li>
65<li><para>to allow different decorations to be placed on the toes; and</para></li>
66<li><para>to enforce a good arch.</para></li></randlist></para></subsec1></section>
67<section id="jd008"><title>Documenting the Shoe</title>
68<para>Documenting the shoe was the best part for Fred Bloggs. His superior design could be captured for all time in a neutrally-encoded, content-specific manner. An excerpt from his DTD gives an insight into the type of information he captured in his documentation.</para>
69<code.block>&lt;!DOCTYPE shoedoc [
70&lt;!ELEMENT shoedoc - - (design, mfg, care, recycle) >
71&lt;!ATTLIST shoedoc designer CDATA #REQUIRED
72 date CDATA #REQUIRED>
73&lt;!ELEMENT design - - (specs, desc) >
74etc.
75</code.block>
76<para>An excerpt from the documentation also gives us insights.</para>
77<code.block><![CDATA[<design>
78<specs sizerange="4-12" widthrange="aa-d" color="navy black white red taupe">
79<para>The arch shall be high. The toe shall be narrow, but not pinch. The heel shall not come off in grates. Sand shall not get in.</para></specs>]]>
80</code.block>
81</section></body>
82<rear><acknowl>
83<para>The authors wish to express our thanks to the Universe for being there and to gravity for holding the sand down long enough to see the footprints.</para></acknowl>
84<bibliog>
85<bibitem id="jd000"><bib>Barrett 00</bib><pub>Barrett, B., Being Empress Made Easy, Galaxy Division of Universal Publishers. 0000</pub></bibitem></bibliog></rear></gcapaper>