From 75bf6f2d26bee013ecbf9e21af4248811a4e2ec7 Mon Sep 17 00:00:00 2001 From: Sergey Poznyakoff Date: Fri, 14 Aug 2015 05:15:52 +0000 Subject: Fix doc generation. * doc/Config: Rename to doc/html.init. * doc/gdbm.texinfo: Fix sectioning. --- doc/Config | 164 ------------------------------------------------------- doc/gdbm.texinfo | 2 +- 2 files changed, 1 insertion(+), 165 deletions(-) delete mode 100644 doc/Config (limited to 'doc') diff --git a/doc/Config b/doc/Config deleted file mode 100644 index babb84c..0000000 --- a/doc/Config +++ /dev/null @@ -1,164 +0,0 @@ -# Texi2any configuration for gdbm documentation. -*- perl -*- -# Copyright (C) 2011, 2015 Sergey Poznyakoff -# -# Gdbm 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 3, or (at your option) -# any later version. -# -# Gdbm 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 Gdbm. If not, see . -use strict; - -my $top_html_dir="/software/gdbm"; -my $graphics_dir="$top_html_dir/graphics"; - -# Show TOC in place of the @contents directive. -set_from_init_file('INLINE_CONTENTS', 1); -# Do not show Texinfo menus. -set_from_init_file('SHOW_MENU', 0); -# Inhibit output of CSS lines in page headers. -set_from_init_file('CSS_LINES', ''); - -set_from_init_file('BODYTEXT', ""); - -set_from_init_file('EXTRA_HEAD', "\ - \ - \ - \ - "); - -set_from_init_file('AFTER_BODY_OPEN', qq{ - - -}); - -sub gray_end_file($) -{ - my $self = shift; - my $program_text = ''; - if ($self->get_conf('PROGRAM_NAME_IN_FOOTER')) { - my $program_string = &{$self->{'format_program_string'}}($self); - $program_text = "

- $program_string -

"; - } - my $pre_body_close = $self->get_conf('PRE_BODY_CLOSE'); - $pre_body_close = '' if (!defined($pre_body_close)); - return " -
-$program_text - -$pre_body_close -
- - - -"; -} - -texinfo_register_formatting_function('end_file', \&gray_end_file); - -set_from_init_file('PRE_BODY_CLOSE', - 'Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.'); - -# Print generating program name at the bottom of a page. -set_from_init_file('PROGRAM_NAME_IN_FOOTER',1); - -# Disable horizontal bars -set_from_init_file('DEFAULT_RULE', ''); -set_from_init_file('BIG_RULE', ''); - -# Turn off footer buttons in section split -set_from_init_file('SECTION_FOOTER_BUTTONS', undef); -#set_from_init_file('SECTION_BUTTONS', undef); -# Turn off navigation bars at the bottom of each section in chapter split mode -set_from_init_file('HEADERS', undef) - if (get_conf('SPLIT') and (get_conf('SPLIT') eq 'chapter')); -# Use navigation icons - -set_from_init_file('ICONS', 1); - -set_from_init_file('ACTIVE_ICONS', - { - 'Top' => "$graphics_dir/top.png", - 'Contents' => "$graphics_dir/ctx.png", - 'Overview' => '', - 'Index' => "$graphics_dir/idx.png", - 'This' => '', - 'Back' => "$graphics_dir/left.png", - 'FastBack' => "$graphics_dir/bwd.png", - 'Prev' => "", - 'Up' => "$graphics_dir/up.png", - 'Next' => "$graphics_dir/right.png", - 'NodeUp' => "$graphics_dir/left.png", - 'NodeNext' => "$graphics_dir/up.png", - 'NodePrev' => "$graphics_dir/right.png", - 'Following' => "$graphics_dir/right.png", - 'Forward' => "$graphics_dir/right.png", - 'FastForward' => "$graphics_dir/fwd.png", - 'About' => '', - 'First' => '', - 'Last' => '', - ' ' => '' - }); - -sub gray_split_status() -{ - my $split = get_conf('SPLIT'); - if ($split eq '') { - return ''; - } elsif ($split eq 'node') { - return ' (split by node)'; - } elsif ($split eq 'section') { - return ' (split by section)'; - } elsif ($split eq 'chapter') { - return ' (split by chapter)'; - } -} - -sub gray_document_title($$) -{ - my $self = shift; - my $direction = shift; - my $status = gray_split_status(); - - return q{} . $self->{title_string} . '' .$status . q{:}; -} - -sub gray_sec_ref($$) -{ - return q{Section:}; -} - -sub gray_chap_ref($$) -{ - return q{Chapter:}; -} - - -my @gray_buttons = (\&gray_document_title, ' ', - \&gray_sec_ref, 'Back', 'Forward', ' ', - \&gray_chap_ref, - 'FastBack', ' ', 'Up', ' ', 'FastForward', ' ', - 'Contents', 'Index' ); - -set_from_init_file('SECTION_BUTTONS', \@gray_buttons); -set_from_init_file('CHAPTER_BUTTONS', \@gray_buttons); -set_from_init_file('NODE_FOOTER_BUTTONS', \@gray_buttons); -set_from_init_file('MISC_BUTTONS', - [\&gray_document_title, - 'Contents', - 'Index', - ' ', - 'About' - ]); 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: * Errors:: Convert internal error codes into English. * Options:: Setting internal options. * Locking:: File locking. +* Variables:: Useful global variables. * Error codes:: Error codes returned by @code{gdbm} calls. -* Variables:: Two useful variables. * Compatibility:: Compatibility with UNIX dbm and ndbm. Programs -- cgit v1.2.1