summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--admin/makedoc.sh2
-rw-r--r--tutorials/OpenID/OpenID.pkg71
2 files changed, 72 insertions, 1 deletions
diff --git a/admin/makedoc.sh b/admin/makedoc.sh
index e13c36e..a13f094 100644
--- a/admin/makedoc.sh
+++ b/admin/makedoc.sh
@@ -1,5 +1,5 @@
#!/bin/sh
set -v
-phpdoc -p -t doc -d Auth -ti "JanRain OpenID Library" \
+phpdoc -p -t doc -d Auth,tutorials -ti "JanRain OpenID Library" \
--ignore \*~,BigMath.php,CryptUtil.php,DiffieHellman.php,HMACSHA1.php,KVForm.php,Parse.php,TrustRoot.php \
-dn "OpenID" -o "HTML:frames:phphtmllib"
diff --git a/tutorials/OpenID/OpenID.pkg b/tutorials/OpenID/OpenID.pkg
new file mode 100644
index 0000000..0ae2aba
--- /dev/null
+++ b/tutorials/OpenID/OpenID.pkg
@@ -0,0 +1,71 @@
+<refentry id="{@id}">
+ <refnamediv>
+ <refname>PHP OpenID API</refname>
+
+ <!--<refpurpose>What makes good documentation? This is
+ unanswerable, but there are a few things to keep in
+ mind</refpurpose>-->
+
+ </refnamediv>
+ <refsynopsisdiv>
+ <author>
+ JanRain, Inc.
+ <authorblurb>
+ {@link mailto:openid@janrain.com openid@janrain.com}
+ </authorblurb>
+ </author>
+ </refsynopsisdiv>
+
+ <para>
+ This is a complete implementation of the OpenID authentication
+ protocol for PHP applications. This package contains:
+
+ <itemizedlist>
+ <listitem>An OpenID server</listitem>
+ <listitem>An OpenID consumer</listitem>
+ <listitem>Stores for MySQL, PostgreSQL, SQLite, and filesystem-based OpenID data storage</listitem>
+ <listitem>PHPUnit unit tests</listitem>
+ <listitem>An example server and consumer</listitem>
+ </itemizedlist>
+ </para>
+
+ <refsect1 id="{@id howto}">
+ <title>How to Use This Package</title>
+
+ <refsect2 id="{@id users}">
+ <title>For Package Users</title>
+
+ <para></para>
+
+ </refsect2>
+
+ <refsect2 id="{@id developers}">
+ <title>For Developers</title>
+
+ <para></para>
+
+ </refsect2>
+
+ </refsect1>
+
+ <refsect1 id="{@id references}">
+ <title>References</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ {@link http://www.openidenabled.com/openid/libraries/php PHP OpenID Libarry}
+ </listitem>
+
+ <listitem>
+ {@link http://www.janrain.com JanRain, Inc.}
+ </listitem>
+
+ <listitem>
+ {@link http://lists.openidenabled.com/mailman/listinfo/dev OpenID Development Discussion List}
+ </listitem>
+ </itemizedlist>
+ </para>
+ </refsect1>
+
+</refentry>
+