Date: Sun, 23 Mar 2003 07:59:26 +0900 (JST) From: Hiroki Sato <hrs@eos.ocn.ne.jp> To: doc@FreeBSD.ORG Subject: patches for adding a simple navigation bar and so on. Message-ID: <20030323.075926.26321843.hrs@eos.ocn.ne.jp>
next in thread | raw e-mail | index | archive | help
----Next_Part(Sun_Mar_23_07:59:26_2003_584)--
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Hi,
I made two patches (1) to add a simple navigation bar to docs
in articles/ and books/, and use docbook.css to arrange the left
margin of <screen> and <programlisting>, and (2) to use
recently-added WITH_* knobs in the translated docs.
The former resolves a indentation problem of
<programlisting><inlinegraphic fileref="foo" format="linespecific"></programlisting>
and adds a simple link back and forth between the split and
non-split version if WITH_DOCFORMAT_NAVI_LINK is defined in the Makefile.
Any comments or objections?
I think I will commit these early in April.
--
| Hiroki SATO <hrs@eos.ocn.ne.jp> / <hrs@FreeBSD.org>
----Next_Part(Sun_Mar_23_07:59:26_2003_584)--
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Content-Disposition: inline; filename="docnavi_n_indent.diff"
Index: share/misc/docbook.css
===================================================================
RCS file: /home/dcvs/doc/share/misc/docbook.css,v
retrieving revision 1.4
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.4 docbook.css
--- share/misc/docbook.css 11 Jul 2001 12:46:50 -0000 1.4
+++ share/misc/docbook.css 22 Mar 2003 21:34:19 -0000
@@ -159,3 +159,7 @@
background-color: #F0F0F0;
text-decoration: underline;
}
+
+.PROGRAMLISTING, .SCREEN {
+ margin-left: 3ex;
+}
Index: share/mk/doc.docbook.mk
===================================================================
RCS file: /home/dcvs/doc/share/mk/doc.docbook.mk,v
retrieving revision 1.78
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.78 doc.docbook.mk
--- share/mk/doc.docbook.mk 16 Feb 2003 14:59:30 -0000 1.78
+++ share/mk/doc.docbook.mk 22 Mar 2003 21:47:35 -0000
@@ -203,6 +203,9 @@
HTMLFLAGS+= -V biblio-xref-title
PRINTFLAGS+= -V biblio-xref-title
.endif
+.if defined(WITH_DOCFORMAT_NAVI_LINK) && !empty(WITH_DOCFORMAT_NAVI_LINK)
+HTMLFLAGS+= -V %generate-docformat-navi-link%
+.endif
PERL?= /usr/bin/perl
PKG_CREATE?= /usr/sbin/pkg_create
Index: share/sgml/freebsd.dsl
===================================================================
RCS file: /home/dcvs/doc/share/sgml/freebsd.dsl,v
retrieving revision 1.69
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.69 freebsd.dsl
--- share/sgml/freebsd.dsl 16 Feb 2003 14:59:30 -0000 1.69
+++ share/sgml/freebsd.dsl 22 Mar 2003 22:07:39 -0000
@@ -76,6 +76,59 @@
(normalize "legalnotice")
(normalize "isbn")))
+ ;; Create a simple navigation link
+ ;; if %generate-docformat-navi-link% defined.
+ (define (make-docformat-navi tlist)
+ (let ((rootgi (gi (sgml-root-element))))
+ (make element gi: "DIV"
+ attributes: '(("CLASS" "DOCFORAMTNAVI"))
+ (literal "[ ")
+ (make-docformat-navi-link rootgi tlist)
+ (literal " ]"))))
+
+ (define (make-docformat-navi-link rootgi tlist)
+ (make sequence
+ (cond
+ ((null? tlist) (empty-sosofo))
+ ((null? (car tlist)) (empty-sosofo))
+ ((not (symbol? (car tlist))) (empty-sosofo))
+ ((equal? (car tlist) 'html-split)
+ (make sequence
+ (create-link (list (list "href" "./index.html"))
+ (literal "Split HTML"))
+ (if (not (null? (cdr tlist)))
+ (make sequence
+ (literal " / ")
+ (make-docformat-navi-link rootgi (cdr tlist)))
+ (empty-sosofo))))
+ ((equal? (car tlist) 'html-single)
+ (make sequence
+ (create-link (list (list "href"
+ (string-append "./" (case-fold-down rootgi) ".html")))
+ (literal "Single HTML"))
+ (if (not (null? (cdr tlist)))
+ (make sequence
+ (literal " / ")
+ (make-docformat-navi-link rootgi (cdr tlist)))
+ (empty-sosofo))))
+ (else (empty-sosofo)))))
+
+ (define (article-titlepage-separator side)
+ (make sequence
+ (if %generate-docformat-navi-link%
+ (make-docformat-navi '(html-split html-single))
+ (empty-sosofo))
+ (make empty-element gi: "HR")))
+
+ (define (book-titlepage-separator side)
+ (if (equal? side 'recto)
+ (make sequence
+ (if %generate-docformat-navi-link%
+ (make-docformat-navi '(html-split html-single))
+ (empty-sosofo))
+ (make empty-element gi: "HR"))
+ (empty-sosofo)))
+
<!-- This is the text to display at the bottom of each page.
Defaults to nothing. The individual stylesheets should
redefine this as necessary. -->
@@ -601,10 +654,10 @@
#f)
(define %indent-programlisting-lines%
- " ")
+ #f)
(define %indent-screen-lines%
- " ")
+ #f)
(define (article-titlepage-recto-elements)
(list (normalize "title")
----Next_Part(Sun_Mar_23_07:59:26_2003_584)--
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Content-Disposition: inline; filename="useknob.diff"
Index: el_GR.ISO8859-7/articles/problem-reports/Makefile
===================================================================
RCS file: /home/dcvs/doc/el_GR.ISO8859-7/articles/problem-reports/Makefile,v
retrieving revision 1.1
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.1 Makefile
--- el_GR.ISO8859-7/articles/problem-reports/Makefile 1 Sep 2002 19:32:54 -0000 1.1
+++ el_GR.ISO8859-7/articles/problem-reports/Makefile 22 Mar 2003 21:25:30 -0000
@@ -1,5 +1,5 @@
# $FreeBSD: doc/el_GR.ISO8859-7/articles/problem-reports/Makefile,v 1.1 2002/09/01 19:32:54 keramida Exp $
-# Original revision: 1.1
+# Original revision: 1.2
DOC?= article
@@ -8,7 +8,7 @@
INSTALL_COMPRESSED?=gz
INSTALL_ONLY_COMPRESSED?=
-JADEFLAGS+= -V %generate-article-toc%
+WITH_ARTICLE_TOC?=YES
TIDYFLAGS+= -raw
SRCS= article.sgml
Index: el_GR.ISO8859-7/articles/releng/Makefile
===================================================================
RCS file: /home/dcvs/doc/el_GR.ISO8859-7/articles/releng/Makefile,v
retrieving revision 1.1
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.1 Makefile
--- el_GR.ISO8859-7/articles/releng/Makefile 6 Sep 2002 22:58:11 -0000 1.1
+++ el_GR.ISO8859-7/articles/releng/Makefile 22 Mar 2003 21:25:55 -0000
@@ -1,6 +1,6 @@
#
# $FreeBSD: doc/el_GR.ISO8859-7/articles/releng/Makefile,v 1.1 2002/09/06 22:58:11 keramida Exp $
-# Original version: 1.7
+# Original version: 1.8
#
# Article: FreeBSD Release Engineering
@@ -11,7 +11,7 @@
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=
-JADEFLAGS+= -V %generate-article-toc%
+WITH_ARTICLE_TOC?=YES
TIDYFLAGS+= -raw
# SGML content
Index: fr_FR.ISO8859-1/articles/contributing/Makefile
===================================================================
RCS file: /home/dcvs/doc/fr_FR.ISO8859-1/articles/contributing/Makefile,v
retrieving revision 1.1
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.1 Makefile
--- fr_FR.ISO8859-1/articles/contributing/Makefile 10 Jul 2002 15:06:08 -0000 1.1
+++ fr_FR.ISO8859-1/articles/contributing/Makefile 22 Mar 2003 21:27:37 -0000
@@ -4,7 +4,7 @@
#
# $FreeBSD: doc/fr_FR.ISO8859-1/articles/contributing/Makefile,v 1.1 2002/07/10 15:06:08 blackend Exp $
# $Id: Makefile,v 1.1 2002/07/10 13:34:37 marc Exp $
-# Original revision: 1.1
+# Original revision: 1.2
DOC?= article
@@ -13,7 +13,7 @@
INSTALL_COMPRESSED?=gz
INSTALL_ONLY_COMPRESSED?=
-JADEFLAGS+= -V %generate-article-toc%
+WITH_ARTICLE_TOC?=YES
SRCS= article.sgml
Index: fr_FR.ISO8859-1/articles/contributors/Makefile
===================================================================
RCS file: /home/dcvs/doc/fr_FR.ISO8859-1/articles/contributors/Makefile,v
retrieving revision 1.1
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.1 Makefile
--- fr_FR.ISO8859-1/articles/contributors/Makefile 24 Aug 2002 15:40:21 -0000 1.1
+++ fr_FR.ISO8859-1/articles/contributors/Makefile 22 Mar 2003 21:27:48 -0000
@@ -4,7 +4,7 @@
#
# $FreeBSD: doc/fr_FR.ISO8859-1/articles/contributors/Makefile,v 1.1 2002/08/24 15:40:21 gioria Exp $
# $Id$
-# Original revision: 1.1
+# Original revision: 1.2
DOC?= article
@@ -13,7 +13,7 @@
INSTALL_COMPRESSED?=gz
INSTALL_ONLY_COMPRESSED?=
-JADEFLAGS+= -V %generate-article-toc%
+WITH_ARTICLE_TOC?=YES
SRCS= article.sgml
Index: fr_FR.ISO8859-1/articles/cvsup-advanced/Makefile
===================================================================
RCS file: /home/dcvs/doc/fr_FR.ISO8859-1/articles/cvsup-advanced/Makefile,v
retrieving revision 1.1
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.1 Makefile
--- fr_FR.ISO8859-1/articles/cvsup-advanced/Makefile 26 May 2002 18:23:45 -0000 1.1
+++ fr_FR.ISO8859-1/articles/cvsup-advanced/Makefile 22 Mar 2003 21:28:04 -0000
@@ -3,7 +3,7 @@
# The FreeBSD French Documentation Project
#
# $FreeBSD: doc/fr_FR.ISO8859-1/articles/cvsup-advanced/Makefile,v 1.1 2002/05/26 18:23:45 gioria Exp $
-# Original revision: 1.1
+# Original revision: 1.2
DOC?= article
@@ -12,7 +12,7 @@
INSTALL_COMPRESSED?=gz
INSTALL_ONLY_COMPRESSED?=
-JADEFLAGS+= -V %generate-article-toc%
+WITH_ARTICLE_TOC?=YES
SRCS= article.sgml
Index: fr_FR.ISO8859-1/articles/releng/Makefile
===================================================================
RCS file: /home/dcvs/doc/fr_FR.ISO8859-1/articles/releng/Makefile,v
retrieving revision 1.1
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.1 Makefile
--- fr_FR.ISO8859-1/articles/releng/Makefile 30 Aug 2002 11:58:25 -0000 1.1
+++ fr_FR.ISO8859-1/articles/releng/Makefile 22 Mar 2003 21:28:31 -0000
@@ -4,7 +4,7 @@
#
# $FreeBSD: doc/fr_FR.ISO8859-1/articles/releng/Makefile,v 1.1 2002/08/30 11:58:25 gioria Exp $
# $Id$
-# Original revision: 1.7
+# Original revision: 1.8
#
# Article: FreeBSD Release Engineering
@@ -15,7 +15,7 @@
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=
-JADEFLAGS+= -V %generate-article-toc%
+WITH_ARTICLE_TOC?=YES
# SGML content
SRCS= article.sgml branches.ascii
Index: fr_FR.ISO8859-1/books/faq/Makefile
===================================================================
RCS file: /home/dcvs/doc/fr_FR.ISO8859-1/books/faq/Makefile,v
retrieving revision 1.2
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.2 Makefile
--- fr_FR.ISO8859-1/books/faq/Makefile 5 Oct 2002 15:17:08 -0000 1.2
+++ fr_FR.ISO8859-1/books/faq/Makefile 22 Mar 2003 21:28:45 -0000
@@ -5,7 +5,7 @@
# Compilation de la FAQ FreeBSD
#
# $FreeBSD: doc/fr_FR.ISO8859-1/books/faq/Makefile,v 1.2 2002/10/05 15:17:08 gioria Exp $
-# Original revision: 1.7
+# Original revision: 1.8
MAINTAINER=nik@FreeBSD.org
DOC?= book
@@ -15,7 +15,7 @@
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=
-JADEFLAGS+=-Vbiblio-xref-title
+WITH_BIBLIOXREF_TITLE?=YES
#
# SRCS lists the individual SGML files that make up the document. Changes
# to any of these files will force a rebuild
Index: pt_BR.ISO8859-1/books/faq/Makefile
===================================================================
RCS file: /home/dcvs/doc/pt_BR.ISO8859-1/books/faq/Makefile,v
retrieving revision 1.1
diff -d -u -I\$FreeBSD:.*\$ -I\$Id:.*\$ -I\$hrs:.*\$ -r1.1 Makefile
--- pt_BR.ISO8859-1/books/faq/Makefile 1 Oct 2002 03:03:19 -0000 1.1
+++ pt_BR.ISO8859-1/books/faq/Makefile 22 Mar 2003 21:29:35 -0000
@@ -6,7 +6,7 @@
# The FreeBSD Documentation Project
# The FreeBSD Brazilian Portuguese Documentation Project
#
-# Original revision: 1.7
+# Original revision: 1.8
#
MAINTAINER=lioux@FreeBSD.org
@@ -18,7 +18,7 @@
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=
-JADEFLAGS+=-Vbiblio-xref-title
+WITH_BIBLIOXREF_TITLE?=YES
#
# SRCS lists the individual SGML files that make up the document. Changes
# to any of these files will force a rebuild
----Next_Part(Sun_Mar_23_07:59:26_2003_584)----
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030323.075926.26321843.hrs>