annotate docs/ReadMe @ 1148:bc28c3bc3769

Put all stylesheets in one central location
author roug
date Sun, 27 Apr 2003 19:41:14 +0000
parents 1b5656126ac6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
467
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
1 Welcome to the OS-9 documentation effort. The motivation behind scanning
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
2 and reissuing the documentation is that without documentation no new
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
3 users will discover OS-9. This little operating system is more than 20
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
4 years old, and we want it to be here for at least another 20 years.
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
5
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
6 We have therefore tried to find the most durable and rich format
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
7 for documents possible. DocBook is more than 10 years old. Older than
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
8 MS-Word. It began in 1991 as a joint project of HaL Computer Systems and
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
9 O'Reilly. It will very likely be around in 2020 also. If it isn't it is
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
10 a text-based format, so it is possible to reverse-engineer and convert
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
11 the format.
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
12
992
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
13 Docbook is in a transition from an SGML-based format to XML. The two formats are
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
14 not compatible. Primary differences are that the DTD is different. For SGML it is
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
15 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
16 and for XML it is
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
17 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
18 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
19 Furthermore, some elements are terminated with /, such as <void/>, <colspec/> etc.
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
20
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
21 DOCBOOK SGML SOFTWARE:
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
22 ---------------------
467
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
23 To create HTML, PDF or PostScript you must have these RPMs installed on
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
24 your RedHat system:
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
25
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
26 docbook-dtd41-sgml
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
27 sgml-common
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
28 docbook-utils
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
29 docbook-utils-pdf
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
30 tetex-dvips
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
31 tetex
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
32 jadetex
992
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
33 ..see also http://sources.redhat.com/docbook-tools/
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
34
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
35 DocBook Install mini-HOWTO: http://www.tldp.org/HOWTO/mini/DocBook-Install/
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
36
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
37 Another approach is the xmlto application installed on newer RedHat systems.
467
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
38
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
39 DOCBOOK REFERENCES:
992
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
40 -------------------
467
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
41 The Duck book
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
42 http://www.docbook.org/
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
43
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
44 The KDE DocBook Authors guide
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
45 http://i18n.kde.org/doc/markup/
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
46
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
47 The Crash Course to Docbook
b631b0ca676b Added a README file for documentation
roug
parents:
diff changeset
48 http://www.caldera.de/~eric/crash-course/HTML/index.html
992
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
49
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
50 Mark Galassi's tutorial/introduction to writing in DocBook.
1b5656126ac6 Use <errorcode> where appropiate
roug
parents: 467
diff changeset
51 http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro.html
1148
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
52
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
53 DOCBOOK EXTENSIONS:
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
54 -------------------
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
55 At the time of this writing Docbook is undergoing modularisation work.
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
56 One of the new modules is the Extended Backhus-Naur Form, which can
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
57 be used to describe syntax for shell and the C language. But currently
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
58 the renderers don't understand the new elements, so we can't use them.
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
59 I've started to rewrite the shell syntax in os9guide/shell.refentry
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
60
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
61 For Extended Backhus-Naur Forms use:
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
62 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook EBNF Module V1.1CR1//EN"
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
63 "http://www.oasis-open.org/docbook/xml/ebnf/1.1CR1/dbebnf.dtd" [
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
64
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
65
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
66 DSSSL STYLESHEET:
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
67 ----------------
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
68 Docbook2pdf uses DSSSL stylesheet. The main one is located in this directory.
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
69 Since the default DSSSL stylesheet is updated once in a while and you must
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
70 reapply your preferences to the new one, here is what is different from
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
71 the default:
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
72 - Enumerate chapters and sections
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
73 - Use element ids as filenames
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 992
diff changeset
74 - Don't generate article titlepage on separate page