diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100755 index 00000000..c8667078 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,104 @@ +# Changelog + +This is the changelog between releases of PHPWord. Releases are listed in reverse chronological order with the latest version are listed on top, while additions/changes in each release are listed in chronological order. Changes in each release are divided into three parts: added or change features, bugfixes, and miscellaneous improvements. Each line contains short information about the change made, the person who made it, and the related issue number(s) in GitHub. + +## 0.9.0 - Not yet released + +This release marked the transformation to namespaces (PHP 5.3+). + +### Features + +None yet + +### Bugfixes + +- Preserve text doesn't render correctly when the text is not the first word, e.g. 'Page {PAGE}' - @ivanlanin + +### Miscellaneous + +- Documentation - @Progi1984 + +## 0.8.1 - 17 Mar 2014 + +This is a bugfix release for image detection functionality. + +- Added fallback for computers that do not have exif_imagetype - @bskrtich, @gabrielbull + +## 0.8.0 - 15 Mar 2014 + +This release merged a lot of improvements from the community. Unit tests introduced in this release and has reached 90% code coverage. + +### Features + +- Template: Permit to save a template generated as a file (PHPWord_Template::saveAs()) - @RomanSyroeshko GH-56 GH-57 +- Word2007: Support sections page numbering - @gabrielbull +- Word2007: Added line height methods to mirror the line height settings in Word in the paragraph styling - @gabrielbull +- Word2007: Added support for page header & page footer height - @JillElaine GH-5 +- General: Add ability to manage line breaks after image insertion - @bskrtich GH-6 GH-66 GH-84 +- Template: Ability to limit number of replacements performed by setValue() method of Template class - @RomanSyroeshko GH-52 GH-53 GH-85 +- Table row: Repeat as header row & allow row to break across pages - @ivanlanin GH-48 GH-86 +- Table: Table width in percentage - @ivanlanin GH-48 GH-86 +- Font: Superscript and subscript - @ivanlanin GH-48 GH-86 +- Paragraph: Hanging paragraph - @ivanlanin GH-48 GH-86 +- Section: Multicolumn and section break - @ivanlanin GH-48 GH-86 +- Template: Ability to apply XSL style sheet to Template - @RomanSyroeshko GH-46 GH-47 GH-83 +- General: PHPWord_Shared_Font::pointSizeToTwips() converter - @ivanlanin GH-87 +- Paragraph: Ability to define normal paragraph style with PHPWord::setNormalStyle() - @ivanlanin GH-87 +- Paragraph: Ability to define parent style (basedOn) and style for following paragraph (next) - @ivanlanin GH-87 +- Clone table rows on the fly when using a template document - @jeroenmoors GH-44 GH-88 +- Initial addition of basic footnote support - @deds GH-16 +- Paragraph: Ability to define paragraph pagination: widow control, keep next, keep lines, and page break before - @ivanlanin GH-92 +- General: PHPWord_Style_Font refactoring - @ivanlanin GH-93 +- Font: Use points instead of halfpoints internally. Conversion to halfpoints done during XML Writing. - @ivanlanin GH-93 +- Paragraph: setTabs() function - @ivanlanin GH-92 +- General: Basic support for TextRun on ODT and RTF - @ivanlanin GH-99 +- Reader: Basic Reader for Word2007 - @ivanlanin GH-104 +- TextRun: Allow Text Break in Text Run - @bskrtich GH-109 +- General: Support for East Asian fontstyle - @jhfangying GH-111 GH-118 +- Image: Use exif_imagetype to check image format instead of extension name - @gabrielbull GH-114 +- General: Setting for XMLWriter Compatibility option - @bskrtich GH-103 +- MemoryImage: Allow remote image when allow_url_open = on - @ivanlanin GH-122 +- TextBreak: Allow font and paragraph style for text break - @ivanlanin GH-18 + +### Bugfixes + +- Fixed bug with cell styling - @gabrielbull +- Fixed bug list items inside of cells - @gabrielbull +- Adding a value that contains "&" in a template breaks it - @SiebelsTim GH-51 +- Example in README.md is broken - @Progi1984 GH-89 +- General: PHPWord_Shared_Drawing::centimetersToPixels() conversion - @ivanlanin GH-94 +- Footnote: Corrupt DOCX reported by MS Word when sections > 1 and not every sections have footnote - @ivanlanin GH-125 + +### Miscellaneous + +- UnitTests - @Progi1984 + +## 0.7.0 - 28 Jan 2014 + +This is the first release after a long development hiatus in [CodePlex](https://phpword.codeplex.com/). This release initialized ODT and RTF Writer, along with some other new features for the existing Word2007 Writer, e.g. tab, multiple header, rowspan and colspan. [Composer](https://packagist.org/packages/phpoffice/phpword) and [Travis](https://travis-ci.org/PHPOffice/PHPWord) were added. + +### Features + +- Implement RTF Writer - @Progi1984 GH-1 +- Implement ODT Writer - @Progi1984 GH-2 +- Word2007: Add rowspan and colspan to cells - @kaystrobach +- Word2007: Support for tab stops - @RLovelett +- Word2007: Support Multiple headers - @RLovelett +- Word2007: Wrapping Styles to Images - @gabrielbull +- Added support for image wrapping style - @gabrielbull + +### Bugfixes + +- "Warning: Invalid error type specified in ...\PHPWord.php on line 226" is thrown when the specified template file is not found - @RomanSyroeshko GH-32 +- PHPWord_Shared_String.IsUTF8 returns FALSE for Cyrillic UTF-8 input - @RomanSyroeshko GH-34 +- Temporary files naming logic in PHPWord_Template can lead to a collision - @RomanSyroeshko GH-38 + +### Miscellaneous + +- Add superscript/subscript styling in Excel2007 Writer - @MarkBaker +- add indentation support to paragraphs - @deds +- Support for Composer - @Progi1984 GH-27 +- Basic CI with Travis - @Progi1984 +- Added PHPWord_Exception and exception when could not copy the template - @Progi1984 +- IMPROVED: Moved examples out of Classes directory - @Progi1984 +- IMPROVED: Advanced string replace in setValue for Template - @Esmeraldo CP-49 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..34985610 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing to PHPWord + +PHPWord is build by the crowd and for the crowd. Every contributions are welcomed; either by [submitting](https://github.com/PHPOffice/PHPWord/issues) bug issues or suggesting improvements, or in a more active form like [requesting](https://github.com/PHPOffice/PHPWord/pulls) a pull. + +We want to create a high quality document writer and reader library that people can use with more confidence and less bugs. We want to collaborate happily, code joyfully, and get a life merrily. Thus, below are some guidelines that we expect to be followed by each contributor. + +- **Be brief, but be bold**: State your issues briefly, but speak out your ideas loudly, even if you can't or don't know how to implement it right away. The world will be better with limitless innovations. +- **Code in PSR**: We use PHP Standards Recommendation (PSR) from as the PHP Framework Interoperability Group (PHP-FIG). If you're not familiar with this standard, please [familiarize yourself now](https://github.com/php-fig/fig-standards). Use [PHPCodeSniffer](http://pear.php.net/package/PHP_CodeSniffer/) to check your code against this standard. +- **Test your code**: Nobody else knows your code better than you. So, please, test your own code before submitting your pull request. PHPWord uses [PHPUnit](http://phpunit.de/) as our testing framework. +- **Request pull in separate branch**: Do not submit your request to the master branch, but create a separate branch named specifically for the issue that you addressed. Read [GitHub manual](https://help.github.com/articles/using-pull-requests) to find out more about this. If you are new to GitHub, read [this short manual](https://help.github.com/articles/fork-a-repo) to get you familiar with forks and how git works in general. + +That's it. Thank you for your interest in PHPWord, and welcome! + +May the Force be with you. \ No newline at end of file diff --git a/changelog.txt b/changelog.txt deleted file mode 100755 index ef1f2227..00000000 --- a/changelog.txt +++ /dev/null @@ -1,87 +0,0 @@ -************************************************************************************** -* PHPWord -* -* Copyright (c) 2011 - 2014 PHPWord -* -* This library is free software; you can redistribute it and/or -* modify it under the terms of the GNU Lesser General Public -* License as published by the Free Software Foundation; either -* version 2.1 of the License, or (at your option) any later version. -* -* This library is distributed in the hope that it will be useful, -* but WITHOUT ANY WARRANTY; without even the implied warranty of -* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -* Lesser General Public License for more details. -* -* You should have received a copy of the GNU Lesser General Public -* License along with this library; if not, write to the Free Software -* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -* -* @copyright Copyright (c) 2011 - 2014 PHPWord (https://github.com/PHPOffice/PHPWord/) -* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL -* @version ##VERSION##, ##DATE## -************************************************************************************** - -Changes in branch for release 0.9.0 : -- Bugfix: (ivanlanin) - Preserve text doesn't render correctly when the text is not the first word, e.g. 'Page {PAGE}' -- QA: (Progi1984) - Documentation - -Changes in branch for release 0.8.1 : -- Feature: (bskrtich, gabrielbull) - Added fallback for computers that do not have exif_imagetype - -Changes in branch for release 0.8.0 : -- Bugfix: (gabrielbull) - Fixed bug with cell styling -- Bugfix: (gabrielbull) - Fixed bug list items inside of cells -- Bugfix: (SiebelsTim) GH-51 - Adding a value that contains "&" in a template breaks it -- Bugfix: (Progi1984) GH-89 - Example in README.md is broken -- Feature: (RomanSyroeshko) GH-56 GH-57 - Template : Permit to save a template generated as a file (PHPWord_Template::saveAs()) -- Feature: (gabrielbull) - Word2007 : Support sections page numbering -- Feature: (gabrielbull) - Word2007 : Added line height methods to mirror the line height settings in Word in the paragraph styling -- Feature: (JillElaine) GH-5 - Word2007 : Added support for page header & page footer height -- Feature: (bskrtich) GH-6 GH-66 GH-84 - General : Add ability to manage line breaks after image insertion -- Feature: (RomanSyroeshko) GH-52 GH-53 GH-85 - Template : Ability to limit number of replacements performed by setValue() method of Template class -- Feature: (ivanlanin) GH-48 GH-86 - Table row: Repeat as header row & allow row to break across pages -- Feature: (ivanlanin) GH-48 GH-86 - Table: Table width in percentage -- Feature: (ivanlanin) GH-48 GH-86 - Font: Superscript and subscript -- Feature: (ivanlanin) GH-48 GH-86 - Paragraph: Hanging paragraph -- Feature: (ivanlanin) GH-48 GH-86 - Section: Multicolumn and section break -- Feature: (RomanSyroeshko) GH-46 GH-47 GH-83 - Template : Ability to apply XSL style sheet to Template -- Feature: (ivanlanin) GH-87 - General: PHPWord_Shared_Font::pointSizeToTwips() converter -- Feature: (ivanlanin) GH-87 - Paragraph: Ability to define normal paragraph style with PHPWord::setNormalStyle() -- Feature: (ivanlanin) GH-87 - Paragraph: Ability to define parent style (basedOn) and style for following paragraph (next) -- Feature: (jeroenmoors) GH-44 GH-88 - Clone table rows on the fly when using a template document -- Feature: (deds) GH-16 - Initial addition of basic footnote support -- Feature: (ivanlanin) GH-92 - Paragraph: Ability to define paragraph pagination: widow control, keep next, keep lines, and page break before -- General: (ivanlanin) GH-93 - General: PHPWord_Style_Font refactoring -- General: (ivanlanin) GH-93 - Font: Use points instead of halfpoints internally. Conversion to halfpoints done during XML Writing. -- Bugfix: (ivanlanin) GH-94 - General: PHPWord_Shared_Drawing::centimetersToPixels() conversion -- Feature: (ivanlanin) GH-92 - Paragraph: setTabs() function -- Feature: (ivanlanin) GH-99 - General: Basic support for TextRun on ODT and RTF -- Feature: (ivanlanin) GH-104 - Reader: Basic Reader for Word2007 -- Feature: (bskrtich ) GH-109 - TextRun: Allow Text Break in Text Run -- Feature: (jhfangying) GH-111 GH-118 - General: Support for East Asian fontstyle -- Feature: (gabrielbull) GH-114 - Image: Use exif_imagetype to check image format instead of extension name -- Feature: (bskrtich ) GH-103 - General: Setting for XMLWriter Compatibility option -- Feature: (ivanlanin) GH-122 - MemoryImage: Allow remote image when allow_url_open = on -- Bugfix: (ivanlanin) GH-125 - Footnote: Corrupt DOCX reported by MS Word when sections > 1 and not every sections have footnote -- Feature: (ivanlanin) GH-18 - TextBreak: Allow font and paragraph style for text break -- QA: (Progi1984) - UnitTests - -Changes in branch for release 0.7.0 : -- Bugfix: (RomanSyroeshko) GH-32 - "Warning: Invalid error type specified in ...\PHPWord.php on line 226" is thrown when the specified template file is not found -- Bugfix: (RomanSyroeshko) GH-34 - PHPWord_Shared_String.IsUTF8 returns FALSE for Cyrillic UTF-8 input -- Bugfix: (RomanSyroeshko) GH-38 - Temporary files naming logic in PHPWord_Template can lead to a collision -- Feature: (Progi1984) GH-1 - Implement RTF Writer -- Feature: (Progi1984) GH-2 - Implement ODT Writer -- Feature: (kaystrobach) - Word2007 : Add rowspan and colspan to cells -- Feature: (RLovelett) - Word2007 : Support for tab stops -- Feature: (RLovelett) - Word2007 : Support Multiple headers -- Feature: (gabrielbull) - Word2007 : Wrapping Styles to Images -- General: (MarkBaker) - Add superscript/subscript styling in Excel2007 Writer -- General: (deds) - add indentation support to paragraphs -- General: (Progi1984) GH-27 - Support for Composer -- General: (Progi1984) - Basic CI with Travis -- General: (Progi1984) - Added PHPWord_Exception and exception when could not copy the template -- General: (Progi1984) - IMPROVED : Moved examples out of Classes directory -- General: (Esmeraldo) CP-49 - IMPROVED : Advanced string replace in setValue for Template -- Feature: (gabrielbull) - Added support for image wrapping style