summaryrefslogtreecommitdiffabout
path: root/doc
authorSergey Poznyakoff <gray@gnu.org.ua>2015-08-14 05:15:52 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2015-08-14 05:15:52 (GMT)
commit75bf6f2d26bee013ecbf9e21af4248811a4e2ec7 (patch) (unidiff)
treed85d8be7ced409a1f6864732217d251b2dd2e20b /doc
parentab1342557c7909592b5aa0fdb011ce9449b3d492 (diff)
downloadgdbm-75bf6f2d26bee013ecbf9e21af4248811a4e2ec7.tar.gz
gdbm-75bf6f2d26bee013ecbf9e21af4248811a4e2ec7.tar.bz2
Fix doc generation.
* doc/Config: Rename to doc/html.init. * doc/gdbm.texinfo: Fix sectioning.
Diffstat (limited to 'doc') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/Config164
-rw-r--r--doc/gdbm.texinfo2
2 files changed, 1 insertions, 165 deletions
diff --git a/doc/Config b/doc/Config
deleted file mode 100644
index babb84c..0000000
--- a/doc/Config
+++ b/dev/null
@@ -1,164 +0,0 @@
1# Texi2any configuration for gdbm documentation. -*- perl -*-
2# Copyright (C) 2011, 2015 Sergey Poznyakoff
3#
4# Gdbm is free software; you can redistribute it and/or modify
5# it under the terms of the GNU General Public License as published by
6# the Free Software Foundation; either version 3, or (at your option)
7# any later version.
8#
9# Gdbm is distributed in the hope that it will be useful,
10# but WITHOUT ANY WARRANTY; without even the implied warranty of
11# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12# GNU General Public License for more details.
13#
14# You should have received a copy of the GNU General Public License
15# along with Gdbm. If not, see <http://www.gnu.org/licenses/>.
16use strict;
17
18my $top_html_dir="/software/gdbm";
19my $graphics_dir="$top_html_dir/graphics";
20
21# Show TOC in place of the @contents directive.
22set_from_init_file('INLINE_CONTENTS', 1);
23# Do not show Texinfo menus.
24set_from_init_file('SHOW_MENU', 0);
25# Inhibit output of CSS lines in page headers.
26set_from_init_file('CSS_LINES', '');
27
28set_from_init_file('BODYTEXT', "");
29
30set_from_init_file('EXTRA_HEAD', "\
31 <link rev=\"made\" href=\"mailto:gray\@gnu.org.ua\">\
32 <link rel=\"stylesheet\" type=\"text/css\" href=\"${top_html_dir}/gray.css\">\
33 <link rel=\"stylesheet\" type=\"text/css\" href=\"${top_html_dir}/texi.css\">\
34 <link rel=\"icon\" type=\"image/png\" href=\"/graphics/gnu-head-icon.png\">");
35
36set_from_init_file('AFTER_BODY_OPEN', qq{
37<!--#include virtual=\"${top_html_dir}/inc/header.html\" -->
38<ul class='tabs'>
39 <li><a href="${top_html_dir}/gdbm.html">Main</a></li>
40 <li><a href="${top_html_dir}/download.html">Downloads</a></li>
41 <li><a class="active" href="${top_html_dir}/manual.html">Documentation</a></li>
42</ul>
43});
44
45sub gray_end_file($)
46{
47 my $self = shift;
48 my $program_text = '';
49 if ($self->get_conf('PROGRAM_NAME_IN_FOOTER')) {
50 my $program_string = &{$self->{'format_program_string'}}($self);
51 $program_text = "<p>
52 $program_string
53</p>";
54 }
55 my $pre_body_close = $self->get_conf('PRE_BODY_CLOSE');
56 $pre_body_close = '' if (!defined($pre_body_close));
57 return "</div>
58<div class=\"copyright\">
59$program_text
60
61$pre_body_close
62</div>
63</div>
64</body>
65</html>
66";
67}
68
69texinfo_register_formatting_function('end_file', \&gray_end_file);
70
71set_from_init_file('PRE_BODY_CLOSE',
72 'Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.');
73
74# Print generating program name at the bottom of a page.
75set_from_init_file('PROGRAM_NAME_IN_FOOTER',1);
76
77# Disable horizontal bars
78set_from_init_file('DEFAULT_RULE', '');
79set_from_init_file('BIG_RULE', '');
80
81# Turn off footer buttons in section split
82set_from_init_file('SECTION_FOOTER_BUTTONS', undef);
83#set_from_init_file('SECTION_BUTTONS', undef);
84# Turn off navigation bars at the bottom of each section in chapter split mode
85set_from_init_file('HEADERS', undef)
86 if (get_conf('SPLIT') and (get_conf('SPLIT') eq 'chapter'));
87# Use navigation icons
88
89set_from_init_file('ICONS', 1);
90
91set_from_init_file('ACTIVE_ICONS',
92 {
93 'Top' => "$graphics_dir/top.png",
94 'Contents' => "$graphics_dir/ctx.png",
95 'Overview' => '',
96 'Index' => "$graphics_dir/idx.png",
97 'This' => '',
98 'Back' => "$graphics_dir/left.png",
99 'FastBack' => "$graphics_dir/bwd.png",
100 'Prev' => "",
101 'Up' => "$graphics_dir/up.png",
102 'Next' => "$graphics_dir/right.png",
103 'NodeUp' => "$graphics_dir/left.png",
104 'NodeNext' => "$graphics_dir/up.png",
105 'NodePrev' => "$graphics_dir/right.png",
106 'Following' => "$graphics_dir/right.png",
107 'Forward' => "$graphics_dir/right.png",
108 'FastForward' => "$graphics_dir/fwd.png",
109 'About' => '',
110 'First' => '',
111 'Last' => '',
112 ' ' => ''
113 });
114
115sub gray_split_status()
116{
117 my $split = get_conf('SPLIT');
118 if ($split eq '') {
119 return '';
120 } elsif ($split eq 'node') {
121 return ' <span class="splitstatus">(split by node)</span>';
122 } elsif ($split eq 'section') {
123 return ' <span class="splitstatus">(split by section)</span>';
124 } elsif ($split eq 'chapter') {
125 return ' <span class="splitstatus">(split by chapter)</span>';
126 }
127}
128
129sub gray_document_title($$)
130{
131 my $self = shift;
132 my $direction = shift;
133 my $status = gray_split_status();
134
135 return q{<span class="title">} . $self->{title_string} . '</span>' .$status . q{<span class="title">:</span>};
136}
137
138sub gray_sec_ref($$)
139{
140 return q{<span class="navtext">Section:</span>};
141}
142
143sub gray_chap_ref($$)
144{
145 return q{<span class="navtext">Chapter:</span>};
146}
147
148
149my @gray_buttons = (\&gray_document_title, ' ',
150 \&gray_sec_ref, 'Back', 'Forward', ' ',
151 \&gray_chap_ref,
152 'FastBack', ' ', 'Up', ' ', 'FastForward', ' ',
153 'Contents', 'Index' );
154
155set_from_init_file('SECTION_BUTTONS', \@gray_buttons);
156set_from_init_file('CHAPTER_BUTTONS', \@gray_buttons);
157set_from_init_file('NODE_FOOTER_BUTTONS', \@gray_buttons);
158set_from_init_file('MISC_BUTTONS',
159 [\&gray_document_title,
160 'Contents',
161 'Index',
162 ' ',
163 'About'
164 ]);
diff --git a/doc/gdbm.texinfo b/doc/gdbm.texinfo
index 11fe910..d1ff23d 100644
--- a/doc/gdbm.texinfo
+++ b/doc/gdbm.texinfo
@@ -112,9 +112,9 @@ Functions:
112* Errors:: Convert internal error codes into English. 112* Errors:: Convert internal error codes into English.
113* Options:: Setting internal options. 113* Options:: Setting internal options.
114* Locking:: File locking. 114* Locking:: File locking.
115* Variables:: Useful global variables.
115 116
116* Error codes:: Error codes returned by @code{gdbm} calls. 117* Error codes:: Error codes returned by @code{gdbm} calls.
117* Variables:: Two useful variables.
118* Compatibility:: Compatibility with UNIX dbm and ndbm. 118* Compatibility:: Compatibility with UNIX dbm and ndbm.
119 119
120Programs 120Programs

Return to:

Send suggestions and report system problems to the System administrator.