Merge pull request #1 from PHPOffice/develop

Develop update from upstream

Author: h6w

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-    - 5.3.3
     - 5.3
     - 5.4
     - 5.5
@@ -10,6 +9,7 @@ php:
 
 matrix:
     allow_failures:
+        - php: 5.2
         - php: hhvm
 
 env:

CHANGELOG.md

@@ -25,6 +25,7 @@ This release added form fields (textinput, checkbox, and dropdown), drawing shap
 - Word2007 Writer : Support for RTL - @Progi1984 GH-331
 - MsDOC Reader: Basic MsDOC Reader - @Progi1984 GH-23 GH-287
 - "absolute" horizontal and vertical positioning of Frame - @basjan GH-302
+- Add new-page function for PDF generation. For multiple PDF-backends - @chc88 GH-426
 
 ### Bugfixes
 
@@ -38,6 +39,7 @@ This release added form fields (textinput, checkbox, and dropdown), drawing shap
 - "addShape()" magic method in AbstractContainer is mistakenly named as "addObject()" - @GMTA GH-356
 - `Element\Section::setPageSizeW()` and `Element\Section::setPageSizeH()` were mentioned in the docs but not implemented.
 - Special Characters (ampersand) in Title break docx output - @RomanSyroeshko GH-401
+- `<th>` tag is closed with `</td>` tag: - @franzholz GH-438
 
 ### Deprecated
 

README.md

@@ -85,51 +85,92 @@ require_once 'path/to/PhpWord/src/PhpWord/Autoloader.php';
 The following is a basic usage example of the PHPWord library.
 
 ```php
+<?php
 require_once 'src/PhpWord/Autoloader.php';
 \PhpOffice\PhpWord\Autoloader::register();
 
+// Creating the new document...
 $phpWord = new \PhpOffice\PhpWord\PhpWord();
 
-// Every element you want to append to the word document is placed in a section.
-// To create a basic section:
+/* Note: any element you append to a document must reside inside of a Section. */
+
+// Adding an empty Section to the document...
 $section = $phpWord->addSection();
+// Adding Text element to the Section having font styled by default...
+$section->addText(
+    htmlspecialchars(
+        '"Learn from yesterday, live for today, hope for tomorrow. '
+            . 'The important thing is not to stop questioning." '
+            . '(Albert Einstein)'
+    )
+);
+
+/*
+ * Note: it's possible to customize font style of the Text element you add in three ways:
+ * - inline;
+ * - using named font style (new font style object will be implicitly created);
+ * - using explicitly created font style object.
+ */
+
+// Adding Text element with font customized inline...
+$section->addText(
+    htmlspecialchars(
+        '"Great achievement is usually born of great sacrifice, '
+            . 'and is never the result of selfishness." '
+            . '(Napoleon Hill)'
+    ),
+    array('name' => 'Tahoma', 'size' => 10)
+);
+
+// Adding Text element with font customized using named font style...
+$fontStyleName = 'oneUserDefinedStyle';
+$phpWord->addFontStyle(
+    $fontStyleName,
+    array('name' => 'Tahoma', 'size' => 10, 'color' => '1B2232', 'bold' => true)
+);
+$section->addText(
+    htmlspecialchars(
+        '"The greatest accomplishment is not in never falling, '
+            . 'but in rising again after you fall." '
+            . '(Vince Lombardi)'
+    ),
+    $fontStyleName
+);
 
-// After creating a section, you can append elements:
-$section->addText('Hello world!');
-
-// You can directly style your text by giving the addText function an array:
-$section->addText('Hello world! I am formatted.',
-    array('name'=>'Tahoma', 'size'=>16, 'bold'=>true));
-
-// If you often need the same style again you can create a user defined style
-// to the word document and give the addText function the name of the style:
-$phpWord->addFontStyle('myOwnStyle',
-    array('name'=>'Verdana', 'size'=>14, 'color'=>'1B2232'));
-$section->addText('Hello world! I am formatted by a user defined style',
-    'myOwnStyle');
-
-// You can also put the appended element to local object like this:
-$fontStyle = array(
-    'name' => 'Verdana',
-    'size' => 22,
-    'bold' => true,
+// Adding Text element with font customized using explicitly created font style object...
+$fontStyle = new \PhpOffice\PhpWord\Style\Font();
+$fontStyle->setBold(true);
+$fontStyle->setName('Tahoma');
+$fontStyle->setSize(13);
+$myTextElement = $section->addText(
+    htmlspecialchars('"Believe you can and you\'re halfway there." (Theodor Roosevelt)')
 );
-$myTextElement = $section->addText('Hello World!');
 $myTextElement->setFontStyle($fontStyle);
 
-// Finally, save the document:
-$phpWord->save('helloWorld.docx');
-$phpWord->save('helloWorld.odt', 'ODText');
-$phpWord->save('helloWorld.rtf', 'RTF');
+// Saving the document as OOXML file...
+$objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'Word2007');
+$objWriter->save('helloWorld.docx');
+
+// Saving the document as ODF file...
+$objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'ODText');
+$objWriter->save('helloWorld.odt');
+
+// Saving the document as HTML file...
+$objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'HTML');
+$objWriter->save('helloWorld.html');
+
+/* Note: we skip RTF, because it's not XML-based and requires a different example. */
+/* Note: we skip PDF, because "HTML-to-PDF" approach is used to create PDF documents. */
 ```
+:warning: Escape any string you pass to OOXML/ODF/HTML document, otherwise it may get broken.
 
 More examples are provided in the [samples folder](samples/). You can also read the [Developers' Documentation](http://phpword.readthedocs.org/) and the [API Documentation](http://phpoffice.github.io/PHPWord/docs/master/) for more detail.
 
 ## Contributing
 
-We welcome everyone to contribute to PHPWord. Below are some of the things that you can do to contribute:
+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
+- 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.