XBook - Authoring Pages (page.dtd)

Author: Just van den Broecke
Organization: Just Objects B.V.
Email: just@justobjects.nl

FileID: $Id: authoring-page.xml,v 1.3 2003/01/06 10:28:08 just Exp $
Date: July 8, 2002

This document describes how to author documentation using page.dtd provided with XBook. This DTD can be used to author simple webpages.


1. Overview

THIS ENTIRE DOCUMENT IS WORK IN PROGRESS

Most of the tags in page.dtd are included from text.dtd. See the Authoring Text (text.dtd) guide.

Power users may immediately go to the DTD definition.

2. Full Example

WORK IN PROGRESS

This example is the file xdoc/main.xml used in this documentation as home.

1: <?xml version="1.0" encoding="UTF-8"?> 2: <!DOCTYPE page PUBLIC "-//Just Objects//DTD XBook//EN" "nl/justobjects/xbook/rsc/dtd/page.dtd"> 3: 4: <page> 5: <info> 6: <title>Just Objects - XBook</title> 7: <id>$Id: main.xml,v 1.6 2004/02/04 14:01:20 just Exp $</id> 8: <author> 9: <name>Just van den Broecke</name> 10: <email>just@justobjects.nl</email> 11: </author> 12: <date>Oktober 9, 2003</date> 13: </info> 14: <content> 15: 16: <para> 17: XBook is a set of tools to generate documentation using XML documents. XBook intends 18: to be a lightweight alternative for DocBook. However, not all your content needs to be in XML. 19: You may include other documents such as generated by javadoc or plain HTML. XBook 20: will integrate those documents into a single navigation structure. 21: </para> 22: 23: <para> 24: Since v1.1.0 XBook includes XMenu for generating DHTML style dropdown menus. 25: </para> 26: 27: <para> 28: XBook includes the following tools: 29: </para> 30: 31: <list> 32: <item><italic>xbook</italic> to generate a complete site from a book.xml file</item> 33: <item><italic>xmenu</italic> for generating DHTML style dropdown menus</item> 34: <item><italic>xdoc</italic> for generating HTML docs from any XML document type (docs, photo album, pages etc)</item> 35: </list> 36: <para>In order to author documents some DTDs with corresponding XSL stylesheets are provided:</para> 37: 38: <list> 39: <item><code>doc.dtd</code> for larger documents like software documentation</item> 40: <item><code>page.dtd</code> for single web-pages</item> 41: <item><code>album.dtd</code> for generating HTML photo albums from raw images and some XML</item> 42: <item><code>slide.dtd</code> for generating HTML presentation slides from XML [PLANNED]</item> 43: 44: </list> 45: 46: <para> 47: This document itself is generated from <code>main.xml</code> using <code>page.dtd</code>. 48: </para> 49: 50: </content> 51: </page> 52: 53: 54: 55:

3. DTD Definition

Below is the actual DTD file.

1: <?xml version="1.0" encoding="UTF-8"?> 2: 3: <!-- 4: DTD for basic webpages. 5: 6: $Author: just $ 7: $Id: page.dtd,v 1.5 2003/11/19 15:12:09 just Exp $ 8: 9: --> 10: <!-- Reuse text.dtd for simple text formatting --> 11: <!ENTITY % text-dtd PUBLIC "-//Just Objects//DTD XBook//EN" "nl/justobjects/xbook/rsc/dtd/text.dtd"> 12: <!-- <!ENTITY % text-dtd SYSTEM "nl/justobjects/xbook/rsc/dtd/text.dtd"> --> 13: %text-dtd; 14: 15: 16: <!-- START The top-level --> 17: 18: <!-- Top element --> 19: <!ELEMENT page (info?,content)> 20: 21: <!-- START Meta Info matter --> 22: 23: <!ELEMENT info (title,id?,author,date)> 24: 25: <!ELEMENT title (%CTEXT;)> 26: <!ELEMENT id (%CTEXT;)> 27: <!ELEMENT author (name, email)> 28: <!ELEMENT name (%CTEXT;)> 29: <!ELEMENT email (%CTEXT;)> 30: <!ELEMENT date (%CTEXT;)> 31: 32: 33: <!-- The content --> 34: <!ELEMENT content (%text; | section1 | section2 | section3 | section4)*> 35: 36: <!-- 37: $Log: page.dtd,v $ 38: Revision 1.5 2003/11/19 15:12:09 just 39: many changes for invoking xbook in ant 40: 41: Revision 1.4 2003/01/06 10:27:22 just 42: removed Arial fonts from default styles 43: 44: Revision 1.3 2002/07/09 23:17:32 just 45: allow images to be used in top of menu frame 46: 47: Revision 1.2 2002/07/09 11:54:14 just 48: only comments and moving Log section to end of document. 49: 50: Revision 1.1 2002/07/05 23:56:23 just 51: introduction of page.dtd and page2html.xsl 52: -->

References

[W3C]
World Wide Web Consortium. http://www.w3c.org
[W3C-XML]
World Wide Web Consortium. Extensible Markup Language (XML) 1.0. W3C Recommendation; http://www.w3.org/TR/1998/REC-xml-19980210