diff xml/en/docs/http/ngx_http_mp4_module.xml @ 271:4c6d2c614d2c

Cleaned up XML tag mess: - all of <parameter> and <code>, and some of <dirname>, <value>, and <command> were replaced by <literal>; - the rest of <dirname> were replaced by links; - <argument> were replaced by <value>; - <value> is now rendered in HTML in italic; - <literal> and <path> can now contain <value>. Cleaned up terminology mess: - directives take "parameters".
author Ruslan Ermilov <ru@nginx.com>
date Fri, 23 Dec 2011 17:29:59 +0000
parents 0188d11c77dd
children be54c443235a
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_mp4_module.xml	Thu Dec 22 13:39:18 2011 +0000
+++ b/xml/en/docs/http/ngx_http_mp4_module.xml	Fri Dec 23 17:29:59 2011 +0000
@@ -9,7 +9,7 @@
 <section id="summary">
 
 <para>
-The module <code>ngx_http_mp4_module</code> provides pseudo-streaming
+The module <literal>ngx_http_mp4_module</literal> provides pseudo-streaming
 server-side support for H.264/AAC files typically having filename extensions
 <path>.mp4</path>, <path>.m4v</path>, and <path>.m4a</path>.
 </para>
@@ -18,7 +18,7 @@
 Pseudo-streaming works in alliance with conforming Flash players.
 A player sends an HTTP request to the server with a start time
 argument in the request URI’s query string (named simply
-<parameter>start</parameter>
+<literal>start</literal>
 and specified in seconds), and the server responds with a stream
 so that its start position corresponds to the requested time,
 for example:
@@ -39,7 +39,7 @@
 <para>
 To start playback, a player first needs to read metadata.
 This is done by sending a special request with the
-<parameter>start=0</parameter>
+<literal>start=0</literal>
 argument.  Many encoding software will insert the metadata at
 the end of the file.  This is bad for pseudo-streaming:
 the metadata needs to be located at the beginning of the file,
@@ -58,7 +58,7 @@
 
 <para>
 For a matching request with a non-zero
-<parameter>start</parameter>
+<literal>start</literal>
 argument, nginx will read metadata from the file, prepare the
 stream starting from the requested offset, and send it to a client.
 This has the same overhead as described above.
@@ -66,7 +66,7 @@
 
 <para>
 If a matching request does not include the
-<parameter>start</parameter>
+<literal>start</literal>
 argument, there is no overhead, and the file is just sent as a static resource.
 Some players also support byte-range requests, and thus do not require
 this module at all.
@@ -74,7 +74,7 @@
 
 <para>
 This module is not built by default, it should be enabled with the
-<code>--with-http_mp4_module</code>
+<literal>--with-http_mp4_module</literal>
 configuration parameter.
 <note>
 If you were using the third-party mp4 module, be sure to disable it.
@@ -119,7 +119,7 @@
 
 
 <directive name="mp4_buffer_size">
-<syntax><argument>size</argument></syntax>
+<syntax><value>size</value></syntax>
 <default>512K</default>
 <context>http</context>
 <context>server</context>
@@ -133,7 +133,7 @@
 
 
 <directive name="mp4_max_buffer_size">
-<syntax><argument>size</argument></syntax>
+<syntax><value>size</value></syntax>
 <default>10M</default>
 <context>http</context>
 <context>server</context>
@@ -141,7 +141,7 @@
 
 <para>
 During metadata processing, a larger buffer may become necessary.
-Its size cannot exceed the specified <argument>size</argument>,
+Its size cannot exceed the specified <value>size</value>,
 or else nginx will return the server error
 <http-status code="500" text="Internal Server Error"/>,
 and log the following: