= PHP_CompatInfo User Guide
:description: Overview of the project, its contents, and how to get started with your first parses
include::revision.txt[]
include::attributes.txt[]


[role="lead"]
This guide documents the final stable version {revnumber}

== Introduction

include::introduction.txt[]


ifdef::basebackend-html[]
== Installation

[role="lead"]
Head to the link:INSTALL.html[Install Guide] if it's your first use with PHP_CompatInfo.

PHP_CompatInfo may be installed in several ways, choose your favorite.

endif::[]

ifdef::basebackend-docbook[]
:leveloffset: 1

include::INSTALL.txt[]

:leveloffset: 0
endif::[]


ifdef::basebackend-html[]
== Getting Started

[role="lead"]
See our link:getting-started.html[tutorial] to learn how to get started with your first parses.

* use the default autoloader
* use your own autoloader
* run the CLI tool alternative

endif::[]

ifdef::basebackend-docbook[]
:leveloffset: 1

include::getting-started.txt[]

:leveloffset: 0
endif::[]


ifdef::basebackend-html[]
== Basic usage

[role="lead"]
Configure the default options to link:basic-usage.html[match your need],
and learn how to enlarge or limit parsing capabilities.

* parse directories recursively
* choose which file to scan
* select pre-defined references or use your own data dictionaries
* use the cache system

endif::[]

ifdef::basebackend-docbook[]
:leveloffset: 1

include::basic-usage.txt[]

:leveloffset: 0
endif::[]


ifdef::basebackend-html[]
== Command Line

[role="lead"]
How to get informations without to write a line of code. Use the link:command-line.html[CLI] tool.

* list data dictionnaries contents
* print multiple reports either on standard output (console) or to a file

endif::[]

ifdef::basebackend-docbook[]
:leveloffset: 1

include::command-line.txt[]

:leveloffset: 0
endif::[]


ifdef::basebackend-html[]

== Appendixes

=== Configure CLI options  

Structure and contents of the link:xml-configuration.html[XML configuration file]
that allow to configure the CLI tool.

=== Transform the XML report to HTML

Postprocessing the XML report file with link:XSLT.html[XSLT] to produces some nice HTML pages.

=== UML class diagrams

Architecture main components highlighted by the link:UML.html[UML] class diagrams.

endif::[]

ifdef::basebackend-docbook[]
:leveloffset: 1

include::xml-configuration.txt[]

include::XSLT.txt[]

include::UML.txt[]

include::LICENSE.txt[]

:leveloffset: 0
endif::[]
