prepare docs of 3.0.0RC2

llaville · Apr 14, 2014 · c5688e5 · c5688e5
1 parent 63233e8
commit c5688e5
Show file tree

Hide file tree

Showing 14 changed files with 454 additions and 290 deletions.
diff --git a/README.asciidoc b/README.asciidoc
@@ -6,7 +6,9 @@ find out the minimum version and the extensions required for a piece of code to
 
 == Blog 
 
-The first mature Release Candidate (RC1) of API 3.0 was released Wed, 19 Feb 2014.
+* The first mature Release Candidate (RC1) of API 3.0 was released Wed, 19 Feb 2014.
+* The last Release Candidate (RC2) of API 3.0 was released Mon, 14 Apr 2014.
+* Final stable release 3.0.0 is planned for Wed, 30 Apr 2014.
 
 It was distributed as source code (install via composer) and a PHAR version 
 that bundles all dependencies in a single file.
@@ -15,12 +17,17 @@ Follow development on the http://php5.laurent-laville.org/compatinfo/blog[offici
 
 Have a look on master branch for previous stable API 2.0
 
+== Install
+
+You can either :
+
+* download the phar version http://bartlett.laurent-laville.org/get/phpcompatinfo-3.0.0RC1-2-gd181e6c.phar[3.0.0RC1]
+* download the phar version http://bartlett.laurent-laville.org/get/phpcompatinfo-3.0.0RC2.phar[3.0.0RC2]
+* install via https://packagist.org/packages/bartlett/php-compatinfo/[packagist] the current source 3.x-dev or the 3.0.0RC2
+
 == Documentation
 
-The documentation for PHP CompatInfo will be soon available 
-in http://php5.laurent-laville.org/compatinfo/manual/3.0/en/[English] 
-and different formats, begun with a web doc,
-built with https://github.com/llaville/asciidoc-bootstrap-backend[AsciiDoc-Bootstrap] 
-and http://getbootstrap.com/[Bootstrap 3].   
+The documentation for PHP CompatInfo 3.0 is only available online
+in http://php5.laurent-laville.org/compatinfo/manual/3.0/en/[English].
 
 AsciiDoc source code are available on `docs` folder of the repository.
diff --git a/docs/LICENSE.asciidoc b/docs/LICENSE.asciidoc
@@ -0,0 +1,45 @@
+= License
+:description: The full details of how CompatInfo is licensed.
+:jumbotron:
+:icons!:
+:iconsfont: font-awesome
+:iconsfontdir: ./fonts/font-awesome
+include::revision.asciidoc[]
+include::attributes.asciidoc[]
+
+[role="lead"]
+[label label-primary]#CompatInfo# is open source.
+You can use it for commercial projects, and open source projects.
+
+== Documentation Licence
+
+All documentation files (extension +.asciidoc+) provided in +docs+ folder are 
+in http://asciidoc.org[AsciiDoc] format. They are built with a Python AsciiDoc backend 
+maintained by myself, that convert output to an html http:/getbootstrap.com[Bootstrap] renders. 
+http://laurent-laville.org/asciidoc/bootstrap/manual/current/en/[AsciiDoc-Bootstrap] 
+is released under the http://www.apache.org/licenses/LICENSE-2.0.html[Apache 2] license.
+
+== Source License
+
+As previous API 2.0, the source code is still under the 
+http://opensource.org/licenses/BSD-3-Clause[BSD 3-Clause] license.
+
+== Credits
+
+I would like to thanks here specially a guy without who this PHP QA tool
+won't be born.
+
+[quote, Davey Shafik, http://daveyshafik.com/]
+____
+Original author, he introduced his http://pear.php.net/pepr/pepr-proposal-show.php?id=27[proposal]
+in 2004, that gave birth of a PEAR package named
+http://pear.php.net/package/PHP_CompatInfo[PHP_CompatInfo].
+____
+
+I would also like to thanks a guy who help me to enhance support of more than 50 extensions.
+
+[quote, Remi Collet, http://blog.famillecollet.com/]
+____
+Contributor of many extensions reference and unit tests. He has joined the team
+on version 2.0.0RC2
+____
diff --git a/docs/LICENSE.txt b/docs/LICENSE.txt
diff --git a/docs/attributes.asciidoc b/docs/attributes.asciidoc
@@ -0,0 +1,11 @@
+:author:      Laurent Laville
+:keywords:    PHP, compatibility, version
+:mandir:      http://php5.laurent-laville.org/compatinfo/manual/3.0
+:brand:       PHP CompatInfo {revnumber}
+:brandref:    https://github.com/llaville/php-compat-info/tree/v3
+:sidebar:     right
+:footer:
+:navinfo1:
+:iconsfont:    font-awesome
+:iconsfontdir: ./fonts/font-awesome
+:imagesdir:    ./images
diff --git a/docs/attributes.txt b/docs/attributes.txt
diff --git a/docs/footer.bs3.html b/docs/footer.bs3.html
@@ -1,32 +1,35 @@
 <div class="row">
-    <div class="col-md-4">
+    <div class="col-md-3">
         <ul class="nav nav-list">
             <li class="nav-header"><span class="glyphicon glyphicon-tag"></span> About</li>
-            <li><a href="CHANGELOG.html">Changelog</a></li>
-            <li><a href="LICENSE.html">License</a></li>
+            <li><a href="license.html">License</a></li>
         </ul>
     </div>
-    <div class="col-md-4">
+    <div class="col-md-3">
         <ul class="nav nav-list">
             <li class="nav-header"><span class="glyphicon glyphicon-book"></span> Get Started</li>
-            <li><a href="http://bartlett.laurent-laville.org/get/PHP_CompatInfo-{revnumber}.tgz">Download</a></li>
-            <li><a href="INSTALL.html">Installation</a></li>
-            <li><a href="phpci-book.html">User Guide</a></li>
+            <li><a href="setup.html">Setup</a></li>
         </ul>
     </div>
-    <div class="col-md-4">
+    <div class="col-md-3">
         <ul class="nav nav-list">
             <li class="nav-header"><span class="glyphicon glyphicon-comment"></span> Get Help</li>
             <li><a href="https://github.com/llaville/php-compat-info/issues">Report an issue</a></li>
         </ul>
     </div>
+    <div class="col-md-3">
+        <ul class="nav nav-list">
+            <li class="nav-header"><span class="glyphicon glyphicon-bullhorn"></span> Stay Tuned</li>
+            <li><a href="http://php5.laurent-laville.org/compatinfo/blog/">Blog</a></li>
+        </ul>
+    </div>
 </div>
 <div class="row">
     <div class="col-md-12">
         <div id="footer-text">
             Version <span class="badge">{revnumber}</span><br>
             Last updated {docdate} {doctime}<br>
-            Built with <a href="https://github.com/llaville/asciidoc-bootstrap-backend">AsciiDoc-Bootstrap backend</a> {bootstrap-backend-version}            
+            Built with <a href="https://github.com/llaville/asciidoc-bootstrap-backend">AsciiDoc-Bootstrap backend</a> {bootstrap-backend-version}
         </div>
         <div id="footer-badges">
             Valid <a href="http://validator.w3.org/check?uri=referer">XHTML</a>

diff --git a/docs/landing.asciidoc b/docs/landing.asciidoc
@@ -0,0 +1,130 @@
+= CompatInfo
+:description: CompatInfo makes it extremely easy to learn and maintain your components compatibilities for reuse in your PHP applications.
+:jumbotron-fullwidth:
+:css-signature: landing
+:icons!:
+:iconsfont: font-awesome
+:iconsfontdir: ./fonts/font-awesome
+include::revision.asciidoc[]
+include::attributes.asciidoc[]
+
+
+== What Is PHP CompatInfo
+
+PHP [label label-primary]#CompatInfo# is a PHP library that parse any data source
+to find out the minimum version and extensions required for it to run.
+
+== Features
+
+[cols="1,11"]
+.icon:flag[size="2x"]
+--
+[medium]*Modern*
+
+[label label-primary]#CompatInfo# takes advantage of new features in PHP 5.3.0 or greater.
+--
+[cols="1,11"]
+.icon:building-o[size="2x"]
+--
+[medium]*Robust*
+
+[label label-primary]#CompatInfo# is strictly tested. Checks code coverage and see by yourself.
+--
+[cols="1,11"]
+.icon:archive[size="2x"]
+--
+[medium]*Explore all data source*
+
+[label label-primary]#CompatInfo# comes with a source provider (based on Symfony http://symfony.com/doc/current/components/finder.html[Finder] component)
+that allow to parse all data source (single file, directories, archives Phar, Zip, Tar, and lot more).
+--
+[cols="1,11"]
+.icon:suitcase[size="2x"]
+--
+[medium]*Solid Foundation*
+
+Whenever possible wheel reinvention was avoided. [label label-primary]#CompatInfo# uses code from well-known projects
+including http://www.symfony.com/[Symfony] Finder, Console, and EventDispatcher.
+--
+
+== Documentation
+
+[role="partintro",cols="3,9"]
+.icon:book[size="7x"] [clearfix]#All documentation are available online and for download in several formats.#
+--
+[medium]*Offline Reading*
+
+The [label label-primary]#CompatInfo# book is available in a selection of formats.
+You can download the documentation for offline reading.
+
+[options="header", cols="3,9", role="table table-bordered table-striped"]
+|===========================
+| Formats                             | Download links
+| icon:file-o[]      Single HTML file | link:{mandir}/en/[phpcompatinfo-book.html.zip]
+| icon:files-o[]     Many HTML files  | link:{mandir}/en/[phpcompatinfo-book.chunked.zip]
+| icon:file-text-o[] HTML Help file   | link:{mandir}/en/[phpcompatinfo-book.chm.zip]
+| icon:file-text[]   PDF A4 file      | link:{mandir}/en/[phpcompatinfo-book-a4.pdf]
+| icon:file-text[]   PDF US file      | link:{mandir}/en/[phpcompatinfo-book-us.pdf]
+| icon:book[]        EPUB file        | link:{mandir}/en/[phpcompatinfo-book.epub.zip]
+|===========================
+--
+
+== License
+
+[role="partintro",cols="3,9"]
+.icon:shield[size="7x"] [clearfix]#CompatInfo is open-source software.#
+--
+[medium]*BSD License*
+
+The full legal text of the BSD 3-clause license is given below.
+----
+ Copyright (c) 2010-2014, Laurent Laville <pear@laurent-laville.org>
+
+ Credits to :
+
+    * Davey Shafik
+      Original author, he introduced his proposal in 2004,
+      that gave birth of a PEAR package named PHP_CompatInfo.
+    * Remi Collet
+      Contributor on many extensions and unit tests since version 2.0.0RC2
+
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+     * Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+     * Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+     * Neither the name of the authors nor the names of its contributors
+       may be used to endorse or promote products derived from this software
+       without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
+ BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+----
+--
+
+== What is next
+
+WARNING: First visit, you are highly recommended to follow chapters in order.
+
+[horizontal]
+Setup:: Configuring your project and get ready for your first parsing.
+Quick Start:: This quick start is a five minute tutorial where you can discover how to identify a data source and parse its contents.
+Handle Results:: Learn how to explore and exploit parsing results.
+Concrete Examples:: Discover how CompatInfo may be use in real condition.
+
+link:setup.html["Go to next chapter: Setup",role="primary",icon="glyphicon-step-forward",options="block"]