diff options
author | Sergey Poznyakoff <gray@gnu.org> | 2015-03-01 22:47:09 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org> | 2015-03-01 22:47:09 +0200 |
commit | 3e205088b3b3434ba17bf08b39f2a5fa1fc6a3b0 (patch) | |
tree | 47f9257ffb4bd5f62743966918950e9586d90c75 | |
parent | ad8c9359649fa7123efc46a98c6cec0dd44f34c8 (diff) | |
download | gamma-3e205088b3b3434ba17bf08b39f2a5fa1fc6a3b0.tar.gz gamma-3e205088b3b3434ba17bf08b39f2a5fa1fc6a3b0.tar.bz2 |
Switch to Texinfo 5.0
* doc/Config: Rewrite.
* doc/Makefile.am: Use Makeinfo 5 instead of texi2htm
* doc/gendocs_template: Ps is not built
* imprimatur: Upgrade.
-rw-r--r-- | doc/Config | 405 | ||||
-rw-r--r-- | doc/Makefile.am | 11 | ||||
-rwxr-xr-x | doc/gendocs.sh | 490 | ||||
-rw-r--r--[-rwxr-xr-x] | doc/gendocs_template | 2 |
4 files changed, 598 insertions, 310 deletions
@@ -1,5 +1,5 @@ | |||
1 | # Texi2html configuration for Gamma documentation. -*- perl -*- | 1 | # Texi2any configuration for gamma documentation. -*- perl -*- |
2 | # Copyright (C) 2009, 2010 Sergey Poznyakoff | 2 | # Copyright (C) 2009, 2010, 2015 Sergey Poznyakoff |
3 | # | 3 | # |
4 | # Gamma is free software; you can redistribute it and/or modify | 4 | # Gamma is free software; you can redistribute it and/or modify |
5 | # it under the terms of the GNU General Public License as published by | 5 | # it under the terms of the GNU General Public License as published by |
@@ -13,352 +13,151 @@ | |||
13 | # | 13 | # |
14 | # You should have received a copy of the GNU General Public License | 14 | # You should have received a copy of the GNU General Public License |
15 | # along with Gamma. If not, see <http://www.gnu.org/licenses/>. | 15 | # along with Gamma. If not, see <http://www.gnu.org/licenses/>. |
16 | use strict; | ||
16 | 17 | ||
17 | $top_html_dir="/software/gamma"; | 18 | my $top_html_dir="/software/gamma"; |
18 | $graphics_dir="$top_html_dir/graphics"; | 19 | my $graphics_dir="$top_html_dir/graphics"; |
19 | 20 | ||
20 | ## texi2html configuration | ||
21 | |||
22 | # Show TOC in place of the @contents directive. | 21 | # Show TOC in place of the @contents directive. |
23 | $INLINE_CONTENTS = 1; | 22 | set_from_init_file('INLINE_CONTENTS', 1); |
24 | # Do not show Texinfo menus. | 23 | # Do not show Texinfo menus. |
25 | $SHOW_MENU = 0; | 24 | set_from_init_file('SHOW_MENU', 0); |
26 | # Inhibit output of CSS lines in page headers. | 25 | # Inhibit output of CSS lines in page headers. |
27 | $CSS_LINES=''; | 26 | set_from_init_file('CSS_LINES', ''); |
28 | # Print footnotes at the end of each file (if the document is split). | ||
29 | $SEPARATED_FOOTNOTES = 0; | ||
30 | 27 | ||
31 | $BODYTEXT = ""; | 28 | set_from_init_file('BODYTEXT', ""); |
32 | 29 | ||
33 | $EXTRA_HEAD=qq{ | 30 | set_from_init_file('EXTRA_HEAD', qq{ |
34 | <link rev="made" href="mailto:gray@gnu.org.ua"> | 31 | <link rev="made" href="mailto:gray\@gnu.org.ua"> |
35 | <link rel="stylesheet" type="text/css" href="${top_html_dir}/gray.css"> | 32 | <link rel="stylesheet" type="text/css" href="${top_html_dir}/gray.css"> |
36 | <link rel="stylesheet" type="text/css" href="${top_html_dir}/texi.css"> | 33 | <link rel="stylesheet" type="text/css" href="${top_html_dir}/texi.css"> |
37 | <link rel="icon" type="image/png" href="/graphics/gnu-head-icon.png">}; | 34 | <link rel="icon" type="image/png" href="/graphics/gnu-head-icon.png">}); |
38 | 35 | ||
39 | $AFTER_BODY_OPEN=qq{ | 36 | set_from_init_file('AFTER_BODY_OPEN', qq{ |
40 | <!--#include virtual="${top_html_dir}/inc/header.html" --> | 37 | <!--#include virtual="${top_html_dir}/inc/header.html" --> |
41 | <ul class="tabs"> | 38 | <ul class="tabs"> |
42 | <li><a href="${top_html_dir}/gamma.html">Main</a></li> | 39 | <li><a href="${top_html_dir}/gamma.html">Main</a></li> |
43 | <li><a href="${top_html_dir}/download.html">Downloads</a></li> | 40 | <li><a href="${top_html_dir}/download.html">Downloads</a></li> |
44 | <li><a class="active" href="${top_html_dir}/manual.html">Documentation</a></li> | 41 | <li><a class="active" href="${top_html_dir}/manual.html">Documentation</a></li> |
45 | </ul>}; | 42 | </ul>}); |
46 | |||
47 | $PRE_BODY_CLOSE="Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved."; | ||
48 | |||
49 | $format_map{'multitable'}='table class="multitable"'; | ||
50 | 43 | ||
51 | $SMALL_RULE = ''; | 44 | sub gray_end_file($) |
52 | $DEFAULT_RULE = ''; | 45 | { |
53 | $MIDDLE_RULE = ''; | 46 | my $self = shift; |
54 | # This is output at the end of a section. | 47 | my $program_text = ''; |
55 | $BIG_RULE = ''; | 48 | if ($self->get_conf('PROGRAM_NAME_IN_FOOTER')) { |
49 | my $program_string = &{$self->{'format_program_string'}}($self); | ||
50 | $program_text = "<p> | ||
51 | $program_string | ||
52 | </p>"; | ||
53 | } | ||
54 | my $pre_body_close = $self->get_conf('PRE_BODY_CLOSE'); | ||
55 | $pre_body_close = '' if (!defined($pre_body_close)); | ||
56 | return "</div> | ||
57 | <div class=\"copyright\"> | ||
58 | $program_text | ||
59 | |||
60 | $pre_body_close | ||
61 | </div> | ||
62 | </div> | ||
63 | </body> | ||
64 | </html> | ||
65 | "; | ||
66 | } | ||
56 | 67 | ||
57 | # Use navigation icons | 68 | texinfo_register_formatting_function('end_file', \&gray_end_file); |
58 | $ICONS = 1; | ||
59 | %ACTIVE_ICONS = | ||
60 | ( | ||
61 | 'Top', "$graphics_dir/top.png", | ||
62 | 'Contents', "$graphics_dir/ctx.png", | ||
63 | 'Overview', '', | ||
64 | 'Index', "$graphics_dir/idx.png", | ||
65 | 'This', '', | ||
66 | 'Back', "$graphics_dir/left.png", | ||
67 | 'FastBack', "$graphics_dir/bwd.png", | ||
68 | 'Prev', "", | ||
69 | 'Up', "$graphics_dir/up.png", | ||
70 | 'Next', "$graphics_dir/right.png", | ||
71 | 'NodeUp', "$graphics_dir/left.png", | ||
72 | 'NodeNext', "$graphics_dir/up.png", | ||
73 | 'NodePrev', "$graphics_dir/right.png", | ||
74 | 'Following', "$graphics_dir/right.png", | ||
75 | 'Forward', "$graphics_dir/right.png", | ||
76 | 'FastForward', "$graphics_dir/fwd.png", | ||
77 | 'About' , '', | ||
78 | 'First', '', | ||
79 | 'Last', '', | ||
80 | ' ', '' | ||
81 | ); | ||
82 | 69 | ||
83 | @SECTION_BUTTONS = | 70 | set_from_init_file('PRE_BODY_CLOSE', |
84 | ( | 71 | 'Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.'); |
85 | \&gray_document_title, | ||
86 | \&gray_sec_ref, | ||
87 | 'Back', 'Forward', | ||
88 | \&gray_chap_ref, 'FastBack', 'Up', 'FastForward', | ||
89 | \&gray_doc_ref, | ||
90 | 'Contents', 'Index', | ||
91 | ' ','About', | ||
92 | ); | ||
93 | 72 | ||
94 | @SECTION_FOOTER_BUTTONS = @SECTION_BUTTONS; | 73 | # Print generating program name at the bottom of a page. |
95 | @NODE_FOOTER_BUTTONS = @SECTION_BUTTONS; | 74 | set_from_init_file('PROGRAM_NAME_IN_FOOTER',1); |
96 | 75 | ||
97 | # buttons for misc stuff | 76 | # Disable horizontal bars |
98 | @MISC_BUTTONS = ( | 77 | set_from_init_file('DEFAULT_RULE', ''); |
99 | \&gray_document_title, | 78 | set_from_init_file('BIG_RULE', ''); |
100 | 'Contents', | ||
101 | 'Index', | ||
102 | ' ', | ||
103 | 'About' | ||
104 | ); | ||
105 | 79 | ||
80 | # Turn off footer buttons in section split | ||
81 | set_from_init_file('SECTION_FOOTER_BUTTONS', undef); | ||
82 | #set_from_init_file('SECTION_BUTTONS', undef); | ||
83 | # Turn off navigation bars at the bottom of each section in chapter split mode | ||
84 | set_from_init_file('HEADERS', undef) | ||
85 | if (get_conf('SPLIT') and (get_conf('SPLIT') eq 'chapter')); | ||
86 | # Use navigation icons | ||
106 | 87 | ||
107 | $print_section = \&gray_print_section; | 88 | set_from_init_file('ICONS', 1); |
108 | $print_navigation = \&gray_print_navigation; | ||
109 | $print_head_navigation = \&gray_print_head_navigation; | ||
110 | $print_foot_navigation = \&gray_print_foot_navigation; | ||
111 | $print_About = \&gray_print_About; | ||
112 | $cell = \&gray_multitable_cell; | ||
113 | $print_page_foot = \&gray_print_page_foot; | ||
114 | |||
115 | sub gray_multitable_cell($$) | ||
116 | { | ||
117 | my $text = shift; | ||
118 | my $row_macro = shift; | ||
119 | 89 | ||
120 | $text =~ s/<p>//; | 90 | set_from_init_file('ACTIVE_ICONS', |
121 | $text =~ s/<\/p>//; | ||
122 | if ($row_macro eq 'headitem') | ||
123 | { | 91 | { |
124 | return '<th>' . $text . '</th>'; | 92 | 'Top' => "$graphics_dir/top.png", |
125 | } | 93 | 'Contents' => "$graphics_dir/ctx.png", |
126 | return '<td>' . $text . '</td>'; | 94 | 'Overview' => '', |
127 | } | 95 | 'Index' => "$graphics_dir/idx.png", |
128 | 96 | 'This' => '', | |
129 | sub gray_print_About | 97 | 'Back' => "$graphics_dir/left.png", |
130 | { | 98 | 'FastBack' => "$graphics_dir/bwd.png", |
131 | return &$print_misc(@_) if (!($SPLIT eq '') or $SECTION_NAVIGATION); | 99 | 'Prev' => "", |
132 | } | 100 | 'Up' => "$graphics_dir/up.png", |
101 | 'Next' => "$graphics_dir/right.png", | ||
102 | 'NodeUp' => "$graphics_dir/left.png", | ||
103 | 'NodeNext' => "$graphics_dir/up.png", | ||
104 | 'NodePrev' => "$graphics_dir/right.png", | ||
105 | 'Following' => "$graphics_dir/right.png", | ||
106 | 'Forward' => "$graphics_dir/right.png", | ||
107 | 'FastForward' => "$graphics_dir/fwd.png", | ||
108 | 'About' => '', | ||
109 | 'First' => '', | ||
110 | 'Last' => '', | ||
111 | ' ' => '' | ||
112 | }); | ||
133 | 113 | ||
134 | sub gray_split_status() | 114 | sub gray_split_status() |
135 | { | 115 | { |
136 | if ($SPLIT eq '') { | 116 | my $split = get_conf('SPLIT'); |
117 | if ($split eq '') { | ||
137 | return ''; | 118 | return ''; |
138 | } elsif ($SPLIT eq 'node') { | 119 | } elsif ($split eq 'node') { |
139 | return ' <span class="splitstatus">(split by node)</span>'; | 120 | return ' <span class="splitstatus">(split by node)</span>'; |
140 | } elsif ($SPLIT eq 'section') { | 121 | } elsif ($split eq 'section') { |
141 | return ' <span class="splitstatus">(split by section)</span>'; | 122 | return ' <span class="splitstatus">(split by section)</span>'; |
142 | } elsif ($SPLIT eq 'chapter') { | 123 | } elsif ($split eq 'chapter') { |
143 | return ' <span class="splitstatus">(split by chapter)</span>'; | 124 | return ' <span class="splitstatus">(split by chapter)</span>'; |
144 | } | 125 | } |
145 | } | 126 | } |
146 | 127 | ||
147 | sub gray_document_title($$) | 128 | sub gray_document_title($$) |
148 | { | 129 | { |
149 | my $fh = shift; | 130 | my $self = shift; |
150 | my $vertical = shift; | 131 | my $direction = shift; |
151 | my $status = gray_split_status(); | 132 | my $status = gray_split_status(); |