jeroen Sun Jun 24 13:45:37 2001 EDT Added files: /phpdoc/en language-snippets.ent Modified files: /phpdoc manual.xml.in /phpdoc/en language-defs.ent /phpdoc/en/functions misc.xml var.xml Log: Added snippets-file, where you can locate common snippets. See highlight-string for an example. Index: phpdoc/manual.xml.in diff -u phpdoc/manual.xml.in:1.68 phpdoc/manual.xml.in:1.69 --- phpdoc/manual.xml.in:1.68 Fri Jun 22 22:34:00 2001 +++ phpdoc/manual.xml.in Sun Jun 24 13:45:37 2001 @@ -2,9 +2,11 @@ <!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V1.7//EN" "@srcdir@/dbxml/docbookx.dtd" [ -<!ENTITY % language-defs SYSTEM "@srcdir@/@LANGDIR@/language-defs.ent"> +<!ENTITY % language-defs SYSTEM "@srcdir@/@LANGDIR@/language-defs.ent"> +<!ENTITY % language-snippets SYSTEM "@srcdir@/@LANGDIR@/language-snippets.ent"> %language-defs; +%language-snippets; <!-- Defaults for entities that should be defined in language-defs --> <!ENTITY % global.entities SYSTEM "@srcdir@/global.ent"> Index: phpdoc/en/language-defs.ent diff -u phpdoc/en/language-defs.ent:1.2 phpdoc/en/language-defs.ent:1.3 --- phpdoc/en/language-defs.ent:1.2 Thu Mar 8 03:45:53 2001 +++ phpdoc/en/language-defs.ent Sun Jun 24 13:45:37 2001 @@ -6,5 +6,3 @@ <!ENTITY FunctionReference "Function Reference"> <!ENTITY Appendixes "Appendixes"> <!ENTITY PEAR "PEAR: the PHP Extension and Application Repository"> - -<!ENTITY available "available in"> Index: phpdoc/en/functions/misc.xml diff -u phpdoc/en/functions/misc.xml:1.47 phpdoc/en/functions/misc.xml:1.48 --- phpdoc/en/functions/misc.xml:1.47 Sat Jun 23 22:10:51 2001 +++ phpdoc/en/functions/misc.xml Sun Jun 24 13:45:37 2001 @@ -510,7 +510,7 @@ The <function>highlight_file</function> function prints out a syntax higlighted version of the code contained in <parameter>filename</parameter> using the colors defined in the built-in syntax highlighter for PHP. - It returns true on success, false otherwise (PHP 4). + &return.success; </simpara> <note> <simpara> @@ -586,6 +586,7 @@ </para> </example> </para> + &tip.ob-capture; <simpara> See also <function>highlight_string</function>, <function>show_source</function>. @@ -610,8 +611,9 @@ The <function>highlight_string</function> function prints out a syntax highlighted version of <parameter>str</parameter> using the colors defined in the built-in syntax highlighter for PHP. - It returns true on success, false otherwise (PHP 4). + &return.success; </simpara> + &tip.ob-capture; <simpara> See also <function>highlight_file</function>, <function>show_source</function>. Index: phpdoc/en/functions/var.xml diff -u phpdoc/en/functions/var.xml:1.55 phpdoc/en/functions/var.xml:1.56 --- phpdoc/en/functions/var.xml:1.55 Sun Jun 24 07:11:35 2001 +++ phpdoc/en/functions/var.xml Sun Jun 24 13:45:37 2001 @@ -876,6 +876,7 @@ pointer to the end. Use <function>reset</function> to bring it back to beginning. </simpara> + &tip.ob-capture; <simpara> Compare <function>print_r</function> to <function>var_dump</function>. @@ -1288,6 +1289,7 @@ that includes its type and value. Arrays are explored recursively with values indented to show structure. </simpara> + &tip.ob-capture; <simpara> Compare <function>var_dump</function> to <function>print_r</function>. Index: phpdoc/en/language-snippets.ent +++ phpdoc/en/language-snippets.ent <!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>'> <!ENTITY return.success 'Returns <constant>TRUE</constant> on succes, <constant>FALSE</constant> on failure.'> <!ENTITY note.not-bin-safe '<warning><simpara>This function is not (yet) binary safe!</simpara></warning>'> <!ENTITY note.bin-safe '<note><simpara>This function is binary-safe</simpara></note>'> <!ENTITY note.no-windows '<note><simpara>This function is not implemented on Windows-platforms</simpara></note>'> <!ENTITY note.no-safemode '<note><simpara>This function is disabled when safe-mode is enabled.</simpara></note>'>