]> granicus.if.org Git - docbook-dsssl/commitdiff
projects / docbook-dsssl / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: cab48e8)
Added notes about Makefile-example.txt and about RNC versions of
authorMichael Smith <xmldoc@users.sourceforge.net>
Fri, 8 Apr 2005 12:11:57 +0000 (12:11 +0000)
committerMichael Smith <xmldoc@users.sourceforge.net>
Fri, 8 Apr 2005 12:11:57 +0000 (12:11 +0000)
schemas; Changed references to "text only" to "non tabular" for
more clarity, and renamed build-textonly.xml to build-nontab.xml

website/example/build-make.xml patch | blob | history
website/example/build-nontab.xml [new file with mode: 0644] patch | blob
website/example/build-textonly.xml [deleted file] patch | blob | history
website/example/build.xml patch | blob | history
website/example/full.xml patch | blob | history
website/example/layout.xml patch | blob | history
website/example/olink.xml patch | blob | history
website/example/website.xml patch | blob | history

diff --git a/website/example/build-make.xml b/website/example/build-make.xml
index a9e001bd843a440652452b6b20507ef949b5e252..299a071e2b18dd9d802c4f60d916d43d6e112f74 100644 (file)
--- a/website/example/build-make.xml
+++ b/website/example/build-make.xml
@@ -17,8 +17,16 @@ you may have to tweak them a bit if you're using some other version of
 <listitem><para>Create your webpages and your <filename>layout.xml</filename>
 file.</para></listitem>
 
-<listitem><para>Create a skeletal <filename>Makefile</filename> like this:
-</para>
+<listitem><para>Create a skeletal <filename>Makefile</filename> like
+the one below.</para>
+
+<note>
+  <para>See the included <ulink
+  url="Makefile-example.txt">Makefile-example.txt</ulink> file for a
+  more detailed example of a real-world makefile. The
+  <filename>Makefile-example.txt</filename> file is the actual
+  makefile used to build the pages you are reading now.</para>
+</note>
 
 <programlisting><![CDATA[PROC=xsltproc
 STYLEDIR=../xsl
diff --git a/website/example/build-nontab.xml b/website/example/build-nontab.xml
new file mode 100644 (file)
index 0000000..51b6565
--- /dev/null
+++ b/website/example/build-nontab.xml
@@ -0,0 +1,24 @@
+<!DOCTYPE webpage SYSTEM "../schema/dtd/website.dtd">
+<webpage id="nontabular">
+<config param="desc" value="Building Non-Tabular Websites"/>
+<config param="rcsdate" value="$Date$"/>
+<head>
+<title>Building Non-Tabular Websites</title>
+<titleabbrev>Non-Tabular</titleabbrev>
+<summary>Building non-tabular Websites</summary>
+</head>
+
+<para>The <filename>tabular.xsl</filename> and
+<filename>chunk-tabular.xsl</filename> stylesheets produce a two-column
+tabular website. If you wish to produce a non-tabular presentation
+more suitable for text-only or audio browsing, use the
+<filename>website.xsl</filename> or
+<filename>chunk-website.xsl</filename> stylesheets.</para>
+
+<para>It's possible to generate both tabular and non-tabular presentations
+in the same directory(ies). Use the <literal>filename-prefix</literal>
+parameter to put a prefix (such as <quote><literal>nontab-</literal></quote>)
+on the non-tabular versions (or put a prefix on the tabular versions,
+if you prefer).</para>
+
+</webpage>
diff --git a/website/example/build-textonly.xml b/website/example/build-textonly.xml
deleted file mode 100644 (file)
index 2585a7d..0000000
--- a/website/example/build-textonly.xml
+++ /dev/null
@@ -1,24 +0,0 @@
-<!DOCTYPE webpage SYSTEM "../schema/dtd/website.dtd">
-<webpage id="textonly">
-<config param="desc" value="Building Text-only Websites"/>
-<config param="rcsdate" value="$Date$"/>
-<head>
-<title>Building Text-only Websites</title>
-<titleabbrev>Text-only</titleabbrev>
-<summary>Building Text-onlyt Websites</summary>
-</head>
-
-<para>The <filename>tabular.xsl</filename> and
-<filename>chunk-tabular.xsl</filename> stylesheets produce a two-column
-tabular website. If you wish to produce a purely text-only presentation
-more suitable for text-only or audio browsing, use the
-<filename>website.xsl</filename> or
-<filename>chunk-website.xsl</filename> stylesheets.</para>
-
-<para>It's possible to generate both tabular and text-only presentations
-in the same directory(ies). Use the <literal>filename-prefix</literal>
-parameter to put a prefix (such as <quote><literal>txt</literal></quote>)
-on the text-only versions (or put a prefix on the tabular versions,
-if you prefer).</para>
-
-</webpage>
diff --git a/website/example/build.xml b/website/example/build.xml
index a7ff54c7d8aad33ed73112a1e3b59253eb0c4695..66723182383363a91f693b58709ef95e0a992ac2 100644 (file)
--- a/website/example/build.xml
+++ b/website/example/build.xml
@@ -18,7 +18,7 @@
  <!-- Main stylesheets -->
  <property name="stylesheetHome" value="${docbookHome}/xsl"/>
 
- <!-- Website DTD and stylesheets -->
+ <!-- Website DTDs/schemas and stylesheets -->
  <property name="websiteHome" value="${docbookHome}/website"/>
 
  <!-- Main Docbook stylesheet -->
diff --git a/website/example/full.xml b/website/example/full.xml
index f7e161a866a7d362a82ef7ed5695d049b1e16657..3c8abf5c05256c0d69eb125b78262a5766acc57c 100644 (file)
--- a/website/example/full.xml
+++ b/website/example/full.xml
@@ -7,9 +7,9 @@
 <para>This is just a test page.</para>
 <webtoc/>
 
-<para>This page uses <filename>website-full.dtd</filename><indexterm>
+<para>This page uses <filename>website-full.dtd</filename>/<filename>website-full.rnc</filename><indexterm>
 <primary><quote>Full</quote> website</primary></indexterm>. The <quote>full</quote>
-DTD is based on DocBook not Simplified DocBook. As such, it can include elements,
+DTD/RELAX NG schema is based on DocBook, not Simplified DocBook. As such, it can include elements,
 like <sgmltag>qandaset</sgmltag> and <sgmltag>index</sgmltag> not present in
 <quote>regular</quote> website.</para>
 
diff --git a/website/example/layout.xml b/website/example/layout.xml
index e66a62b4a4e32c52c066a5173fefa3d25f2309fc..6f6c4b70ba37732db1e9c704d9f3837848f76700 100644 (file)
--- a/website/example/layout.xml
+++ b/website/example/layout.xml
@@ -2,7 +2,7 @@
 <!DOCTYPE layout PUBLIC "-//Norman Walsh//DTD Website Layout V2.5.0//EN"
           "http://docbook.sourceforge.net/release/website/2.5.0/schema/dtd/layout.dtd">
 <layout>
-  <config param="text-prefix" value="txt"/>
+  <config param="text-prefix" value="n-"/>
 
   <config param="homebanner-tabular" value="graphics/homebanner.png"
          altval="Home Banner"/>
@@ -24,19 +24,19 @@
 
   <toc page="website.xml" filename="index.html">
     <tocentry page="wslayout.xml" filename="layout.html"/>
-    <tocentry page="olink.xml" filename="linking.html"/>
+    <tocentry page="olink.xml" filename="linking.html" revisionflag="changed"/>
     <tocentry page="custom.xml" filename="custom.html"/>
     <tocentry page="building.xml" filename="building.html" tocskip='1'>
       <tocentry page="build-make.xml" filename="buildmake.html" revisionflag="changed"/>
       <tocentry page="build-ext.xml" filename="buildext.html"/>
-      <tocentry page="build-textonly.xml" filename="textonly.html"/>
+      <tocentry page="build-nontab.xml" filename="nontab.html"  revisionflag="changed"/>
     </tocentry>
     <tocentry page="test2.xml" filename="formtest.html"/>
     <tocentry page="test3.xml" filename="test3.html"/>
     <tocentry page="rddl.xml" filename="rddl.html"/>
     <tocentry page="php.xml" filename="php.html"/>
-    <tocentry page="rss.xml" filename="rss.html" revisionflag="added"/>
-    <tocentry page="full.xml" filename="full.html" revisionflag="added"/>
+    <tocentry page="rss.xml" filename="rss.html"/>
+    <tocentry page="full.xml" filename="full.html" revisionflag="changed"/>
     <tocentry page="revflag.xml" filename="revflag.html"/>
     <tocentry id="nwalsh.com" href="http://nwalsh.com/">
       <title>nwalsh.com</title>
diff --git a/website/example/olink.xml b/website/example/olink.xml
index b1f31ea506e2ca138c9ebce2e6f33cc8ecf4b950..42bc314225ed078f0119df6f2f6dcfc47ca31007 100644 (file)
--- a/website/example/olink.xml
+++ b/website/example/olink.xml
@@ -75,7 +75,16 @@ generated database file. If you use the default filename
 parameter on the command line.</para>
 </listitem>
 </orderedlist>
-<para>Here is a sample <filename>Makefile</filename> using xsltproc and XML catalogs:</para>
+<para>Below is a simple example <filename>Makefile</filename> (using
+xsltproc and XML catalogs) that does a olink-aware build of a
+website.</para>
+<note>
+  <para>See the included <ulink
+  url="Makefile-example.txt">Makefile-example.txt</ulink> file for a
+  more detailed example of a real-world makefile. The
+  <filename>Makefile-example.txt</filename> file is the actual
+  makefile used to build the pages you are reading now.</para>
+</note>
 <programlisting>
 PROC = XML_CATALOG_FILES=../catalog.xml  xsltproc
 
diff --git a/website/example/website.xml b/website/example/website.xml
index f59192d2e7539d3197f42a97480ee8e2bf16acfa..92631a07bf27a298889de7091b41246ca6ca7dd0 100644 (file)
--- a/website/example/website.xml
+++ b/website/example/website.xml
@@ -13,13 +13,24 @@
 <keywords>Norman Walsh, DSSSL, SGML, XML, DocBook, Website</keywords>
 </head>
 
-<para> This small, somewhat contrived website demonstrates the
+<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>
+<note>
+  <para>Though this "site" remains a good example of a Website
+  instance, the how-to information here is no longer actively
+  maintained. For more up-to-date information, see the <ulink
+  url="http://sagehill.net/docbookxsl/Website.html">Website</ulink>
+  chapter in Bob Stayton's book <ulink
+  url="http://sagehill.net/book-description.html">DocBook XSL: The
+  Complete Guide</ulink>.</para>
+</note>
+
+<para>Both <ulink url="index.html">tabular</ulink> and <ulink
+url="n-index.html">non-tabular</ulink> versions are available,
+demonstrating how multiple presentations can be derived from the same
+sources.</para>
 
 <webtoc/>
 
@@ -27,7 +38,7 @@ the same sources.</para>
 
 <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
+separate XML document authored according to the Website schema/DTD, a customization
 of <ulink url="http://www.oasis-open.org/docbook/">DocBook</ulink>.</para>
 
 <para>Website imposes the following additional constraints:</para>
@@ -46,19 +57,26 @@ that don't appear in the navigational hierarchy at all.</para>
 
 <section><title>Requirements</title>
 
-<para>In order to build a website with Website, you must have:</para>
+<para>In order to build a website with DocBook Website, you must have,
+at a minimum:</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><para>The Website DTD (either
+<filename>website.dtd</filename> or
+<filename>website-full.dtd</filename>) OR the Website RELAX NG schema
+(<filename>website.rnc</filename> or
+<filename>website-full.rnc</filename>).</para></listitem>
+<listitem><para>The <ulink
+url="http://www.oasis-open.org/docbook/xml/4.4/">DocBook XML
+V4.4</ulink> DTD (if you want to use
+<filename>website-full.dtd</filename>).</para></listitem>
+<listitem><para>The Website XSL stylesheets.</para></listitem>
+<listitem><para>The <ulink
+url="http://docbook.sourceforge.net/release/xsl/">DocBook XSL
+Stylesheets</ulink> (which are imported by the Website XSL
+stylesheets).</para>
 </listitem>
-<listitem><para>The Website DTD and stylesheets.
+<listitem><para>An XSLT engine such as Saxon or xsltproc.
 </para></listitem>
 </itemizedlist>
 
Unnamed repository; edit this file 'description' to name the repository.