#154: Update documentation to include API docs and code coverage report

ivanlanin · ivanlanin · commit b2a0e08db990 · 2014-05-05T22:31:29.000+07:00
diff --git a/README.md b/README.md
@@ -7,40 +7,44 @@
 [![License](https://poser.pugx.org/phpoffice/phpword/license.png)](https://packagist.org/packages/phpoffice/phpword)
 
 
-PHPWord is a library written in pure PHP that provides a set of classes to write to and read from different document file formats. The current version of PHPWord supports Microsoft [Office Open XML](http://en.wikipedia.org/wiki/Office_Open_XML) (OOXML or OpenXML), OASIS [Open Document Format for Office Applications](http://en.wikipedia.org/wiki/OpenDocument) (OpenDocument or ODF), and [Rich Text Format](http://en.wikipedia.org/wiki/Rich_Text_Format) (RTF).
+PHPWord is a library written in pure PHP that provides a set of classes to write to and read from different document file formats. The current version of PHPWord supports Microsoft [Office Open XML](http://en.wikipedia.org/wiki/Office_Open_XML) (OOXML or OpenXML), OASIS [Open Document Format for Office Applications](http://en.wikipedia.org/wiki/OpenDocument) (OpenDocument or ODF), [Rich Text Format](http://en.wikipedia.org/wiki/Rich_Text_Format) (RTF), HTML, and PDF.
+
+PHPWord is an open source project licensed under the terms of [LGPL version 3](https://github.com/PHPOffice/PHPWord/blob/develop/LICENSE.md). PHPWord is aimed to be a high quality software product by incorporating [continuous integration](https://travis-ci.org/PHPOffice/PHPWord) and [unit testing](http://phpoffice.github.io/PHPWord/coverage/develop/). You can learn more about PHPWord by reading the [Developers' Documentation](http://phpword.readthedocs.org/) and the [API Documentation](http://phpoffice.github.io/PHPWord/docs/develop/).
+
+## Features
 
 With PHPWord, you can create DOCX, ODT, or RTF documents dynamically using your PHP 5.3+ scripts. Below are some of the things that you can do with PHPWord library:
 
-* Set document properties, e.g. title, subject, and creator.
-* Create document sections with different settings, e.g. portrait/landscape, page size, and page numbering
-* Create header and footer for each sections
-* Set default font type, font size, and paragraph style
-* Use UTF-8 and East Asia fonts/characters
-* Define custom font styles (e.g. bold, italic, color) and paragraph styles (e.g. centered, multicolumns, spacing) either as named style or inline in text
-* Insert paragraphs, either as a simple text or complex one (a text run) that contains other elements
-* Insert titles (headers) and table of contents
-* Insert text breaks and page breaks
-* Insert and format images, either local, remote, or as page watermarks
-* Insert binary OLE Objects such as Excel or Visio
-* Insert and format table with customized properties for each rows (e.g. repeat as header row) and cells (e.g. background color, rowspan, colspan)
-* Insert list items as bulleted, numbered, or multilevel
-* Insert hyperlinks
-* Insert footnotes and endnotes
-* Create document from templates
-* Use XSL 1.0 style sheets to transform main document part of OOXML template
-* ... and many more features on progress
-
-__Want to contribute?__ [Fork us](https://github.com/PHPOffice/PHPWord/fork) or [submit](https://github.com/PHPOffice/PHPWord/issues) your bug reports or feature requests to us.
+- Set document properties, e.g. title, subject, and creator.
+- Create document sections with different settings, e.g. portrait/landscape, page size, and page numbering
+- Create header and footer for each sections
+- Set default font type, font size, and paragraph style
+- Use UTF-8 and East Asia fonts/characters
+- Define custom font styles (e.g. bold, italic, color) and paragraph styles (e.g. centered, multicolumns, spacing) either as named style or inline in text
+- Insert paragraphs, either as a simple text or complex one (a text run) that contains other elements
+- Insert titles (headers) and table of contents
+- Insert text breaks and page breaks
+- Insert and format images, either local, remote, or as page watermarks
+- Insert binary OLE Objects such as Excel or Visio
+- Insert and format table with customized properties for each rows (e.g. repeat as header row) and cells (e.g. background color, rowspan, colspan)
+- Insert list items as bulleted, numbered, or multilevel
+- Insert hyperlinks
+- Insert footnotes and endnotes
+- Create document from templates
+- Use XSL 1.0 style sheets to transform main document part of OOXML template
+- ... and many more features on progress
 
 ## Requirements
-* PHP 5.3+
-* PHP [Zip](http://php.net/manual/en/book.zip.php) extension
-* PHP [XML Parser](http://www.php.net/manual/en/xml.installation.php) extension
 
-### Optional PHP extensions
-* PHP [GD](http://php.net/manual/en/book.image.php) extension
-* PHP [XMLWriter](http://php.net/manual/en/book.xmlwriter.php) extension
-* PHP [XSL](http://php.net/manual/en/book.xsl.php) extension
+PHPWord requires the following:
+
+- PHP 5.3+
+- [Zip extension](http://php.net/manual/en/book.zip.php)
+- [XML Parser extension](http://www.php.net/manual/en/xml.installation.php)
+- [GD extension](http://php.net/manual/en/book.image.php) (optional, used to add images)
+- [XMLWriter extension](http://php.net/manual/en/book.xmlwriter.php) (optional, used to write DOCX and ODT)
+- [XSL extension](http://php.net/manual/en/book.xsl.php) (optional, used to apply XSL style sheet to template )
+- [dompdf](https://github.com/dompdf/dompdf) (optional, used to write PDF)
 
 ## Installation
 
@@ -63,7 +67,7 @@ require_once 'path/to/PhpWord/src/PhpWord/Autoloader.php';
 \PhpOffice\PhpWord\Autoloader::register();
 ```
 
-## Basic usage
+## Usages
 
 The following is a basic example of the PHPWord library. More examples are provided in the [samples folder](samples/).
 
@@ -107,6 +111,11 @@ $objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'RTF');
 $objWriter->save('helloWorld.rtf');
 ```
 
-## Documentation
+## Contributing
+
+We welcome everyone to contribute to PHPWord. Below are some of the things that you can do to contribute:
 
-__Want to know more?__ Read the full documentation of PHPWord on [Read The Docs](http://phpword.readthedocs.org/).
+- Read [our contributing guide](https://github.com/PHPOffice/PHPWord/blob/master/CONTRIBUTING.md)
+- [Fork us](https://github.com/PHPOffice/PHPWord/fork) and [request a pull](https://github.com/PHPOffice/PHPWord/pulls) to the [develop](https://github.com/PHPOffice/PHPWord/tree/develop) branch
+- Submit [bug reports or feature requests](https://github.com/PHPOffice/PHPWord/issues) to GitHub
+- Follow [@PHPWord](https://twitter.com/PHPWord) and [@PHPOffice](https://twitter.com/PHPOffice) on Twitter
diff --git a/docs/intro.rst b/docs/intro.rst
@@ -12,18 +12,14 @@ Applications <http://en.wikipedia.org/wiki/OpenDocument>`__
 (OpenDocument or ODF), and `Rich Text
 Format <http://en.wikipedia.org/wiki/Rich_Text_Format>`__ (RTF).
 
-No Windows operating system is needed for usage because the resulting
-DOCX, ODT, or RTF files can be opened by all major `word processing
-softwares <http://en.wikipedia.org/wiki/List_of_word_processors>`__.
-
-PHPWord is an open source project licensed under LGPL version 3. PHPWord is `unit
-tested <https://travis-ci.org/PHPOffice/PHPWord>`__ to make sure that
-the released versions are stable.
-
-**Want to contribute?** `Fork
-us <https://github.com/PHPOffice/PHPWord/fork>`__ or
-`submit <https://github.com/PHPOffice/PHPWord/issues>`__ your bug
-reports or feature requests to us.
+PHPWord is an open source project licensed under the terms of `LGPL
+version 3 <https://github.com/PHPOffice/PHPWord/blob/develop/LICENSE.md>`__.
+PHPWord is aimed to be a high quality software product by incorporating
+`continuous integration <https://travis-ci.org/PHPOffice/PHPWord>`__ and
+`unit testing <http://phpoffice.github.io/PHPWord/coverage/develop/>`__.
+You can learn more about PHPWord by reading this Developers'
+Documentation and the `API
+Documentation <http://phpoffice.github.io/PHPWord/docs/develop/>`__.
 
 Features
 --------
@@ -180,3 +176,20 @@ Readers
 +---------------------------+----------------------+--------+-------+-------+
 |                           | Protection           |        |       |       |
 +---------------------------+----------------------+--------+-------+-------+
+
+Contributing
+------------
+
+We welcome everyone to contribute to PHPWord. Below are some of the
+things that you can do to contribute:
+
+-  Read `our contributing
+   guide <https://github.com/PHPOffice/PHPWord/blob/master/CONTRIBUTING.md>`__
+-  `Fork us <https://github.com/PHPOffice/PHPWord/fork>`__ and `request
+   a pull <https://github.com/PHPOffice/PHPWord/pulls>`__ to the
+   `develop <https://github.com/PHPOffice/PHPWord/tree/develop>`__
+   branch
+-  Submit `bug reports or feature
+   requests <https://github.com/PHPOffice/PHPWord/issues>`__ to GitHub
+-  Follow `@PHPWord <https://twitter.com/PHPWord>`__ and
+   `@PHPOffice <https://twitter.com/PHPOffice>`__ on Twitter
diff --git a/docs/src/documentation.md b/docs/src/documentation.md
@@ -47,11 +47,7 @@ Don't forget to change `code::` directive to `code-block::` in the resulting rst
 
 PHPWord is a library written in pure PHP that provides a set of classes to write to and read from different document file formats. The current version of PHPWord supports Microsoft [Office Open XML](http://en.wikipedia.org/wiki/Office_Open_XML) (OOXML or OpenXML), OASIS [Open Document Format for Office Applications](http://en.wikipedia.org/wiki/OpenDocument) (OpenDocument or ODF), and [Rich Text Format](http://en.wikipedia.org/wiki/Rich_Text_Format) (RTF).
 
-No Windows operating system is needed for usage because the resulting DOCX, ODT, or RTF files can be opened by all major [word processing softwares](http://en.wikipedia.org/wiki/List_of_word_processors).
-
-PHPWord is an open source project licensed under LGPL version 3. PHPWord is [unit tested](https://travis-ci.org/PHPOffice/PHPWord) to make sure that the released versions are stable.
-
-**Want to contribute?** [Fork us](https://github.com/PHPOffice/PHPWord/fork) or [submit](https://github.com/PHPOffice/PHPWord/issues) your bug reports or feature requests to us.
+PHPWord is an open source project licensed under the terms of [LGPL version 3](https://github.com/PHPOffice/PHPWord/blob/develop/LICENSE.md). PHPWord is aimed to be a high quality software product by incorporating [continuous integration](https://travis-ci.org/PHPOffice/PHPWord) and [unit testing](http://phpoffice.github.io/PHPWord/coverage/develop/). You can learn more about PHPWord by reading this Developers' Documentation and the [API Documentation](http://phpoffice.github.io/PHPWord/docs/develop/).
 
 ## Features
 
@@ -142,6 +138,15 @@ Below are the supported features for each file formats.
 | **Bonus**               | Encryption         |      |     |     |
 |                         | Protection         |      |     |     |
 
+## Contributing
+
+We welcome everyone to contribute to PHPWord. Below are some of the things that you can do to contribute:
+
+- Read [our contributing guide](https://github.com/PHPOffice/PHPWord/blob/master/CONTRIBUTING.md)
+- [Fork us](https://github.com/PHPOffice/PHPWord/fork) and [request a pull](https://github.com/PHPOffice/PHPWord/pulls) to the [develop](https://github.com/PHPOffice/PHPWord/tree/develop) branch
+- Submit [bug reports or feature requests](https://github.com/PHPOffice/PHPWord/issues) to GitHub
+- Follow [@PHPWord](https://twitter.com/PHPWord) and [@PHPOffice](https://twitter.com/PHPOffice) on Twitter
+
 # Installing/configuring
 
 ## Requirements
@@ -938,13 +943,18 @@ PHPWord requires PHP 5.3+ since 0.8, while PHPWord 0.6.3 from CodePlex can run w
 
 # References
 
+## ISO/IEC 29500, Third edition, 2012-09-01
+
+-   [Part 1: Fundamentals and Markup Language Reference](http://standards.iso.org/ittf/PubliclyAvailableStandards/c061750_ISO_IEC_29500-1_2012.zip)
+-   [Part 2: Open Packaging Conventions](http://standards.iso.org/ittf/PubliclyAvailableStandards/c061796_ISO_IEC_29500-2_2012.zip)
+-   [Part 3: Markup Compatibility and Extensibility](http://standards.iso.org/ittf/PubliclyAvailableStandards/c061797_ISO_IEC_29500-3_2012.zip)
+-   [Part 4: Transitional Migration Features](http://standards.iso.org/ittf/PubliclyAvailableStandards/c061798_ISO_IEC_29500-4_2012.zip)
+
 ## Formal specifications
 
-- [Office Open XML (OOXML) (ECMA-376) Schema](http://www.schemacentral.com/sc/ooxml/ss.html)
-- [Oasis OpenDocument Standard Version 1.2](http://docs.oasis-open.org/office/v1.2/os/OpenDocument-v1.2-os.html)
-- [Rich Text Format (RTF) Specification, version 1.9.1](http://www.microsoft.com/en-us/download/details.aspx?id=10725)
+-   [Oasis OpenDocument Standard Version 1.2](http://docs.oasis-open.org/office/v1.2/os/OpenDocument-v1.2-os.html)
+-   [Rich Text Format (RTF) Specification, version 1.9.1](http://www.microsoft.com/en-us/download/details.aspx?id=10725)
 
 ## Other resources
 
-- [DocumentFormat.OpenXml.Wordprocessing Namespace on MSDN](http://msdn.microsoft.com/en-us/library/documentformat.openxml.wordprocessing%28v=office.14%29.aspx)
-
+-   [DocumentFormat.OpenXml.Wordprocessing Namespace on MSDN](http://msdn.microsoft.com/en-us/library/documentformat.openxml.wordprocessing%28v=office.14%29.aspx)
