summaryrefslogtreecommitdiff
path: root/tools/gnome-doc-tool.in
blob: 5ee858da5f9312211fb570b62cb6a1247a63b910 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
#!/bin/sh
# gnome-doc-html - Convert documentation to HTML
# gnome-doc-html.  Generated from gnome-doc-html.in by configure.
# Copyright (C) 2006 Shaun McCance <shaunm@gnome.org>
#
# 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 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
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 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, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# As a special exception to the GNU General Public License, if you
# distribute this file as part of a program that contains a
# configuration script generated by Autoconf, you may include it under
# the same distribution terms that you use for the rest of that program.

progname=`echo "$0" | sed 's%^.*/%%'`

PROGRAM=gnome-doc-html
PACKAGE=@PACKAGE@
VERSION=@VERSION@
prefix=@prefix@
datarootdir=@datarootdir@
datadir=@datadir@
pkgdatadir=@datadir@/gnome-doc-utils
xsltdir=@datadir@/xml/gnome/xslt

error() {
    echo "$progname: $1" 1>&2;
    exit 1;
}

print_help() {
    cat <<EOF
Usage: $progname <COMMAND> [OPTIONS] FILE
Process a documentation file.

COMMAND is one of:
  html       convert the document to HTML
  xhtml      convert the document to XHTML
  help       display this help and exit
EOF
}

print_help_html() {
    format="$1"
    upformat=`echo $format | tr a-z A-Z`
    cat <<EOF
Usage: $progname $format [OPTIONS] FILE
Convert FILE into $upformat.

Basic Output Control:
  -c, --css-file=FILE             file to output CSS to
  -d, --chunk-depth=INT           how deep sections should be chunked
  -e, --extension=EXT             the extension to append to output files
  -n, --no-figures                do not copy figures into the output directory
  -o, --output=PATH               the file or directory to output to

Formatting Control:
  --admon-graphics-path=PATH      the path to the admonition graphics
  --admon-graphics-size=INT       the size of the admonition graphics
  --admon-graphics-extension=EXT  the extension of the admonition grahpics
  --classsynopsis-language=LANG   the default programming language to be used
                                  for classsynopsis elements
  --funcsynopsis-style=STYLE      the style to be used to render funcsynopsis
                                  elements, either 'KR' or 'ANSI'

Miscellaneous:
  -v, --verbose                   print all the commands executed
  -V, --version                   print version information and exit
  -h, --help                      display this help and exit
EOF
}
echo_verbose() {
    if [ "x$doc_verbose" = "x1" ]; then echo $1; fi
}
mkdir_p() {
    __dir__='';
    echo $1 | sed -e 's/\//\n/g' | while read d; do
	__dir__="$__dir__$d/"
	if [ ! -d "$__dir__" ]; then
	    echo_verbose "mkdir \"$__dir__\""
	    mkdir "$__dir__"
	fi
    done;
}

DO_html() {
    doc_format="$1"
    shift
    longopts='
      -lcss-file:
      -lchunk-depth:
      -lextension:
      -lno-figures
      -loutput:
      -ladmon-graphics-path:
      -ladmon-graphics-size:
      -ladmon-graphics-extension:
      -lclasssynopsis-language:
      -lfuncsynopsis-style:
      -lverbose
      -lversion
      -lhelp
    ';
    options=`getopt -qn$progname $longopts -- c:d:e:o:nvVh "$@"`
    if [ "$?" != "0" ]; then print_help_html $doc_format 1>&2; exit 1; fi
    eval set -- "$options";
    while [ "$1" != "--" ]; do
	case "$1" in
	    -c | --css-file)
		doc_css_file="$2";;
	    -d | --chunk-depth)
		doc_chunk_depth="$2";;
	    -e | --extension)
		doc_extension="$2";;
	    -n | --no-figures)
		doc_no_figures="1";;
	    -o | --output)
		doc_output="$2";;

	    --admon-graphics-path)
		doc_admon_graphics_path="$2";;
	    --admon-graphics-size)
		doc_admon_graphics_size="$2";;
	    --admon-graphics-extension)
		doc_admon_graphics_extension="$2";;
	    --classsynopsis-language)
		doc_classsynopsis_language="$2";;
	    --funcsynopsis-style)
		doc_funcsynopsis_style="$2";;

	    -v | --verbose)
		doc_verbose=1;;

	    -V | --version)
		echo "$PROGRAM ($PACKAGE) $VERSION"
		exit 0;;
	    -h | --help)
		print_help_html $doc_format
		exit 0;;
	    --)
		print_help_html $doc_format 1>&2
		exit 1;;
	esac
	shift
    done
    shift

    if [ "$#" != "1" ]; then print_help_html $doc_format 1>& 2; exit 1; fi;
    doc_input="$1"
    if [ ! -f "$doc_input" ]; then error "$doc_input: No such file"; fi
    doc_indir=$( (cd $(dirname "$doc_input") && pwd) )
    doc_infile=$(basename "$doc_input")
    doc_inbase=$(basename "$doc_infile" ".xml")
    if [ "$doc_inbase" = "$doc_infile" ]; then
      doc_inbase=$(basename "$doc_infile" ".docbook")
    fi;

    if [ "x$doc_output" = "x" ]; then
	doc_outdir=`pwd`
	if [ "x$doc_extension" = "x" ]; then doc_extension=".$doc_format"; fi
	doc_outfile="${doc_inbase}${doc_extension}"
    elif [ -d "$doc_output" -o $(echo "$doc_output" | sed -e 's/.*\/$/\//') = "/" ]; then
	mkdir_p "$doc_output"
	doc_outdir=`(cd "$doc_output" && pwd)`
	if [ "x$doc_extension" = "x" ]; then doc_extension=".$doc_format"; fi
	doc_outfile="${doc_inbase}${doc_extension}"
    else
	dir=`dirname "$doc_output"`
	mkdir_p "$dir"
	doc_outdir=`(cd "$dir" && pwd)`
	doc_outfile=`basename "$doc_output"`
	if [ "x$doc_extension" = "x" ]; then
	    doc_extension=`echo "$doc_outfile" | grep -o '\..*'`
	fi;
    fi;
    doc_outbase=$(basename "$doc_outfile" "$doc_extension")

    params='--param db.chunk.chunk_top 0'
    params="$params --stringparam db.chunk.basename \"$doc_outbase\""
    params="$params --stringparam db.chunk.extension \"$doc_extension\""
    if [ "x$doc_chunk_depth" != "x" ]; then
	params="$params --param db.chunk.max_depth $doc_chunk_depth"
    fi
    if [ "x$doc_css_file" != "x" ]; then
	params="$params --stringparam db2html.css.file \"$doc_css_file\""
    fi
    if [ "x$doc_admon_graphics_path" != "x" ]; then
	params="$params --stringparam db2html.admon.graphics_path"
	params="$params \"$doc_admon_graphics_path\""
    fi
    if [ "x$doc_admon_graphics_size" != "x" ]; then
	params="$params --stringparam db2html.admon.graphics_size"
	params="$params \"$doc_admon_graphics_size\""
    fi
    if [ "x$doc_admon_graphics_extension" != "x" ]; then
	params="$params --stringparam db2html.admon.graphics_extension"
	params="$params \"$doc_admon_graphics_extension\""
    fi
    if [ "x$doc_classsynopsis_language" != "x" ]; then
	params="$params --stringparam db2html.classsynopsis.language"
	params="$params \"$doc_classsynopsis_language\""
    fi
    if [ "x$doc_funcsynopsis_style" != "x" ]; then
	params="$params --stringparam db2html.funcsynopsis.style"
	params="$params \"$doc_funcsynopsis_style\""
    fi

    cmd="xmllint --noent --xinclude \"$doc_indir/$doc_infile\" |\
      xsltproc $params -o \"$doc_outdir/$doc_outfile\" \"$xsltdir/docbook/html/db2$doc_format.xsl\" -"
    echo_verbose "$cmd"
    eval "$cmd"

    if [ "x$doc_no_figures" != "x1" -a "$doc_indir" != "$doc_outdir" ]; then
	xmllint --noent --xinclude "$doc_indir/$doc_infile" \
	    | xsltproc "$xsltdir/docbook/utils/figures.xsl" - \
	    | while read fig; do
	    mkdir_p "$doc_outdir/"`dirname "$fig"`
	    cmd="cp \"$doc_indir/$fig\" \"$doc_outdir/$fig\""
	    echo_verbose "$cmd"
	    eval "$cmd"
	done
    fi
}


command="$1";
if [ "x$command" = "x" ]; then
    print_help 1>&2;
    exit 1;
fi;
shift;
if [ "$command" = "html" -o "$command" = "xhtml" ]; then
    DO_html "$command" $@;
elif [ "$command" = "-V" -o "$command" = "--version" ]; then
    echo "$PROGRAM ($PACKAGE) $VERSION";
    exit 0;
elif [ "$command" = "help" ]; then
    print_help;
    exit 0;
else
    print_help 1>&2;
    exit 1;
fi;