diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2015-03-02 14:38:34 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2015-03-02 14:39:32 +0200 |
commit | 448b11b3f51873392e916eec9dbe1dd11a96c72b (patch) | |
tree | adecc3e6cafd62ad2123415281ccec91f1a43817 | |
parent | fc34bf502a37736bc4d44cad6bd1c6230103b305 (diff) | |
download | cfpeek-448b11b3f51873392e916eec9dbe1dd11a96c72b.tar.gz cfpeek-448b11b3f51873392e916eec9dbe1dd11a96c72b.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
* doc/gendocs.sh: New file.
* imprimatur: Upgrade.
-rw-r--r-- | doc/Config | 402 | ||||
-rw-r--r-- | doc/Makefile.am | 5 | ||||
-rwxr-xr-x | doc/gendocs.sh | 490 | ||||
-rw-r--r--[-rwxr-xr-x] | doc/gendocs_template | 10 | ||||
m--------- | grecs | 0 | ||||
m--------- | imprimatur | 0 |
6 files changed, 598 insertions, 309 deletions
@@ -1,5 +1,5 @@ | |||
1 | # Texi2html configuration for Cfpeek documentation. -*- perl -*- | 1 | # Texi2any configuration for cfpeek documentation. -*- perl -*- |
2 | # Copyright (C) 2011 Sergey Poznyakoff | 2 | # Copyright (C) 2011, 2015 Sergey Poznyakoff |
3 | # | 3 | # |
4 | # Cfpeek is free software; you can redistribute it and/or modify | 4 | # Cfpeek 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,152 @@ | |||
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 Cfpeek. If not, see <http://www.gnu.org/licenses/>. | 15 | # along with Cfpeek. If not, see <http://www.gnu.org/licenses/>. |
16 | use strict; | ||
16 | 17 | ||
17 | $top_html_dir="/software/cfpeek"; | 18 | my $top_html_dir="/software/cfpeek"; |
18 | $graphics_dir="$top_html_dir/graphics"; | 19 | my $graphics_dir="$top_html_dir/graphics"; |
19 | |||
20 | ## texi2html configuration | ||
21 | 20 | ||
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="\ | 30 | set_from_init_file('EXTRA_HEAD', "\ |
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}/cfpeek.html">Main</a></li> | 39 | <li><a href="${top_html_dir}/cfpeek.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 | }; | 43 | }); |
47 | |||
48 | $PRE_BODY_CLOSE="Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved."; | ||
49 | |||
50 | $format_map{'multitable'}='table class="multitable"'; | ||
51 | |||
52 | $SMALL_RULE = ''; | ||
53 | $DEFAULT_RULE = ''; | ||
54 | $MIDDLE_RULE = ''; | ||
55 | # This is output at the end of a section. | ||
56 | $BIG_RULE = ''; | ||
57 | 44 | ||
58 | # Use navigation icons | 45 | sub gray_end_file($) |
59 | $ICONS = 1; | 46 | { |
60 | %ACTIVE_ICONS = | 47 | my $self = shift; |
61 | ( | 48 | my $program_text = ''; |
62 | 'Top', "$graphics_dir/top.png", | 49 | if ($self->get_conf('PROGRAM_NAME_IN_FOOTER')) { |
63 | 'Contents', "$graphics_dir/ctx.png", | 50 | my $program_string = &{$self->{'format_program_string'}}($self); |
64 | 'Overview', '', | 51 | $program_text = "<p> |
65 | 'Index', "$graphics_dir/idx.png", | 52 | $program_string |
66 | 'This', '', | 53 | </p>"; |
67 | 'Back', "$graphics_dir/left.png", | 54 | } |
68 | 'FastBack', "$graphics_dir/bwd.png", | 55 | my $pre_body_close = $self->get_conf('PRE_BODY_CLOSE'); |
69 | 'Prev', "", | 56 | $pre_body_close = '' if (!defined($pre_body_close)); |
70 | 'Up', "$graphics_dir/up.png", | 57 | return "</div> |
71 | 'Next', "$graphics_dir/right.png", | 58 | <div class=\"copyright\"> |
72 | 'NodeUp', "$graphics_dir/left.png", | 59 | $program_text |
73 | 'NodeNext', "$graphics_dir/up.png", | 60 | |
74 | 'NodePrev', "$graphics_dir/right.png", | 61 | $pre_body_close |
75 | 'Following', "$graphics_dir/right.png", | 62 | </div> |
76 | 'Forward', "$graphics_dir/right.png", | 63 | </div> |
77 | 'FastForward', "$graphics_dir/fwd.png", | 64 | </body> |
78 | 'About' , '', | 65 | </html> |
79 | 'First', '', | 66 | "; |
80 | 'Last', '', | 67 | } |
81 | ' ', '' | ||
82 | ); | ||
83 | 68 | ||
84 | @SECTION_BUTTONS = | 69 | texinfo_register_formatting_function('end_file', \&gray_end_file); |
85 | ( | ||
86 | \&gray_document_title, | ||
87 | \&gray_sec_ref, | ||
88 | 'Back', 'Forward', | ||
89 | \&gray_chap_ref, 'FastBack', 'Up', 'FastForward', | ||
90 | \&gray_doc_ref, | ||
91 | 'Contents', 'Index', | ||
92 | ' ','About', | ||
93 | ); | ||
94 | 70 | ||
95 | @SECTION_FOOTER_BUTTONS = @SECTION_BUTTONS; | 71 | set_from_init_file('PRE_BODY_CLOSE', |
96 | @NODE_FOOTER_BUTTONS = @SECTION_BUTTONS; | 72 | 'Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.'); |
97 | 73 | ||
98 | # buttons for misc stuff | 74 | # Print generating program name at the bottom of a page. |
99 | @MISC_BUTTONS = ( | 75 | set_from_init_file('PROGRAM_NAME_IN_FOOTER',1); |
100 | \&gray_document_title, | ||
101 | 'Contents', | ||
102 | 'Index', | ||
103 | ' ', | ||
104 | 'About' | ||
105 | ); | ||
106 | 76 | ||
77 | # Disable horizontal bars | ||
78 | set_from_init_file('DEFAULT_RULE', ''); | ||
79 | set_from_init_file('BIG_RULE', ''); | ||
107 | 80 | ||
108 | $print_section = \&gray_print_section; | 81 | # Turn off footer buttons in section split |
109 | $print_navigation = \&gray_print_navigation; | 82 | set_from_init_file('SECTION_FOOTER_BUTTONS', undef); |
110 | $print_head_navigation = \&gray_print_head_navigation; | 83 | #set_from_init_file('SECTION_BUTTONS', undef); |
111 | $print_foot_navigation = \&gray_print_foot_navigation; | 84 | # Turn off navigation bars at the bottom of each section in chapter split mode |
112 | $print_About = \&gray_print_About; | 85 | set_from_init_file('HEADERS', undef) |
113 | $cell = \&gray_multitable_cell; | 86 | if (get_conf('SPLIT') and (get_conf('SPLIT') eq 'chapter')); |
114 | $print_page_foot = \&gray_print_page_foot; | 87 | # Use navigation icons |
115 | 88 | ||
116 | sub gray_multitable_cell($$) | 89 | set_from_init_file('ICONS', 1); |
117 | { | ||
118 | my $text = shift; | ||
119 | my $row_macro = shift; | ||
120 | 90 | ||
121 | $text =~ s/<p>//; | 91 | set_from_init_file('ACTIVE_ICONS', |
122 | $text =~ s/<\/p>//; | ||
123 | if ($row_macro eq 'headitem') | ||
124 | { | 92 | { |
125 | return '<th>' . $text . '</th>'; | 93 | 'Top' => "$graphics_dir/top.png", |
126 | } | 94 | 'Contents' => "$graphics_dir/ctx.png", |
127 | return '<td>' . $text . '</td>'; | 95 | 'Overview' => '', |
128 | } | 96 | 'Index' => "$graphics_dir/idx.png", |
129 | 97 | 'This' => '', | |
130 | sub gray_print_About | 98 | 'Back' => "$graphics_dir/left.png", |
131 | { | 99 | 'FastBack' => "$graphics_dir/bwd.png", |
132 | return &$print_misc(@_) if (!($SPLIT eq '') or $SECTION_NAVIGATION); | 100 | 'Prev' => "", |
133 | } | 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 | }); | ||
134 | 114 | ||
135 | sub gray_split_status() | 115 | sub gray_split_status() |
136 | { | 116 | { |
137 | if ($SPLIT eq '') { | 117 | my $split = get_conf('SPLIT'); |
118 | if ($split eq '') { | ||
138 | return ''; | 119 | return ''; |
139 | } elsif ($SPLIT eq 'node') { | 120 | } elsif ($split eq 'node') { |
140 | return ' <span class="splitstatus">(split by node)</span>'; | 121 | return ' <span class="splitstatus">(split by node)</span>'; |
141 | } elsif ($SPLIT eq 'section') { | 122 | } elsif ($split eq 'section') { |
142 | return ' <span class="splitstatus">(split by section)</span>'; | 123 | return ' <span class="splitstatus">(split by section)</span>'; |
143 | } elsif ($SPLIT eq 'chapter') { | 124 | } elsif ($split eq 'chapter') { |
144 | return ' <span class="splitstatus">(split by chapter)</span>'; | 125 | return ' <span class="splitstatus">(split by chapter)</span>'; |
145 | } | 126 | } |
146 | } | 127 | } |
147 | 128 | ||
148 | sub gray_document_title($$) | 129 | sub gray_document_title($$) |
149 | { | 130 | { |
150 |