svn: /pear/peardoc/trunk/en/package/text/ text-diff/examples/shell-inline.php text-diff/images/shell-inline.png text-diff/usage-examples.xml text-diff.xml

cweiske                                  Thu, 03 Sep 2009 22:02:38 +0000

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

Log:
add text_diff example for using it on the shell with console_color

Changed paths:
    A   pear/peardoc/trunk/en/package/text/text-diff/examples/shell-inline.php
    A   pear/peardoc/trunk/en/package/text/text-diff/images/
    A   pear/peardoc/trunk/en/package/text/text-diff/images/shell-inline.png
    A   pear/peardoc/trunk/en/package/text/text-diff/usage-examples.xml
    U   pear/peardoc/trunk/en/package/text/text-diff.xml

Added: pear/peardoc/trunk/en/package/text/text-diff/examples/shell-inline.php
===================================================================
--- pear/peardoc/trunk/en/package/text/text-diff/examples/shell-inline.php	                        (rev 0)
+++ pear/peardoc/trunk/en/package/text/text-diff/examples/shell-inline.php	2009-09-03 22:02:38 UTC (rev 288011)
@@ -0,0 +1,23 @@
+<?php
+require_once 'Console/Color.php';
+require_once 'Text/Diff.php';
+require_once 'Text/Diff/Renderer/inline.php';
+
+$lines1 = file('1.htm');
+$lines2 = file('2.htm');
+
+$diff     = new Text_Diff('auto', array($lines1, $lines2));
+$renderer = new Text_Diff_Renderer_inline(
+    array(
+        'ins_prefix' => '%g',
+        'ins_suffix' => '%n',
+        'del_prefix' => '%r',
+        'del_suffix' => '%n',
+    )
+);
+echo Console_Color::convert(
+    htmlspecialchars_decode(
+        $renderer->render($diff)
+    )
+);
+?>
\ No newline at end of file

Added: pear/peardoc/trunk/en/package/text/text-diff/images/shell-inline.png
===================================================================
(Binary files differ)


Property changes on: pear/peardoc/trunk/en/package/text/text-diff/images/shell-inline.png
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: pear/peardoc/trunk/en/package/text/text-diff/usage-examples.xml
===================================================================
--- pear/peardoc/trunk/en/package/text/text-diff/usage-examples.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/package/text/text-diff/usage-examples.xml	2009-09-03 22:02:38 UTC (rev 288011)
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter xmlns="http://docbook.org/ns/docbook" version="lillet"
+ xml:id="package.text.text-diff.usage-example"
+>
+ <info>
+  <title>Usage examples</title>
+ </info>
+
+ <section xml:id="package.text.text-diff.usage-examples.shell">
+  <info>
+   <title>Colorized diff output on the shell</title>
+  </info>
+
+  <para>
+   Together with Console_Color, it is possible to use Text_Diff
+   to generate colored diffs on an ANSI terminal.
+  </para>
+
+  <programlisting role="php">
+   <xi:include parse="text"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    href="&package.text.text-diff.examples.shell-inline.php;"
+   >
+    <xi:fallback>FIXME:MISSING XINCLUDE CONTENT</xi:fallback>
+   </xi:include>
+  </programlisting>
+
+  <simpara>
+   is displayed like that on a shell:
+  </simpara>
+
+  <figure>
+   <screenshot>
+    <mediaobject>
+     <alt>Screenshot</alt>
+     <imageobject>
+      <imagedata
+       align="center" format="png"
+       fileref="en/package/text/text-diff/images/shell-inline.png"
+      />
+     </imageobject>
+    </mediaobject>
+   </screenshot>
+  </figure>
+
+ </section>
+
+</chapter>

Modified: pear/peardoc/trunk/en/package/text/text-diff.xml
===================================================================
--- pear/peardoc/trunk/en/package/text/text-diff.xml	2009-09-03 21:43:08 UTC (rev 288010)
+++ pear/peardoc/trunk/en/package/text/text-diff.xml	2009-09-03 22:02:38 UTC (rev 288011)
@@ -12,4 +12,5 @@
  </info>

  &package.text.text-diff.intro;
+ &package.text.text-diff.usage-examples;
 </book>