Skip to content

Commit 8a54b22

Browse files
committed
(1) Change CHANGELOG format to simplify release notes creation (2) Add CONTRIBUTING guideline
1 parent dc28fd6 commit 8a54b22

File tree

3 files changed

+118
-87
lines changed

3 files changed

+118
-87
lines changed

CHANGELOG.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Changelog
2+
3+
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.
4+
5+
## 0.9.0 - Not yet released
6+
7+
This release marked the transformation to namespaces (PHP 5.3+).
8+
9+
### Features
10+
11+
None yet
12+
13+
### Bugfixes
14+
15+
- Preserve text doesn't render correctly when the text is not the first word, e.g. 'Page {PAGE}' - @ivanlanin
16+
17+
### Miscellaneous
18+
19+
- Documentation - @Progi1984
20+
21+
## 0.8.1 - 17 Mar 2014
22+
23+
This is a bugfix release for image detection functionality.
24+
25+
- Added fallback for computers that do not have exif_imagetype - @bskrtich, @gabrielbull
26+
27+
## 0.8.0 - 15 Mar 2014
28+
29+
This release merged a lot of improvements from the community. Unit tests introduced in this release and has reached 90% code coverage.
30+
31+
### Features
32+
33+
- Template: Permit to save a template generated as a file (PHPWord_Template::saveAs()) - @RomanSyroeshko GH-56 GH-57
34+
- Word2007: Support sections page numbering - @gabrielbull
35+
- Word2007: Added line height methods to mirror the line height settings in Word in the paragraph styling - @gabrielbull
36+
- Word2007: Added support for page header & page footer height - @JillElaine GH-5
37+
- General: Add ability to manage line breaks after image insertion - @bskrtich GH-6 GH-66 GH-84
38+
- Template: Ability to limit number of replacements performed by setValue() method of Template class - @RomanSyroeshko GH-52 GH-53 GH-85
39+
- Table row: Repeat as header row & allow row to break across pages - @ivanlanin GH-48 GH-86
40+
- Table: Table width in percentage - @ivanlanin GH-48 GH-86
41+
- Font: Superscript and subscript - @ivanlanin GH-48 GH-86
42+
- Paragraph: Hanging paragraph - @ivanlanin GH-48 GH-86
43+
- Section: Multicolumn and section break - @ivanlanin GH-48 GH-86
44+
- Template: Ability to apply XSL style sheet to Template - @RomanSyroeshko GH-46 GH-47 GH-83
45+
- General: PHPWord_Shared_Font::pointSizeToTwips() converter - @ivanlanin GH-87
46+
- Paragraph: Ability to define normal paragraph style with PHPWord::setNormalStyle() - @ivanlanin GH-87
47+
- Paragraph: Ability to define parent style (basedOn) and style for following paragraph (next) - @ivanlanin GH-87
48+
- Clone table rows on the fly when using a template document - @jeroenmoors GH-44 GH-88
49+
- Initial addition of basic footnote support - @deds GH-16
50+
- Paragraph: Ability to define paragraph pagination: widow control, keep next, keep lines, and page break before - @ivanlanin GH-92
51+
- General: PHPWord_Style_Font refactoring - @ivanlanin GH-93
52+
- Font: Use points instead of halfpoints internally. Conversion to halfpoints done during XML Writing. - @ivanlanin GH-93
53+
- Paragraph: setTabs() function - @ivanlanin GH-92
54+
- General: Basic support for TextRun on ODT and RTF - @ivanlanin GH-99
55+
- Reader: Basic Reader for Word2007 - @ivanlanin GH-104
56+
- TextRun: Allow Text Break in Text Run - @bskrtich GH-109
57+
- General: Support for East Asian fontstyle - @jhfangying GH-111 GH-118
58+
- Image: Use exif_imagetype to check image format instead of extension name - @gabrielbull GH-114
59+
- General: Setting for XMLWriter Compatibility option - @bskrtich GH-103
60+
- MemoryImage: Allow remote image when allow_url_open = on - @ivanlanin GH-122
61+
- TextBreak: Allow font and paragraph style for text break - @ivanlanin GH-18
62+
63+
### Bugfixes
64+
65+
- Fixed bug with cell styling - @gabrielbull
66+
- Fixed bug list items inside of cells - @gabrielbull
67+
- Adding a value that contains "&" in a template breaks it - @SiebelsTim GH-51
68+
- Example in README.md is broken - @Progi1984 GH-89
69+
- General: PHPWord_Shared_Drawing::centimetersToPixels() conversion - @ivanlanin GH-94
70+
- Footnote: Corrupt DOCX reported by MS Word when sections > 1 and not every sections have footnote - @ivanlanin GH-125
71+
72+
### Miscellaneous
73+
74+
- UnitTests - @Progi1984
75+
76+
## 0.7.0 - 28 Jan 2014
77+
78+
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.
79+
80+
### Features
81+
82+
- Implement RTF Writer - @Progi1984 GH-1
83+
- Implement ODT Writer - @Progi1984 GH-2
84+
- Word2007: Add rowspan and colspan to cells - @kaystrobach
85+
- Word2007: Support for tab stops - @RLovelett
86+
- Word2007: Support Multiple headers - @RLovelett
87+
- Word2007: Wrapping Styles to Images - @gabrielbull
88+
- Added support for image wrapping style - @gabrielbull
89+
90+
### Bugfixes
91+
92+
- "Warning: Invalid error type specified in ...\PHPWord.php on line 226" is thrown when the specified template file is not found - @RomanSyroeshko GH-32
93+
- PHPWord_Shared_String.IsUTF8 returns FALSE for Cyrillic UTF-8 input - @RomanSyroeshko GH-34
94+
- Temporary files naming logic in PHPWord_Template can lead to a collision - @RomanSyroeshko GH-38
95+
96+
### Miscellaneous
97+
98+
- Add superscript/subscript styling in Excel2007 Writer - @MarkBaker
99+
- add indentation support to paragraphs - @deds
100+
- Support for Composer - @Progi1984 GH-27
101+
- Basic CI with Travis - @Progi1984
102+
- Added PHPWord_Exception and exception when could not copy the template - @Progi1984
103+
- IMPROVED: Moved examples out of Classes directory - @Progi1984
104+
- IMPROVED: Advanced string replace in setValue for Template - @Esmeraldo CP-49

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contributing to PHPWord
2+
3+
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.
4+
5+
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.
6+
7+
- **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.
8+
- **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.
9+
- **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.
10+
- **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.
11+
12+
That's it. Thank you for your interest in PHPWord, and welcome!
13+
14+
May the Force be with you.

changelog.txt

Lines changed: 0 additions & 87 deletions
This file was deleted.

0 commit comments

Comments
 (0)