cvs: phpdoc /en language-snippets.ent

erica Sun Sep 15 00:45:32 2002 EDT Modified files: /phpdoc/en language-snippets.ent Log: -- Made many of the references easier to understand. -- Changed reference of "the global <link linkend="configuration.file">configuration file</link> &php.ini;" to just &php.ini;. -- Fixed some grammatical errors. Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.29 phpdoc/en/language-snippets.ent:1.30 --- phpdoc/en/language-snippets.ent:1.29 Tue Sep 10 09:33:16 2002 +++ phpdoc/en/language-snippets.ent Sun Sep 15 00:45:31 2002 @@ -1,39 +1,38 @@ -<!-- $Revision: 1.29 $ --> +<!-- $Revision: 1.30 $ --> <!ENTITY warn.experimental '<warning><simpara>This extension is -<emphasis>EXPERIMENTAL</emphasis>. The behaviour of this extension, -including the names of its functions, and anything else documented -about this extension may change in a future release of PHP without -notice. Be warned and use this extension at your own -risk.</simpara></warning>'> +<emphasis>EXPERIMENTAL</emphasis>. The behaviour of this extension -- +including the names of its functions and anything else documented +about this extension -- may change without notice in a future release of PHP. +Use this extension at your own risk.</simpara></warning>'> <!ENTITY warn.experimental.func '<warning><simpara>This function is <emphasis>EXPERIMENTAL</emphasis>. The behaviour of this function, the name of this function, and anything else documented about this -function may change in a future release of PHP without notice. Be -warned and use this function at your own risk.</simpara></warning>'> +function may change without notice in a future release of PHP. +Use this function at your own risk.</simpara></warning>'> <!ENTITY warn.undocumented.func '<warning><simpara>This function is currently not documented; only the argument list is available.</simpara></warning>'> <!ENTITY warn.no-win32-fopen-wrapper '<warning><para>The Windows -version of <literal>PHP</literal> currently does not support remote -file accessing for this function, even if +version of <literal>PHP</literal> currently does not support accessing +remote files via this function, even if <link linkend="ini.allow-url-fopen">allow_url_fopen</link> is enabled. </para></warning>'> <!ENTITY tip.ob-capture '<tip><simpara>As with anything that outputs its result directly to the browser, you can use the <link linkend="ref.outcontrol">output-control functions</link> to capture -the output of this function, and save it - for example - in a -<type>string</type>.</simpara></tip>'> +the output of this function, and save it in a +<type>string</type> (for example).</simpara></tip>'> <!ENTITY tip.fopen-wrapper '<tip><simpara>You can use a URL as a filename with this function if the "fopen wrappers" have been enabled. See <function>fopen</function> for more details.</simpara></tip>'> -<!ENTITY return.success 'Returns &true; on success, &false; on failure.'> +<!ENTITY return.success 'Returns &true; on success or &false; on failure.'> <!ENTITY return.falseproblem '<warning><simpara>This function may return Boolean &false;, but may also return a non-Boolean value which @@ -63,59 +62,56 @@ <!ENTITY note.sm.uidcheck '<note><simpara>When <link linkend="features.safe-mode">safe mode</link> is enabled, PHP checks whether -the file(s)/directories you are about to operate on have the same UID as the +the files or directories you are about to operate on have the same UID (owner) as the script that is being executed.</simpara></note>'> <!ENTITY note.sm.uidcheck.dir '<note><simpara>When <link linkend="features.safe-mode">safe mode</link> is enabled, PHP checks whether -the directory in which you are about to operate has the same UID as the +the directory in which you are about to operate has the same UID (owner) as the script that is being executed.</simpara></note>'> <!-- Common pieces in features/safe-mode.xml Jade doesn't allow in-line entities, so I put them here... Though they should have been inline in safe-mode.xml --> -<!ENTITY sm.uidcheck 'Checks whether the file(s)/directories you are -about to operate on have the same UID as the script that is being +<!ENTITY sm.uidcheck 'Checks whether the files or directories you are +about to operate on have the same UID (owner) as the script that is being executed.'> <!ENTITY sm.uidcheck.dir 'Checks whether the directory in which -you are about to operate has the same UID as the script that is being +you are about to operate has the same UID (owner) as the script that is being executed.'> <!ENTITY sm.disabled 'This function is disabled in <link linkend="features.safe-mode">safe mode</link>.'> <!-- Common pieces in partintro-sections --> -<!ENTITY no.config '<para>This extension does not define any -configuration directives.</para>'> -<!ENTITY no.resource '<para>This extension does not define any resource types.</para>'> -<!ENTITY no.constants '<para>This extension does not define any constants.</para>'> -<!ENTITY no.requirement '<para>These functions are available as part of the -standard module, which is always available.</para>'> +<!ENTITY no.config '<para>This extension has no configuration directives defined in &php.ini;.</para>'> +<!ENTITY no.resource '<para>This extension has no resource types defined.</para>'> +<!ENTITY no.constants '<para>This extension has no constants defined.</para>'> +<!ENTITY no.requirement '<para>These functions are always available.</para>'> <!ENTITY no.install '<para>There is no installation needed to use these -functions, they are part of the PHP core.</para>'> +functions; they are part of the PHP core.</para>'> <!-- Used in reference/$extname/ini.xml --> <!ENTITY extension.runtime '<simpara> -The behaviour of these functions are affected by settings in the -global <link linkend="configuration.file">configuration file</link> &php.ini;. +The behaviour of these functions is affected by settings in &php.ini;. </simpara>'> <!-- Used in reference/$extname/constants.xml --> <!ENTITY extension.constants '<simpara> -These constants are defined by this extension, and +The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime. </simpara>'> <!-- For STANDARD Constants used in reference/$extname/constants.xml --> <!ENTITY extension.constants.core '<simpara> -The constants listed here are always available as part of the PHP core. +The constants below are always available as part of the PHP core. </simpara>'> <!-- Used in reference/$extname/classes.xml --> <!ENTITY extension.classes '<simpara> -These classes are defined by this extension, and +The classes below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime. </simpara>'>