svn: /pear/peardoc/trunk/en/package/system/system-launcher/ intro.xml

[email protected] (Christian Weiske) Tue, 21 Feb 2012 20:48:22 +0000
Newsgroups php.pear.doc
Message-ID <[email protected]>
--d5057f033ae16390addbe719a7fb4b771c45c153
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit

cweiske                                  Tue, 21 Feb 2012 20:48:22 +0000

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

Log:
CS on system_launcher docs, link api methods

Changed paths:
    U   pear/peardoc/trunk/en/package/system/system-launcher/intro.xml

Modified: pear/peardoc/trunk/en/package/system/system-launcher/intro.xml
===================================================================
--- pear/peardoc/trunk/en/package/system/system-launcher/intro.xml	2012-02-21 20:42:51 UTC (rev 323413)
+++ pear/peardoc/trunk/en/package/system/system-launcher/intro.xml	2012-02-21 20:48:22 UTC (rev 323414)
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
-<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.system.system-launcher.intro">
+<refentry version="lillet" xml:id="package.system.system-launcher.intro"
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:phd="http://www.php.net/ns/phd"
+>
  <refnamediv>
   <refname>Using System_Launcher</refname>
   <refpurpose>
@@ -7,7 +10,11 @@
   </refpurpose>
  </refnamediv>

- <refsection xml:id="package.system.system-launcher.intro.contrib"><info><title>Contributors</title></info>
+
+ <refsection xml:id="package.system.system-launcher.intro.contrib">
+  <info>
+  <title>Contributors</title>
+  </info>

   <para>
    <itemizedlist>
@@ -17,7 +24,11 @@
   </para>
  </refsection>

- <refsection xml:id="package.system.system-launcher.intro.desc"><info><title>Description</title></info>
+
+ <refsection xml:id="package.system.system-launcher.intro.desc">
+  <info>
+   <title>Description</title>
+  </info>

   <para>
    By using the operating system's features for opening a file or URL,
@@ -25,32 +36,37 @@
    et cetera. For instance, upon successful install, the "Getting started" URL
    could be loaded in the browser.
   </para>
-
  </refsection>

- <refsection xml:id="package.system.system-launcher.intro.usage"><info><title>Using System_Launcher</title></info>
+
+ <refsection xml:id="package.system.system-launcher.intro.usage">
+  <info>
+   <title>Using System_Launcher</title>
+  </info>

-  <example><info><title>Open a local HTML file in the web browser</title></info>
+  <example>
+   <info>
+    <title>Open a local HTML file in the web browser</title>
+   </info>

-   <programlisting role="php">
-    <![CDATA[
-<?php
+   <programlisting role="php"><![CDATA[<?php
 require_once 'System/Launcher.php';
 $launcher = new System_Launcher;
 $launcher->launch(dirname(__FILE__) . '/test.htm', true);
-?>
-]]></programlisting>
+?>]]></programlisting>
   </example>

   <para>
    At first, you need to instantitiate a new
-   <classname>System_Launcher</classname> object. The operating
-   system is determined there, which is needed for choosing a way
-   of launching programs.
+   <phd:pearapi phd:package="System_Launcher" phd:linkend="System_Launcher">System_Launcher object</phd:pearapi>.
+   The operating system is determined there, which is needed for choosing
+   a way of launching programs.
   </para>

   <para>
-   The <literal>launch()</literal> method tells the operating system
+   The
+   <phd:pearapi phd:package="System_Launcher" phd:linkend="System_Launcher::launch">launch()</phd:pearapi>
+   method tells the operating system
    to open the given file as it is associated. Browsers regularly
    open HTML documents, and image viewers open PNGs, and so on.
   </para>
@@ -58,8 +74,6 @@
   <para>
    You can also feed it a URL instead of a file.
   </para>
-
  </refsection>

-
 </refentry>

--d5057f033ae16390addbe719a7fb4b771c45c153--