From 61bf4f33083c5661b5b8c84c1e1b37d0a7af573c Mon Sep 17 00:00:00 2001 From: Jose Antonio Ortega Ruiz Date: Fri, 21 Mar 2008 00:38:11 +0100 Subject: Manual generation scripts updated and ignoring doc/manual --- doc/.gitignore | 13 +++++ doc/gendocs.sh | 145 ++++++++++++++++++++++++++++++++++++--------------- doc/gendocs_template | 125 +++++++++++++++++++++++--------------------- 3 files changed, 181 insertions(+), 102 deletions(-) (limited to 'doc') diff --git a/doc/.gitignore b/doc/.gitignore index e186ac5..bb67de2 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,3 +1,16 @@ /Makefile.in +/mdk.aux +/mdk.cp +/mdk.cps +/mdk.fn +/mdk.fns /mdk.info +/mdk.ky +/mdk.log +/mdk.pg +/mdk.toc +/mdk.tp +/mdk.vr +/mdk.vrs /texinfo.tex +/manual/* diff --git a/doc/gendocs.sh b/doc/gendocs.sh index d27da69..5247034 100755 --- a/doc/gendocs.sh +++ b/doc/gendocs.sh @@ -1,14 +1,16 @@ #!/bin/sh # gendocs.sh -- generate a GNU manual in many formats. This script is # mentioned in maintain.texi. See the help message below for usage details. -# $Id: gendocs.sh,v 1.17 2006/05/19 00:07:52 karl Exp $ -# -# Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc. + +scriptversion=2008-03-05.14 + +# Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 +# Free Software Foundation, Inc. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2, or (at your option) -# any later version. +# the Free Software Foundation; either version 3 of the License, +# or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -16,10 +18,8 @@ # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with this program; if not, you can either send email to this -# program's maintainer or write to: The Free Software Foundation, -# Inc.; 51 Franklin Street, Fifth Floor; Boston, MA 02110-1301, USA. -# +# along with this program. If not, see . +# # Original author: Mohit Agarwal. # Send bug reports and any other correspondence to bug-texinfo@gnu.org. @@ -29,22 +29,22 @@ srcdir=`pwd` scripturl="http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs.sh" templateurl="http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs_template" +: ${SETLANG="env LANG= LC_MESSAGES= LC_ALL= LANGUAGE="} : ${MAKEINFO="makeinfo"} : ${TEXI2DVI="texi2dvi -t @finalout"} : ${DVIPS="dvips"} -: ${DOCBOOK2TXT="docbook2txt"} : ${DOCBOOK2HTML="docbook2html"} : ${DOCBOOK2PDF="docbook2pdf"} : ${DOCBOOK2PS="docbook2ps"} +: ${DOCBOOK2TXT="docbook2txt"} : ${GENDOCS_TEMPLATE_DIR="."} +: ${TEXI2HTML="texi2html"} unset CDPATH +unset use_texi2html -rcs_revision='$Revision: 1.17 $' -rcs_version=`set - $rcs_revision; echo $2` -program=`echo "$0" | sed -e 's!.*/!!'` -version="gendocs.sh $rcs_version +version="gendocs.sh $scriptversion -Copyright (C) 2006 Free Software Foundation, Inc. +Copyright (C) 2007 Free Software Foundation, Inc. There is NO warranty. You may redistribute this software under the terms of the GNU General Public License. For more information about these matters, see the files named COPYING." @@ -58,7 +58,8 @@ See the GNU Maintainers document for a more extensive discussion: Options: -o OUTDIR write files into OUTDIR, instead of manual/. --docbook convert to DocBook too (xml, txt, html, pdf and ps). - --html ARG pass indicated ARG to makeinfo for HTML targets. + --html ARG pass indicated ARG to makeinfo or texi2html for HTML targets. + --texi2html use texi2html to generate HTML targets. --help display this help and exit successfully. --version display version information and exit successfully. @@ -85,9 +86,20 @@ times with different YOURMANUAL values, specifying a different output directory with -o each time. Then write (by hand) an overall index.html with links to them all. +If a manual's texinfo sources are spread across several directories, +first copy or symlink all Texinfo sources into a single directory. +(Part of the script's work is to make a tar.gz of the sources.) + You can set the environment variables MAKEINFO, TEXI2DVI, and DVIPS to control the programs that get executed, and GENDOCS_TEMPLATE_DIR to -control where the gendocs_template file is looked for. +control where the gendocs_template file is looked for. (With --docbook, +the environment variables DOCBOOK2HTML, DOCBOOK2PDF, DOCBOOK2PS, and +DOCBOOK2TXT are also respected.) + +By default, makeinfo is run in the default (English) locale, since +that's the language of most Texinfo manuals. If you happen to have a +non-English manual and non-English web site, check the SETLANG setting +in the source. Email bug reports or enhancement requests to bug-texinfo@gnu.org. " @@ -110,6 +122,7 @@ while test $# -gt 0; do -o) shift; outdir=$1;; --docbook) docbook=yes;; --html) shift; html=$1;; + --texi2html) use_texi2html=1;; -*) echo "$0: Unknown or ambiguous option \`$1'." >&2 echo "$0: Try \`--help' for more information." >&2 @@ -146,7 +159,7 @@ fi echo Generating output formats for $srcfile -cmd="${MAKEINFO} -o $PACKAGE.info \"$srcfile\"" +cmd="$SETLANG $MAKEINFO -o $PACKAGE.info \"$srcfile\"" echo "Generating info files... ($cmd)" eval "$cmd" mkdir -p $outdir/ @@ -177,7 +190,7 @@ eval "$cmd" pdf_size=`calcsize $PACKAGE.pdf` mv $PACKAGE.pdf $outdir/ -cmd="${MAKEINFO} -o $PACKAGE.txt --no-split --no-headers \"$srcfile\"" +cmd="$SETLANG $MAKEINFO -o $PACKAGE.txt --no-split --no-headers \"$srcfile\"" echo "Generating ASCII... ($cmd)" eval "$cmd" ascii_size=`calcsize $PACKAGE.txt` @@ -185,28 +198,60 @@ gzip -f -9 -c $PACKAGE.txt >$outdir/$PACKAGE.txt.gz ascii_gz_size=`calcsize $outdir/$PACKAGE.txt.gz` mv $PACKAGE.txt $outdir/ -cmd="${MAKEINFO} --no-split --html -o $PACKAGE.html $html \"$srcfile\"" -echo "Generating monolithic html... ($cmd)" -rm -rf $PACKAGE.html # in case a directory is left over -eval "$cmd" -html_mono_size=`calcsize $PACKAGE.html` -gzip -f -9 -c $PACKAGE.html >$outdir/$PACKAGE.html.gz -html_mono_gz_size=`calcsize $outdir/$PACKAGE.html.gz` -mv $PACKAGE.html $outdir/ +html_split() { + cmd="$SETLANG $TEXI2HTML --output $PACKAGE.html --split=$1 $html --node-files \"$srcfile\"" + echo "Generating html by $1... ($cmd)" + eval "$cmd" + split_html_dir=$PACKAGE.html + ( + cd ${split_html_dir} || exit 1 + ln -sf ${PACKAGE}.html index.html + tar -czf ../$outdir/${PACKAGE}.html_$1.tar.gz -- *.html + ) + eval html_$1_tgz_size=`calcsize $outdir/${PACKAGE}.html_$1.tar.gz` + rm -f $outdir/html_$1/*.html + mkdir -p $outdir/html_$1/ + mv ${split_html_dir}/*.html $outdir/html_$1/ + rmdir ${split_html_dir} +} -cmd="${MAKEINFO} --html -o $PACKAGE.html $html \"$srcfile\"" -echo "Generating html by node... ($cmd)" -eval "$cmd" -split_html_dir=$PACKAGE.html -( - cd ${split_html_dir} || exit 1 - tar -czf ../$outdir/${PACKAGE}.html_node.tar.gz -- *.html -) -html_node_tgz_size=`calcsize $outdir/${PACKAGE}.html_node.tar.gz` -rm -f $outdir/html_node/*.html -mkdir -p $outdir/html_node/ -mv ${split_html_dir}/*.html $outdir/html_node/ -rmdir ${split_html_dir} +if test -z "$use_texi2html"; then + cmd="$SETLANG $MAKEINFO --no-split --html -o $PACKAGE.html $html \"$srcfile\"" + echo "Generating monolithic html... ($cmd)" + rm -rf $PACKAGE.html # in case a directory is left over + eval "$cmd" + html_mono_size=`calcsize $PACKAGE.html` + gzip -f -9 -c $PACKAGE.html >$outdir/$PACKAGE.html.gz + html_mono_gz_size=`calcsize $outdir/$PACKAGE.html.gz` + mv $PACKAGE.html $outdir/ + + cmd="$SETLANG $MAKEINFO --html -o $PACKAGE.html $html \"$srcfile\"" + echo "Generating html by node... ($cmd)" + eval "$cmd" + split_html_dir=$PACKAGE.html + ( + cd ${split_html_dir} || exit 1 + tar -czf ../$outdir/${PACKAGE}.html_node.tar.gz -- *.html + ) + html_node_tgz_size=`calcsize $outdir/${PACKAGE}.html_node.tar.gz` + rm -f $outdir/html_node/*.html + mkdir -p $outdir/html_node/ + mv ${split_html_dir}/*.html $outdir/html_node/ + rmdir ${split_html_dir} +else + cmd="$SETLANG $TEXI2HTML --output $PACKAGE.html $html \"$srcfile\"" + echo "Generating monolithic html... ($cmd)" + rm -rf $PACKAGE.html # in case a directory is left over + eval "$cmd" + html_mono_size=`calcsize $PACKAGE.html` + gzip -f -9 -c $PACKAGE.html >$outdir/$PACKAGE.html.gz + html_mono_gz_size=`calcsize $outdir/$PACKAGE.html.gz` + mv $PACKAGE.html $outdir/ + + html_split node + html_split chapter + html_split section +fi echo Making .tar.gz for sources... srcfiles=`ls *.texinfo *.texi *.txi *.eps 2>/dev/null` @@ -214,7 +259,7 @@ tar cvzfh $outdir/$PACKAGE.texi.tar.gz $srcfiles texi_tgz_size=`calcsize $outdir/$PACKAGE.texi.tar.gz` if test -n "$docbook"; then - cmd="${MAKEINFO} -o - --docbook \"$srcfile\" > ${srcdir}/$PACKAGE-db.xml" + cmd="$SETLANG $MAKEINFO -o - --docbook \"$srcfile\" > ${srcdir}/$PACKAGE-db.xml" echo "Generating docbook XML... $(cmd)" eval "$cmd" docbook_xml_size=`calcsize $PACKAGE-db.xml` @@ -257,7 +302,13 @@ if test -n "$docbook"; then fi echo Writing index file... -curdate=`date '+%B %d, %Y'` +if test -z "$use_texi2html"; then + CONDS="/%%IF *HTML_SECTION%%/,/%%ENDIF *HTML_SECTION%%/d;\ + /%%IF *HTML_CHAPTER%%/,/%%ENDIF *HTML_CHAPTER%%/d" +else + CONDS="/%%ENDIF.*%%/d;/%%IF *HTML_SECTION%%/d;/%%IF *HTML_CHAPTER%%/d" +fi +curdate=`$SETLANG date '+%B %d, %Y'` sed \ -e "s!%%TITLE%%!$MANUAL_TITLE!g" \ -e "s!%%DATE%%!$curdate!g" \ @@ -265,6 +316,8 @@ sed \ -e "s!%%HTML_MONO_SIZE%%!$html_mono_size!g" \ -e "s!%%HTML_MONO_GZ_SIZE%%!$html_mono_gz_size!g" \ -e "s!%%HTML_NODE_TGZ_SIZE%%!$html_node_tgz_size!g" \ + -e "s!%%HTML_SECTION_TGZ_SIZE%%!$html_section_tgz_size!g" \ + -e "s!%%HTML_CHAPTER_TGZ_SIZE%%!$html_chapter_tgz_size!g" \ -e "s!%%INFO_TGZ_SIZE%%!$info_tgz_size!g" \ -e "s!%%DVI_GZ_SIZE%%!$dvi_gz_size!g" \ -e "s!%%PDF_SIZE%%!$pdf_size!g" \ @@ -280,6 +333,14 @@ sed \ -e "s!%%DOCBOOK_XML_GZ_SIZE%%!$docbook_xml_gz_size!g" \ -e "s,%%SCRIPTURL%%,$scripturl,g" \ -e "s!%%SCRIPTNAME%%!$prog!g" \ + -e "$CONDS" \ $GENDOCS_TEMPLATE_DIR/gendocs_template >$outdir/index.html echo "Done! See $outdir/ subdirectory for new files." + +# Local variables: +# eval: (add-hook 'write-file-hooks 'time-stamp) +# time-stamp-start: "scriptversion=" +# time-stamp-format: "%:y-%02m-%02d.%02H" +# time-stamp-end: "$" +# End: diff --git a/doc/gendocs_template b/doc/gendocs_template index 22fbc75..be93a63 100644 --- a/doc/gendocs_template +++ b/doc/gendocs_template @@ -1,15 +1,7 @@ - - - - - - + %%TITLE%% - GNU Project - Free Software Foundation (FSF) - - - - + +

%%TITLE%%

@@ -17,79 +9,92 @@ - - -

%%TITLE%%

-
Free Software Foundation
last updated %%DATE%%
-

- - [image of the head of a GNU] - -(no gifs due to patent problems) -

-

This manual (%%PACKAGE%%) is available in the following formats:

+

You can buy printed copies of +some manuals (among other items) from the Free Software Foundation; +this helps support FSF activities.

+

(This page generated by the %%SCRIPTNAME%% script.)

-
-

-Return to the GNU MDK home page. -

+ + + + + + +
+ + - + -- cgit v1.2.3