[bt-devel] Helpdialog - dockbook format - <set> of <book>(s) :)

Fred Saalbach bt-devel@crosswire.org
Mon, 19 Feb 2001 15:37:46 -0500


This is a multi-part message in MIME format.
--------------4D6719DF898374B7B33D4885
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit

Joachim

And everyone else interested in documentation!

I made a trial run attempting to put several books into a docbook set, and IT
WORKS!

The general form of the docbook looks like this:

<!DOCTYPE Set PUBLIC "-//KDE//DTD DocBook V3.1-Based Variant V1.0//EN" [
<!ENTITY chap1 SYSTEM "intro.dockbook">
]>
<set>
<book>
&chap1
</book>
<book>
Book text
</book>
</set>

I will probably need to rethink the ID= tag format, so that each generated
html file will indicate whether it is help dialog, handbook or whatever.
(there seems to be a limit to the allowed length of the ID="name" name.)
The upside of this is that all of the bibletime html files can remain in one
folder, and will have a common index system.  Index.html now has an index of
books contained in the set, each book has an index for it's contents.
Adding more books to the documentation package should be simple.  See the
attachment (index.html).

I suspect that the source files will go back to something like

bibletime-2/bibletime/docs/en
bibletime-2/bibletime/docs/en/HTML
bibletime-2/bibletime/docs/en/HTML/common

With the docbook files and tipdatabase in /en, generated html files in
/en/HTML and pictures in /common

The target directory for make  won't need to change

It looks like I will need to take a some time to figure out how much I need to
render to Caesar (time to do the taxes here ) so it will be a few days before
I try to refine the layout for the document set.

--
Best Regards
Fred Saalbach
saalbach@sybercom.net



--------------4D6719DF898374B7B33D4885
Content-Type: text/html; charset=us-ascii;
 name="index.html"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="index.html"

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>BibleTime Documentation Package</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="NEXT"
TITLE="The BibleTime Handbook"
HREF="hdbk.html"><META
HTTP-EQUIV="Content-Style-Type"
CONTENT="text/css"><LINK
REL="stylesheet"
HREF="common/kde-common.css"
TYPE="text/css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=iso-8859-1"><META
HTTP-EQUIV="Content-Language"
CONTENT="en"><LINK
REL="stylesheet"
HREF="common/kde-localised.css"
TYPE="text/css"
TITLE="KDE-English"><LINK
REL="stylesheet"
HREF="common/kde-default.css"
TYPE="text/css"
TITLE="KDE-Default"></HEAD
><BODY
CLASS="SET"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#AA0000"
VLINK="#AA0055"
ALINK="#AA0000"
STYLE="font-family: sans-serif;"
><DIV
CLASS="logoheader"
><A
HREF="http://www.kde.org/"
><IMG
SRC="common/logotp3.png"
BORDER="0"
ALT="The K Desktop Environment"
HEIGHT="62"
WIDTH="229"></A
></DIV
><DIV
CLASS="SET"
><A
NAME="AEN1"
></A
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="TITLE"
><A
NAME="AEN1"
>BibleTime Documentation Package</A
></H1
></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="hdbk.html"
>The BibleTime Handbook</A
></DT
><DT
><A
HREF="help.html"
>Bibletime Help Dialog</A
></DT
></DL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="hdbk.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>The BibleTime Handbook</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
--------------4D6719DF898374B7B33D4885--