]> git.sesse.net Git - ffmpeg/blob - doc/t2h.init
APIChanges: add entry for av_read_packet deprecation
[ffmpeg] / doc / t2h.init
1 # no horiz rules between sections
2 $end_section = \&Libav_end_section;
3 sub Libav_end_section($$)
4 {
5 }
6
7 $EXTRA_HEAD =
8 '<link rel="icon" href="favicon.png" type="image/png" />
9 ';
10
11 $CSS_LINES = $ENV{"LIBAV_CSS"} || <<EOT;
12 <style type="text/css">
13 <!--
14 .container {
15   margin-right: auto;
16   margin-left: auto;
17   width: 1070px;
18 }
19 body {
20   font-size: 14px;
21   line-height: 20px;
22   color: #333333;
23   background-color: #ffffff;
24 }
25 a {
26   color: #0088cc;
27   text-decoration: none;
28 }
29 a:hover {
30   color: #005580;
31   text-decoration: underline;
32 }
33 p {
34   margin: 0 0 10px;
35 }
36 h2,
37 h3,
38 h4 {
39   margin: 10px 0;
40   font-family: inherit;
41   font-weight: bold;
42   line-height: 1;
43   border-color: #D6E9C6;
44   color: #468847;
45   border-style: solid;
46   border-width: 0 0 1px;
47   padding-left: 0.5em;
48 }
49
50 h1 a,
51 h2 a,
52 h3 a,
53 h4 a {
54   color: inherit;
55 }
56 h1 {
57   font-size: 30px;
58   line-height: 40px;
59 }
60 h2 {
61   font-size: 20px;
62   line-height: 40px;
63 }
64 h3 {
65   font-size: 18px;
66   line-height: 40px;
67 }
68 code,
69 pre {
70   padding: 0 3px 2px;
71   font-family: monospace;
72   font-size: 12px;
73   color: #333333;
74   border-radius: 3px;
75 }
76 pre {
77   display: block;
78   padding: 9.5px;
79   margin: 0 0 10px;
80   font-size: 13px;
81   line-height: 20px;
82   word-break: break-all;
83   word-wrap: break-word;
84   white-space: pre;
85   white-space: pre-wrap;
86   background-color: #f5f5f5;
87   border: 1px solid #ccc;
88   border-radius: 4px;
89 }
90
91 code {
92   padding: 2px 4px;
93   color: #d14;
94   background-color: #f7f7f9;
95   border: 1px solid #e1e1e8;
96 }
97 pre code {
98   padding: 0;
99   color: inherit;
100   background-color: transparent;
101   border: 0;
102 }
103 .alert {
104   padding: 8px 35px 8px 14px;
105   margin-bottom: 20px;
106   text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
107   background-color: #fcf8e3;
108   border: 1px solid #fbeed5;
109   border-radius: 4px;
110   color: #c09853;
111 }
112
113 .alert-danger,
114 .alert-error {
115   background-color: #f2dede;
116   border-color: #eed3d7;
117   color: #b94a48;
118 }
119 .alert-info {
120   background-color: #d9edf7;
121   border-color: #bce8f1;
122   color: #3a87ad;
123 }
124
125 ul.toc {
126   list-style-type: none;
127 }
128 -->
129 </style>
130 EOT
131
132 my $TEMPLATE_HEADER = $ENV{"LIBAV_HEADER"} || <<EOT;
133 <link rel="icon" href="favicon.png" type="image/png" />
134 </head>
135 <body>
136 <div class="container">
137 EOT
138
139 $PRE_BODY_CLOSE = '</div></div>';
140
141 $SMALL_RULE = '';
142 $BODYTEXT = '';
143
144 $print_page_foot = \&Libav_print_page_foot;
145 sub Libav_print_page_foot($$)
146 {
147     my $fh = shift;
148     my $program_string = defined &T2H_DEFAULT_program_string ?
149         T2H_DEFAULT_program_string() : program_string();
150     print $fh '<footer class="footer pagination-right">' . "\n";
151     print $fh '<span class="label label-info">' . $program_string;
152     print $fh "</span></footer></div>\n";
153 }
154
155 $float = \&Libav_float;
156
157 sub Libav_float($$$$)
158 {
159     my $text = shift;
160     my $float = shift;
161     my $caption = shift;
162     my $shortcaption = shift;
163
164     my $label = '';
165     if (exists($float->{'id'}))
166     {
167         $label = &$anchor($float->{'id'});
168     }
169     my $class = '';
170     my $subject = '';
171
172     if ($caption =~ /NOTE/)
173     {
174         $class = "alert alert-info";
175     }
176     elsif ($caption =~ /IMPORTANT/)
177     {
178         $class = "alert alert-warning";
179     }
180
181     return '<div class="float ' . $class . '">' . "$label\n" . $text . '</div>';
182 }
183
184 $print_page_head = \&Libav_print_page_head;
185 sub Libav_print_page_head($$)
186 {
187     my $fh = shift;
188     my $longtitle = "$Texi2HTML::THISDOC{'title_no_texi'}";
189     $longtitle .= ": $Texi2HTML::NO_TEXI{'This'}" if exists $Texi2HTML::NO_TEXI{'This'};
190     my $description = $DOCUMENT_DESCRIPTION;
191     $description = $longtitle if (!defined($description));
192     $description = "<meta name=\"description\" content=\"$description\">" if
193          ($description ne '');
194     $description = $Texi2HTML::THISDOC{'documentdescription'} if (defined($Texi2HTML::THISDOC{'documentdescription'}));
195     my $encoding = '';
196     $encoding = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=$ENCODING\">" if (defined($ENCODING) and ($ENCODING ne ''));
197     $longtitle =~ s/Documentation.*//g;
198     $longtitle = "Libav documentation : " . $longtitle;
199
200     print $fh <<EOT;
201 <!DOCTYPE html>
202 <html>
203 $Texi2HTML::THISDOC{'copying'}<!-- Created on $Texi2HTML::THISDOC{today} by $Texi2HTML::THISDOC{program} -->
204 <!--
205 $Texi2HTML::THISDOC{program_authors}
206 -->
207 <head>
208 <title>$longtitle</title>
209
210 $description
211 <meta name="keywords" content="$longtitle">
212 <meta name="resource-type" content="document">
213 <meta name="distribution" content="global">
214 <meta name="Generator" content="$Texi2HTML::THISDOC{program}">
215 $encoding
216 $CSS_LINES
217 $TEMPLATE_HEADER
218 EOT
219 }
220
221 # no navigation elements
222 $SECTION_NAVIGATION = 0;
223 # the same for texi2html 5.0
224 $HEADERS = 0;
225
226 # TOC and Chapter headings link
227 $TOC_LINKS = 1;
228
229 # print the TOC where @contents is used
230 $INLINE_CONTENTS = 1;