File: website.xml

package info (click to toggle)
docbook-website 2.5.0.0-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,512 kB
  • sloc: xml: 1,341; lisp: 412; java: 77; makefile: 39; javascript: 8; sh: 2
file content (127 lines) | stat: -rw-r--r-- 4,007 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<!DOCTYPE webpage SYSTEM "../schema/dtd/website.dtd" [
<!NOTATION XML SYSTEM "xml">
<!ENTITY test1a SYSTEM "test1a.xml" NDATA XML>
<!ENTITY test3 SYSTEM "test3.xml" NDATA XML>
<!ENTITY about.xml SYSTEM "about.xml" NDATA XML>
]>
<webpage id="home">
<config param="desc" value="The Test Home Page"/>
<config param="rcsdate" value="$Date: 2003/01/16 15:05:46 $"/>
<config param="footer" value="about.html" altval="About..."/>
<head>
<title>Welcome to Website</title>
<summary>Introduction</summary>
<keywords>Norman Walsh, DSSSL, SGML, XML, DocBook, Website</keywords>
</head>

<para> This small, somewhat contrived website demonstrates the
Website document type. Website provides a system for building static
Websites from XML content.</para>

<para>A <ulink url="txtindex.html">text-only</ulink> version is also
available, demonstrating how multiple presentations can be derived from
the same sources.</para>

<webtoc/>

<section><title>What is a Website?</title>

<para>A website is a collection of pages organized, for the purposes of
navigation, into one or more hierarchies. In Website, each page is a
separate XML document authored according to the Website DTD, a customization
of <ulink url="http://www.oasis-open.org/docbook/">DocBook</ulink>.</para>

<para>Website imposes the following additional constraints:</para>

<itemizedlist>
<listitem><para>Each <sgmltag>webpage</sgmltag> must have an ID and
the IDs must be unique across the entire website.</para>
</listitem>
<listitem><para>No page can occur in more than one location in the
navigational hierarchy of the website. Note, however, that you can have
pages, such as the <olink targetdocent="about.xml">about page</olink>,
that don't appear in the navigational hierarchy at all.</para>
</listitem>
</itemizedlist>
</section>

<section><title>Requirements</title>

<para>In order to build a website with Website, you must have:</para>

<itemizedlist>
<listitem><para>The
<ulink url="http://www.oasis-open.org/docbook/xml/4.1.2/">DocBook XML
V4.1.2</ulink> DTD.
</para></listitem>
<listitem><para>An XSLT processor.
</para></listitem>
<listitem><para>The <ulink url="http://nwalsh.com/docbook/xsl/">DocBook
XSL Stylesheets</ulink>.</para>
</listitem>
<listitem><para>The Website DTD and stylesheets.
</para></listitem>
</itemizedlist>

</section>

<section><title>Changes from Website 1.x</title>

<para>I've completely redesigned the way the Website doctype works for
V2. In version 1, all of the pages in a website were part of a single,
monolithic XML document.</para>

<para>Making all of the pages part of a single document had a number
of drawbacks:</para>

<orderedlist>
<listitem><para>It wasn't convenient to update only part of a website
(only the pages that had been changed, for example).
</para></listitem>
<listitem><para>For very large websites, there were memory issues associated
with parsing and formatting the whole thing.
</para></listitem>
<listitem><para>There was no practical way to publish the XML content of
a site.
</para></listitem>
<listitem><para>It was difficult to share pages across different web sites.
</para></listitem>
<listitem><para>It was very tedious to setup a system that allowed
the same content to be published
with different navigational hierarchies.
</para></listitem>
</orderedlist>

<para>Website overcomes all of these difficulties.</para>

<para>In fairness, the old style had some advantages:</para>

<orderedlist>
<listitem><para>There was only a single source document to maintain.
</para></listitem>
<listitem><para>Navigation was derived automatically from the structure
of the source document.
</para></listitem>
<listitem><para>Link checking was cheap and easy.
</para></listitem>
</orderedlist>
</section>

<section id="whatsnew">
<title>What's New</title>
<variablelist>
<varlistentry><term>20 Mar 2001</term>
<listitem>
<para>Reworked using the Website paradigm.</para>
</listitem>
</varlistentry>
</variablelist>
</section>

</webpage>

<!--
Local variables:
mode: docbook
End:
-->