diff options
author | panne <unknown> | 2004-08-26 20:08:55 +0000 |
---|---|---|
committer | panne <unknown> | 2004-08-26 20:08:55 +0000 |
commit | a1939730ba7a460d702aca22322c4ec558e8be6d (patch) | |
tree | 6610d61c46e65191414110753580ead48d2dd0e0 /docs | |
parent | bb88e732b7383c10496c0f60c3bdea2c22362cc6 (diff) | |
download | haskell-a1939730ba7a460d702aca22322c4ec558e8be6d.tar.gz |
[project @ 2004-08-26 20:08:39 by panne]
SGML is dead, long live DocBook XML!
Note: The BuildRequires tags in the spec files are still incomplete
and the documentation about the DocBook tools needs to be updated,
too. Stay tuned...
Diffstat (limited to 'docs')
-rw-r--r-- | docs/building/building.xml | 13 | ||||
-rw-r--r-- | docs/docbook-cheat-sheet/docbook-cheat-sheet.xml | 4 | ||||
-rw-r--r-- | docs/fptools-both.dsl | 144 |
3 files changed, 8 insertions, 153 deletions
diff --git a/docs/building/building.xml b/docs/building/building.xml index 32a4f9de88..7f063cfd7e 100644 --- a/docs/building/building.xml +++ b/docs/building/building.xml @@ -3345,9 +3345,8 @@ directive. <indexterm><primary>DocBook, pre-supposed</primary></indexterm> </term> <listitem> - <para>Much of our documentation is written in SGML, using - the DocBook DTD. Instructions on installing and - configuring the DocBook tools are below.</para> + <para>Much of our documentation is written in DocBook XML, instructions + on installing and configuring the DocBook tools are below.</para> </listitem> </varlistentry> @@ -3548,11 +3547,11 @@ $ make install</screen> <para>Because there are many different formats that the DocBook documentation can be generated in, you have to select which ones - you want by setting the <literal>SGMLDocWays</literal> variable + you want by setting the <literal>XMLDocWays</literal> variable to a list of them. For example, in <filename>build.mk</filename> you might have a line:</para> -<screen>SGMLDocWays = html ps</screen> +<screen>XMLDocWays = html ps</screen> <para>This will cause the documentation to be built in the requested formats as part of the main build (the default is not to build @@ -3572,9 +3571,9 @@ $ make install</screen> documentation, which goes into <literal>$(datadir)/html</literal>, to keep things tidy.</para> - <para>Note that unless you set <literal>$(SGMLDocWays)</literal> + <para>Note that unless you set <literal>$(XMLDocWays)</literal> to a list of formats, the <literal>install-docs</literal> target - won't do anything for SGML documentation.</para> + won't do anything for DocBook XML documentation.</para> </sect2> </sect1> diff --git a/docs/docbook-cheat-sheet/docbook-cheat-sheet.xml b/docs/docbook-cheat-sheet/docbook-cheat-sheet.xml index 7f76339a7c..f90ab7a085 100644 --- a/docs/docbook-cheat-sheet/docbook-cheat-sheet.xml +++ b/docs/docbook-cheat-sheet/docbook-cheat-sheet.xml @@ -61,7 +61,7 @@ <varlistentry> <term>Comments</term> <listitem> - <para>Comments in SGML look like this: <sgmltag + <para>Comments in XML look like this: <sgmltag class="sgmlcomment">This is a comment</sgmltag>.</para> </listitem> </varlistentry> @@ -175,7 +175,7 @@ <sect1 id="docbook-tables"> <title>Tables</title> - <para>Tables are quite complicated to write in SGML (as in HTML, + <para>Tables are quite complicated to write in DocBook XML (as in HTML, there are lots of fiddly tags), so here's an example you can cannibalise. In the spirit of the LaTeX short introduction I don't repeat all the markup verbatim; you have to look at the source for diff --git a/docs/fptools-both.dsl b/docs/fptools-both.dsl deleted file mode 100644 index e04d221f2a..0000000000 --- a/docs/fptools-both.dsl +++ /dev/null @@ -1,144 +0,0 @@ -<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [ -<!ENTITY % html "IGNORE"> -<![%html;[ -<!ENTITY % print "IGNORE"> -<!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" CDATA dsssl> -]]> -<!ENTITY % print "INCLUDE"> -<![%print;[ -<!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook Print Stylesheet//EN" CDATA dsssl> -]]> -]> - -<!-- This is (or was) the standard Cygnus DocBook tools stylesheet - -Options added: - -%section-autolabel%: true -%paper-type%: A4 - ---> - - -<style-sheet> - -<style-specification id="print" use="docbook"> -<style-specification-body> - -;; ==================== -;; customize the print stylesheet -;; ==================== - -;; make funcsynopsis look pretty -(define %funcsynopsis-decoration% - ;; Decorate elements of a FuncSynopsis? - #t) - -;; use graphics in admonitions, and have their path be "." -;; NO: we are not yet ready to use gifs in TeX and so forth -(define %admon-graphics-path% - "./") -(define %admon-graphics% - #f) - -;; this is necessary because right now jadetex does not understand -;; symbolic entities, whereas things work well with numeric entities. -(declare-characteristic preserve-sdata? - "UNREGISTERED::James Clark//Characteristic::preserve-sdata?" - #f) -(define %two-side% #t) - -(define %section-autolabel% - ;; Are sections enumerated? - #t) -;; (define %title-font-family% -;; ;; The font family used in titles -;; "Ariel") -(define %visual-acuity% - ;; General measure of document text size - ;; "presbyopic" - ;; "large-type" - "normal") - -(define %generate-set-toc% #t) -(define %generate-part-toc% #t) - -;; (define %block-start-indent% 10pt) - -(define %graphic-default-extension% "eps") - -(define %paper-type% - ;; Name of paper type - "A4") - -</style-specification-body> -</style-specification> - -<!-- -;; ==================== -;; customize the html stylesheet -;; ==================== ---> -<style-specification id="html" use="docbook"> -<style-specification-body> - -;; this is necessary because right now jadetex does not understand -;; symbolic entities, whereas things work well with numeric entities. -(declare-characteristic preserve-sdata? - "UNREGISTERED::James Clark//Characteristic::preserve-sdata?" - #f) - -;; put the legal notice in a separate file -(define %generate-legalnotice-link% - #t) - -;; use graphics in admonitions, and have their path be "stylesheet-images" -;; NO: they do not yet look very good -(define %admon-graphics-path% - "./stylesheet-images/") -(define %admon-graphics% - #f) - -;; make funcsynopsis look pretty -(define %funcsynopsis-decoration% - ;; Decorate elements of a FuncSynopsis? - #t) - -(define %html-ext% ".html") -(define %body-attr% - ;; What attributes should be hung off of BODY? - '()) -;; (list -;; (list "BGCOLOR" "#FFFFFF") -;; (list "TEXT" "#000000"))) - -(define %generate-article-toc% - ;; Should a Table of Contents be produced for Articles? - ;; If true, a Table of Contents will be generated for each 'Article'. - #t) - -(define %generate-part-toc% #t) - -(define %shade-verbatim% - #t) - -(define %use-id-as-filename% - ;; Use ID attributes as name for component HTML files? - #t) - -(define %graphic-default-extension% "gif") - -(define %section-autolabel% #t) - -;; Uncomment the setting below if you want .html output as one -;; big page. [ Notice that 'jade' dumps the output on stdout -;; rather than on honour the -o option...at least my copy does.] -;; -;;(define nochunks #t) - -</style-specification-body> -</style-specification> - -<external-specification id="docbook" document="docbook.dsl"> - -</style-sheet> |