Doc: Update manual and changelog

Author: ivanlanin

CHANGELOG.md

@@ -1,60 +1,50 @@
-**************************************************************************************
-* PHPPowerPoint
-*
-* Copyright (c) 2009 - 2010 PHPPowerPoint
-*
-* 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) 2009 - 2010 PHPPowerPoint (http://www.codeplex.com/PHPPowerPoint)
-* @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt	LGPL
-* @version    ##VERSION##, ##DATE##
-**************************************************************************************
-
-
-To be planned:
-- General:  (MB) CP-1165 - Rename PHPPowerpoint.php to PHPPowerPoint.php
-- General:  (MB) CP-5270 - Create build script using Phing
-- Feature:  (MB) CP- 815 - Provide fluent interfaces where possible
-- Feature:  (MB) CP-1034 - Use existing presentation template when writing PPTX file
-- Feature:  (MB) CP-1093 - Implement bullet and numeric lists
-- Feature:  (MB) CP-1173 - getProperties: setCompany feature request
-- Feature:  (MB) CP-1375 - New shape type: table
-- Feature:  (MB) CP-2804 - Use of CDATA text when writing text
-- Feature:  (MB) CP-1378 - Possibility to set borders on tables and table cells
-- Feature:  (MB) CP-4921 - Access to additional properties of Text Boxes
-- Feature:  (MB) CP-7010 - Applied patch 7010
-- Feature:  (MB) CP-7020 - Applied patch 7020
-- Feature:  (MB) CP-1196 - Add a hyperlink to an image or textbox
-- Feature:  (MBaker) Implement autoloader
-- Feature:  (Progi1984) Implement ODP Writer
-- Feature:  (MB) CP-4953 - PowerPoint Charts
-- Feature:  (MB) CP-5580 - Editing chart data
-- Feature:  (MB) CP-5461 - Solid Fill support
-- Feature:  (MB) CP-8375 - Applied patch 8375
-- Feature:  (Progi1984) Implement ODP Writer
-- Bugfix:   (MBaker) Allow solid colour fill
-- Bugfix:   (MB) CP-3910 - Table width setting Office 2007
-- Bugfix:   (MB) CP-4598 - Bullet characters in Master Slide Layouts of template file become corrupted
-- Bugfix:   (MB) CP-3424 - Generated files cannot be opened in Office 08 for Mac OSX
-- Bugfix:   (MB) CP-2541 - Table Cell Borders Not Displaying Correctly
-- Bugfix:   (MB) CP-4597 - Multiple Master Slides are not supported 
-- Bugfix:   (MB) CP-4596 - Images in Layouts other than first Master Slide within Template file causes corrupted PPTX
-- Bugfix :  (delphiki) GH-16 - Fixed A3 and A4 formats dimensions 
-- Bugfix :  (delphiki) GH-18 - Fixed custom document layout
-
-Initial version:
+# Changelog
+
+## 0.2.0 - Not yet released
+
+### Features
+
+- Provide fluent interfaces where possible - @maartenba CP- 815
+- Use existing presentation template when writing PPTX file - @maartenba CP-1034
+- Implement bullet and numeric lists - @maartenba CP-1093
+- getProperties: setCompany feature request - @maartenba CP-1173
+- New shape type: table - @maartenba CP-1375
+- Use of CDATA text when writing text - @maartenba CP-2804
+- Possibility to set borders on tables and table cells - @maartenba CP-1378
+- Access to additional properties of Text Boxes - @maartenba CP-4921
+- Applied patch 7010 - @maartenba CP-7010
+- Applied patch 7020 - @maartenba CP-7020
+- Add a hyperlink to an image or textbox - @maartenba CP-1196
+- PowerPoint Charts - @maartenba CP-4953
+- Editing chart data - @maartenba CP-5580
+- Solid Fill support - @maartenba CP-5461
+- Applied patch 8375 - @maartenba CP-8375
+- Implement autoloader - @MarkBaker
+- Implement ODP Writer - @Progi1984
+
+### Bugfix
+
+- Allow solid colour fill - @MarkBaker
+- Table width setting Office 2007 - @maartenba CP-3910
+- Bullet characters in Master Slide Layouts of template file become corrupted - @maartenba CP-4598
+- Generated files cannot be opened in Office 08 for Mac OSX - @maartenba CP-3424
+- Table Cell Borders Not Displaying Correctly - @maartenba CP-2541
+- Multiple Master Slides are not supported - @maartenba CP-4597
+- Images in Layouts other than first Master Slide within Template file causes corrupted PPTX - @maartenba CP-4596
+- Fixed A3 and A4 formats dimensions - @delphiki GH-16
+- Fixed custom document layout - @delphiki GH-18
+
+### Miscellaneous
+
+- Rename PHPPowerpoint.php to PHPPowerPoint.php - @maartenba CP-1165
+- Create build script using Phing - @maartenba CP-5270
+- QA: Prepare `.travis.yml` and `phpcs.xml` for Travis build passing - @Progi1984 @ivanlanin
+- QA: Initiate unit tests - @Progi1984 @ivanlanin
+- QA: Cleanup source code for PSR dan PHPDoc compatibility - @ivanlanin
+- Doc: Initiate documentation - @ivanlanin
+
+## 0.1.0
+
 - Create a Presentation object
 - Add one or more Slide objects
 - Add one or more Shapes to Slide objects

Documentation/PHPPowerPoint Manual.md renamed to Documentation/PHPPowerPointManual.md

@@ -1,6 +1,33 @@
 # PHPPowerPoint Manual
 
-PHPPowerPoint is a library written in pure PHP that provides a set of classes to write to and read from different presentation file formats, i.e. OpenXML (.pptx) and OpenDocument (.odp). PHPPowerPoint is an open source project licensed under LGPL.
+PHPPowerPoint is a library written in pure PHP that provides a set of classes to write to different presentation file formats, i.e. OpenXML (.pptx) and OpenDocument (.odp). PHPPowerPoint is an open source project licensed under LGPL.
+
+## Contents
+
+- [Overview](#overview)
+    - [Features](#features)
+    - [Requirements](#requirements)
+    - [Installation](#installation)
+- [Objects](#objects)
+    - [Document properties](#document-properties)
+    - [Slides](#slides)
+    - [Shapes](#shapes)
+        - [Rich text](#rich-text)
+        - [Line](#line)
+        - [Chart](#chart)
+        - [Drawing](#drawing)
+        - [Table](#table)
+    - [Styles](#styles)
+        - [Fill](#fill)
+        - [Border](#border)
+        - [Alignment](#alignment)
+        - [Font](#font)
+        - [Bullet](#bullet)
+        - [Color](#color)
+- [Writers](#writers)
+    - [OOXML](#ooxml)
+    - [OpenDocument](#opendocument)
+- [References](#references)
 
 ## Overview
 
@@ -39,7 +66,7 @@ After that, you can use the library by creating a new instance of the class.
 $phpPowerPoint = new PHPPowerPoint();
 ```
 
-## Usages
+## Objects
 
 ### Document properties
 
@@ -75,22 +102,7 @@ $shape = $slide->createRichTextShape();
 
 ### Shapes
 
-Shapes are objects that can be added to a slide. There are five types of shapes that can be used, i.e. rich text, line, chart, drawing, and table.
-
-To create a shape, use the following methods of a slide.
-
-- `createRichTextShape`
-- `createLineShape`
-- `createChartShape`
-- `createDrawingShape`
-- `createTableShape`
-
-Example:
-
-```php
-$richText = $slide->createRichTextShape();
-$line = $slide->createLineShape();
-```
+Shapes are objects that can be added to a slide. There are five types of shapes that can be used, i.e. [rich text](#rich-text), [line](#line), [chart](#chart), [drawing](#drawing), and [table](#table). Read the corresponding section of this manual for detail information of each shape.
 
 Every shapes have common properties that you can set by using fluent interface.
 
@@ -99,9 +111,9 @@ Every shapes have common properties that you can set by using fluent interface.
 - `offsetX` in pixels
 - `offsetY` in pixels
 - `rotation` in degrees
-- `fill`
-- `border`
-- `shadow`
+- `fill` see *[Fill](#fill)*
+- `border` see *[Border](#border)*
+- `shadow` see *[Shadow](#shadow)*
 - `hyperlink`
 
 Example:
@@ -116,7 +128,13 @@ $richtext = $slide->createRichTextShape()
 
 #### Rich text
 
-Rich text shapes contain paragraphs of texts. Below are the properties that you can set for a rich text shape.
+Rich text shapes contain paragraphs of texts. To create a rich text shape, use `createRichTextShape` method of slide.
+
+```php
+$richtext = $slide->createRichTextShape()
+```
+
+Below are the properties that you can set for a rich text shape.
 
 - `wrap`
 - `autoFit`
@@ -140,34 +158,105 @@ $richtext = $slide->createRichTextShape()
 
 Properties that can be set for each paragraphs are as follow.
 
-- `alignment`
-- `font`
-- `bulletStyle`
+- `alignment` see *[Alignment](#alignment)*
+- `font` see *[Font](#font)*
+- `bulletStyle` see *[Bullet](#bullet)*
 
 #### Line
 
+To create a line, use `createLineShape` method of slide.
+
+```php
+$line = $slide->createLineShape($fromX, $fromY, $toX, $toY);
+```
+
 #### Chart
 
+To create a chart, use `createChartShape` method of slide.
+
+```php
+$chart = $slide->createChartShape();
+```
+
 #### Drawing
 
+To create a drawing, use `createDrawingShape` method of slide.
+
+```php
+$drawing = $slide->createDrawingShape();
+$drawing->setName('Unique name')
+    ->setDescription('Description of the drawing')
+    ->setPath('/path/to/drawing.filename');
+```
+
 #### Table
 
+To create a table, use `createTableShape` method of slide.
+
+```php
+$table = $slide->createTableShape($columns);
+```
+
 ### Styles
 
 #### Fill
 
+Use this style to define fill of a shape as example below.
+
+```php
+$shape->getFill()
+    ->setFillType(PHPPowerPoint_Style_Fill::FILL_GRADIENT_LINEAR)
+    ->setRotation(270)
+    ->setStartColor(new PHPPowerPoint_Style_Color('FFCCCCCC'))
+    ->setEndColor(new PHPPowerPoint_Style_Color('FFFFFFFF'));
+```
+
+Properties:
+
 - `fillType`
 - `rotation`
 - `startColor`
 - `endColor`
 
 #### Border
 
+Use this style to define border of a shape as example below.
+
+```php
+$shape->getBorder()
+    ->setLineStyle(PHPPowerPoint_Style_Border::LINE_SINGLE)
+    ->setLineWidth(4)
+    ->getColor()->setARGB('FFC00000');
+```
+
+Properties:
+
 - `lineWidth`
 - `lineStyle`
 - `dashStyle`
 - `color`
 
+#### Shadow
+
+Use this style to define shadow of a shape as example below.
+
+```php
+$shape->getShadow()
+    ->setVisible(true)
+    ->setDirection(45)
+    ->setDistance(10);
+```
+
+Properties:
+
+- `visible`
+- `blurRadius`
+- `distance`
+- `direction`
+- `alignment`
+- `color`
+- `alpha`
+
 #### Alignment
 
 - `horizontal`
@@ -197,3 +286,19 @@ Properties that can be set for each paragraphs are as follow.
 - `bulletNumericStartAt`
 
 #### Color
+
+To be completed.
+
+## Writers
+
+### OOXML
+
+To be completed.
+
+### OpenDocument
+
+To be completed.
+
+## References
+
+To be completed.

README.md

@@ -42,7 +42,7 @@ $phpPowerPoint = new PHPPowerPoint();
 
 ### Want to learn more?
 
-[Read the manual](Documentation/PHPPowerPoint Manual.md).
+[Read the manual](Documentation/PHPPowerPointManual.md).
 
 ### Want to contribute?
 

composer.json

@@ -13,6 +13,10 @@
         {
             "name": "Franck Lefevre",
             "homepage": "http://blog.rootslabs.net"
+        },
+        {
+            "name": "Ivan Lanin",
+            "homepage": "http://ivan.lanin.org"
         }
     ],
     "require": {