svn: /pear/peardoc/trunk/en/package/text/text-diff/ intro.xml usage-examples.xml

cweiske                                  Thu, 03 Sep 2009 22:19:34 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=288012

Log:
interlink docs a bit for text_diff

Changed paths:
    U   pear/peardoc/trunk/en/package/text/text-diff/intro.xml
    U   pear/peardoc/trunk/en/package/text/text-diff/usage-examples.xml

Modified: pear/peardoc/trunk/en/package/text/text-diff/intro.xml
===================================================================
--- pear/peardoc/trunk/en/package/text/text-diff/intro.xml	2009-09-03 22:02:38 UTC (rev 288011)
+++ pear/peardoc/trunk/en/package/text/text-diff/intro.xml	2009-09-03 22:19:34 UTC (rev 288012)
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <chapter xmlns="http://docbook.org/ns/docbook" version="lillet"
  xml:id="package.text.text-diff.intro"
+ xmlns:phd="http://www.php.net/ns/phd"
 >
  <info>
   <title>Introduction to Text_Diff</title>
@@ -32,17 +33,35 @@
  </orderedlist>

  <para>
-  In Text_Diff, an <emphasis>Engine</emphasis> is used to compute the difference
+  In <phd:pearapi phd:package="Text_Diff"
+   phd:linkend="Text_Diff">Text_Diff</phd:pearapi>,
+  an <emphasis>Engine</emphasis> is used to compute the difference
   between the files/strings. The packages contains several of them:
-  <literal>native</literal>, <literal>shell</literal>, <literal>string</literal>
-  and <literal>xdiff</literal>. One should use <literal>auto</literal> to let
-  Text_Diff decide which one is the best for the system.
+  <phd:pearapi phd:package="Text_Diff"
+   phd:linkend="Text_Diff_Engine_native">native</phd:pearapi>,
+  <phd:pearapi phd:package="Text_Diff"
+   phd:linkend="Text_Diff_Engine_shell">shell</phd:pearapi>,
+  <phd:pearapi phd:package="Text_Diff"
+   phd:linkend="Text_Diff_Engine_string">string</phd:pearapi>
+  and <phd:pearapi phd:package="Text_Diff"
+   phd:linkend="Text_Diff_Engine_xdiff">xdiff</phd:pearapi>.
+  One should use <literal>auto</literal> to let
+  <classname>Text_Diff</classname> decide which one is
+  the best for the system.
  </para>

  <para>
   The second part, creating the output, is made possible by
-  renderers. Text_Diff comes with <literal>context</literal>,
-  <literal>inline</literal> and <literal>unified</literal>
+  renderers. Text_Diff comes with
+  <link linkend="package.text.text-diff.intro.renderers.context">
+   context
+  </link>,
+  <link linkend="package.text.text-diff.intro.renderers.inline">
+   inline
+  </link>
+  and <link linkend="package.text.text-diff.intro.renderers.unified">
+   unified
+  </link>
   renderers.
  </para>


Modified: pear/peardoc/trunk/en/package/text/text-diff/usage-examples.xml
===================================================================
--- pear/peardoc/trunk/en/package/text/text-diff/usage-examples.xml	2009-09-03 22:02:38 UTC (rev 288011)
+++ pear/peardoc/trunk/en/package/text/text-diff/usage-examples.xml	2009-09-03 22:19:34 UTC (rev 288012)
@@ -12,7 +12,9 @@
   </info>

   <para>
-   Together with Console_Color, it is possible to use Text_Diff
+   Together with
+   <link linkend="package.console.console-color">Console_Color</link>,
+   it is possible to use <classname>Text_Diff</classname>
    to generate colored diffs on an ANSI terminal.
   </para>