diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000000..433a62077a --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,51 @@ +name: Deploy + +on: + push: + branches: + - develop + pull_request: + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + ### MkDocs + - name: Setup Python + uses: actions/setup-python@v2 + with: + python-version: 3.x + - name: Install Python Dependencies + run: pip install mkdocs-material autolink-references-mkdocs-plugin + - name: Build documentation + run: mkdocs build --site-dir public + ### PHPUnit + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: 8.1 + extensions: ctype, dom, gd, iconv, fileinfo, libxml, mbstring, simplexml, xml, xmlreader, xmlwriter, zip, zlib + coverage: xdebug + - name: Create directory public/coverage + run: mkdir ./public/coverage + - name: Install PHP Dependencies + run: composer install --ansi --prefer-dist --no-interaction --no-progress + - name: Build Coverage Report + run: XDEBUG_MODE=coverage ./vendor/bin/phpunit -c ./ --coverage-text --coverage-html ./public/coverage + ### PHPDoc + - name: Create directory public/docs + run: mkdir ./public/docs + - name: Install PhpDocumentor + run: wget https://phpdoc.org/phpDocumentor.phar && chmod +x phpDocumentor.phar + - name: Build Documentation + run: ./phpDocumentor.phar run -d ./src -t ./public/docs + + ### Deploy + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: github.ref == 'refs/heads/develop' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./public diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml deleted file mode 100644 index aa35f57f87..0000000000 --- a/.github/workflows/github-pages.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: GithHub Pages -on: - push: - tags: - - '*' - -jobs: - github-pages: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v3 - - - name: Setup PHP, with composer and extensions - uses: shivammathur/setup-php@v2 - with: - php-version: 7.4 - coverage: none # remove xdebug - - - name: Build API documentation - run: | - curl -LO https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.0.0/phpDocumentor.phar - php phpDocumentor.phar --directory src/ --target docs/api - - - name: Deploy to GithHub Pages - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs/api diff --git a/.github/workflows/ci.yml b/.github/workflows/php.yml similarity index 100% rename from .github/workflows/ci.yml rename to .github/workflows/php.yml diff --git a/.gitignore b/.gitignore index 7e80be0d15..3695438057 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,4 @@ phpword.ini /nbproject /.php_cs.cache /.phpunit.result.cache +/public \ No newline at end of file diff --git a/.scrutinizer.yml b/.scrutinizer.yml deleted file mode 100644 index d1fe59618d..0000000000 --- a/.scrutinizer.yml +++ /dev/null @@ -1,35 +0,0 @@ -build: - nodes: - analysis: - tests: - override: [php-scrutinizer-run] - environment: - php: - version: '7.4' - pecl_extensions: - - zip - -filter: - excluded_paths: [ 'vendor/*', 'tests/*', 'samples/*', 'src/PhpWord/Shared/PCLZip/*' ] - -before_commands: - - "composer install --prefer-source --dev" - -tools: - php_code_sniffer: - enabled: true - config: - standard: PSR2 - php_mess_detector: - enabled: true - config: - ruleset: phpmd.xml.dist - external_code_coverage: - enabled: false - timeout: 1200 - php_cpd: true - # php_sim: # Temporarily disabled to allow focus on things other than duplicates - # min_mass: 40 - php_pdepend: true - php_analyzer: true - sensiolabs_security_checker: true diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 1abf460f68..0000000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,796 +0,0 @@ -# Changelog -All notable changes to this project will be documented in this file. -This project adheres to [Semantic Versioning](http://semver.org/). - -## [1.2.0](https://github.com/PHPOffice/PHPWord/tree/1.2.0) (WIP) - -[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.1.0...1.2.0) - -## Enhancements - -- Word2007 Reader/Writer : Added noWrap table cell property by @kernusr in #2359 -- HTML Reader : Support for `font-variant: small-caps` by @cambraca in #2117 -- Improved TextDirection for styling a cell by @terryzwt in #2429 -- Word2007 Reader : Added option to disable loading images by @aelliott1485 in #2450 -- HTML Writer : Added border-spacing to default styles for table by @kernusr in #2451 -- Word2007 Reader : Support for table cell borders and margins by @kernusr in #2454 - -### Bug fixes - -- Fixed wrong mimetype for docx files by @gamerlv in #2416 -- Word2007 Reader : Read hyperlingks in headings by @hannesdorn in #2433 -- PclZip : strtr using empty string by @spl1nes in #2432 -- Fixed PHP 8.2 deprecated about Allow access to an undefined property by @DAdq26 in #2440 -- Template Processor : Fixed choose dimention for Float Value by @gdevilbat in #2449 -- HTML Parser : Fix image parsing from url without extension by @JokubasR in #2459 - -### Miscellaneous - -- Added PHPStan by @PowerKiKi in #2405 -- Bump symfony/process from 4.4.44 to 5.4.26 by @dependabot in #2431 -- Bump phpunit/phpunit from 9.6.8 to 9.6.10 by @dependabot in #2430 -- Added Coveralls.io by @Progi1984 in #2452 -- Added support for PHP 8.2 & PHP 8.3 by @Progi1984 in #2453 - -## [1.1.0](https://github.com/PHPOffice/PHPWord/tree/1.1.0) (2023-05-30) - -[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.0.0...1.1.0) - -### Enhancements - -- Introduce deleteRow() method for TemplateProcessor -- HTML Reader: Add basic support for CSS Style Tag -- Allow customizing macro syntax in TemplateProcessor -- Add background color support for textboxes -- Add softhyphen support to word reader -- Add support table row height when importing HTML -- Add support for fractional font sizes -- Added image quality support, with the maximum quality as default -- Support for reading nested tables - -### Bug fixes - -- DOCX reader: Read empty vmerge -- Fixed setting width of Cell Style - -### Miscellaneous - -- `master` is the new default branch - -## [1.0.0](https://github.com/PHPOffice/PHPWord/tree/1.0.0) (2022-11-15) - -[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.3...1.0.0) - -### BREAKING CHANGE - -Most deprecated things were dropped. See details in -https://github.com/PHPOffice/PHPWord/commit/b9f1151bc6f90c276153c3c9dca10a5fc7f355fb. - -#### Dropped classes: - -- `PhpOffice\PhpWord\Template` - -#### Dropped constants: - -- `PhpOffice\PhpWord\Style\Font::UNDERLINE_DOTHASH` -- `PhpOffice\PhpWord\Style\Font::UNDERLINE_DOTHASHHEAVY` -- `PhpOffice\PhpWord\Style\Cell::VALIGN_TOP` -- `PhpOffice\PhpWord\Style\Cell::VALIGN_CENTER` -- `PhpOffice\PhpWord\Style\Cell::VALIGN_BOTTOM` -- `PhpOffice\PhpWord\Style\Cell::VALIGN_BOTH` -- `PhpOffice\PhpWord\Style\TOC::TABLEADER_DOT` -- `PhpOffice\PhpWord\Style\TOC::TABLEADER_UNDERSCORE` -- `PhpOffice\PhpWord\Style\TOC::TABLEADER_LINE` -- `PhpOffice\PhpWord\Style\TOC::TABLEADER_NONE` -- `PhpOffice\PhpWord\Style\Table::WIDTH_AUTO` -- `PhpOffice\PhpWord\Style\Table::WIDTH_PERCENT` -- `PhpOffice\PhpWord\Style\Table::WIDTH_TWIP` -- `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_NAME` -- `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_SIZE` -- `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_COLOR` -- `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_CONTENT_TYPE` -- -#### Dropped methods: - -- `PhpOffice\PhpWord\Ekement\AbstractContainer::createTextRun()` -- `PhpOffice\PhpWord\Ekement\AbstractContainer::createFootnote()` -- `PhpOffice\PhpWord\Ekement\Footnote::getReferenceId()` -- `PhpOffice\PhpWord\Ekement\Footnote::setReferenceId()` -- `PhpOffice\PhpWord\Ekement\Image::getIsWatermark()` -- `PhpOffice\PhpWord\Ekement\Image::getIsMemImage()` -- `PhpOffice\PhpWord\Ekement\Link::getTarget()` -- `PhpOffice\PhpWord\Ekement\Link::getLinkSrc()` -- `PhpOffice\PhpWord\Ekement\Link::getLinkName()` -- `PhpOffice\PhpWord\Ekement\OLEObject::getObjectId()` -- `PhpOffice\PhpWord\Ekement\OLEObject::setObjectId()` -- `PhpOffice\PhpWord\Ekement\Section::getFootnotePropoperties()` -- `PhpOffice\PhpWord\Ekement\Section::setSettings()` -- `PhpOffice\PhpWord\Ekement\Section::getSettings()` -- `PhpOffice\PhpWord\Ekement\Section::createHeader()` -- `PhpOffice\PhpWord\Ekement\Section::createFooter()` -- `PhpOffice\PhpWord\Ekement\Section::getFooter()` -- `PhpOffice\PhpWord\Media::addSectionMediaElement()` -- `PhpOffice\PhpWord\Media::addSectionLinkElement()` -- `PhpOffice\PhpWord\Media::getSectionMediaElements()` -- `PhpOffice\PhpWord\Media::countSectionMediaElements()` -- `PhpOffice\PhpWord\Media::addHeaderMediaElement()` -- `PhpOffice\PhpWord\Media::countHeaderMediaElements()` -- `PhpOffice\PhpWord\Media::getHeaderMediaElements()` -- `PhpOffice\PhpWord\Media::addFooterMediaElement()` -- `PhpOffice\PhpWord\Media::countFooterMediaElements()` -- `PhpOffice\PhpWord\Media::getFooterMediaElements()` -- `PhpOffice\PhpWord\PhpWord::getProtection()` -- `PhpOffice\PhpWord\PhpWord::loadTemplate()` -- `PhpOffice\PhpWord\PhpWord::createSection()` -- `PhpOffice\PhpWord\PhpWord::getDocumentProperties()` -- `PhpOffice\PhpWord\PhpWord::setDocumentProperties()` -- `PhpOffice\PhpWord\Reader\AbstractReader::getReadDataOnly()` -- `PhpOffice\PhpWord\Settings::getCompatibility()` -- `PhpOffice\PhpWord\Style\AbstractStyle::setArrayStyle()` -- `PhpOffice\PhpWord\Style\Cell::getDefaultBorderColor()` -- `PhpOffice\PhpWord\Style\Font::getBold()` -- `PhpOffice\PhpWord\Style\Font::getItalic()` -- `PhpOffice\PhpWord\Style\Font::getSuperScript()` -- `PhpOffice\PhpWord\Style\Font::getSubScript()` -- `PhpOffice\PhpWord\Style\Font::getStrikethrough()` -- `PhpOffice\PhpWord\Style\Font::getParagraphStyle()` -- `PhpOffice\PhpWord\Style\Frame::getAlign()` -- `PhpOffice\PhpWord\Style\Frame::setAlign()` -- `PhpOffice\PhpWord\Style\NumberingLevel::getAlign()` -- `PhpOffice\PhpWord\Style\NumberingLevel::setAlign()` -- `PhpOffice\PhpWord\Style\Paragraph::getAlign()` -- `PhpOffice\PhpWord\Style\Paragraph::setAlign()` -- `PhpOffice\PhpWord\Style\Paragraph::getWidowControl()` -- `PhpOffice\PhpWord\Style\Paragraph::getKeepNext()` -- `PhpOffice\PhpWord\Style\Paragraph::getKeepLines()` -- `PhpOffice\PhpWord\Style\Paragraph::getPageBreakBefore()` -- `PhpOffice\PhpWord\Style\Row::getTblHeader()` -- `PhpOffice\PhpWord\Style\Row::isTblHeader()` -- `PhpOffice\PhpWord\Style\Row::getCantSplit()` -- `PhpOffice\PhpWord\Style\Row::getExactHeight()` -- `PhpOffice\PhpWord\Style\Spacing::getRule()` -- `PhpOffice\PhpWord\Style\Spacing::setRule()` -- `PhpOffice\PhpWord\Style\Table::getAlign()` -- `PhpOffice\PhpWord\Style\Table::setAlign()` -- `PhpOffice\PhpWord\Writer\AbstractWriter::getUseDiskCaching()` -- `PhpOffice\PhpWord\Writer\HTML::writeDocument()` - -### Bug fixes - -- Multiple PHP 8.1 fixes -- `loadConfig` returns config that was actually applied -- HTML Reader : Override inline style on HTML attribute for table -- HTML Reader : Use `border` attribute for tables -- HTML Reader : Style page-break-after in paragraph -- HTML Reader : Heading in Text Run is not allowed -- -### Miscellaneous - -- Drop support for PHP 7.0 and older - -## [0.18.3](https://github.com/PHPOffice/PHPWord/tree/0.18.3) (2022-02-17) - -[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.2...0.18.3) - -### Bug fixes -- PHP 8.1 compatibility - -## [0.18.2](https://github.com/PHPOffice/PHPWord/tree/0.18.2) (2021-06-04) - -[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.1...0.18.2) - -### Bug fixes -- when adding image to relationship first check that the generated RID is actually unique [\#2063](https://github.com/PHPOffice/PHPWord/pull/2063) ([tpv-ebben](https://github.com/tpv-ebben)) -- Update chart, don't write 'c:overlap' if grouping is 'clustered' [\#2052](https://github.com/PHPOffice/PHPWord/pull/2052) ([dfsd534](https://github.com/dfsd534)) -- Update Html parser to accept line-height:normal [\#2041](https://github.com/PHPOffice/PHPWord/pull/2041) ([joelgo](https://github.com/joelgo)) -- Fix image border in Word2007 Writer for LibreOffice 7 [\#2021](https://github.com/PHPOffice/PHPWord/pull/2021) ([kamilmmach](https://github.com/kamilmmach)) - -### Miscellaneous -- Corrected namespace for Language class in docs. [\#2087](https://github.com/PHPOffice/PHPWord/pull/2087) ([MegaChriz](https://github.com/MegaChriz)) -- Added support for Garamond font [\#2078](https://github.com/PHPOffice/PHPWord/pull/2078) ([artemkolotilkin](https://github.com/artemkolotilkin)) -- Add BorderStyle for Cell Style to documentation [\#2090](https://github.com/PHPOffice/PHPWord/pull/2090) ([DShkrabak](https://github.com/DShkrabak)) - -## [0.18.1](https://github.com/PHPOffice/PHPWord/tree/0.18.1) (2021-03-08) - -[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.0...0.18.1) - -### Bug fixes -- Fix BC break in #1946. This package does not replace laminas/laminas-zendframework-bridge [\#2032](https://github.com/PHPOffice/PHPWord/pull/2032) ([mussbach](https://github.com/mussbach)) - -## [0.18.0](https://github.com/PHPOffice/PHPWord/tree/0.18.0) (2021-02-12) - -[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.17.0...0.18.0) - -### Enhancements -- Add support for charts in template processor [\#2012](https://github.com/PHPOffice/PHPWord/pull/2012) ([dbarzin](https://github.com/dbarzin)) -- add/setting page element border style. [\#1986](https://github.com/PHPOffice/PHPWord/pull/1986) ([emnabs](https://github.com/emnabs)) -- allow to use customized pdf library [\#1983](https://github.com/PHPOffice/PHPWord/pull/1983) ([SailorMax](https://github.com/SailorMax)) -- feat: Update addHtml to handle style inheritance [\#1965](https://github.com/PHPOffice/PHPWord/pull/1965) ([Julien1138](https://github.com/Julien1138)) -- Add parsing of Shape node values [\#1924](https://github.com/PHPOffice/PHPWord/pull/1924) ([sven-ahrens](https://github.com/sven-ahrens)) -- Allow to redefine TCPDF object [\#1907](https://github.com/PHPOffice/PHPWord/pull/1907) ([SailorMax](https://github.com/SailorMax)) -- Enhancements to addHTML parser [\#1902](https://github.com/PHPOffice/PHPWord/pull/1902) ([lubosdz](https://github.com/lubosdz)) -- Make Default Paper Configurable [\#1851](https://github.com/PHPOffice/PHPWord/pull/1851) ([oleibman](https://github.com/oleibman)) -- Implement various missing features for the ODT writer [\#1796](https://github.com/PHPOffice/PHPWord/pull/1796) ([oleibman](https://github.com/oleibman)) -- Added support for "cloudConvert" images [\#1794](https://github.com/PHPOffice/PHPWord/pull/1794) ([ErnestStaug](https://github.com/ErnestStaug)) -- Add support for several features for the RTF writer [\#1775](https://github.com/PHPOffice/PHPWord/pull/1775) ([oleibman](https://github.com/oleibman)) -- Add font style for Field elements [\#1774](https://github.com/PHPOffice/PHPWord/pull/1774) ([oleibman](https://github.com/oleibman)) -- Add support for ListItemRun in HTML writer [\#1766](https://github.com/PHPOffice/PHPWord/pull/1766) ([stefan-91](https://github.com/stefan-91)) -- Improvements in RTF writer [\#1755](https://github.com/PHPOffice/PHPWord/pull/1755) ([oleibman](https://github.com/oleibman)) -- Allow a closure to be passed with image replacement tags [\#1716](https://github.com/PHPOffice/PHPWord/pull/1716) ([mbardelmeijer](https://github.com/mbardelmeijer)) -- Add Option for Dynamic Chart Legend Position [\#1699](https://github.com/PHPOffice/PHPWord/pull/1699) ([Stephan212](https://github.com/Stephan212)) -- Add parsing of HTML checkbox input field [\#1832](https://github.com/PHPOffice/PHPWord/pull/1832) ([Matze2010](https://github.com/Matze2010)) - -### Bug fixes -- Fix image stroke in libreoffice 7.x [\#1992](https://github.com/PHPOffice/PHPWord/pull/1992) ([Adizbek](https://github.com/Adizbek)) -- Fix deprecated warning for non-hexadecimal number [\#1988](https://github.com/PHPOffice/PHPWord/pull/1988) ([Ciki](https://github.com/Ciki)) -- Fix limit not taken into account when adding image in template [\#1967](https://github.com/PHPOffice/PHPWord/pull/1967) ([jsochor](https://github.com/jsochor)) -- Add null check when setComplexValue is not found [\#1936](https://github.com/PHPOffice/PHPWord/pull/1936) ([YannikFirre](https://github.com/YannikFirre)) -- Some document have non-standard locale code [\#1824](https://github.com/PHPOffice/PHPWord/pull/1824) ([ErnestStaug](https://github.com/ErnestStaug)) -- Fixes PHPDoc @param and @return types for several Converter methods [\#1818](https://github.com/PHPOffice/PHPWord/pull/1818) ([caugner](https://github.com/caugner)) -- Update the regexp to avoid catastrophic backtracking [\#1809](https://github.com/PHPOffice/PHPWord/pull/1809) ([juzser](https://github.com/juzser)) -- Fix PHPUnit tests on develop branch [\#1771](https://github.com/PHPOffice/PHPWord/pull/1771) ([mdupont](https://github.com/mdupont)) -- TemplateProcessor cloneBlock wrongly clones images [\#1763](https://github.com/PHPOffice/PHPWord/pull/1763) ([alarai](https://github.com/alarai)) - -### Miscellaneous -- Compatibility with PHP 7.4, PHP 8.0 and migrate to Laminas Escaper [\#1946](https://github.com/PHPOffice/PHPWord/pull/1946) ([liborm85](https://github.com/liborm85)) -- Remove legacy PHPOffice/Common package, fix PHP 8.0 compatibility [\#1996](https://github.com/PHPOffice/PHPWord/pull/1996) ([liborm85](https://github.com/liborm85)) -- Improve Word2007 Test Coverage [\#1858](https://github.com/PHPOffice/PHPWord/pull/1858) ([oleibman](https://github.com/oleibman)) -- Fix typo in docs. Update templates-processing.rst [\#1952](https://github.com/PHPOffice/PHPWord/pull/1952) ([mnvx](https://github.com/mnvx)) -- Fix documentation and method name for FootnoteProperties [\#1776](https://github.com/PHPOffice/PHPWord/pull/1776) ([mdupont](https://github.com/mdupont)) -- fix: documentation about paragraph indentation [\#1764](https://github.com/PHPOffice/PHPWord/pull/1764) ([mdupont](https://github.com/mdupont)) -- Update templates-processing.rst [\#1745](https://github.com/PHPOffice/PHPWord/pull/1745) ([igronus](https://github.com/igronus)) -- Unused variables $rows, $cols in sample [\#1877](https://github.com/PHPOffice/PHPWord/pull/1877) ([ThanasisMpalatsoukas](https://github.com/ThanasisMpalatsoukas)) -- Add unit test for NumberingStyle [\#1744](https://github.com/PHPOffice/PHPWord/pull/1744) ([Manunchik](https://github.com/Manunchik)) -- Add unit test for PhpWord Settings [\#1743](https://github.com/PHPOffice/PHPWord/pull/1743) ([Manunchik](https://github.com/Manunchik)) -- Add unit test for Media elements [\#1742](https://github.com/PHPOffice/PHPWord/pull/1742) ([Manunchik](https://github.com/Manunchik)) -- Update templates processing docs [\#1729](https://github.com/PHPOffice/PHPWord/pull/1729) ([hcdias](https://github.com/hcdias)) - -v0.17.0 (01 oct 2019) ----------------------- -### Added -- Add methods setValuesFromArray and cloneRowFromArray to the TemplateProcessor @geraldb-nicat #670 -- Set complex type in template @troosan #1565 -- implement support for section vAlign @troosan #1569 -- ParseStyle for border-color @Gllrm0 #1551 -- Html writer auto invert text color @SailorMax #1387 -- Add RightToLeft table presentation. @troosan #1550 -- Add support for page vertical alignment. @troosan #672 #1569 -- Adding setNumId method for ListItem style @eweso #1329 -- Add support for basic fields in RTF writer. @Samuel-BF #1717 - -### Fixed -- Fix HTML border-color parsing. @troosan #1551 #1570 -- Language::validateLocale should pass with locale 'zxx'. @efpapado #1558 -- can't align center vertically with the text @ter987 #672 -- fix parsing of border-color and add test @troosan #1570 -- TrackChange doesn't handle all return types of \DateTime::createFromFormat(...) @superhaggis #1584 -- To support PreserveText inside sub container @bhattnishant #1637 -- No nested w:pPr elements in ListItemRun. @waltertamboer #1628 -- Ensure that entity_loader disable variable is re-set back to the original setting @seamuslee001 #1585 - -### Miscellaneous -- Use embedded http server to test loading of remote images @troosan #1544 -- Change private to protected to be able extending class Html @SpinyMan #1646 -- Fix apt-get crash in Travis CI for PHP 5.3 @mdupont #1707 - -v0.16.0 (30 dec 2018) ----------------------- -### Added -- Add getVariableCount method in TemplateProcessor. @nicoder #1272 -- Add setting Chart Title and Legend visibility @Tom-Magill #1433 -- Add ability to pass a Style object in Section constructor @ndench #1416 -- Add support for hidden text @Alexmg86 #1527 -- Add support for setting images in TemplateProcessor @SailorMax #1170 -- Add "Plain Text" type to SDT (Structured Document Tags) @morrisdj #1541 -- Added possibility to index variables inside cloned block in TemplateProcessor @JPBetley #817 -- Added possibility to replace variables inside cloned block with values in TemplateProcessor @DIDoS #1392 - -### Fixed -- Fix regex in `cloneBlock` function @nicoder #1269 -- HTML Title Writer loses text when Title contains a TextRun instead a string. @begnini #1436 -- Fix regex in fixBrokenMacros, make it less greedy @MuriloSo @brainwood @yurii-sio2 #1502 #1345 -- 240 twips are being added to line spacing, should not happen when using lineRule fixed @troosan #1509 #1505 -- Adding table layout to the generated HTML @aarangara #1441 -- Fix loading of Sharepoint document @Garrcomm #1498 -- RTF writer: Round getPageSizeW and getPageSizeH to avoid decimals @Patrick64 #1493 -- Fix parsing of Office 365 documents @Timanx #1485 -- For RTF writers, sizes should should never have decimals @Samuel-BF #1536 -- Style Name Parsing fails if document generated by a non-english word version @begnini #1434 - -### Miscellaneous -- Get rid of duplicated code in TemplateProcessor @abcdmitry #1161 - -v0.15.0 (14 Jul 2018) ----------------------- -### Added -- Parsing of `align` HTML attribute - @troosan #1231 -- Parse formatting inside HTML lists - @troosan @samimussbach #1239 #945 #1215 #508 -- Parsing of CSS `direction` instruction, HTML `lang` attribute, formatting inside table cell - @troosan #1273 #1252 #1254 -- Add support for Track changes @Cip @troosan #354 #1262 -- Add support for fixed Table Layout @aoloe @ekopach @troosan #841 #1276 -- Add support for Cell Spacing @dox07 @troosan #1040 -- Add parsing of formatting inside lists @atomicalnet @troosan #594 -- Added support for Vertically Raised or Lowered Text (w:position) @anrikun @troosan #640 -- Add support for MACROBUTTON field @phryneas @troosan #1021 -- Add support for Hyphenation @Trainmaster #1282 (Document: `autoHyphenation`, `consecutiveHyphenLimit`, `hyphenationZone`, `doNotHyphenateCaps`, Paragraph: `suppressAutoHyphens`) -- Added support for Floating Table Positioning (tblpPr) @anrikun #639 -- Added support for Image text wrapping distance @troosan #1310 -- Added parsing of CSS line-height and text-indent in HTML reader @troosan #1316 -- Added the ability to enable gridlines and axislabels on charts @FrankMeyer #576 -- Add support for table indent (tblInd) @Trainmaster #1343 -- Added parsing of internal links in HTML reader @lalop #1336 -- Several improvements to charts @JAEK-S #1332 -- Add parsing of html image in base64 format @jgpATs2w #1382 -- Added Support for Indentation & Tabs on RTF Writer. @smaug1985 #1405 -- Allows decimal numbers in HTML line-height style @jgpATs2w #1413 - -### Fixed -- Fix reading of docx default style - @troosan #1238 -- Fix the size unit of when parsing html images - @troosan #1254 -- Fixed HTML parsing of nested lists - @troosan #1265 -- Save PNG alpha information when using remote images. @samsullivan #779 -- Fix parsing of `` tag. @troosan #1274 -- Bookmark are not writton as internal link in html writer @troosan #1263 -- It should be possible to add a Footnote in a ListItemRun @troosan #1287 #1287 -- Fix colspan and rowspan for tables in HTML Writer @mattbolt #1292 -- Fix parsing of Heading and Title formating @troosan @gthomas2 #465 -- Fix Dateformat typo, fix hours casing, add Month-Day-Year formats @ComputerTinker #591 -- Support reading of w:drawing for documents produced by word 2011+ @gthomas2 #464 #1324 -- Fix missing column width in ODText writer @potofcoffee #413 -- Disable entity loader before parsing XML to avoid XXE injection @Tom4t0 #1427 - -### Changed -- Remove zend-stdlib dependency @Trainmaster #1284 -- The default unit for `\PhpOffice\PhpWord\Style\Image` changed from `px` to `pt`. - -### Miscellaneous -- Drop GitHub pages, switch to coveralls for code coverage analysis @czosel #1360 - -v0.14.0 (29 Dec 2017) ----------------------- -This release fixes several bugs and adds some new features. -This version brings compatibility with PHP 7.0 & 7.1 - -### Added -- Possibility to control the footnote numbering - @troosan #1068 -- Image creation from string - @troosan #937 -- Introduced the `\PhpOffice\PhpWord\SimpleType\NumberFormat` simple type. - @troosan -- Support for ContextualSpacing - @postHawk #1088 -- Possiblity to hide spelling and/or grammatical errors - @troosan #542 -- Possiblity to set default document language as well as changing the language for each text element - @troosan #1108 -- Support for Comments - @troosan #1067 -- Support for paragraph textAlignment - @troosan #1165 -- Add support for HTML underline tag in addHtml - @zNightFalLz #1186 -- Add support for HTML
in addHtml - @anrikun @troosan #659 -- Allow to change cell width unit - guillaume-ro-fr #986 -- Allow to change the line height rule @troosan -- Implement PageBreak for odt writer @cookiekiller #863 #824 -- Allow to force an update of all fields on opening a document - @troosan #951 -- Allow adding a CheckBox in a TextRun - @irond #727 -- Add support for HTML img tag - @srggroup #934 -- Add support for password protection for docx - @mariahaubner #1019 - -### Fixed -- Loosen dependency to Zend -- Images are not being printed when generating PDF - @hubertinio #1074 #431 -- Fixed some PHP 7 warnings - @ likeuntomurphy #927 -- Fixed PHP 7.2 compatibility (renamed `Object` class names to `ObjectElement`) - @SailorMax #1185 -- Fixed Word 97 reader - @alsofronie @Benpxpx @mario-rivera #912 #920 #892 -- Fixed image loading over https - @troosan #988 -- Impossibility to set different even and odd page headers - @troosan #981 -- Fixed Word2007 reader where unnecessary paragraphs were being created - @donghaobo #1043 #620 -- Fixed Word2007 reader where margins were not being read correctly - @slowprog #885 #1008 -- Impossible to add element PreserveText in Section - @rvanlaak #452 -- Added missing options for numbering format - @troosan #1041 -- Fixed impossibility to set a different footer for first page - @ctrlaltca #1116, @aoloe #875 -- Fixed styles not being applied by HTML writer, better pdf output - @sarke #1047 #500 #1139 -- Fixed read docx error when document contains image from remote url - @FBnil #1173 #1176 -- Padded the $args array to remove error - @kaigoh #1150, @reformed #870 -- Fix incorrect image size between windows and mac - @bskrtich #874 -- Fix adding HTML table to document - @mogilvie @arivanbastos #324 -- Fix parsing on/off values (w:val="true|false|1|0|on|off") - @troosan #1221 #1219 -- Fix error on Empty Dropdown Entry - @ComputerTinker #592 - -### Deprecated -- PhpWord->getProtection(), get it from the settings instead PhpWord->getSettings()->getDocumentProtection(); - - - -v0.13.0 (31 July 2016) -------------------- -This release brings several improvements in `TemplateProcessor`, automatic output escaping feature for OOXML, ODF, HTML, and RTF (turned off, by default). -It also introduces constants for horizontal alignment options, and resolves some issues with PHP 7. -Manual installation feature has been dropped since the release. Please, use [Composer](https://getcomposer.org/) to install PHPWord. - -### Added -- Introduced the `\PhpOffice\PhpWord\SimpleType\Jc` simple type. - @RomanSyroeshko -- Introduced the `\PhpOffice\PhpWord\SimpleType\JcTable` simple type. - @RomanSyroeshko -- Introduced writer for the "Paragraph Alignment" element (see `\PhpOffice\PhpWord\Writer\Word2007\Element\ParagraphAlignment`). - @RomanSyroeshko -- Introduced writer for the "Table Alignment" element (see `\PhpOffice\PhpWord\Writer\Word2007\Element\TableAlignment`). - @RomanSyroeshko -- Supported indexed arrays in arguments of `TemplateProcessor::setValue()`. - @RomanSyroeshko #618 -- Introduced automatic output escaping for OOXML, ODF, HTML, and RTF. To turn the feature on use `phpword.ini` or `\PhpOffice\PhpWord\Settings`. - @RomanSyroeshko #483 -- Supported processing of headers and footers in `TemplateProcessor::applyXslStyleSheet()`. - @RomanSyroeshko #335 - -### Changed -- Improved error message for the case when `autoload.php` is not found. - @RomanSyroeshko #371 -- Renamed the `align` option of `NumberingLevel`, `Frame`, `Table`, and `Paragraph` styles into `alignment`. - @RomanSyroeshko -- Improved performance of `TemplateProcessor::setValue()`. - @kazitanvirahsan #614, #617 -- Fixed some HTML tags not rendering any output (p, header & table) - #257, #324 - @twmobius and @garethellis - -### Deprecated -- `getAlign` and `setAlign` methods of `NumberingLevel`, `Frame`, `Table`, and `Paragraph` styles. -Use the correspondent `getAlignment` and `setAlignment` methods instead. - @RomanSyroeshko -- `left`, `right`, and `justify` alignment options for paragraphs (now are mapped to `Jc::START`, `Jc::END`, and `Jc::BOTH`). - @RomanSyroeshko -- `left`, `right`, and `justify` alignment options for tables (now are mapped to `Jc::START`, `Jc::END`, and `Jc::CENTER`). - @RomanSyroeshko -- `TCPDF` due to its limited HTML support. Use `DomPDF` or `MPDF` writer instead. - @RomanSyroeshko #399 - -### Removed -- `\PhpOffice\PhpWord\Style\Alignment`. Style properties, which previously stored instances of this class, now deal with strings. -In each case set of available string values is defined by the correspondent simple type. - @RomanSyroeshko -- Manual installation support. Since the release we have dependencies on third party libraries, -so installation via ZIP-archive download is not an option anymore. To install PHPWord use [Composer](https://getcomposer.org/). - We also removed `\PhpOffice\PhpWord\Autoloader`, because the latter change made it completely useless. - Autoloaders provided by Composer are in use now (see `bootstrap.php`). - @RomanSyroeshko -- `\PhpOffice\PhpWord\Shared\Drawing` replaced by `\PhpOffice\Common\Drawing`. - @Progi1984 #658 -- `\PhpOffice\PhpWord\Shared\Font`. - @Progi1984 #658 -- `\PhpOffice\PhpWord\Shared\String` replaced by `\PhpOffice\Common\Text`. - @Progi1984 @RomanSyroeshko #658 -- `\PhpOffice\PhpWord\Shared\XMLReader` replaced by `\PhpOffice\Common\XMLReader`. - @Progi1984 #658 -- `\PhpOffice\PhpWord\Shared\XMLWriter` replaced by `\PhpOffice\Common\XMLWriter`. - @Progi1984 @RomanSyroeshko #658 -- `AbstractContainer::addMemoryImage()`. Use `AbstractContainer::addImage()` instead. - -### Fixed -- `Undefined property` error while reading MS-DOC documents. - @jaberu #610 -- Corrupted OOXML template issue in case when its names is broken immediately after `$` sign. -That case wasn't taken into account in implementation of `TemplateProcessor::fixBrokenMacros()`. - @RomanSyroeshko @d-damien #548 - - - -v0.12.1 (30 August 2015) ------------------------ -Maintenance release. This release is focused primarily on `TemplateProcessor`. - -### Changes -- Changed visibility of all private properties and methods of `TemplateProcessor` to `protected`. - @RomanSyroeshko #498 -- Improved performance of `TemplateProcessor::setValue()`. - @RomanSyroeshko @nicoSWD #513 - -### Bugfixes -- Fixed issue with "Access denied" message while opening `Sample_07_TemplateCloneRow.docx` and `Sample_23_TemplateBlock.docx` result files on Windows platform. - @RomanSyroeshko @AshSat #532 -- Fixed `PreserveText` element alignment in footer (see `Sample_12_HeaderFooter.php`). - @RomanSyroeshko @SSchwaiger #495 - - - -v0.12.0 (3 January 2015) ------------------------ -This release added form fields (textinput, checkbox, and dropdown), drawing shapes (arc, curve, line, polyline, rect, oval), and basic 2D chart (pie, doughnut, bar, line, area, scatter, radar) elements along with some new styles. Basic MsDoc reader is introduced. - -### Features -- Element: Ability to add drawing shapes (arc, curve, line, polyline, rect, oval) using new `Shape` element - @ivanlanin #123 -- Font: New `scale`, `spacing`, and `kerning` property of font style - @ivanlanin -- Paragraph: Added shading to the paragraph style for full width shading - @lrobert #264 -- RTF Writer: Support for sections, margins, and borders - @ivanlanin #249 -- Section: Ability to set paper size, e.g. A4, A3, and Legal - @ivanlanin #249 -- General: New `PhpWord::save()` method to encapsulate `IOFactory` - @ivanlanin -- General: New `Shared\Converter` static class - @ivanlanin -- Chart: Basic 2D chart (pie, doughnut, bar, line, area, scatter, radar) - @ivanlanin #278 -- Chart: 3D charts and ability to set width and height - @ivanlanin -- FormField: Ability to add textinput, checkbox, and dropdown form elements - @ivanlanin #266 -- Setting: Ability to define document protection (readOnly, comments, trackedChanges, forms) - @ivanlanin -- Setting: Ability to remove [Compatibility Mode] text in the MS Word title bar - @ivanlanin -- SDT: Ability to add structured document tag elements (comboBox, dropDownList, date) - @ivanlanin -- Paragraph: Support for paragraph with borders - @ivanlanin #294 -- Word2007 Writer : Support for RTL - @Progi1984 #331 -- MsDOC Reader: Basic MsDOC Reader - @Progi1984 #23, #287 -- "absolute" horizontal and vertical positioning of Frame - @basjan #302 -- Add new-page function for PDF generation. For multiple PDF-backends - @chc88 #426 -- Report style options enumerated when style unknown - @h6w - -### Bugfixes -- Fix rare PclZip/realpath/PHP version problem - @andrew-kzoo #261 -- `addHTML` encoding and ampersand fixes for PHP 5.3 - @bskrtich #270 -- Page breaks on titles and tables - @ivanlanin #274 -- Table inside vertical border does not rendered properly - @ivanlanin #280 -- `add` of container should be case insensitive, e.g. `addToc` should be accepted, not only `addTOC` - @ivanlanin #294 -- Fix specific borders (and margins) were not written correctly in word2007 writer - @pscheit #327 -- "HTML is not a valid writer" exception while running "Sample_36_RTL.php" - @RomanSyroeshko #340 -- "addShape()" magic method in AbstractContainer is mistakenly named as "addObject()" - @GMTA #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 #401 -- `` tag is closed with `` tag: - @franzholz #438 - -### Deprecated -- `Element\Link::getTarget()` replaced by `Element\Link::getSource()` -- `Element\Section::getSettings()` and `Element\Section::setSettings()` replaced by `Element\Section::getStyle()` and `Element\Section::setStyle()` -- `Shared\Drawing` and `Shared\Font` merged into `Shared\Converter` -- `DocumentProperties` replaced by `Metadata\DocInfo` -- `Template` replaced by `TemplateProcessor` -- `PhpWord->loadTemplate($filename)` - -### Miscellaneous -- Docs: Add known issue on `README` about requirement for temporary folder to be writable and update `samples/index.php` for this requirement check - @ivanlanin #238 -- Docs: Correct elements.rst about Line - @chrissharkman #292 -- PclZip: Remove temporary file after used - @andrew-kzoo #265 -- Autoloader: Add the ability to set the autoloader options - @bskrtich #267 -- Element: Refactor elements to move set relation Id from container to element - @ivanlanin -- Introduced CreateTemporaryFileException, CopyFileException - @RomanSyroeshko -- Settings: added method to set user defined temporary directory - @RomanSyroeshko #310 -- Renamed `Template` into `TemplateProcessor` - @RomanSyroeshko #216 -- Reverted #51. All text escaping must be performed out of the library - @RomanSyroeshko #51 - - - -v0.11.1 (2 June 2014) --------------------- -This is an immediate bugfix release for HTML reader. - -- HTML Reader: `

` and header tags puts no output - @canyildiz @ivanlanin #257 - - - -v0.11.0 (1 June 2014) --------------------- -This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3. Four new elements were added: TextBox, ListItemRun, Field, and Line. Relative and absolute positioning for images and textboxes were added. Writer classes were refactored into parts, elements, and styles. ODT and RTF features were enhanced. Ability to add elements to PHPWord object via HTML were implemented. RTF and HTML reader were initiated. - -### Features -- Image: Ability to define relative and absolute positioning - @basjan #217 -- Footer: Conform footer with header by adding firstPage, evenPage and by inheritance - @basjan @ivanlanin #219 -- Element: New `TextBox` element - @basjan @ivanlanin #228, #229, #231 -- HTML: Ability to add elements to PHPWord object via html - @basjan #231 -- Element: New `ListItemRun` element that can add a list item with inline formatting like a textrun - @basjan #235 -- Table: Ability to add table inside a cell (nested table) - @ivanlanin #149 -- RTF Writer: UTF8 support for RTF: Internal UTF8 text is converted to Unicode before writing - @ivanlanin #158 -- Table: Ability to define table width (in percent and twip) and position - @ivanlanin #237 -- RTF Writer: Ability to add links and page breaks in RTF - @ivanlanin #196 -- ListItemRun: Remove fontStyle parameter because ListItemRun is inherited from TextRun and TextRun doesn't have fontStyle - @ivanlanin -- Config: Ability to use a config file to store various common settings - @ivanlanin #200 -- ODT Writer: Enable inline font style in TextRun - @ivanlanin -- ODT Writer: Enable underline, strike/doublestrike, smallcaps/allcaps, superscript/subscript font style - @ivanlanin -- ODT Writer: Enable section and column - @ivanlanin -- PDF Writer: Add TCPDF and mPDF as optional PDF renderer library - @ivanlanin -- ODT Writer: Enable title element and custom document properties - @ivanlanin -- ODT Reader: Ability to read standard and custom document properties - @ivanlanin -- Word2007 Writer: Enable the missing custom document properties writer - @ivanlanin -- Image: Enable "image float left" - @ivanlanin #244 -- RTF Writer: Ability to write document properties - @ivanlanin -- RTF Writer: Ability to write image - @ivanlanin -- Element: New `Field` element - @basjan #251 -- RTF Reader: Basic RTF reader - @ivanlanin #72, #252 -- Element: New `Line` element - @basjan #253 -- Title: Ability to apply numbering in heading - @ivanlanin #193 -- HTML Reader: Basic HTML reader - @ivanlanin #80, #254 -- RTF Writer: Basic table writing - @ivanlanin #245 - -### Bugfixes -- Header: All images added to the second header were assigned to the first header - @basjan #222 -- Conversion: Fix conversion from cm to pixel, pixel to cm, and pixel to point - @basjan #233, #234 -- PageBreak: Page break adds new line in the beginning of the new page - @ivanlanin #150 -- Image: `marginLeft` and `marginTop` cannot accept float value - @ivanlanin #248 -- Title: Orphan `w:fldChar` caused OpenOffice to crash when opening DOCX - @ivanlanin #236 - -### Deprecated -- Static classes `Footnotes`, `Endnotes`, and `TOC` -- `Writer\Word2007\Part`: `Numbering::writeNumbering()`, `Settings::writeSettings()`, `WebSettings::writeWebSettings()`, `ContentTypes::writeContentTypes()`, `Styles::writeStyles()`, `Document::writeDocument()` all changed into `write()` -- `Writer\Word2007\Part\DocProps`: Split into `Writer\Word2007\Part\DocPropsCore` and `Writer\Word2007\Part\DocPropsApp` -- `Element\Title::getBookmarkId()` replaced by `Element\Title::getRelationId()` -- `Writer\HTML::writeDocument`: Replaced by `Writer\HTML::getContent` - -### Miscellaneous -- License: Change the project license from LGPL 2.1 into LGPL 3.0 - #211 -- Word2007 Writer: New `Style\Image` class - @ivanlanin -- Refactor: Replace static classes `Footnotes`, `Endnotes`, and `TOC` with `Collections` - @ivanlanin #206 -- QA: Reactivate `phpcpd` and `phpmd` on Travis - @ivanlanin -- Refactor: PHPMD recommendation: Change all `get...` method that returns `boolean` into `is...` or `has...` - @ivanlanin -- Docs: Create gh-pages branch for API documentation - @Progi1984 #154 -- QA: Add `.scrutinizer.yml` and include `composer.lock` for preparation to Scrutinizer - @ivanlanin #186 -- Writer: Refactor writer parts using composite pattern - @ivanlanin -- Docs: Show code quality and test code coverage badge on README -- Style: Change behaviour of `set...` function of boolean properties; when none is defined, assumed true - @ivanlanin -- Shared: Unify PHP ZipArchive and PCLZip features into PhpWord ZipArchive - @ivanlanin -- Docs: Create VERSION file - @ivanlanin -- QA: Improve dan update requirement check in `samples` folder - @ivanlanin - - - -v0.10.1 (21 May 2014) --------------------- -This is a bugfix release for `php-zip` requirement in Composer. - -- Change Composer requirements for php-zip from `require` to `suggest` - @bskrtich #246 - - - -v0.10.0 (4 May 2014) -------------------- -This release marked heavy refactorings on internal code structure with the creation of some abstract classes to reduce code duplication. `Element` subnamespace is introduced in this release to replace `Section`. Word2007 reader capability is greatly enhanced. Endnote is introduced. List numbering is now customizable. Basic HTML and PDF writing support is enabled. Basic ODText reader is introduced. - -### Features -- Image: Get image dimensions without EXIF extension - @andrew-kzoo #184 -- Table: Add `tblGrid` element for Libre/Open Office table sizing - @gianis6 #183 -- Footnote: Ability to insert textbreak in footnote `$footnote->addTextBreak()` - @ivanlanin -- Footnote: Ability to style footnote reference mark by using `FootnoteReference` style - @ivanlanin -- Font: Add `bgColor` to font style to define background using HEX color - @jcarignan #168 -- Table: Add `exactHeight` to row style to define whether row height should be exact or atLeast - @jcarignan #168 -- Element: New `CheckBox` element for sections and table cells - @ozilion #156 -- Settings: Ability to use PCLZip as alternative to ZipArchive - @bskrtich @ivanlanin #106, #140, #185 -- Template: Ability to find & replace variables in headers & footers - @dgudgeon #190 -- Template: Ability to clone & delete block of text using `cloneBlock` and `deleteBlock` - @diego-vieira #191 -- TOC: Ability to have two or more TOC in one document and to set min and max depth for TOC - @Pyreweb #189 -- Table: Ability to add footnote in table cell - @ivanlanin #187 -- Footnote: Ability to add image in footnote - @ivanlanin #187 -- ListItem: Ability to add list item in header/footer - @ivanlanin #187 -- CheckBox: Ability to add checkbox in header/footer - @ivanlanin #187 -- Link: Ability to add link in header/footer - @ivanlanin #187 -- Object: Ability to add object in header, footer, textrun, and footnote - @ivanlanin #187 -- Media: Add `Media::resetElements()` to reset all media data - @juzi #19 -- General: Add `Style::resetStyles()` - @ivanlanin #187 -- DOCX Reader: Ability to read header, footer, footnotes, link, preservetext, textbreak, pagebreak, table, list, image, and title - @ivanlanin -- Endnote: Ability to add endnotes - @ivanlanin -- ListItem: Ability to create custom list and reset list number - @ivanlanin #10, #198 -- ODT Writer: Basic table writing support - @ivanlanin -- Image: Keep image aspect ratio if only 1 dimension styled - @japonicus #194 -- HTML Writer: Basic HTML writer: text, textrun, link, title, textbreak, table, image (as Base64), footnote, endnote - @ivanlanin #203, #67, #147 -- PDF Writer: Basic PDF writer using DomPDF: All HTML element except image - @ivanlanin #68 -- DOCX Writer: Change `docProps/app.xml` `Application` to `PHPWord` - @ivanlanin -- DOCX Writer: Create `word/settings.xml` and `word/webSettings.xml` dynamically - @ivanlanin -- ODT Writer: Basic image writing - @ivanlanin -- ODT Writer: Link writing - @ivanlanin -- ODT Reader: Basic ODText Reader - @ivanlanin #71 -- Section: Ability to define gutter and line numbering - @ivanlanin -- Font: Small caps, all caps, and double strikethrough - @ivanlanin #151 -- Settings: Ability to use measurement unit other than twips with `setMeasurementUnit` - @ivanlanin #199 -- Style: Remove `bgColor` from `Font`, `Table`, and `Cell` and put it into the new `Shading` style - @ivanlanin -- Style: New `Indentation` and `Spacing` style - @ivanlanin -- Paragraph: Ability to define first line and right indentation - @ivanlanin - -### Bugfixes -- Footnote: Footnote content doesn't show footnote reference number - @ivanlanin #170 -- Documentation: Error in a function - @theBeerNut #195 - -### Deprecated -- `createTextRun` replaced by `addTextRun` -- `createFootnote` replaced by `addFootnote` -- `createHeader` replaced by `addHeader` -- `createFooter` replaced by `addFooter` -- `createSection` replaced by `addSection` -- `Element\Footnote::getReferenceId` replaced by `Element\AbstractElement::getRelationId` -- `Element\Footnote::setReferenceId` replaced by `Element\AbstractElement::setRelationId` -- `Footnote::addFootnoteLinkElement` replaced by `Media::addElement` -- `Footnote::getFootnoteLinkElements` replaced by `Media::getElements` -- All current methods on `Media` -- `Element\Link::getLinkSrc` replaced by `Element\Link::getTarget` -- `Element\Link::getLinkName` replaced by `Element\Link::getText` -- `Style\Cell::getDefaultBorderColor` - -### Miscellaneous -- Documentation: Simplify page level docblock - @ivanlanin #179 -- Writer: Refactor writer classes and create a new `Write\AbstractWriter` abstract class - @ivanlanin #160 -- General: Refactor folders: `Element` and `Exception` - @ivanlanin #187 -- General: Remove legacy `HashTable` and `Shared\ZipStreamWrapper` and all related properties/methods - @ivanlanin #187 -- Element: New `AbstractElement` abstract class - @ivanlanin #187 -- Media: Refactor media class to use one method for all docPart (section, header, footer, footnote) - @ivanlanin #187 -- General: Remove underscore prefix from all private properties name - @ivanlanin #187 -- General: Move Section `Settings` to `Style\Section` - @ivanlanin #187 -- General: Give `Abstract` prefix and `Interface` suffix for all abstract classes and interfaces as per [PHP-FIG recommendation](https://github.com/php-fig/fig-standards/blob/master/bylaws/002-psr-naming-conventions.md) - @ivanlanin #187 -- Style: New `Style\AbstractStyle` abstract class - @ivanlanin #187 -- Writer: New 'ODText\Base` class - @ivanlanin #187 -- General: Rename `Footnote` to `Footnotes` to reflect the nature of collection - @ivanlanin -- General: Add some unit tests for Shared & Element (100%!) - @Progi1984 -- Test: Add some samples and tests for image wrapping style - @brunocasado #59 -- Refactor: Remove Style\Tabs - @ivanlanin -- Refactor: Apply composite pattern for writers - @ivanlanin -- Refactor: Split `AbstractContainer` from `AbstractElement` - @ivanlanin -- Refactor: Apply composite pattern for Word2007 reader - @ivanlanin - - - -v0.9.1 (27 Mar 2014) -------------------- -This is a bugfix release for PSR-4 compatibility. - -- Fixed PSR-4 composer autoloader - @AntonTyutin - - - -v0.9.0 (26 Mar 2014) -------------------- -This release marked the transformation to namespaces (PHP 5.3+). - -### Features -- Image: Ability to use remote or GD images using `addImage()` on sections, headers, footer, cells, and textruns - @ivanlanin -- Header: Ability to use remote or GD images using `addWatermark()` - @ivanlanin - -### Bugfixes -- Preserve text doesn't render correctly when the text is not the first word, e.g. 'Page {PAGE}' - @ivanlanin - -### Miscellaneous -- Move documentation to [Read The Docs](http://phpword.readthedocs.org/en/develop/) - @Progi1984 @ivanlanin #82 -- Reorganize and redesign samples folder - @ivanlanin #137 -- Use `PhpOffice\PhpWord` namespace for PSR compliance - @RomanSyroeshko @gabrielbull #159, #58 -- Restructure folders and change folder name `Classes` to `src` and `Tests` to `test` for PSR compliance - @RomanSyroeshko @gabrielbull -- Compliance to phpDocumentor - @ivanlanin -- Merge Style\TableFull into Style\Table. Style\TableFull is deprecated - @ivanlanin #160 -- Merge Section\MemoryImage into Section\Image. Section\Image is deprecated - @ivanlanin #160 - - - -v0.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 - - - -v0.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 #56, #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 #5 -- General: Add ability to manage line breaks after image insertion - @bskrtich #6, #66, #84 -- Template: Ability to limit number of replacements performed by setValue() method of Template class - @RomanSyroeshko #52, #53, #85 -- Table row: Repeat as header row & allow row to break across pages - @ivanlanin #48, #86 -- Table: Table width in percentage - @ivanlanin #48, #86 -- Font: Superscript and subscript - @ivanlanin #48, #86 -- Paragraph: Hanging paragraph - @ivanlanin #48, #86 -- Section: Multicolumn and section break - @ivanlanin #48, #86 -- Template: Ability to apply XSL style sheet to Template - @RomanSyroeshko #46, #47, #83 -- General: PHPWord_Shared_Font::pointSizeToTwips() converter - @ivanlanin #87 -- Paragraph: Ability to define normal paragraph style with PHPWord::setNormalStyle() - @ivanlanin #87 -- Paragraph: Ability to define parent style (basedOn) and style for following paragraph (next) - @ivanlanin #87 -- Clone table rows on the fly when using a template document - @jeroenmoors #44, #88 -- Initial addition of basic footnote support - @deds #16 -- Paragraph: Ability to define paragraph pagination: widow control, keep next, keep lines, and page break before - @ivanlanin #92 -- General: PHPWord_Style_Font refactoring - @ivanlanin #93 -- Font: Use points instead of halfpoints internally. Conversion to halfpoints done during XML Writing. - @ivanlanin #93 -- Paragraph: setTabs() function - @ivanlanin #92 -- General: Basic support for TextRun on ODT and RTF - @ivanlanin #99 -- Reader: Basic Reader for Word2007 - @ivanlanin #104 -- TextRun: Allow Text Break in Text Run - @bskrtich #109 -- General: Support for East Asian fontstyle - @jhfangying #111, #118 -- Image: Use exif_imagetype to check image format instead of extension name - @gabrielbull #114 -- General: Setting for XMLWriter Compatibility option - @bskrtich #103 -- MemoryImage: Allow remote image when allow_url_open = on - @ivanlanin #122 -- TextBreak: Allow font and paragraph style for text break - @ivanlanin #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 #51 -- Example in README.md is broken - @Progi1984 #89 -- General: PHPWord_Shared_Drawing::centimetersToPixels() conversion - @ivanlanin #94 -- Footnote: Corrupt DOCX reported by MS Word when sections > 1 and not every sections have footnote - @ivanlanin #125 - -### Miscellaneous -- UnitTests - @Progi1984 - - - -v0.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 #1 -- Implement ODT Writer - @Progi1984 #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 #32 -- PHPWord_Shared_String.IsUTF8 returns FALSE for Cyrillic UTF-8 input - @RomanSyroeshko #34 -- Temporary files naming logic in PHPWord_Template can lead to a collision - @RomanSyroeshko #38 - -### Miscellaneous -- Add superscript/subscript styling in Excel2007 Writer - @MarkBaker -- add indentation support to paragraphs - @deds -- Support for Composer - @Progi1984 #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 [#49](http://phpword.codeplex.com/workitem/49) diff --git a/README.md b/README.md index ceb8451a4c..11bcd1525c 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ 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](COPYING.LESSER). PHPWord is aimed to be a high quality software product by incorporating [continuous integration](https://github.com/PHPOffice/PHPWord/actions) and unit testing. You can learn more about PHPWord by reading the [Developers' Documentation](http://phpword.readthedocs.org/). +PHPWord is an open source project licensed under the terms of [LGPL version 3](COPYING.LESSER). PHPWord is aimed to be a high quality software product by incorporating [continuous integration](https://github.com/PHPOffice/PHPWord/actions) and unit testing. You can learn more about PHPWord by reading the [Developers' Documentation](https://phpoffice.github.io/PHPWord/). If you have any questions, please ask on [StackOverFlow](https://stackoverflow.com/questions/tagged/phpword) @@ -20,7 +20,7 @@ Read more about PHPWord: - [Installation](#installation) - [Getting started](#getting-started) - [Contributing](#contributing) -- [Developers' Documentation](http://phpword.readthedocs.org/) +- [Developers' Documentation](https://phpoffice.github.io/PHPWord/) ## Features @@ -150,7 +150,7 @@ $objWriter->save('helloWorld.html'); ``` More examples are provided in the [samples folder](samples/). For an easy access to those samples launch `php -S localhost:8000` in the samples directory then browse to [http://localhost:8000](http://localhost:8000) to view the samples. -You can also read the [Developers' Documentation](http://phpword.readthedocs.org/) for more detail. +You can also read the [Developers' Documentation](https://phpoffice.github.io/PHPWord/) for more detail. ## Contributing @@ -159,4 +159,4 @@ We welcome everyone to contribute to PHPWord. Below are some of the things that - Read [our contributing guide](CONTRIBUTING.md). - [Fork us](https://github.com/PHPOffice/PHPWord/fork) and [request a pull](https://github.com/PHPOffice/PHPWord/pulls) to the [master](https://github.com/PHPOffice/PHPWord/tree/master) 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. +- Follow [@PHPOffice](https://twitter.com/PHPOffice) on Twitter. diff --git a/composer.json b/composer.json index 445b372f5f..6890bf6d9f 100644 --- a/composer.json +++ b/composer.json @@ -6,7 +6,7 @@ "docx", "OOXML", "OpenXML", "Office Open XML", "ISO IEC 29500", "WordprocessingML", "RTF", "Rich Text Format", "doc", "odt", "ODF", "OpenDocument", "PDF", "HTML" ], - "homepage": "https://phpword.readthedocs.io/", + "homepage": "https://phpoffice.github.io/PHPWord/", "type": "library", "license": "LGPL-3.0", "authors": [ diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index bd38cd5d9d..0000000000 --- a/docs/Makefile +++ /dev/null @@ -1,153 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PHPWord.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PHPWord.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/PHPWord" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PHPWord" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/changes/0.x/0.10.0.md b/docs/changes/0.x/0.10.0.md new file mode 100644 index 0000000000..3c31d772c2 --- /dev/null +++ b/docs/changes/0.x/0.10.0.md @@ -0,0 +1,84 @@ + +# 0.10.0 (4 May 2014) + +This release marked heavy refactorings on internal code structure with the creation of some abstract classes to reduce code duplication. `Element` subnamespace is introduced in this release to replace `Section`. Word2007 reader capability is greatly enhanced. Endnote is introduced. List numbering is now customizable. Basic HTML and PDF writing support is enabled. Basic ODText reader is introduced. + +### Features +- Image: Get image dimensions without EXIF extension - @andrew-kzoo #184 +- Table: Add `tblGrid` element for Libre/Open Office table sizing - @gianis6 #183 +- Footnote: Ability to insert textbreak in footnote `$footnote->addTextBreak()` - @ivanlanin +- Footnote: Ability to style footnote reference mark by using `FootnoteReference` style - @ivanlanin +- Font: Add `bgColor` to font style to define background using HEX color - @jcarignan #168 +- Table: Add `exactHeight` to row style to define whether row height should be exact or atLeast - @jcarignan #168 +- Element: New `CheckBox` element for sections and table cells - @ozilion #156 +- Settings: Ability to use PCLZip as alternative to ZipArchive - @bskrtich @ivanlanin #106, #140, #185 +- Template: Ability to find & replace variables in headers & footers - @dgudgeon #190 +- Template: Ability to clone & delete block of text using `cloneBlock` and `deleteBlock` - @diego-vieira #191 +- TOC: Ability to have two or more TOC in one document and to set min and max depth for TOC - @Pyreweb #189 +- Table: Ability to add footnote in table cell - @ivanlanin #187 +- Footnote: Ability to add image in footnote - @ivanlanin #187 +- ListItem: Ability to add list item in header/footer - @ivanlanin #187 +- CheckBox: Ability to add checkbox in header/footer - @ivanlanin #187 +- Link: Ability to add link in header/footer - @ivanlanin #187 +- Object: Ability to add object in header, footer, textrun, and footnote - @ivanlanin #187 +- Media: Add `Media::resetElements()` to reset all media data - @juzi #19 +- General: Add `Style::resetStyles()` - @ivanlanin #187 +- DOCX Reader: Ability to read header, footer, footnotes, link, preservetext, textbreak, pagebreak, table, list, image, and title - @ivanlanin +- Endnote: Ability to add endnotes - @ivanlanin +- ListItem: Ability to create custom list and reset list number - @ivanlanin #10, #198 +- ODT Writer: Basic table writing support - @ivanlanin +- Image: Keep image aspect ratio if only 1 dimension styled - @japonicus #194 +- HTML Writer: Basic HTML writer: text, textrun, link, title, textbreak, table, image (as Base64), footnote, endnote - @ivanlanin #203, #67, #147 +- PDF Writer: Basic PDF writer using DomPDF: All HTML element except image - @ivanlanin #68 +- DOCX Writer: Change `docProps/app.xml` `Application` to `PHPWord` - @ivanlanin +- DOCX Writer: Create `word/settings.xml` and `word/webSettings.xml` dynamically - @ivanlanin +- ODT Writer: Basic image writing - @ivanlanin +- ODT Writer: Link writing - @ivanlanin +- ODT Reader: Basic ODText Reader - @ivanlanin #71 +- Section: Ability to define gutter and line numbering - @ivanlanin +- Font: Small caps, all caps, and double strikethrough - @ivanlanin #151 +- Settings: Ability to use measurement unit other than twips with `setMeasurementUnit` - @ivanlanin #199 +- Style: Remove `bgColor` from `Font`, `Table`, and `Cell` and put it into the new `Shading` style - @ivanlanin +- Style: New `Indentation` and `Spacing` style - @ivanlanin +- Paragraph: Ability to define first line and right indentation - @ivanlanin + +### Bugfixes +- Footnote: Footnote content doesn't show footnote reference number - @ivanlanin #170 +- Documentation: Error in a function - @theBeerNut #195 + +### Deprecated +- `createTextRun` replaced by `addTextRun` +- `createFootnote` replaced by `addFootnote` +- `createHeader` replaced by `addHeader` +- `createFooter` replaced by `addFooter` +- `createSection` replaced by `addSection` +- `Element\Footnote::getReferenceId` replaced by `Element\AbstractElement::getRelationId` +- `Element\Footnote::setReferenceId` replaced by `Element\AbstractElement::setRelationId` +- `Footnote::addFootnoteLinkElement` replaced by `Media::addElement` +- `Footnote::getFootnoteLinkElements` replaced by `Media::getElements` +- All current methods on `Media` +- `Element\Link::getLinkSrc` replaced by `Element\Link::getTarget` +- `Element\Link::getLinkName` replaced by `Element\Link::getText` +- `Style\Cell::getDefaultBorderColor` + +### Miscellaneous +- Documentation: Simplify page level docblock - @ivanlanin #179 +- Writer: Refactor writer classes and create a new `Write\AbstractWriter` abstract class - @ivanlanin #160 +- General: Refactor folders: `Element` and `Exception` - @ivanlanin #187 +- General: Remove legacy `HashTable` and `Shared\ZipStreamWrapper` and all related properties/methods - @ivanlanin #187 +- Element: New `AbstractElement` abstract class - @ivanlanin #187 +- Media: Refactor media class to use one method for all docPart (section, header, footer, footnote) - @ivanlanin #187 +- General: Remove underscore prefix from all private properties name - @ivanlanin #187 +- General: Move Section `Settings` to `Style\Section` - @ivanlanin #187 +- General: Give `Abstract` prefix and `Interface` suffix for all abstract classes and interfaces as per [PHP-FIG recommendation](https://github.com/php-fig/fig-standards/blob/master/bylaws/002-psr-naming-conventions.md) - @ivanlanin #187 +- Style: New `Style\AbstractStyle` abstract class - @ivanlanin #187 +- Writer: New 'ODText\Base` class - @ivanlanin #187 +- General: Rename `Footnote` to `Footnotes` to reflect the nature of collection - @ivanlanin +- General: Add some unit tests for Shared & Element (100%!) - @Progi1984 +- Test: Add some samples and tests for image wrapping style - @brunocasado #59 +- Refactor: Remove Style\Tabs - @ivanlanin +- Refactor: Apply composite pattern for writers - @ivanlanin +- Refactor: Split `AbstractContainer` from `AbstractElement` - @ivanlanin +- Refactor: Apply composite pattern for Word2007 reader - @ivanlanin + + diff --git a/docs/changes/0.x/0.10.1.md b/docs/changes/0.x/0.10.1.md new file mode 100644 index 0000000000..3fd3f620c9 --- /dev/null +++ b/docs/changes/0.x/0.10.1.md @@ -0,0 +1,9 @@ + + +# 0.10.1 (21 May 2014) + +This is a bugfix release for `php-zip` requirement in Composer. + +- Change Composer requirements for php-zip from `require` to `suggest` - @bskrtich #246 + + diff --git a/docs/changes/0.x/0.11.0.md b/docs/changes/0.x/0.11.0.md new file mode 100644 index 0000000000..303b4fe66d --- /dev/null +++ b/docs/changes/0.x/0.11.0.md @@ -0,0 +1,62 @@ +# 0.11.0 (1 June 2014) + +This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3. Four new elements were added: TextBox, ListItemRun, Field, and Line. Relative and absolute positioning for images and textboxes were added. Writer classes were refactored into parts, elements, and styles. ODT and RTF features were enhanced. Ability to add elements to PHPWord object via HTML were implemented. RTF and HTML reader were initiated. + +### Features +- Image: Ability to define relative and absolute positioning - @basjan #217 +- Footer: Conform footer with header by adding firstPage, evenPage and by inheritance - @basjan @ivanlanin #219 +- Element: New `TextBox` element - @basjan @ivanlanin #228, #229, #231 +- HTML: Ability to add elements to PHPWord object via html - @basjan #231 +- Element: New `ListItemRun` element that can add a list item with inline formatting like a textrun - @basjan #235 +- Table: Ability to add table inside a cell (nested table) - @ivanlanin #149 +- RTF Writer: UTF8 support for RTF: Internal UTF8 text is converted to Unicode before writing - @ivanlanin #158 +- Table: Ability to define table width (in percent and twip) and position - @ivanlanin #237 +- RTF Writer: Ability to add links and page breaks in RTF - @ivanlanin #196 +- ListItemRun: Remove fontStyle parameter because ListItemRun is inherited from TextRun and TextRun doesn't have fontStyle - @ivanlanin +- Config: Ability to use a config file to store various common settings - @ivanlanin #200 +- ODT Writer: Enable inline font style in TextRun - @ivanlanin +- ODT Writer: Enable underline, strike/doublestrike, smallcaps/allcaps, superscript/subscript font style - @ivanlanin +- ODT Writer: Enable section and column - @ivanlanin +- PDF Writer: Add TCPDF and mPDF as optional PDF renderer library - @ivanlanin +- ODT Writer: Enable title element and custom document properties - @ivanlanin +- ODT Reader: Ability to read standard and custom document properties - @ivanlanin +- Word2007 Writer: Enable the missing custom document properties writer - @ivanlanin +- Image: Enable "image float left" - @ivanlanin #244 +- RTF Writer: Ability to write document properties - @ivanlanin +- RTF Writer: Ability to write image - @ivanlanin +- Element: New `Field` element - @basjan #251 +- RTF Reader: Basic RTF reader - @ivanlanin #72, #252 +- Element: New `Line` element - @basjan #253 +- Title: Ability to apply numbering in heading - @ivanlanin #193 +- HTML Reader: Basic HTML reader - @ivanlanin #80, #254 +- RTF Writer: Basic table writing - @ivanlanin #245 + +### Bugfixes +- Header: All images added to the second header were assigned to the first header - @basjan #222 +- Conversion: Fix conversion from cm to pixel, pixel to cm, and pixel to point - @basjan #233, #234 +- PageBreak: Page break adds new line in the beginning of the new page - @ivanlanin #150 +- Image: `marginLeft` and `marginTop` cannot accept float value - @ivanlanin #248 +- Title: Orphan `w:fldChar` caused OpenOffice to crash when opening DOCX - @ivanlanin #236 + +### Deprecated +- Static classes `Footnotes`, `Endnotes`, and `TOC` +- `Writer\Word2007\Part`: `Numbering::writeNumbering()`, `Settings::writeSettings()`, `WebSettings::writeWebSettings()`, `ContentTypes::writeContentTypes()`, `Styles::writeStyles()`, `Document::writeDocument()` all changed into `write()` +- `Writer\Word2007\Part\DocProps`: Split into `Writer\Word2007\Part\DocPropsCore` and `Writer\Word2007\Part\DocPropsApp` +- `Element\Title::getBookmarkId()` replaced by `Element\Title::getRelationId()` +- `Writer\HTML::writeDocument`: Replaced by `Writer\HTML::getContent` + +### Miscellaneous +- License: Change the project license from LGPL 2.1 into LGPL 3.0 - #211 +- Word2007 Writer: New `Style\Image` class - @ivanlanin +- Refactor: Replace static classes `Footnotes`, `Endnotes`, and `TOC` with `Collections` - @ivanlanin #206 +- QA: Reactivate `phpcpd` and `phpmd` on Travis - @ivanlanin +- Refactor: PHPMD recommendation: Change all `get...` method that returns `boolean` into `is...` or `has...` - @ivanlanin +- Docs: Create gh-pages branch for API documentation - @Progi1984 #154 +- QA: Add `.scrutinizer.yml` and include `composer.lock` for preparation to Scrutinizer - @ivanlanin #186 +- Writer: Refactor writer parts using composite pattern - @ivanlanin +- Docs: Show code quality and test code coverage badge on README +- Style: Change behaviour of `set...` function of boolean properties; when none is defined, assumed true - @ivanlanin +- Shared: Unify PHP ZipArchive and PCLZip features into PhpWord ZipArchive - @ivanlanin +- Docs: Create VERSION file - @ivanlanin +- QA: Improve dan update requirement check in `samples` folder - @ivanlanin + diff --git a/docs/changes/0.x/0.11.1.md b/docs/changes/0.x/0.11.1.md new file mode 100644 index 0000000000..19be54c67c --- /dev/null +++ b/docs/changes/0.x/0.11.1.md @@ -0,0 +1,5 @@ +# 0.11.1 (2 June 2014) + +This is an immediate bugfix release for HTML reader. + +- HTML Reader: `

` and header tags puts no output - @canyildiz @ivanlanin #257 diff --git a/docs/changes/0.x/0.12.0.md b/docs/changes/0.x/0.12.0.md new file mode 100644 index 0000000000..28a1c3ec2f --- /dev/null +++ b/docs/changes/0.x/0.12.0.md @@ -0,0 +1,60 @@ +# 0.12.0 (3 January 2015) + +This release added form fields (textinput, checkbox, and dropdown), drawing shapes (arc, curve, line, polyline, rect, oval), and basic 2D chart (pie, doughnut, bar, line, area, scatter, radar) elements along with some new styles. Basic MsDoc reader is introduced. + +### Features +- Element: Ability to add drawing shapes (arc, curve, line, polyline, rect, oval) using new `Shape` element - @ivanlanin #123 +- Font: New `scale`, `spacing`, and `kerning` property of font style - @ivanlanin +- Paragraph: Added shading to the paragraph style for full width shading - @lrobert #264 +- RTF Writer: Support for sections, margins, and borders - @ivanlanin #249 +- Section: Ability to set paper size, e.g. A4, A3, and Legal - @ivanlanin #249 +- General: New `PhpWord::save()` method to encapsulate `IOFactory` - @ivanlanin +- General: New `Shared\Converter` static class - @ivanlanin +- Chart: Basic 2D chart (pie, doughnut, bar, line, area, scatter, radar) - @ivanlanin #278 +- Chart: 3D charts and ability to set width and height - @ivanlanin +- FormField: Ability to add textinput, checkbox, and dropdown form elements - @ivanlanin #266 +- Setting: Ability to define document protection (readOnly, comments, trackedChanges, forms) - @ivanlanin +- Setting: Ability to remove [Compatibility Mode] text in the MS Word title bar - @ivanlanin +- SDT: Ability to add structured document tag elements (comboBox, dropDownList, date) - @ivanlanin +- Paragraph: Support for paragraph with borders - @ivanlanin #294 +- Word2007 Writer : Support for RTL - @Progi1984 #331 +- MsDOC Reader: Basic MsDOC Reader - @Progi1984 #23, #287 +- "absolute" horizontal and vertical positioning of Frame - @basjan #302 +- Add new-page function for PDF generation. For multiple PDF-backends - @chc88 #426 +- Report style options enumerated when style unknown - @h6w + +### Bugfixes +- Fix rare PclZip/realpath/PHP version problem - @andrew-kzoo #261 +- `addHTML` encoding and ampersand fixes for PHP 5.3 - @bskrtich #270 +- Page breaks on titles and tables - @ivanlanin #274 +- Table inside vertical border does not rendered properly - @ivanlanin #280 +- `add` of container should be case insensitive, e.g. `addToc` should be accepted, not only `addTOC` - @ivanlanin #294 +- Fix specific borders (and margins) were not written correctly in word2007 writer - @pscheit #327 +- "HTML is not a valid writer" exception while running "Sample_36_RTL.php" - @RomanSyroeshko #340 +- "addShape()" magic method in AbstractContainer is mistakenly named as "addObject()" - @GMTA #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 #401 +- `` tag is closed with `` tag: - @franzholz #438 + +### Deprecated +- `Element\Link::getTarget()` replaced by `Element\Link::getSource()` +- `Element\Section::getSettings()` and `Element\Section::setSettings()` replaced by `Element\Section::getStyle()` and `Element\Section::setStyle()` +- `Shared\Drawing` and `Shared\Font` merged into `Shared\Converter` +- `DocumentProperties` replaced by `Metadata\DocInfo` +- `Template` replaced by `TemplateProcessor` +- `PhpWord->loadTemplate($filename)` + +### Miscellaneous +- Docs: Add known issue on `README` about requirement for temporary folder to be writable and update `samples/index.php` for this requirement check - @ivanlanin #238 +- Docs: Correct elements.rst about Line - @chrissharkman #292 +- PclZip: Remove temporary file after used - @andrew-kzoo #265 +- Autoloader: Add the ability to set the autoloader options - @bskrtich #267 +- Element: Refactor elements to move set relation Id from container to element - @ivanlanin +- Introduced CreateTemporaryFileException, CopyFileException - @RomanSyroeshko +- Settings: added method to set user defined temporary directory - @RomanSyroeshko #310 +- Renamed `Template` into `TemplateProcessor` - @RomanSyroeshko #216 +- Reverted #51. All text escaping must be performed out of the library - @RomanSyroeshko #51 + + + +v \ No newline at end of file diff --git a/docs/changes/0.x/0.12.1.md b/docs/changes/0.x/0.12.1.md new file mode 100644 index 0000000000..db133ac462 --- /dev/null +++ b/docs/changes/0.x/0.12.1.md @@ -0,0 +1,11 @@ +# 0.12.1 (30 August 2015) + +Maintenance release. This release is focused primarily on `TemplateProcessor`. + +### Changes +- Changed visibility of all private properties and methods of `TemplateProcessor` to `protected`. - @RomanSyroeshko #498 +- Improved performance of `TemplateProcessor::setValue()`. - @RomanSyroeshko @nicoSWD #513 + +### Bugfixes +- Fixed issue with "Access denied" message while opening `Sample_07_TemplateCloneRow.docx` and `Sample_23_TemplateBlock.docx` result files on Windows platform. - @RomanSyroeshko @AshSat #532 +- Fixed `PreserveText` element alignment in footer (see `Sample_12_HeaderFooter.php`). - @RomanSyroeshko @SSchwaiger #495 diff --git a/docs/changes/0.x/0.13.0.md b/docs/changes/0.x/0.13.0.md new file mode 100644 index 0000000000..ece6d18990 --- /dev/null +++ b/docs/changes/0.x/0.13.0.md @@ -0,0 +1,47 @@ +# 0.13.0 (31 July 2016) + +This release brings several improvements in `TemplateProcessor`, automatic output escaping feature for OOXML, ODF, HTML, and RTF (turned off, by default). +It also introduces constants for horizontal alignment options, and resolves some issues with PHP 7. +Manual installation feature has been dropped since the release. Please, use [Composer](https://getcomposer.org/) to install PHPWord. + +### Added +- Introduced the `\PhpOffice\PhpWord\SimpleType\Jc` simple type. - @RomanSyroeshko +- Introduced the `\PhpOffice\PhpWord\SimpleType\JcTable` simple type. - @RomanSyroeshko +- Introduced writer for the "Paragraph Alignment" element (see `\PhpOffice\PhpWord\Writer\Word2007\Element\ParagraphAlignment`). - @RomanSyroeshko +- Introduced writer for the "Table Alignment" element (see `\PhpOffice\PhpWord\Writer\Word2007\Element\TableAlignment`). - @RomanSyroeshko +- Supported indexed arrays in arguments of `TemplateProcessor::setValue()`. - @RomanSyroeshko #618 +- Introduced automatic output escaping for OOXML, ODF, HTML, and RTF. To turn the feature on use `phpword.ini` or `\PhpOffice\PhpWord\Settings`. - @RomanSyroeshko #483 +- Supported processing of headers and footers in `TemplateProcessor::applyXslStyleSheet()`. - @RomanSyroeshko #335 + +### Changed +- Improved error message for the case when `autoload.php` is not found. - @RomanSyroeshko #371 +- Renamed the `align` option of `NumberingLevel`, `Frame`, `Table`, and `Paragraph` styles into `alignment`. - @RomanSyroeshko +- Improved performance of `TemplateProcessor::setValue()`. - @kazitanvirahsan #614, #617 +- Fixed some HTML tags not rendering any output (p, header & table) - #257, #324 - @twmobius and @garethellis + +### Deprecated +- `getAlign` and `setAlign` methods of `NumberingLevel`, `Frame`, `Table`, and `Paragraph` styles. +Use the correspondent `getAlignment` and `setAlignment` methods instead. - @RomanSyroeshko +- `left`, `right`, and `justify` alignment options for paragraphs (now are mapped to `Jc::START`, `Jc::END`, and `Jc::BOTH`). - @RomanSyroeshko +- `left`, `right`, and `justify` alignment options for tables (now are mapped to `Jc::START`, `Jc::END`, and `Jc::CENTER`). - @RomanSyroeshko +- `TCPDF` due to its limited HTML support. Use `DomPDF` or `MPDF` writer instead. - @RomanSyroeshko #399 + +### Removed +- `\PhpOffice\PhpWord\Style\Alignment`. Style properties, which previously stored instances of this class, now deal with strings. +In each case set of available string values is defined by the correspondent simple type. - @RomanSyroeshko +- Manual installation support. Since the release we have dependencies on third party libraries, +so installation via ZIP-archive download is not an option anymore. To install PHPWord use [Composer](https://getcomposer.org/). + We also removed `\PhpOffice\PhpWord\Autoloader`, because the latter change made it completely useless. + Autoloaders provided by Composer are in use now (see `bootstrap.php`). - @RomanSyroeshko +- `\PhpOffice\PhpWord\Shared\Drawing` replaced by `\PhpOffice\Common\Drawing`. - @Progi1984 #658 +- `\PhpOffice\PhpWord\Shared\Font`. - @Progi1984 #658 +- `\PhpOffice\PhpWord\Shared\String` replaced by `\PhpOffice\Common\Text`. - @Progi1984 @RomanSyroeshko #658 +- `\PhpOffice\PhpWord\Shared\XMLReader` replaced by `\PhpOffice\Common\XMLReader`. - @Progi1984 #658 +- `\PhpOffice\PhpWord\Shared\XMLWriter` replaced by `\PhpOffice\Common\XMLWriter`. - @Progi1984 @RomanSyroeshko #658 +- `AbstractContainer::addMemoryImage()`. Use `AbstractContainer::addImage()` instead. + +### Fixed +- `Undefined property` error while reading MS-DOC documents. - @jaberu #610 +- Corrupted OOXML template issue in case when its names is broken immediately after `$` sign. +That case wasn't taken into account in implementation of `TemplateProcessor::fixBrokenMacros()`. - @RomanSyroeshko @d-damien #548 + diff --git a/docs/changes/0.x/0.14.0.md b/docs/changes/0.x/0.14.0.md new file mode 100644 index 0000000000..c6a71267d5 --- /dev/null +++ b/docs/changes/0.x/0.14.0.md @@ -0,0 +1,47 @@ +# 0.14.0 (29 Dec 2017) + +This release fixes several bugs and adds some new features. +This version brings compatibility with PHP 7.0 & 7.1 + +### Added +- Possibility to control the footnote numbering -by [@troosan](https://github.com/troosan) in [#1068](https://github.com/PHPOffice/PHPWord/pull/1068) +- Image creation from string -by [@troosan](https://github.com/troosan) in [#937](https://github.com/PHPOffice/PHPWord/pull/937) +- Introduced the `\PhpOffice\PhpWord\SimpleType\NumberFormat` simple type. - @troosan +- Support for ContextualSpacing -by [@postHawk](https://github.com/postHawk) in [#1088](https://github.com/PHPOffice/PHPWord/pull/1088) +- Possiblity to hide spelling and/or grammatical errors -by [@troosan](https://github.com/troosan) in [#542](https://github.com/PHPOffice/PHPWord/pull/542) +- Possiblity to set default document language as well as changing the language for each text element -by [@troosan](https://github.com/troosan) in [#1108](https://github.com/PHPOffice/PHPWord/pull/1108) +- Support for Comments -by [@troosan](https://github.com/troosan) in [#1067](https://github.com/PHPOffice/PHPWord/pull/1067) +- Support for paragraph textAlignment -by [@troosan](https://github.com/troosan) in [#1165](https://github.com/PHPOffice/PHPWord/pull/1165) +- Add support for HTML underline tag `` in addHtml -by [@zNightFalLz](https://github.com/zNightFalLz) in [#1186](https://github.com/PHPOffice/PHPWord/pull/1186) +- Add support for HTML `
` in addHtml - @anrikunby [@troosan](https://github.com/troosan) in [#659](https://github.com/PHPOffice/PHPWord/pull/659) +- Allow to change cell width unit - guillaume-ro-fr #986 +- Allow to change the line height rule @troosan +- Implement PageBreak for odt writerby [@cookiekiller](https://github.com/cookiekiller) in [#863](https://github.com/PHPOffice/PHPWord/pull/863) #824 +- Allow to force an update of all fields on opening a document -by [@troosan](https://github.com/troosan) in [#951](https://github.com/PHPOffice/PHPWord/pull/951) +- Allow adding a CheckBox in a TextRun -by [@irond](https://github.com/irond) in [#727](https://github.com/PHPOffice/PHPWord/pull/727) +- Add support for HTML img tag -by [@srggroup](https://github.com/srggroup) in [#934](https://github.com/PHPOffice/PHPWord/pull/934) +- Add support for password protection for docx -by [@mariahaubner](https://github.com/mariahaubner) in [#1019](https://github.com/PHPOffice/PHPWord/pull/1019) + +### Fixed +- Loosen dependency to Zend +- Images are not being printed when generating PDF -by [@hubertinio](https://github.com/hubertinio) in [#1074](https://github.com/PHPOffice/PHPWord/pull/1074) #431 +- Fixed some PHP 7 warnings - @ likeuntomurphy #927 +- Fixed PHP 7.2 compatibility (renamed `Object` class names to `ObjectElement`) -by [@SailorMax](https://github.com/SailorMax) in [#1185](https://github.com/PHPOffice/PHPWord/pull/1185) +- Fixed Word 97 reader - @alsofronie @Benpxpxby [@mario-rivera](https://github.com/mario-rivera) in [#912](https://github.com/PHPOffice/PHPWord/pull/912) #920 #892 +- Fixed image loading over https -by [@troosan](https://github.com/troosan) in [#988](https://github.com/PHPOffice/PHPWord/pull/988) +- Impossibility to set different even and odd page headers -by [@troosan](https://github.com/troosan) in [#981](https://github.com/PHPOffice/PHPWord/pull/981) +- Fixed Word2007 reader where unnecessary paragraphs were being created -by [@donghaobo](https://github.com/donghaobo) in [#1043](https://github.com/PHPOffice/PHPWord/pull/1043) #620 +- Fixed Word2007 reader where margins were not being read correctly -by [@slowprog](https://github.com/slowprog) in [#885](https://github.com/PHPOffice/PHPWord/pull/885) #1008 +- Impossible to add element PreserveText in Section -by [@rvanlaak](https://github.com/rvanlaak) in [#452](https://github.com/PHPOffice/PHPWord/pull/452) +- Added missing options for numbering format -by [@troosan](https://github.com/troosan) in [#1041](https://github.com/PHPOffice/PHPWord/pull/1041) +- Fixed impossibility to set a different footer for first page -by [@ctrlaltca](https://github.com/ctrlaltca) in [#1116](https://github.com/PHPOffice/PHPWord/pull/1116),by [@aoloe](https://github.com/aoloe) in [#875](https://github.com/PHPOffice/PHPWord/pull/875) +- Fixed styles not being applied by HTML writer, better pdf output -by [@sarke](https://github.com/sarke) in [#1047](https://github.com/PHPOffice/PHPWord/pull/1047) #500 #1139 +- Fixed read docx error when document contains image from remote url -by [@FBnil](https://github.com/FBnil) in [#1173](https://github.com/PHPOffice/PHPWord/pull/1173) #1176 +- Padded the $args array to remove error -by [@kaigoh](https://github.com/kaigoh) in [#1150](https://github.com/PHPOffice/PHPWord/pull/1150),by [@reformed](https://github.com/reformed) in [#870](https://github.com/PHPOffice/PHPWord/pull/870) +- Fix incorrect image size between windows and mac -by [@bskrtich](https://github.com/bskrtich) in [#874](https://github.com/PHPOffice/PHPWord/pull/874) +- Fix adding HTML table to document - @mogilvieby [@arivanbastos](https://github.com/arivanbastos) in [#324](https://github.com/PHPOffice/PHPWord/pull/324) +- Fix parsing on/off values (w:val="true|false|1|0|on|off") -by [@troosan](https://github.com/troosan) in [#1221](https://github.com/PHPOffice/PHPWord/pull/1221) #1219 +- Fix error on Empty Dropdown Entry -by [@ComputerTinker](https://github.com/ComputerTinker) in [#592](https://github.com/PHPOffice/PHPWord/pull/592) + +### Deprecated +- PhpWord->getProtection(), get it from the settings instead PhpWord->getSettings()->getDocumentProtection(); diff --git a/docs/changes/0.x/0.15.0.md b/docs/changes/0.x/0.15.0.md new file mode 100644 index 0000000000..4fa0b8811d --- /dev/null +++ b/docs/changes/0.x/0.15.0.md @@ -0,0 +1,45 @@ +# 0.15.0 (14 Jul 2018) + +### Added +- Parsing of `align` HTML attribute -by [@troosan](https://github.com/troosan) in [#1231](https://github.com/PHPOffice/PHPWord/pull/1231) +- Parse formatting inside HTML lists - @troosanby [@samimussbach](https://github.com/samimussbach) in [#1239](https://github.com/PHPOffice/PHPWord/pull/1239) / [#945](https://github.com/PHPOffice/PHPWord/pull/945) / [#1215](https://github.com/PHPOffice/PHPWord/pull/1215) / [#508](https://github.com/PHPOffice/PHPWord/pull/508) +- Parsing of CSS `direction` instruction, HTML `lang` attribute, formatting inside table cell -by [@troosan](https://github.com/troosan) in [#1273](https://github.com/PHPOffice/PHPWord/pull/1273) / [#1252](https://github.com/PHPOffice/PHPWord/pull/1252) / [#1254](https://github.com/PHPOffice/PHPWord/pull/1254) +- Add support for Track changes @Cipby [@troosan](https://github.com/troosan) in [#354](https://github.com/PHPOffice/PHPWord/pull/354) / [#1262](https://github.com/PHPOffice/PHPWord/pull/1262) +- Add support for fixed Table Layout @aoloe @ekopachby [@troosan](https://github.com/troosan) in [#841](https://github.com/PHPOffice/PHPWord/pull/841) / [#1276](https://github.com/PHPOffice/PHPWord/pull/1276) +- Add support for Cell Spacing @dox07by [@troosan](https://github.com/troosan) in [#1040](https://github.com/PHPOffice/PHPWord/pull/1040) +- Add parsing of formatting inside lists @atomicalnetby [@troosan](https://github.com/troosan) in [#594](https://github.com/PHPOffice/PHPWord/pull/594) +- Added support for Vertically Raised or Lowered Text (w:position) @anrikunby [@troosan](https://github.com/troosan) in [#640](https://github.com/PHPOffice/PHPWord/pull/640) +- Add support for MACROBUTTON field @phryneasby [@troosan](https://github.com/troosan) in [#1021](https://github.com/PHPOffice/PHPWord/pull/1021) +- Add support for Hyphenationby [@Trainmaster](https://github.com/Trainmaster) in [#1282](https://github.com/PHPOffice/PHPWord/pull/1282) (Document: `autoHyphenation`, `consecutiveHyphenLimit`, `hyphenationZone`, `doNotHyphenateCaps`, Paragraph: `suppressAutoHyphens`) +- Added support for Floating Table Positioning (tblpPr)by [@anrikun](https://github.com/anrikun) in [#639](https://github.com/PHPOffice/PHPWord/pull/639) +- Added support for Image text wrapping distanceby [@troosan](https://github.com/troosan) in [#1310](https://github.com/PHPOffice/PHPWord/pull/1310) +- Added parsing of CSS line-height and text-indent in HTML readerby [@troosan](https://github.com/troosan) in [#1316](https://github.com/PHPOffice/PHPWord/pull/1316) +- Added the ability to enable gridlines and axislabels on chartsby [@FrankMeyer](https://github.com/FrankMeyer) in [#576](https://github.com/PHPOffice/PHPWord/pull/576) +- Add support for table indent (tblInd)by [@Trainmaster](https://github.com/Trainmaster) in [#1343](https://github.com/PHPOffice/PHPWord/pull/1343) +- Added parsing of internal links in HTML readerby [@lalop](https://github.com/lalop) in [#1336](https://github.com/PHPOffice/PHPWord/pull/1336) +- Several improvements to chartsby [@JAEK-S](https://github.com/JAEK-S) in [#1332](https://github.com/PHPOffice/PHPWord/pull/1332) +- Add parsing of html image in base64 formatby [@jgpATs2w](https://github.com/jgpATs2w) in [#1382](https://github.com/PHPOffice/PHPWord/pull/1382) +- Added Support for Indentation & Tabs on RTF Writer.by [@smaug1985](https://github.com/smaug1985) in [#1405](https://github.com/PHPOffice/PHPWord/pull/1405) +- Allows decimal numbers in HTML line-height styleby [@jgpATs2w](https://github.com/jgpATs2w) in [#1413](https://github.com/PHPOffice/PHPWord/pull/1413) + +### Fixed +- Fix reading of docx default style -by [@troosan](https://github.com/troosan) in [#1238](https://github.com/PHPOffice/PHPWord/pull/1238) +- Fix the size unit of when parsing html images -by [@troosan](https://github.com/troosan) in [#1254](https://github.com/PHPOffice/PHPWord/pull/1254) +- Fixed HTML parsing of nested lists -by [@troosan](https://github.com/troosan) in [#1265](https://github.com/PHPOffice/PHPWord/pull/1265) +- Save PNG alpha information when using remote images.by [@samsullivan](https://github.com/samsullivan) in [#779](https://github.com/PHPOffice/PHPWord/pull/779) +- Fix parsing of `` tag.by [@troosan](https://github.com/troosan) in [#1274](https://github.com/PHPOffice/PHPWord/pull/1274) +- Bookmark are not writton as internal link in html writerby [@troosan](https://github.com/troosan) in [#1263](https://github.com/PHPOffice/PHPWord/pull/1263) +- It should be possible to add a Footnote in a ListItemRunby [@troosan](https://github.com/troosan) in [#1287](https://github.com/PHPOffice/PHPWord/pull/1287) #1287 +- Fix colspan and rowspan for tables in HTML Writerby [@mattbolt](https://github.com/mattbolt) in [#1292](https://github.com/PHPOffice/PHPWord/pull/1292) +- Fix parsing of Heading and Title formating @troosanby [@gthomas2](https://github.com/gthomas2) in [#465](https://github.com/PHPOffice/PHPWord/pull/465) +- Fix Dateformat typo, fix hours casing, add Month-Day-Year formatsby [@ComputerTinker](https://github.com/ComputerTinker) in [#591](https://github.com/PHPOffice/PHPWord/pull/591) +- Support reading of w:drawing for documents produced by word 2011+by [@gthomas2](https://github.com/gthomas2) in [#464](https://github.com/PHPOffice/PHPWord/pull/464) #1324 +- Fix missing column width in ODText writerby [@potofcoffee](https://github.com/potofcoffee) in [#413](https://github.com/PHPOffice/PHPWord/pull/413) +- Disable entity loader before parsing XML to avoid XXE injectionby [@Tom4t0](https://github.com/Tom4t0) in [#1427](https://github.com/PHPOffice/PHPWord/pull/1427) + +### Changed +- Remove zend-stdlib dependencyby [@Trainmaster](https://github.com/Trainmaster) in [#1284](https://github.com/PHPOffice/PHPWord/pull/1284) +- The default unit for `\PhpOffice\PhpWord\Style\Image` changed from `px` to `pt`. + +### Miscellaneous +- Drop GitHub pages, switch to coveralls for code coverage analysisby [@czosel](https://github.com/czosel) in [#1360](https://github.com/PHPOffice/PHPWord/pull/1360) diff --git a/docs/changes/0.x/0.16.0.md b/docs/changes/0.x/0.16.0.md new file mode 100644 index 0000000000..3eccc34d03 --- /dev/null +++ b/docs/changes/0.x/0.16.0.md @@ -0,0 +1,27 @@ +# 0.16.0 (30 dec 2018) + +### Added +- Add getVariableCount method in TemplateProcessor.by [@nicoder](https://github.com/nicoder) in [#1272](https://github.com/PHPOffice/PHPWord/pull/1272) +- Add setting Chart Title and Legend visibilityby [@Tom-Magill](https://github.com/Tom-Magill) in [#1433](https://github.com/PHPOffice/PHPWord/pull/1433) +- Add ability to pass a Style object in Section constructorby [@ndench](https://github.com/ndench) in [#1416](https://github.com/PHPOffice/PHPWord/pull/1416) +- Add support for hidden textby [@Alexmg86](https://github.com/Alexmg86) in [#1527](https://github.com/PHPOffice/PHPWord/pull/1527) +- Add support for setting images in TemplateProcessorby [@SailorMax](https://github.com/SailorMax) in [#1170](https://github.com/PHPOffice/PHPWord/pull/1170) +- Add "Plain Text" type to SDT (Structured Document Tags)by [@morrisdj](https://github.com/morrisdj) in [#1541](https://github.com/PHPOffice/PHPWord/pull/1541) +- Added possibility to index variables inside cloned block in TemplateProcessorby [@JPBetley](https://github.com/JPBetley) in [#817](https://github.com/PHPOffice/PHPWord/pull/817) +- Added possibility to replace variables inside cloned block with values in TemplateProcessorby [@DIDoS](https://github.com/DIDoS) in [#1392](https://github.com/PHPOffice/PHPWord/pull/1392) + +### Fixed +- Fix regex in `cloneBlock` functionby [@nicoder](https://github.com/nicoder) in [#1269](https://github.com/PHPOffice/PHPWord/pull/1269) +- HTML Title Writer loses text when Title contains a TextRun instead a string.by [@begnini](https://github.com/begnini) in [#1436](https://github.com/PHPOffice/PHPWord/pull/1436) +- Fix regex in fixBrokenMacros, make it less greedy @MuriloSo @brainwoodby [@yurii-sio2](https://github.com/yurii-sio2) in [#1502](https://github.com/PHPOffice/PHPWord/pull/1502) / [#1345](https://github.com/PHPOffice/PHPWord/pull/1345) +- 240 twips are being added to line spacing, should not happen when using lineRule fixedby [@troosan](https://github.com/troosan) in [#1509](https://github.com/PHPOffice/PHPWord/pull/1509) / [#1505](https://github.com/PHPOffice/PHPWord/pull/1505) +- Adding table layout to the generated HTMLby [@aarangara](https://github.com/aarangara) in [#1441](https://github.com/PHPOffice/PHPWord/pull/1441) +- Fix loading of Sharepoint documentby [@Garrcomm](https://github.com/Garrcomm) in [#1498](https://github.com/PHPOffice/PHPWord/pull/1498) +- RTF writer: Round getPageSizeW and getPageSizeH to avoid decimalsby [@Patrick64](https://github.com/Patrick64) in [#1493](https://github.com/PHPOffice/PHPWord/pull/1493) +- Fix parsing of Office 365 documentsby [@Timanx](https://github.com/Timanx) in [#1485](https://github.com/PHPOffice/PHPWord/pull/1485) +- For RTF writers, sizes should should never have decimalsby [@Samuel-BF](https://github.com/Samuel-BF) in [#1536](https://github.com/PHPOffice/PHPWord/pull/1536) +- Style Name Parsing fails if document generated by a non-english word versionby [@begnini](https://github.com/begnini) in [#1434](https://github.com/PHPOffice/PHPWord/pull/1434) + +### Miscellaneous +- Get rid of duplicated code in TemplateProcessorby [@abcdmitry](https://github.com/abcdmitry) in [#1161](https://github.com/PHPOffice/PHPWord/pull/1161) + diff --git a/docs/changes/0.x/0.17.0.md b/docs/changes/0.x/0.17.0.md new file mode 100644 index 0000000000..ffd2d91dd4 --- /dev/null +++ b/docs/changes/0.x/0.17.0.md @@ -0,0 +1,27 @@ +# 0.17.0 (01 oct 2019) + +### Added +- Add methods setValuesFromArray and cloneRowFromArray to the TemplateProcessor [@geraldb-nicat](https://github.com/geraldb-nicat) GH-670 +- Set complex type in template [@troosan](https://github.com/troosan) GH-1565 +- implement support for section vAlign [@troosan](https://github.com/troosan) GH-1569 +- ParseStyle for border-color [@Gllrm0](https://github.com/Gllrm0) GH-1551 +- Html writer auto invert text color [@SailorMax](https://github.com/SailorMax) GH-1387 +- Add RightToLeft table presentation. [@troosan](https://github.com/troosan) GH-1550 +- Add support for page vertical alignment. [@troosan](https://github.com/troosan) GH-672 GH-1569 +- Adding setNumId method for ListItem style [@eweso](https://github.com/eweso) GH-1329 +- Add support for basic fields in RTF writer. [@Samuel-BF](https://github.com/Samuel-BF) GH-1717 + +### Fixed +- Fix HTML border-color parsing. [@troosan](https://github.com/troosan) GH-1551 / GH-1570 +- Language::validateLocale should pass with locale 'zxx'. [@efpapado](https://github.com/efpapado) GH-1558 +- can't align center vertically with the text [@ter987](https://github.com/ter987) GH-672 +- fix parsing of border-color and add test [@troosan](https://github.com/troosan) GH-1570 +- TrackChange doesn't handle all return types of \DateTime::createFromFormat(...) [@superhaggis](https://github.com/superhaggis) GH-1584 +- To support PreserveText inside sub container [@bhattnishant](https://github.com/bhattnishant) GH-1637 +- No nested w:pPr elements in ListItemRun. [@waltertamboer](https://github.com/waltertamboer) GH-1628 +- Ensure that entity_loader disable variable is re-set back to the original setting [@seamuslee001](https://github.com/seamuslee001) GH-1585 + +### Miscellaneous +- Use embedded http server to test loading of remote images [@troosan](https://github.com/troosan) GH-1544 +- Change private to protected to be able extending class Html [@SpinyMan](https://github.com/SpinyMan) GH-1646 +- Fix apt-get crash in Travis CI for PHP 5.3 [@mdupont](https://github.com/mdupont) GH-1707 \ No newline at end of file diff --git a/docs/changes/0.x/0.18.0.md b/docs/changes/0.x/0.18.0.md new file mode 100644 index 0000000000..5f9d6a4d2f --- /dev/null +++ b/docs/changes/0.x/0.18.0.md @@ -0,0 +1,47 @@ +# [0.18.0](https://github.com/PHPOffice/PHPWord/tree/0.18.0) (2021-02-12) + +[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.17.0...0.18.0) + +### Enhancements +- Add support for charts in template processor [#2012](https://github.com/PHPOffice/PHPWord/pull/2012) ([@dbarzin](https://github.com/dbarzin)) +- add/setting page element border style. [#1986](https://github.com/PHPOffice/PHPWord/pull/1986) ([@emnabs](https://github.com/emnabs)) +- allow to use customized pdf library [#1983](https://github.com/PHPOffice/PHPWord/pull/1983) ([@SailorMax](https://github.com/SailorMax)) +- feat: Update addHtml to handle style inheritance [#1965](https://github.com/PHPOffice/PHPWord/pull/1965) ([@Julien1138](https://github.com/Julien1138)) +- Add parsing of Shape node values [#1924](https://github.com/PHPOffice/PHPWord/pull/1924) ([@sven-ahrens](https://github.com/sven-ahrens)) +- Allow to redefine TCPDF object [#1907](https://github.com/PHPOffice/PHPWord/pull/1907) ([@SailorMax](https://github.com/SailorMax)) +- Enhancements to addHTML parser [#1902](https://github.com/PHPOffice/PHPWord/pull/1902) ([@lubosdz](https://github.com/lubosdz)) +- Make Default Paper Configurable [#1851](https://github.com/PHPOffice/PHPWord/pull/1851) ([@oleibman](https://github.com/oleibman)) +- Implement various missing features for the ODT writer [#1796](https://github.com/PHPOffice/PHPWord/pull/1796) ([@oleibman](https://github.com/oleibman)) +- Added support for "cloudConvert" images [#1794](https://github.com/PHPOffice/PHPWord/pull/1794) ([@ErnestStaug](https://github.com/ErnestStaug)) +- Add support for several features for the RTF writer [#1775](https://github.com/PHPOffice/PHPWord/pull/1775) ([@oleibman](https://github.com/oleibman)) +- Add font style for Field elements [#1774](https://github.com/PHPOffice/PHPWord/pull/1774) ([@oleibman](https://github.com/oleibman)) +- Add support for ListItemRun in HTML writer [#1766](https://github.com/PHPOffice/PHPWord/pull/1766) ([@stefan-91](https://github.com/stefan-91)) +- Improvements in RTF writer [#1755](https://github.com/PHPOffice/PHPWord/pull/1755) ([@oleibman](https://github.com/oleibman)) +- Allow a closure to be passed with image replacement tags [#1716](https://github.com/PHPOffice/PHPWord/pull/1716) ([@mbardelmeijer](https://github.com/mbardelmeijer)) +- Add Option for Dynamic Chart Legend Position [#1699](https://github.com/PHPOffice/PHPWord/pull/1699) ([@Stephan212](https://github.com/Stephan212)) +- Add parsing of HTML checkbox input field [#1832](https://github.com/PHPOffice/PHPWord/pull/1832) ([@Matze2010](https://github.com/Matze2010)) + +### Bug fixes +- Fix image stroke in libreoffice 7.x [#1992](https://github.com/PHPOffice/PHPWord/pull/1992) ([@Adizbek](https://github.com/Adizbek)) +- Fix deprecated warning for non-hexadecimal number [#1988](https://github.com/PHPOffice/PHPWord/pull/1988) ([@Ciki](https://github.com/Ciki)) +- Fix limit not taken into account when adding image in template [#1967](https://github.com/PHPOffice/PHPWord/pull/1967) ([@jsochor](https://github.com/jsochor)) +- Add null check when setComplexValue is not found [#1936](https://github.com/PHPOffice/PHPWord/pull/1936) ([@YannikFirre](https://github.com/YannikFirre)) +- Some document have non-standard locale code [#1824](https://github.com/PHPOffice/PHPWord/pull/1824) ([@ErnestStaug](https://github.com/ErnestStaug)) +- Fixes PHPDoc @param and @return types for several Converter methods [#1818](https://github.com/PHPOffice/PHPWord/pull/1818) ([@caugner](https://github.com/caugner)) +- Update the regexp to avoid catastrophic backtracking [#1809](https://github.com/PHPOffice/PHPWord/pull/1809) ([@juzser](https://github.com/juzser)) +- Fix PHPUnit tests on develop branch [#1771](https://github.com/PHPOffice/PHPWord/pull/1771) ([@mdupont](https://github.com/mdupont)) +- TemplateProcessor cloneBlock wrongly clones images [#1763](https://github.com/PHPOffice/PHPWord/pull/1763) ([@alarai](https://github.com/alarai)) + +### Miscellaneous +- Compatibility with PHP 7.4, PHP 8.0 and migrate to Laminas Escaper [#1946](https://github.com/PHPOffice/PHPWord/pull/1946) ([@liborm85](https://github.com/liborm85)) +- Remove legacy PHPOffice/Common package, fix PHP 8.0 compatibility [#1996](https://github.com/PHPOffice/PHPWord/pull/1996) ([@liborm85](https://github.com/liborm85)) +- Improve Word2007 Test Coverage [#1858](https://github.com/PHPOffice/PHPWord/pull/1858) ([@oleibman](https://github.com/oleibman)) +- Fix typo in docs. Update templates-processing.rst [#1952](https://github.com/PHPOffice/PHPWord/pull/1952) ([@mnvx](https://github.com/mnvx)) +- Fix documentation and method name for FootnoteProperties [#1776](https://github.com/PHPOffice/PHPWord/pull/1776) ([@mdupont](https://github.com/mdupont)) +- fix: documentation about paragraph indentation [#1764](https://github.com/PHPOffice/PHPWord/pull/1764) ([@mdupont](https://github.com/mdupont)) +- Update templates-processing.rst [#1745](https://github.com/PHPOffice/PHPWord/pull/1745) ([@igronus](https://github.com/igronus)) +- Unused variables $rows, $cols in sample [#1877](https://github.com/PHPOffice/PHPWord/pull/1877) ([@ThanasisMpalatsoukas](https://github.com/ThanasisMpalatsoukas)) +- Add unit test for NumberingStyle [#1744](https://github.com/PHPOffice/PHPWord/pull/1744) ([@Manunchik](https://github.com/Manunchik)) +- Add unit test for PhpWord Settings [#1743](https://github.com/PHPOffice/PHPWord/pull/1743) (@[Manunchik](https://github.com/Manunchik)) +- Add unit test for Media elements [#1742](https://github.com/PHPOffice/PHPWord/pull/1742) ([@Manunchik](https://github.com/Manunchik)) +- Update templates processing docs [#1729](https://github.com/PHPOffice/PHPWord/pull/1729) ([@hcdias](https://github.com/hcdias)) diff --git a/docs/changes/0.x/0.18.1.md b/docs/changes/0.x/0.18.1.md new file mode 100644 index 0000000000..f4e1547a26 --- /dev/null +++ b/docs/changes/0.x/0.18.1.md @@ -0,0 +1,7 @@ +# [0.18.1](https://github.com/PHPOffice/PHPWord/tree/0.18.1) (2021-03-08) + +[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.0...0.18.1) + +### Bug fixes +- Fix BC break in GH-1946. + This package does not replace laminas/laminas-zendframework-bridge by [@mussbach](https://github.com/mussbach) in [#2032](https://github.com/PHPOffice/PHPWord/pull/2032) \ No newline at end of file diff --git a/docs/changes/0.x/0.18.2.md b/docs/changes/0.x/0.18.2.md new file mode 100644 index 0000000000..fe40b7eb3a --- /dev/null +++ b/docs/changes/0.x/0.18.2.md @@ -0,0 +1,14 @@ +# [0.18.2](https://github.com/PHPOffice/PHPWord/tree/0.18.2) (2021-06-04) + +[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.1...0.18.2) + +### Bug fixes +- when adding image to relationship first check that the generated RID is actually unique by [@tpv-ebben](https://github.com/tpv-ebben) in [#2063](https://github.com/PHPOffice/PHPWord/pull/2063) +- Update chart, don't write 'c:overlap' if grouping is 'clustered' by [@dfsd534](https://github.com/dfsd534) in [#2052](https://github.com/PHPOffice/PHPWord/pull/2052) +- Update Html parser to accept line-height:normal by [@joelgo](https://github.com/joelgo) in [#2041](https://github.com/PHPOffice/PHPWord/pull/2041) +- Fix image border in Word2007 Writer for LibreOffice 7 by [k@amilmmach](https://github.com/kamilmmach) in [#2021](https://github.com/PHPOffice/PHPWord/pull/2021) + +### Miscellaneous +- Corrected namespace for Language class in docs by [@MegaChriz](https://github.com/MegaChriz) in [#2087](https://github.com/PHPOffice/PHPWord/pull/2087) +- Added support for Garamond font by [@artemkolotilkin](https://github.com/artemkolotilkin) in [#2078](https://github.com/PHPOffice/PHPWord/pull/2078) +- Add BorderStyle for Cell Style to documentation by [@DShkrabak](https://github.com/DShkrabak) in [#2090](https://github.com/PHPOffice/PHPWord/pull/2090) diff --git a/docs/changes/0.x/0.18.3.md b/docs/changes/0.x/0.18.3.md new file mode 100644 index 0000000000..123fe1f2b0 --- /dev/null +++ b/docs/changes/0.x/0.18.3.md @@ -0,0 +1,6 @@ +# [0.18.3](https://github.com/PHPOffice/PHPWord/tree/0.18.3) (2022-02-17) + +[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.2...0.18.3) + +### Bug fixes +- PHP 8.1 compatibility diff --git a/docs/changes/0.x/0.7.0.md b/docs/changes/0.x/0.7.0.md new file mode 100644 index 0000000000..11c3784bc3 --- /dev/null +++ b/docs/changes/0.x/0.7.0.md @@ -0,0 +1,26 @@ +# 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 #1 +- Implement ODT Writer - @Progi1984 #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 #32 +- PHPWord_Shared_String.IsUTF8 returns FALSE for Cyrillic UTF-8 input - @RomanSyroeshko #34 +- Temporary files naming logic in PHPWord_Template can lead to a collision - @RomanSyroeshko #38 + +### Miscellaneous +- Add superscript/subscript styling in Excel2007 Writer - @MarkBaker +- add indentation support to paragraphs - @deds +- Support for Composer - @Progi1984 #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 [#49](http://phpword.codeplex.com/workitem/49) \ No newline at end of file diff --git a/docs/changes/0.x/0.8.0.md b/docs/changes/0.x/0.8.0.md new file mode 100644 index 0000000000..6d5ae7c37c --- /dev/null +++ b/docs/changes/0.x/0.8.0.md @@ -0,0 +1,45 @@ +# 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 #56, #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 #5 +- General: Add ability to manage line breaks after image insertion - @bskrtich #6, #66, #84 +- Template: Ability to limit number of replacements performed by setValue() method of Template class - @RomanSyroeshko #52, #53, #85 +- Table row: Repeat as header row & allow row to break across pages - @ivanlanin #48, #86 +- Table: Table width in percentage - @ivanlanin #48, #86 +- Font: Superscript and subscript - @ivanlanin #48, #86 +- Paragraph: Hanging paragraph - @ivanlanin #48, #86 +- Section: Multicolumn and section break - @ivanlanin #48, #86 +- Template: Ability to apply XSL style sheet to Template - @RomanSyroeshko #46, #47, #83 +- General: PHPWord_Shared_Font::pointSizeToTwips() converter - @ivanlanin #87 +- Paragraph: Ability to define normal paragraph style with PHPWord::setNormalStyle() - @ivanlanin #87 +- Paragraph: Ability to define parent style (basedOn) and style for following paragraph (next) - @ivanlanin #87 +- Clone table rows on the fly when using a template document - @jeroenmoors #44, #88 +- Initial addition of basic footnote support - @deds #16 +- Paragraph: Ability to define paragraph pagination: widow control, keep next, keep lines, and page break before - @ivanlanin #92 +- General: PHPWord_Style_Font refactoring - @ivanlanin #93 +- Font: Use points instead of halfpoints internally. Conversion to halfpoints done during XML Writing. - @ivanlanin #93 +- Paragraph: setTabs() function - @ivanlanin #92 +- General: Basic support for TextRun on ODT and RTF - @ivanlanin #99 +- Reader: Basic Reader for Word2007 - @ivanlanin #104 +- TextRun: Allow Text Break in Text Run - @bskrtich #109 +- General: Support for East Asian fontstyle - @jhfangying #111, #118 +- Image: Use exif_imagetype to check image format instead of extension name - @gabrielbull #114 +- General: Setting for XMLWriter Compatibility option - @bskrtich #103 +- MemoryImage: Allow remote image when allow_url_open = on - @ivanlanin #122 +- TextBreak: Allow font and paragraph style for text break - @ivanlanin #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 #51 +- Example in README.md is broken - @Progi1984 #89 +- General: PHPWord_Shared_Drawing::centimetersToPixels() conversion - @ivanlanin #94 +- Footnote: Corrupt DOCX reported by MS Word when sections > 1 and not every sections have footnote - @ivanlanin #125 + +### Miscellaneous +- UnitTests - @Progi1984 \ No newline at end of file diff --git a/docs/changes/0.x/0.8.1.md b/docs/changes/0.x/0.8.1.md new file mode 100644 index 0000000000..340e6e369a --- /dev/null +++ b/docs/changes/0.x/0.8.1.md @@ -0,0 +1,9 @@ + +# 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 + + + diff --git a/docs/changes/0.x/0.9.0.md b/docs/changes/0.x/0.9.0.md new file mode 100644 index 0000000000..8b96f24a77 --- /dev/null +++ b/docs/changes/0.x/0.9.0.md @@ -0,0 +1,19 @@ +# 0.9.0 (26 Mar 2014) + +This release marked the transformation to namespaces (PHP 5.3+). + +### Features +- Image: Ability to use remote or GD images using `addImage()` on sections, headers, footer, cells, and textruns - @ivanlanin +- Header: Ability to use remote or GD images using `addWatermark()` - @ivanlanin + +### Bugfixes +- Preserve text doesn't render correctly when the text is not the first word, e.g. 'Page {PAGE}' - @ivanlanin + +### Miscellaneous +- Move documentation to [Read The Docs](http://phpword.readthedocs.org/en/develop/) - by [@Progi1984](https://github.com/Progi1984) & [@ivanlanin](https://github.com/ivanlanin) in [#82](https://github.com/PHPOffice/PHPWord/pull/82) +- Reorganize and redesign samples folder - @ivanlanin #137 +- Use `PhpOffice\PhpWord` namespace for PSR compliance - @RomanSyroeshko @gabrielbull #159, #58 +- Restructure folders and change folder name `Classes` to `src` and `Tests` to `test` for PSR compliance - @RomanSyroeshko @gabrielbull +- Compliance to phpDocumentor - @ivanlanin +- Merge Style\TableFull into Style\Table. Style\TableFull is deprecated - @ivanlanin #160 +- Merge Section\MemoryImage into Section\Image. Section\Image is deprecated - @ivanlanin #160 diff --git a/docs/changes/0.x/0.9.1.md b/docs/changes/0.x/0.9.1.md new file mode 100644 index 0000000000..9278f916cf --- /dev/null +++ b/docs/changes/0.x/0.9.1.md @@ -0,0 +1,8 @@ + +# 0.9.1 (27 Mar 2014) + +This is a bugfix release for PSR-4 compatibility. + +- Fixed PSR-4 composer autoloader - @AntonTyutin + + diff --git a/docs/changes/1.x/1.0.0.md b/docs/changes/1.x/1.0.0.md new file mode 100644 index 0000000000..4240a0bd18 --- /dev/null +++ b/docs/changes/1.x/1.0.0.md @@ -0,0 +1,110 @@ +# [1.0.0](https://github.com/PHPOffice/PHPWord/tree/1.0.0) (2022-11-15) + +[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.3...1.0.0) + +### BREAKING CHANGE + +Most deprecated things were dropped. See details in +https://github.com/PHPOffice/PHPWord/commit/b9f1151bc6f90c276153c3c9dca10a5fc7f355fb. + +#### Dropped classes: + +- `PhpOffice\PhpWord\Template` + +#### Dropped constants: + +- `PhpOffice\PhpWord\Style\Font::UNDERLINE_DOTHASH` +- `PhpOffice\PhpWord\Style\Font::UNDERLINE_DOTHASHHEAVY` +- `PhpOffice\PhpWord\Style\Cell::VALIGN_TOP` +- `PhpOffice\PhpWord\Style\Cell::VALIGN_CENTER` +- `PhpOffice\PhpWord\Style\Cell::VALIGN_BOTTOM` +- `PhpOffice\PhpWord\Style\Cell::VALIGN_BOTH` +- `PhpOffice\PhpWord\Style\TOC::TABLEADER_DOT` +- `PhpOffice\PhpWord\Style\TOC::TABLEADER_UNDERSCORE` +- `PhpOffice\PhpWord\Style\TOC::TABLEADER_LINE` +- `PhpOffice\PhpWord\Style\TOC::TABLEADER_NONE` +- `PhpOffice\PhpWord\Style\Table::WIDTH_AUTO` +- `PhpOffice\PhpWord\Style\Table::WIDTH_PERCENT` +- `PhpOffice\PhpWord\Style\Table::WIDTH_TWIP` +- `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_NAME` +- `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_SIZE` +- `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_COLOR` +- `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_CONTENT_TYPE` +- +#### Dropped methods: + +- `PhpOffice\PhpWord\Ekement\AbstractContainer::createTextRun()` +- `PhpOffice\PhpWord\Ekement\AbstractContainer::createFootnote()` +- `PhpOffice\PhpWord\Ekement\Footnote::getReferenceId()` +- `PhpOffice\PhpWord\Ekement\Footnote::setReferenceId()` +- `PhpOffice\PhpWord\Ekement\Image::getIsWatermark()` +- `PhpOffice\PhpWord\Ekement\Image::getIsMemImage()` +- `PhpOffice\PhpWord\Ekement\Link::getTarget()` +- `PhpOffice\PhpWord\Ekement\Link::getLinkSrc()` +- `PhpOffice\PhpWord\Ekement\Link::getLinkName()` +- `PhpOffice\PhpWord\Ekement\OLEObject::getObjectId()` +- `PhpOffice\PhpWord\Ekement\OLEObject::setObjectId()` +- `PhpOffice\PhpWord\Ekement\Section::getFootnotePropoperties()` +- `PhpOffice\PhpWord\Ekement\Section::setSettings()` +- `PhpOffice\PhpWord\Ekement\Section::getSettings()` +- `PhpOffice\PhpWord\Ekement\Section::createHeader()` +- `PhpOffice\PhpWord\Ekement\Section::createFooter()` +- `PhpOffice\PhpWord\Ekement\Section::getFooter()` +- `PhpOffice\PhpWord\Media::addSectionMediaElement()` +- `PhpOffice\PhpWord\Media::addSectionLinkElement()` +- `PhpOffice\PhpWord\Media::getSectionMediaElements()` +- `PhpOffice\PhpWord\Media::countSectionMediaElements()` +- `PhpOffice\PhpWord\Media::addHeaderMediaElement()` +- `PhpOffice\PhpWord\Media::countHeaderMediaElements()` +- `PhpOffice\PhpWord\Media::getHeaderMediaElements()` +- `PhpOffice\PhpWord\Media::addFooterMediaElement()` +- `PhpOffice\PhpWord\Media::countFooterMediaElements()` +- `PhpOffice\PhpWord\Media::getFooterMediaElements()` +- `PhpOffice\PhpWord\PhpWord::getProtection()` +- `PhpOffice\PhpWord\PhpWord::loadTemplate()` +- `PhpOffice\PhpWord\PhpWord::createSection()` +- `PhpOffice\PhpWord\PhpWord::getDocumentProperties()` +- `PhpOffice\PhpWord\PhpWord::setDocumentProperties()` +- `PhpOffice\PhpWord\Reader\AbstractReader::getReadDataOnly()` +- `PhpOffice\PhpWord\Settings::getCompatibility()` +- `PhpOffice\PhpWord\Style\AbstractStyle::setArrayStyle()` +- `PhpOffice\PhpWord\Style\Cell::getDefaultBorderColor()` +- `PhpOffice\PhpWord\Style\Font::getBold()` +- `PhpOffice\PhpWord\Style\Font::getItalic()` +- `PhpOffice\PhpWord\Style\Font::getSuperScript()` +- `PhpOffice\PhpWord\Style\Font::getSubScript()` +- `PhpOffice\PhpWord\Style\Font::getStrikethrough()` +- `PhpOffice\PhpWord\Style\Font::getParagraphStyle()` +- `PhpOffice\PhpWord\Style\Frame::getAlign()` +- `PhpOffice\PhpWord\Style\Frame::setAlign()` +- `PhpOffice\PhpWord\Style\NumberingLevel::getAlign()` +- `PhpOffice\PhpWord\Style\NumberingLevel::setAlign()` +- `PhpOffice\PhpWord\Style\Paragraph::getAlign()` +- `PhpOffice\PhpWord\Style\Paragraph::setAlign()` +- `PhpOffice\PhpWord\Style\Paragraph::getWidowControl()` +- `PhpOffice\PhpWord\Style\Paragraph::getKeepNext()` +- `PhpOffice\PhpWord\Style\Paragraph::getKeepLines()` +- `PhpOffice\PhpWord\Style\Paragraph::getPageBreakBefore()` +- `PhpOffice\PhpWord\Style\Row::getTblHeader()` +- `PhpOffice\PhpWord\Style\Row::isTblHeader()` +- `PhpOffice\PhpWord\Style\Row::getCantSplit()` +- `PhpOffice\PhpWord\Style\Row::getExactHeight()` +- `PhpOffice\PhpWord\Style\Spacing::getRule()` +- `PhpOffice\PhpWord\Style\Spacing::setRule()` +- `PhpOffice\PhpWord\Style\Table::getAlign()` +- `PhpOffice\PhpWord\Style\Table::setAlign()` +- `PhpOffice\PhpWord\Writer\AbstractWriter::getUseDiskCaching()` +- `PhpOffice\PhpWord\Writer\HTML::writeDocument()` + +### Bug fixes + +- Multiple PHP 8.1 fixes +- `loadConfig` returns config that was actually applied +- HTML Reader : Override inline style on HTML attribute for table +- HTML Reader : Use `border` attribute for tables +- HTML Reader : Style page-break-after in paragraph +- HTML Reader : Heading in Text Run is not allowed + +### Miscellaneous + +- Drop support for PHP 7.0 and older \ No newline at end of file diff --git a/docs/changes/1.x/1.1.0.md b/docs/changes/1.x/1.1.0.md new file mode 100644 index 0000000000..1fee96fb87 --- /dev/null +++ b/docs/changes/1.x/1.1.0.md @@ -0,0 +1,24 @@ +# [1.1.0](https://github.com/PHPOffice/PHPWord/tree/1.1.0) (2023-05-30) + +[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.0.0...1.1.0) + +### Enhancements + +- Introduce deleteRow() method for TemplateProcessor +- HTML Reader: Add basic support for CSS Style Tag +- Allow customizing macro syntax in TemplateProcessor +- Add background color support for textboxes +- Add softhyphen support to word reader +- Add support table row height when importing HTML +- Add support for fractional font sizes +- Added image quality support, with the maximum quality as default +- Support for reading nested tables + +### Bug fixes + +- DOCX reader: Read empty vmerge +- Fixed setting width of Cell Style + +### Miscellaneous + +- `master` is the new default branch \ No newline at end of file diff --git a/docs/changes/1.x/1.2.0.md b/docs/changes/1.x/1.2.0.md new file mode 100644 index 0000000000..e52771c08c --- /dev/null +++ b/docs/changes/1.x/1.2.0.md @@ -0,0 +1,30 @@ +# [1.2.0](https://github.com/PHPOffice/PHPWord/tree/1.2.0) (WIP) + +[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.1.0...1.2.0) + +## Enhancements + +- Word2007 Reader/Writer : Added noWrap table cell property by [@kernusr](https://github.com/kernusr) in GH-2359 +- HTML Reader : Support for `font-variant: small-caps` by [@cambraca](https://github.com/cambraca) in GH-2117 +- Improved TextDirection for styling a cell by [@terryzwt](https://github.com/terryzwt) in GH-2429 +- Word2007 Reader : Added option to disable loading images by [@aelliott1485](https://github.com/aelliott1485) in GH-2450 +- HTML Writer : Added border-spacing to default styles for table by [@kernusr](https://github.com/kernusr) in GH-2451 +- Word2007 Reader : Support for table cell borders and margins by [@kernusr](https://github.com/kernusr) in GH-2454 + +### Bug fixes + +- Fixed wrong mimetype for docx files by [@gamerlv](https://github.com/gamerlv) in GH-2416 +- Word2007 Reader : Read hyperlingks in headings by [@hannesdorn](https://github.com/hannesdorn) in GH-2433 +- PclZip : strtr using empty string by [@spl1nes](https://github.com/spl1nes) in GH-2432 +- Fixed PHP 8.2 deprecated about Allow access to an undefined property by [@DAdq26](https://github.com/DAdq26) in GH-2440 +- Template Processor : Fixed choose dimention for Float Value by [@gdevilbat](https://github.com/gdevilbat) in GH-2449 +- HTML Parser : Fix image parsing from url without extension by [@JokubasR](https://github.com/JokubasR) in GH-2459 + +### Miscellaneous + +- Added PHPStan by [@PowerKiKi](https://github.com/PowerKiKi) in GH-2405 +- Bump symfony/process from 4.4.44 to 5.4.26 by [@dependabot](https://github.com/dependabot) in GH-2431 +- Bump phpunit/phpunit from 9.6.8 to 9.6.10 by [@dependabot](https://github.com/dependabot) in GH-2430 +- Added Coveralls.io by [@Progi1984](https://github.com/Progi1984) in GH-2452 +- Added support for PHP 8.2 & PHP 8.3 by [@Progi1984](https://github.com/Progi1984) in GH-2453 +- Moved documention from ReadTheDocs to MkDocs & Github Pages by [@Progi1984](https://github.com/Progi1984) in GH-2465 \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index ef7b2dcf6c..0000000000 --- a/docs/conf.py +++ /dev/null @@ -1,290 +0,0 @@ -# -*- coding: utf-8 -*- -# -# PhpWord documentation build configuration file, created by -# sphinx-quickstart on Fri Mar 14 23:09:26 2014. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'PHPWord' -copyright = u'2014-2021, PHPWord Contributors' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.18.2' -# The full version, including alpha/beta/rc tags. -release = version - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -#html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'PHPWorddoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'PHPWord.tex', u'PHPWord Documentation', - u'The PHPWord Team', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'PHPWord', u'PHPWord Documentation', - [u'The PHPWord Team'], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------------ - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'PHPWord', u'PHPWord Documentation', - u'The PHPWord Team', 'PHPWord', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = u'PHPWord' -epub_author = u'The PHPWord Team' -epub_publisher = u'The PHPWord Team' -epub_copyright = copyright - -# The language of the text. It defaults to the language option -# or en if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# A tuple containing the cover image and cover page html template filenames. -#epub_cover = () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -#epub_exclude_files = [] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True - -# Highlight PHP without starting addText($text, [$fontStyle], [$paragraphStyle]); - $textrun = $section->addTextRun([$paragraphStyle]); - -- ``$text``. Text to be displayed in the document. -- ``$fontStyle``. See :ref:`font-style`. -- ``$paragraphStyle``. See :ref:`paragraph-style`. - -For available styling options see :ref:`font-style` and :ref:`paragraph-style`. - -If you want to enable track changes on added text you can mark it as INSERTED or DELETED by a specific user at a given time: - -.. code-block:: php - - $text = $section->addText('Hello World!'); - $text->setChanged(\PhpOffice\PhpWord\Element\ChangedElement::TYPE_INSERTED, 'Fred', (new \DateTime())); - -Titles -~~~~~~ - -If you want to structure your document or build table of contents, you need titles or headings. -To add a title to the document, use the ``addTitleStyle`` and ``addTitle`` method. -If `depth` is 0, a Title will be inserted, otherwise a Heading1, Heading2, ... - -.. code-block:: php - - $phpWord->addTitleStyle($depth, [$fontStyle], [$paragraphStyle]); - $section->addTitle($text, [$depth]); - -- ``depth``. -- ``$fontStyle``. See :ref:`font-style`. -- ``$paragraphStyle``. See :ref:`paragraph-style`. -- ``$text``. Text to be displayed in the document. This can be `string` or a `\PhpOffice\PhpWord\Element\TextRun` - -It's necessary to add a title style to your document because otherwise the title won't be detected as a real title. - -Links -~~~~~ - -You can add Hyperlinks to the document by using the function addLink: - -.. code-block:: php - - $section->addLink($linkSrc, [$linkName], [$fontStyle], [$paragraphStyle]); - -- ``$linkSrc``. The URL of the link. -- ``$linkName``. Placeholder of the URL that appears in the document. -- ``$fontStyle``. See :ref:`font-style`. -- ``$paragraphStyle``. See :ref:`paragraph-style`. - -Preserve texts -~~~~~~~~~~~~~~ - -The ``addPreserveText`` method is used to add a page number or page count to headers or footers. - -.. code-block:: php - - $footer->addPreserveText('Page {PAGE} of {NUMPAGES}.'); - -Breaks ------- - -Text breaks -~~~~~~~~~~~ - -Text breaks are empty new lines. To add text breaks, use the following syntax. All parameters are optional. - -.. code-block:: php - - $section->addTextBreak([$breakCount], [$fontStyle], [$paragraphStyle]); - -- ``$breakCount``. How many lines. -- ``$fontStyle``. See :ref:`font-style`. -- ``$paragraphStyle``. See :ref:`paragraph-style`. - -Page breaks -~~~~~~~~~~~ - -There are two ways to insert a page break, using the ``addPageBreak`` -method or using the ``pageBreakBefore`` style of paragraph. - -.. code-block:: php - - $section->addPageBreak(); - -Lists ------ - -Lists can be added by using ``addListItem`` and ``addListItemRun`` methods. -``addListItem`` is used for creating lists that only contain plain text. -``addListItemRun`` is used for creating complex list items that contains texts -with different style (some bold, other italics, etc) or other elements, e.g. -images or links. The syntaxes are as follow: - -Basic usage: - -.. code-block:: php - - $section->addListItem($text, [$depth], [$fontStyle], [$listStyle], [$paragraphStyle]); - $listItemRun = $section->addListItemRun([$depth], [$listStyle], [$paragraphStyle]) - -Parameters: - -- ``$text``. Text that appears in the document. -- ``$depth``. Depth of list item. -- ``$fontStyle``. See :ref:`font-style`. -- ``$listStyle``. List style of the current element TYPE\_NUMBER, - TYPE\_ALPHANUM, TYPE\_BULLET\_FILLED, etc. See list of constants in PHPWord\\Style\\ListItem. -- ``$paragraphStyle``. See :ref:`paragraph-style`. - -See ``Sample_14_ListItem.php`` for more code sample. - -Advanced usage: - -You can also create your own numbering style by changing the ``$listStyle`` parameter with the name of your numbering style. - -.. code-block:: php - - $phpWord->addNumberingStyle( - 'multilevel', - array( - 'type' => 'multilevel', - 'levels' => array( - array('format' => 'decimal', 'text' => '%1.', 'left' => 360, 'hanging' => 360, 'tabPos' => 360), - array('format' => 'upperLetter', 'text' => '%2.', 'left' => 720, 'hanging' => 360, 'tabPos' => 720), - ) - ) - ); - $section->addListItem('List Item I', 0, null, 'multilevel'); - $section->addListItem('List Item I.a', 1, null, 'multilevel'); - $section->addListItem('List Item I.b', 1, null, 'multilevel'); - $section->addListItem('List Item II', 0, null, 'multilevel'); - -For available styling options see :ref:`numbering-level-style`. - -Tables ------- - -To add tables, rows, and cells, use the ``addTable``, ``addRow``, and ``addCell`` methods: - -.. code-block:: php - - $table = $section->addTable([$tableStyle]); - $table->addRow([$height], [$rowStyle]); - $cell = $table->addCell($width, [$cellStyle]); - -Table style can be defined with ``addTableStyle``: - -.. code-block:: php - - $tableStyle = array( - 'borderColor' => '006699', - 'borderSize' => 6, - 'cellMargin' => 50 - ); - $firstRowStyle = array('bgColor' => '66BBFF'); - $phpWord->addTableStyle('myTable', $tableStyle, $firstRowStyle); - $table = $section->addTable('myTable'); - -For available styling options see :ref:`table-style`. - -Cell span -~~~~~~~~~ - -You can span a cell on multiple columns by using ``gridSpan`` or multiple rows by using ``vMerge``. - -.. code-block:: php - - $cell = $table->addCell(200); - $cell->getStyle()->setGridSpan(5); - -See ``Sample_09_Tables.php`` for more code sample. - -Images ------- - -To add an image, use the ``addImage`` method to sections, headers, footers, textruns, or table cells. - -.. code-block:: php - - $section->addImage($src, [$style]); - -- ``$src``. String path to a local image, URL of a remote image or the image data, as a string. Warning: Do not pass user-generated strings here, as that would allow an attacker to read arbitrary files or perform server-side request forgery by passing file paths or URLs instead of image data. -- ``$style``. See :ref:`image-style`. - -Examples: - -.. code-block:: php - - $section = $phpWord->addSection(); - $section->addImage( - 'mars.jpg', - array( - 'width' => 100, - 'height' => 100, - 'marginTop' => -1, - 'marginLeft' => -1, - 'wrappingStyle' => 'behind' - ) - ); - $footer = $section->addFooter(); - $footer->addImage('http://example.com/image.php'); - $textrun = $section->addTextRun(); - $textrun->addImage('http://php.net/logo.jpg'); - $source = file_get_contents('/path/to/my/images/earth.jpg'); - $textrun->addImage($source); - -Watermarks -~~~~~~~~~~ - -To add a watermark (or page background image), your section needs a -header reference. After creating a header, you can use the -``addWatermark`` method to add a watermark. - -.. code-block:: php - - $section = $phpWord->addSection(); - $header = $section->addHeader(); - $header->addWatermark('resources/_earth.jpg', array('marginTop' => 200, 'marginLeft' => 55)); - -Objects -------- - -You can add OLE embeddings, such as Excel spreadsheets or PowerPoint -presentations to the document by using ``addOLEObject`` method. - -.. code-block:: php - - $section->addOLEObject($src, [$style]); - -Table of contents ------------------ - -To add a table of contents (TOC), you can use the ``addTOC`` method. -Your TOC can only be generated if you have add at least one title (See "Titles"). - -.. code-block:: php - - $section->addTOC([$fontStyle], [$tocStyle], [$minDepth], [$maxDepth]); - -- ``$fontStyle``. See font style section. -- ``$tocStyle``. See available options below. -- ``$minDepth``. Minimum depth of header to be shown. Default 1. -- ``$maxDepth``. Maximum depth of header to be shown. Default 9. - -Options for ``$tocStyle``: - -- ``tabLeader``. Fill type between the title text and the page number. Use the defined constants in ``\PhpOffice\PhpWord\Style\TOC``. -- ``tabPos``. The position of the tab where the page number appears in *twip*. -- ``indent``. The indent factor of the titles in *twip*. - -Footnotes & endnotes --------------------- - -You can create footnotes with ``addFootnote`` and endnotes with -``addEndnote`` in texts or textruns, but it's recommended to use textrun -to have better layout. You can use ``addText``, ``addLink``, -``addTextBreak``, ``addImage``, ``addOLEObject`` on footnotes and endnotes. - -On textrun: - -.. code-block:: php - - $textrun = $section->addTextRun(); - $textrun->addText('Lead text.'); - $footnote = $textrun->addFootnote(); - $footnote->addText('Footnote text can have '); - $footnote->addLink('http://test.com', 'links'); - $footnote->addText('.'); - $footnote->addTextBreak(); - $footnote->addText('And text break.'); - $textrun->addText('Trailing text.'); - $endnote = $textrun->addEndnote(); - $endnote->addText('Endnote put at the end'); - -On text: - -.. code-block:: php - - $section->addText('Lead text.'); - $footnote = $section->addFootnote(); - $footnote->addText('Footnote text.'); - -By default the footnote reference number will be displayed with decimal number -starting from 1. This number uses the ``FooterReference`` style which you can -redefine with the ``addFontStyle`` method. Default value for this style is -``array('superScript' => true)``; - -The footnote numbering can be controlled by setting the FootnoteProperties on the Section. - -.. code-block:: php - - $fp = new \PhpOffice\PhpWord\ComplexType\FootnoteProperties(); - //sets the position of the footnote (pageBottom (default), beneathText, sectEnd, docEnd) - $fp->setPos(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::POSITION_BENEATH_TEXT); - //set the number format to use (decimal (default), upperRoman, upperLetter, ...) - $fp->setNumFmt(\PhpOffice\PhpWord\SimpleType\NumberFormat::LOWER_ROMAN); - //force starting at other than 1 - $fp->setNumStart(2); - //when to restart counting (continuous (default), eachSect, eachPage) - $fp->setNumRestart(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::RESTART_NUMBER_EACH_PAGE); - //And finaly, set it on the Section - $section->setFootnoteProperties($fp); - -Checkboxes ----------- - -Checkbox elements can be added to sections or table cells by using ``addCheckBox``. - -.. code-block:: php - - $section->addCheckBox($name, $text, [$fontStyle], [$paragraphStyle]) - -- ``$name``. Name of the check box. -- ``$text``. Text to be displayed in the document. -- ``$fontStyle``. See :ref:`font-style`. -- ``$paragraphStyle``. See :ref:`paragraph-style`. - -Textboxes ---------- - -To be completed - -Fields ------- - -Currently the following fields are supported: - -- PAGE -- NUMPAGES -- DATE -- XE -- INDEX - -.. code-block:: php - - $section->addField($fieldType, [$properties], [$options], [$fieldText], [$fontStyle]) - -- ``$fontStyle``. See :ref:`font-style`. - -See ``\PhpOffice\PhpWord\Element\Field`` for list of properties and options available for each field type. -Options which are not specifically defined can be added. Those must start with a ``\``. - -For instance for the INDEX field, you can do the following (See `Index Field for list of available options `_ ): - -.. code-block:: php - - //the $fieldText can be either a simple string - $fieldText = 'The index value'; - - //or a 'TextRun', to be able to format the text you want in the index - $fieldText = new TextRun(); - $fieldText->addText('My '); - $fieldText->addText('bold index', ['bold' => true]); - $fieldText->addText(' entry'); - $section->addField('XE', array(), array(), $fieldText); - - //this actually adds the index - $section->addField('INDEX', array(), array('\\e " " \\h "A" \\c "3"'), 'right click to update index'); - -Line ----- - -Line elements can be added to sections by using ``addLine``. - -.. code-block:: php - - $lineStyle = array('weight' => 1, 'width' => 100, 'height' => 0, 'color' => 635552); - $section->addLine($lineStyle); - -Available line style attributes: - -- ``weight``. Line width in *twip*. -- ``color``. Defines the color of stroke. -- ``dash``. Line types: dash, rounddot, squaredot, dashdot, longdash, longdashdot, longdashdotdot. -- ``beginArrow``. Start type of arrow: block, open, classic, diamond, oval. -- ``endArrow``. End type of arrow: block, open, classic, diamond, oval. -- ``width``. Line-object width in *pt*. -- ``height``. Line-object height in *pt*. -- ``flip``. Flip the line element: true, false. - -Chart ------ - -Charts can be added using - -.. code-block:: php - - $categories = array('A', 'B', 'C', 'D', 'E'); - $series = array(1, 3, 2, 5, 4); - $chart = $section->addChart('line', $categories, $series, $style); - -For available styling options see :ref:`chart-style`. - -check out the Sample_32_Chart.php for more options and styling. - -Comments --------- - -Comments can be added to a document by using ``addComment``. -The comment can contain formatted text. Once the comment has been added, it can be linked to any element with ``setCommentStart``. - -.. code-block:: php - - // first create a comment - $comment= new \PhpOffice\PhpWord\Element\Comment('Authors name', new \DateTime(), 'my_initials'); - $comment->addText('Test', array('bold' => true)); - - // add it to the document - $phpWord->addComment($comment); - - $textrun = $section->addTextRun(); - $textrun->addText('This '); - $text = $textrun->addText('is'); - // link the comment to the text you just created - $text->setCommentStart($comment); - -If no end is set for a comment using the ``setCommentEnd``, the comment will be ended automatically at the end of the element it is started on. - -Track Changes -------------- - -Track changes can be set on text elements. There are 2 ways to set the change information on an element. -Either by calling the `setChangeInfo()`, or by setting the `TrackChange` instance on the element with `setTrackChange()`. - -.. code-block:: php - - $phpWord = new \PhpOffice\PhpWord\PhpWord(); - - // New portrait section - $section = $phpWord->addSection(); - $textRun = $section->addTextRun(); - - $text = $textRun->addText('Hello World! Time to '); - - $text = $textRun->addText('wake ', array('bold' => true)); - $text->setChangeInfo(TrackChange::INSERTED, 'Fred', time() - 1800); - - $text = $textRun->addText('up'); - $text->setTrackChange(new TrackChange(TrackChange::INSERTED, 'Fred')); - - $text = $textRun->addText('go to sleep'); - $text->setChangeInfo(TrackChange::DELETED, 'Barney', new \DateTime('@' . (time() - 3600))); diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000000..81341fbc18 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,5 @@ +# Frequently asked questions + +## How contribute to PHPWord? +- Improve the documentation + diff --git a/docs/faq.rst b/docs/faq.rst deleted file mode 100644 index 451e1d7305..0000000000 --- a/docs/faq.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _faq: - -Frequently asked questions -========================== - -How contribute to PHPWord? --------------------------- -- Improve the documentation (`Sphinx Format `__) diff --git a/docs/general.rst b/docs/general.rst deleted file mode 100644 index 145df162ab..0000000000 --- a/docs/general.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _general: - -General usage -============= - -Basic example -------------- - -The following is a basic example of the PHPWord library. More examples -are provided in the `samples -folder `__. - -.. code-block:: php - - addSection(); - // Adding Text element to the Section having font styled by default... - $section->addText( - '"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( - '"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( - '"The greatest accomplishment is not in never falling, ' - . 'but in rising again after you fall." ' - . '(Vince Lombardi)', - $fontStyleName - ); - - // 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('"Believe you can and you\'re halfway there." (Theodor Roosevelt)'); - $myTextElement->setFontStyle($fontStyle); - - // 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. */ - -PHPWord Settings ----------------- - -The ``PhpOffice\PhpWord\Settings`` class provides some options that will -affect the behavior of PHPWord. Below are the options. - -XML Writer compatibility -~~~~~~~~~~~~~~~~~~~~~~~~ - -This option sets -`XMLWriter::setIndent `__ -and -`XMLWriter::setIndentString `__. -The default value of this option is ``true`` (compatible), which is -`required for -OpenOffice `__ to -render OOXML document correctly. You can set this option to ``false`` -during development to make the resulting XML file easier to read. - -.. code-block:: php - - \PhpOffice\PhpWord\Settings::setCompatibility(false); - -Zip class -~~~~~~~~~ - -By default, PHPWord uses `Zip extension `__ -to deal with ZIP compressed archives and files inside them. If you can't have -Zip extension installed on your server, you can use pure PHP library -alternative, `PclZip `__, which is -included in PHPWord. - -.. code-block:: php - - \PhpOffice\PhpWord\Settings::setZipClass(\PhpOffice\PhpWord\Settings::PCLZIP); - -Output escaping -~~~~~~~~~~~~~~~ - -Writing documents of some formats, especially XML-based, requires correct output escaping. -Without it your document may become broken when you put special characters like ampersand, quotes, and others in it. - -Escaping can be performed in two ways: outside of the library by a software developer and inside of the library by built-in mechanism. -By default, the built-in mechanism is disabled for backward compatibility with versions prior to v0.13.0. -To turn it on set ``outputEscapingEnabled`` option to ``true`` in your PHPWord configuration file or use the following instruction at runtime: - -.. code-block:: php - - \PhpOffice\PhpWord\Settings::setOutputEscapingEnabled(true); - -Default Paper -~~~~~~~~~~~~~ - -By default, all sections of the document will print on A4 paper. -You can alter the default paper by using the following function: - -.. code-block:: php - - \PhpOffice\PhpWord\Settings::setDefaultPaper('Letter'); - -Default font -~~~~~~~~~~~~ - -By default, every text appears in Arial 10 point. You can alter the -default font by using the following two functions: - -.. code-block:: php - - $phpWord->setDefaultFontName('Times New Roman'); - $phpWord->setDefaultFontSize(12); - -Document settings ------------------ -Settings for the generated document can be set using ``$phpWord->getSettings()`` - -Magnification Setting -~~~~~~~~~~~~~~~~~~~~~ -The default zoom value is 100 percent. This can be changed either to another percentage - -.. code-block:: php - - $phpWord->getSettings()->setZoom(75); - -Or to predefined values ``fullPage``, ``bestFit``, ``textFit`` - -.. code-block:: php - - $phpWord->getSettings()->setZoom(Zoom::BEST_FIT); - -Mirroring the Page Margins -~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use mirror margins to set up facing pages for double-sided documents, such as books or magazines. - -.. code-block:: php - - $phpWord->getSettings()->setMirrorMargins(true); - -Spelling and grammatical checks -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -By default spelling and grammatical errors are shown as soon as you open a word document. -For big documents this can slow down the opening of the document. You can hide the spelling and/or grammatical errors with: - -.. code-block:: php - - $phpWord->getSettings()->setHideGrammaticalErrors(true); - $phpWord->getSettings()->setHideSpellingErrors(true); - -You can also specify the status of the spell and grammar checks, marking spelling or grammar as dirty will force a re-check when opening the document. - -.. code-block:: php - - $proofState = new \PhpOffice\PhpWord\ComplexType\ProofState(); - $proofState->setGrammar(\PhpOffice\PhpWord\ComplexType\ProofState::CLEAN); - $proofState->setSpelling(\PhpOffice\PhpWord\ComplexType\ProofState::DIRTY); - - $phpWord->getSettings()->setProofState($proofState); - -Track Revisions -~~~~~~~~~~~~~~~ -Track changes can be activated using ``setTrackRevisions``, you can furture specify - -- Not to use move syntax, instead moved items will be seen as deleted in one place and added in another -- Not track formatting revisions - -.. code-block:: php - - $phpWord->getSettings()->setTrackRevisions(true); - $phpWord->getSettings()->setDoNotTrackMoves(true); - $phpWord->getSettings()->setDoNotTrackFormatting(true); - -Decimal Symbol -~~~~~~~~~~~~~~ -The default symbol to represent a decimal figure is the ``.`` in english. In french you might want to change it to ``,`` for instance. - -.. code-block:: php - - $phpWord->getSettings()->setDecimalSymbol(','); - -Document Language -~~~~~~~~~~~~~~~~~ -The default language of the document can be change with the following. - -.. code-block:: php - - $phpWord->getSettings()->setThemeFontLang(new Language(Language::FR_BE)); - -``Language`` has 3 parameters, one for Latin languages, one for East Asian languages and one for Complex (Bi-Directional) languages. -A couple of language codes are provided in the ``PhpOffice\PhpWord\Style\Language`` class but any valid code/ID can be used. - -In case you are generating an RTF document the language need to be set differently. - -.. code-block:: php - - $lang = new Language(); - $lang->setLangId(Language::EN_GB_ID); - $phpWord->getSettings()->setThemeFontLang($lang); - -Document information --------------------- - -You can set the document information such as title, creator, and company -name. Use the following functions: - -.. code-block:: php - - $properties = $phpWord->getDocInfo(); - $properties->setCreator('My name'); - $properties->setCompany('My factory'); - $properties->setTitle('My title'); - $properties->setDescription('My description'); - $properties->setCategory('My category'); - $properties->setLastModifiedBy('My name'); - $properties->setCreated(mktime(0, 0, 0, 3, 12, 2014)); - $properties->setModified(mktime(0, 0, 0, 3, 14, 2014)); - $properties->setSubject('My subject'); - $properties->setKeywords('my, key, word'); - -Measurement units ------------------ - -The base length unit in Open Office XML is twip. Twip means "TWentieth -of an Inch Point", i.e. 1 twip = 1/1440 inch. - -You can use PHPWord helper functions to convert inches, centimeters, or -points to twip. - -.. code-block:: php - - // Paragraph with 6 points space after - $phpWord->addParagraphStyle('My Style', array( - 'spaceAfter' => \PhpOffice\PhpWord\Shared\Converter::pointToTwip(6)) - ); - - $section = $phpWord->addSection(); - $sectionStyle = $section->getStyle(); - // half inch left margin - $sectionStyle->setMarginLeft(\PhpOffice\PhpWord\Shared\Converter::inchToTwip(.5)); - // 2 cm right margin - $sectionStyle->setMarginRight(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(2)); - -Document protection -------------------- - -The document (or parts of it) can be password protected. - -.. code-block:: php - - $documentProtection = $phpWord->getSettings()->getDocumentProtection(); - $documentProtection->setEditing(DocProtect::READ_ONLY); - $documentProtection->setPassword('myPassword'); - -Automatically Recalculate Fields on Open ----------------------------------------- - -To force an update of the fields present in the document, set updateFields to true - -.. code-block:: php - - $phpWord->getSettings()->setUpdateFields(true); - -Hyphenation ------------ -Hyphenation describes the process of breaking words with hyphens. There are several options to control hyphenation. - -Auto hyphenation -~~~~~~~~~~~~~~~~ - -To automatically hyphenate text set ``autoHyphenation`` to ``true``. - -.. code-block:: php - - $phpWord->getSettings()->setAutoHyphenation(true); - -Consecutive Hyphen Limit -~~~~~~~~~~~~~~~~~~~~~~~~ - -The maximum number of consecutive lines of text ending with a hyphen can be controlled by the ``consecutiveHyphenLimit`` option. -There is no limit if the option is not set or the provided value is ``0``. - -.. code-block:: php - - $phpWord->getSettings()->setConsecutiveHyphenLimit(2); - -Hyphenation Zone -~~~~~~~~~~~~~~~~ - -The hyphenation zone (in *twip*) is the allowed amount of whitespace before hyphenation is applied. -The smaller the hyphenation zone the more words are hyphenated. Or in other words, the wider the hyphenation zone the less words are hyphenated. - -.. code-block:: php - - $phpWord->getSettings()->setHyphenationZone(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(1)); - -Hyphenate Caps -~~~~~~~~~~~~~~ - -To control whether or not words in all capital letters shall be hyphenated use the `doNotHyphenateCaps` option. - -.. code-block:: php - - $phpWord->getSettings()->setDoNotHyphenateCaps(true); diff --git a/docs/howto.md b/docs/howto.md new file mode 100644 index 0000000000..f53217f869 --- /dev/null +++ b/docs/howto.md @@ -0,0 +1,101 @@ +# How to + +## Create float left image + +Use absolute positioning relative to margin horizontally and to line vertically. + +``` php + 40, + 'height' => 40, + 'wrappingStyle' => 'square', + 'positioning' => 'absolute', + 'posHorizontalRel' => 'margin', + 'posVerticalRel' => 'line', +); +$textrun->addImage('resources/_earth.jpg', $imageStyle); +``` + +## Download the produced file automatically + +Use ``php://output`` as the filename. + +``` php +addSection(); +$section->addText('Hello World!'); +$file = 'HelloWorld.docx'; +header("Content-Description: File Transfer"); +header('Content-Disposition: attachment; filename="' . $file . '"'); +header('Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document'); +header('Content-Transfer-Encoding: binary'); +header('Cache-Control: must-revalidate, post-check=0, pre-check=0'); +header('Expires: 0'); +$xmlWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'Word2007'); +$xmlWriter->save("php://output"); +``` + +## Create numbered headings + +Define a numbering style and title styles, and match the two styles (with ``pStyle`` and ``numStyle``) like below. + +``` php +addNumberingStyle( + 'hNum', + array('type' => 'multilevel', 'levels' => array( + array('pStyle' => 'Heading1', 'format' => 'decimal', 'text' => '%1'), + array('pStyle' => 'Heading2', 'format' => 'decimal', 'text' => '%1.%2'), + array('pStyle' => 'Heading3', 'format' => 'decimal', 'text' => '%1.%2.%3'), + ) + ) +); +$phpWord->addTitleStyle(1, array('size' => 16), array('numStyle' => 'hNum', 'numLevel' => 0)); +$phpWord->addTitleStyle(2, array('size' => 14), array('numStyle' => 'hNum', 'numLevel' => 1)); +$phpWord->addTitleStyle(3, array('size' => 12), array('numStyle' => 'hNum', 'numLevel' => 2)); + +$section->addTitle('Heading 1', 1); +$section->addTitle('Heading 2', 2); +$section->addTitle('Heading 3', 3); +``` + +## Add a link within a title + +Apply 'HeadingN' paragraph style to TextRun or Link. Sample code: + +``` php +addTitleStyle(1, array('size' => 16, 'bold' => true)); +$phpWord->addTitleStyle(2, array('size' => 14, 'bold' => true)); +$phpWord->addFontStyle('Link', array('color' => '0000FF', 'underline' => 'single')); + +$section = $phpWord->addSection(); + +// Textrun +$textrun = $section->addTextRun('Heading1'); +$textrun->addText('The '); +$textrun->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord', 'Link'); + +// Link +$section->addLink('https://github.com/', 'GitHub', 'Link', 'Heading2'); +``` + +## Remove [Compatibility Mode] text in the MS Word title bar + +Use the ``Metadata\Compatibility\setOoxmlVersion(n)`` method with ``n`` is the version of Office: + +* 14 = Office 2010 +* 15 = Office 2013 + +``` php +getCompatibility()->setOoxmlVersion(15); +``` diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000..1398fd90c4 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,115 @@ +# + +![PHPWord](images/phpword.svg) + +PHPWord is a library written in pure PHP that provides a set ofclasses to write to different document file formats, i.e. [Microsoft Office Open XML](http://en.wikipedia.org/wiki/Office_Open_XML)(`.docx`), OASIS [Open Document Format for Office Applications](http://en.wikipedia.org/wiki/OpenDocument) (`.odt`), [Rich Text Format](http://en.wikipedia.org/wiki/Rich_Text_Format) (`.rtf`), [Microsoft Word Binary File](https://en.wikipedia.org/wiki/Doc_(computing)) (`.doc`), HTML (`.html`), and PDF (`.pdf`). + +PHPWord is an open source project licensed under the terms of [LGPL version 3](https://github.com/PHPOffice/PHPWord/blob/master/COPYING.LESSER). PHPWord is aimed to be a high quality software product by incorporating [continuous integration and unit testing](https://github.com/PHPOffice/PHPWord/actions/workflows/php.yml). You can learn more about PHPWord by reading this Developers'Documentation. + + +## Features + +- 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 +- Insert drawing shapes (arc, curve, line, polyline, rect, oval) +- Insert charts (pie, doughnut, bar, line, area, scatter, radar) +- Insert form fields (textinput, checkbox, and dropdown) +- Create document from templates +- Use XSL 1.0 style sheets to transform headers, main document part, and footers of an OOXML template +- ... and many more features on progress + +## File formats + +Below are the supported features for each file formats. + + +### Writers + + +| Features | | OOXML | ODF | RTF | HTML | PDF | +|---------------------------|----------------------|--------|-------|-------|--------|--------| +| **Document Properties** | Standard | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | +| | Custom | :material-check: | :material-check: | | | | +| **Element Type** | Text | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | +| | Text Run | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | +| | Title | :material-check: | :material-check: | | :material-check: | :material-check: | +| | Link | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | +| | Preserve Text | :material-check: | | | | | +| | Text Break | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | +| | Page Break | :material-check: | | :material-check: | | | +| | List | :material-check: | | | | | +| | Table | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | +| | Image | :material-check: | :material-check: | :material-check: | :material-check: | | +| | Object | :material-check: | | | | | +| | Watermark | :material-check: | | | | | +| | Table of Contents | :material-check: | | | | | +| | Header | :material-check: | | | | | +| | Footer | :material-check: | | | | | +| | Footnote | :material-check: | | | :material-check: | | +| | Endnote | :material-check: | | | :material-check: | | +| | Comments | :material-check: | | | | | +| **Graphs** | 2D basic graphs | :material-check: | | | | | +| | 2D advanced graphs | | | | | | +| | 3D graphs | :material-check: | | | | | +| **Math** | OMML support | | | | | | +| | MathML support | | | | | | +| **Bonus** | Encryption | | | | | | +| | Protection | | | | | | + +### Readers + + +| Features | | OOXML | DOC | ODF | RTF | HTML | +|---------------------------|----------------------|--------|-------|-------|-------|-------| +| **Document Properties** | Standard | :material-check: | | | | | +| | Custom | :material-check: | | | | | +| **Element Type** | Text | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | +| | Text Run | :material-check: | | | | | +| | Title | :material-check: | | :material-check: | | | +| | Link | :material-check: | :material-check: | | | | +| | Preserve Text | :material-check: | | | | | +| | Text Break | :material-check: | :material-check: | | | | +| | Page Break | :material-check: | | | | | +| | List | :material-check: | | :material-check: | | :material-check: | +| | Table | :material-check: | | | | :material-check: | +| | Image | :material-check: | :material-check: | | | | +| | Object | | | | | | +| | Watermark | | | | | | +| | Table of Contents | | | | | | +| | Header | :material-check: | | | | | +| | Footer | :material-check: | | | | | +| | Footnote | :material-check: | | | | | +| | Endnote | :material-check: | | | | | +| | Comments | | | | | | +| **Graphs** | 2D basic graphs | | | | | | +| | 2D advanced graphs | | | | | | +| | 3D graphs | | | | | | +| **Math** | OMML support | | | | | | +| | MathML support | | | | | | +| **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 [master](https://github.com/PHPOffice/PHPWord/tree/master) branch +- Submit [bug reports or feature requests](https://github.com/PHPOffice/PHPWord/issues) to GitHub +- Follow [@PHPOffice](https://twitter.com/PHPOffice) on Twitter diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 671c32a64c..0000000000 --- a/docs/index.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. PHPWord documentation master file, created by - sphinx-quickstart on Fri Mar 14 23:09:26 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to PHPWord's documentation -================================== - -|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 (OOXML or OpenXML), OASIS Open -Document Format for Office Applications (OpenDocument or ODF), and Rich Text -Format (RTF). - -.. toctree:: - :maxdepth: 2 - - intro - installing - general - containers - elements - styles - templates-processing - writersreaders - recipes - faq - credits - references - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - -.. |PHPWord| image:: images/phpword.png diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 0000000000..1b54a3173f --- /dev/null +++ b/docs/install.md @@ -0,0 +1,52 @@ +# Installation + +## Requirements + +Mandatory: + +- PHP 7.1+ +- PHP [DOM extension](http://php.net/manual/en/book.dom.php) +- PHP [JSON extension](http://php.net/manual/en/book.json.php) +- PHP [XML Parser extension](http://www.php.net/manual/en/xml.installation.php) +- PHP [XMLWriter extension](http://php.net/manual/en/book.xmlwriter.php) + + +## Installation + +There are two ways to install PHPWord, i.e. via [Composer](http://getcomposer.org) or manually by downloading the library. + +### Using Composer + +To install via Composer, add the following lines to your `composer.json`: + +``` json +{ + "require": { + "phpoffice/phpword": "dev-master" + } +} +``` + + +### Using manual install +To install manually: + +* [download PHPOffice\PHPWord package from GitHub](https://github.com/PHPOffice/PHPWord/archive/master.zip) +* [download PHPOffice\Common package from GitHub](https://github.com/PHPOffice/Common/archive/master.zip) +* extract the package and put the contents to your machine. + + +``` php +`__ extension - -Optional: - -- `Zip `__ extension -- `GD `__ extension -- `XMLWriter `__ extension -- `XSL `__ extension -- `dompdf `__ library - -Installation ------------- - -PHPWord is installed via `Composer `__. -You just need to `add dependency `__ on PHPWord into your package. - -Example: - -.. code-block:: bash - - composer require phpoffice/phpword - -If you are a developer or if you want to help us with testing then fetch the latest branch for developers. -Notice: all contributions must be done against the developer branch. - -Example: - -.. code-block:: bash - - composer require phpoffice/phpword:dev-master - -Using samples -------------- - -More examples are provided in the ``samples`` directory. -For an easy access to those samples launch ``php -S localhost:8000`` in the samples directory then browse to http://localhost:8000 to view the samples. diff --git a/docs/intro.rst b/docs/intro.rst deleted file mode 100644 index 94cc48d19e..0000000000 --- a/docs/intro.rst +++ /dev/null @@ -1,196 +0,0 @@ -.. _intro: - -Introduction -============ - -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 `__ (OOXML or -OpenXML), OASIS `Open Document Format for Office -Applications `__ -(OpenDocument or ODF), and `Rich Text -Format `__ (RTF). - -PHPWord is an open source project licensed under the terms of `LGPL -version 3 `__. -PHPWord is aimed to be a high quality software product. -You can learn more about PHPWord by reading this Developers' -Documentation. - -Features --------- - -- 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 right-to-left text -- 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 -- Insert drawing shapes (arc, curve, line, polyline, rect, oval) -- Insert charts (pie, doughnut, bar, line, area, scatter, radar) -- Insert form fields (textinput, checkbox, and dropdown) -- Insert comments -- Create document from templates -- Use XSL 1.0 style sheets to transform headers, main document part, and footers of an OOXML template -- ... and many more features on progress - -File formats ------------- - -Below are the supported features for each file formats. - -Writers -~~~~~~~ - -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| Features | | OOXML | ODF | RTF | HTML | PDF | -+===========================+======================+========+=======+=======+========+=======+ -| **Document Properties** | Standard | ✓ | ✓ | ✓ | ✓ | ✓ | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Custom | ✓ | ✓ | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| **Element Type** | Text | ✓ | ✓ | ✓ | ✓ | ✓ | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Text Run | ✓ | ✓ | ✓ | ✓ | ✓ | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Title | ✓ | ✓ | | ✓ | ✓ | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Link | ✓ | ✓ | ✓ | ✓ | ✓ | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Preserve Text | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Text Break | ✓ | ✓ | ✓ | ✓ | ✓ | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Page Break | ✓ | | ✓ | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | List | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Table | ✓ | ✓ | ✓ | ✓ | ✓ | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Image | ✓ | ✓ | ✓ | ✓ | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Object | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Watermark | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Table of Contents | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Header | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Footer | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Footnote | ✓ | | | ✓ | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Endnote | ✓ | | | ✓ | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Comments | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| **Graphs** | 2D basic graphs | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | 2D advanced graphs | | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | 3D graphs | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| **Math** | OMML support | | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | MathML support | | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| **Bonus** | Encryption | | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ -| | Protection | | | | | | -+---------------------------+----------------------+--------+-------+-------+--------+-------+ - -Readers -~~~~~~~ - -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| Features | | OOXML | DOC | ODF | RTF | HTML | -+===========================+======================+========+=======+=======+=======+=======+ -| **Document Properties** | Standard | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Custom | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| **Element Type** | Text | ✓ | ✓ | ✓ | ✓ | ✓ | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Text Run | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Title | ✓ | | ✓ | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Link | ✓ | ✓ | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Preserve Text | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Text Break | ✓ | ✓ | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Page Break | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | List | ✓ | | ✓ | | ✓ | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Table | ✓ | | | | ✓ | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Image | ✓ | ✓ | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Object | | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Watermark | | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Table of Contents | | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Header | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Footer | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Footnote | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Endnote | ✓ | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | Comments | | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| **Graphs** | 2D basic graphs | | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | 2D advanced graphs | | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | 3D graphs | | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| **Math** | OMML support | | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| | MathML support | | | | | | -+---------------------------+----------------------+--------+-------+-------+-------+-------+ -| **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 `__. -- `Fork us `__ and `request - a pull `__ to the - `master `__ - branch. -- Submit `bug reports or feature - requests `__ to GitHub. -- Follow `@PHPWord `__ and - `@PHPOffice `__ on Twitter. diff --git a/docs/recipes.rst b/docs/recipes.rst deleted file mode 100644 index b470d28615..0000000000 --- a/docs/recipes.rst +++ /dev/null @@ -1,97 +0,0 @@ -.. _recipes: - -Recipes -======= - -Create float left image ------------------------ - -Use absolute positioning relative to margin horizontally and to line vertically. - -.. code-block:: php - - $imageStyle = array( - 'width' => 40, - 'height' => 40, - 'wrappingStyle' => 'square', - 'positioning' => 'absolute', - 'posHorizontalRel' => 'margin', - 'posVerticalRel' => 'line', - ); - $textrun->addImage('resources/_earth.jpg', $imageStyle); - $textrun->addText($lipsumText); - -Download the produced file automatically ----------------------------------------- - -Use ``php://output`` as the filename. - -.. code-block:: php - - $phpWord = new \PhpOffice\PhpWord\PhpWord(); - $section = $phpWord->addSection(); - $section->addText('Hello World!'); - $file = 'HelloWorld.docx'; - header("Content-Description: File Transfer"); - header('Content-Disposition: attachment; filename="' . $file . '"'); - header('Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document'); - header('Content-Transfer-Encoding: binary'); - header('Cache-Control: must-revalidate, post-check=0, pre-check=0'); - header('Expires: 0'); - $xmlWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'Word2007'); - $xmlWriter->save("php://output"); - -Create numbered headings ------------------------- - -Define a numbering style and title styles, and match the two styles (with ``pStyle`` and ``numStyle``) like below. - -.. code-block:: php - - $phpWord->addNumberingStyle( - 'hNum', - array('type' => 'multilevel', 'levels' => array( - array('pStyle' => 'Heading1', 'format' => 'decimal', 'text' => '%1'), - array('pStyle' => 'Heading2', 'format' => 'decimal', 'text' => '%1.%2'), - array('pStyle' => 'Heading3', 'format' => 'decimal', 'text' => '%1.%2.%3'), - ) - ) - ); - $phpWord->addTitleStyle(1, array('size' => 16), array('numStyle' => 'hNum', 'numLevel' => 0)); - $phpWord->addTitleStyle(2, array('size' => 14), array('numStyle' => 'hNum', 'numLevel' => 1)); - $phpWord->addTitleStyle(3, array('size' => 12), array('numStyle' => 'hNum', 'numLevel' => 2)); - - $section->addTitle('Heading 1', 1); - $section->addTitle('Heading 2', 2); - $section->addTitle('Heading 3', 3); - -Add a link within a title -------------------------- - -Apply 'HeadingN' paragraph style to TextRun or Link. Sample code: - -.. code-block:: php - - $phpWord = new \PhpOffice\PhpWord\PhpWord(); - $phpWord->addTitleStyle(1, array('size' => 16, 'bold' => true)); - $phpWord->addTitleStyle(2, array('size' => 14, 'bold' => true)); - $phpWord->addFontStyle('Link', array('color' => '0000FF', 'underline' => 'single')); - - $section = $phpWord->addSection(); - - // Textrun - $textrun = $section->addTextRun('Heading1'); - $textrun->addText('The '); - $textrun->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord', 'Link'); - - // Link - $section->addLink('https://github.com/', 'GitHub', 'Link', 'Heading2'); - -Remove [Compatibility Mode] text in the MS Word title bar ---------------------------------------------------------- - -Use the ``Metadata\Compatibility\setOoxmlVersion(n)`` method with ``n`` is the version of Office (14 = Office 2010, 15 = Office 2013). - -.. code-block:: php - - $phpWord->getCompatibility()->setOoxmlVersion(15); diff --git a/docs/references.rst b/docs/references.rst deleted file mode 100644 index a17f558db6..0000000000 --- a/docs/references.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. _references: - -References -========== - -ISO/IEC 29500, Third edition, 2012-09-01 ----------------------------------------- - -- `Part 1: Fundamentals and Markup Language Reference - `__ -- `Part 2: Open Packaging Conventions - `__ -- `Part 3: Markup Compatibility and Extensibility - `__ -- `Part 4: Transitional Migration Features - `__ - -Formal specifications ---------------------- - -- `Oasis OpenDocument Standard Version 1.2 `__ -- `Rich Text Format (RTF) Specification, version 1.9.1 `__ - -Other resources ---------------- - -- `DocumentFormat.OpenXml.Wordprocessing Namespace on - MSDN `__ diff --git a/docs/styles.rst b/docs/styles.rst deleted file mode 100644 index 075dd3967d..0000000000 --- a/docs/styles.rst +++ /dev/null @@ -1,213 +0,0 @@ -.. _styles: - -Styles -====== - -.. _section-style: - -Section -------- - -Available Section style options: - -- ``borderBottomColor``. Border bottom color. -- ``borderBottomSize``. Border bottom size in *twip*. -- ``borderLeftColor``. Border left color. -- ``borderLeftSize``. Border left size in *twip*. -- ``borderRightColor``. Border right color. -- ``borderRightSize``. Border right size in *twip*. -- ``borderTopColor``. Border top color. -- ``borderTopSize``. Border top size in *twip*. -- ``breakType``. Section break type (nextPage, nextColumn, continuous, evenPage, oddPage). -- ``colsNum``. Number of columns. -- ``colsSpace``. Spacing between columns. -- ``footerHeight``. Spacing to bottom of footer. -- ``gutter``. Page gutter spacing. -- ``headerHeight``. Spacing to top of header. -- ``marginTop``. Page margin top in *twip*. -- ``marginLeft``. Page margin left in *twip*. -- ``marginRight``. Page margin right in *twip*. -- ``marginBottom``. Page margin bottom in *twip*. -- ``orientation``. Page orientation (``portrait``, which is default, or ``landscape``). - See ``\PhpOffice\PhpWord\Style\Section::ORIENTATION_...`` class constants for possible values -- ``pageSizeH``. Page height in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged. -- ``pageSizeW``. Page width in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged. -- ``vAlign``. Vertical Page Alignment - See ``\PhpOffice\PhpWord\SimpleType\VerticalJc`` for possible values - -.. _font-style: - -Font ----- - -Available Font style options: - -- ``allCaps``. All caps, *true* or *false*. -- ``bgColor``. Font background color, e.g. *FF0000*. -- ``bold``. Bold, *true* or *false*. -- ``color``. Font color, e.g. *FF0000*. -- ``doubleStrikethrough``. Double strikethrough, *true* or *false*. -- ``fgColor``. Font highlight color, e.g. *yellow*, *green*, *blue*. - See ``\PhpOffice\PhpWord\Style\Font::FGCOLOR_...`` class constants for possible values -- ``hint``. Font content type, *default*, *eastAsia*, or *cs*. -- ``italic``. Italic, *true* or *false*. -- ``name``. Font name, e.g. *Arial*. -- ``rtl``. Right to Left language, *true* or *false*. -- ``size``. Font size, e.g. *20*, *22*. -- ``smallCaps``. Small caps, *true* or *false*. -- ``strikethrough``. Strikethrough, *true* or *false*. -- ``subScript``. Subscript, *true* or *false*. -- ``superScript``. Superscript, *true* or *false*. -- ``underline``. Underline, *single*, *dash*, *dotted*, etc. - See ``\PhpOffice\PhpWord\Style\Font::UNDERLINE_...`` class constants for possible values -- ``lang``. Language, either a language code like *en-US*, *fr-BE*, etc. or an object (or as an array) if you need to set eastAsian or bidirectional languages - See ``\PhpOffice\PhpWord\Style\Language`` class for some language codes. -- ``position``. The text position, raised or lowered, in half points -- ``hidden``. Hidden text, *true* or *false*. - -.. _paragraph-style: - -Paragraph ---------- - -Available Paragraph style options: - -- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. - See ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values. -- ``basedOn``. Parent style. -- ``hanging``. Hanging indentation in *half inches*. -- ``indent``. Indent (left indentation) in *half inches*. -- ``indentation``. An array of indentation key => value pairs in *twip*. Supports *left*, *right*, *firstLine* and *hanging* indentation. - See ``\PhpOffice\PhpWord\Style\Indentation`` for possible identation types. -- ``keepLines``. Keep all lines on one page, *true* or *false*. -- ``keepNext``. Keep paragraph with next paragraph, *true* or *false*. -- ``lineHeight``. Text line height, e.g. *1.0*, *1.5*, etc. -- ``next``. Style for next paragraph. -- ``pageBreakBefore``. Start paragraph on next page, *true* or *false*. -- ``spaceBefore``. Space before paragraph in *twip*. -- ``spaceAfter``. Space after paragraph in *twip*. -- ``spacing``. Space between lines in *twip*. If spacingLineRule is auto, 240 (height of 1 line) will be added, so if you want a double line height, set this to 240. -- ``spacingLineRule``. Line Spacing Rule. *auto*, *exact*, *atLeast* - See ``\PhpOffice\PhpWord\SimpleType\LineSpacingRule`` class constants for possible values. -- ``suppressAutoHyphens``. Hyphenation for paragraph, *true* or *false*. -- ``tabs``. Set of custom tab stops. -- ``widowControl``. Allow first/last line to display on a separate page, *true* or *false*. -- ``contextualSpacing``. Ignore Spacing Above and Below When Using Identical Styles, *true* or *false*. -- ``bidi``. Right to Left Paragraph Layout, *true* or *false*. -- ``shading``. Paragraph Shading. -- ``textAlignment``. Vertical Character Alignment on Line. - See ``\PhpOffice\PhpWord\SimpleType\TextAlignment`` class constants for possible values. - -.. _table-style: - -Table ------ - -Available Table style options: - -- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. - See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values. -- ``bgColor``. Background color, e.g. '9966CC'. -- ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'. -- ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*. -- ``cellMargin(Top|Right|Bottom|Left)``. Cell margin in *twip*. -- ``indent``. Table indent from leading margin. Must be an instance of ``\PhpOffice\PhpWord\ComplexType\TblWidth``. -- ``width``. Table width in Fiftieths of a Percent or Twentieths of a Point. -- ``unit``. The unit to use for the width. One of ``\PhpOffice\PhpWord\SimpleType\TblWidth``. Defaults to *auto*. -- ``layout``. Table layout, either *fixed* or *autofit* See ``\PhpOffice\PhpWord\Style\Table`` for constants. -- ``cellSpacing`` Cell spacing in *twip* -- ``position`` Floating Table Positioning, see below for options -- ``bidiVisual`` Present table as Right-To-Left - -Floating Table Positioning options: - -- ``leftFromText`` Distance From Left of Table to Text in *twip* -- ``rightFromText`` Distance From Right of Table to Text in *twip* -- ``topFromText`` Distance From Top of Table to Text in *twip* -- ``bottomFromText`` Distance From Top of Table to Text in *twip* -- ``vertAnchor`` Table Vertical Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::VANCHOR_*`` -- ``horzAnchor`` Table Horizontal Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::HANCHOR_*`` -- ``tblpXSpec`` Relative Horizontal Alignment From Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::XALIGN_*`` -- ``tblpX`` Absolute Horizontal Distance From Anchorin *twip* -- ``tblpYSpec`` Relative Vertical Alignment From Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::YALIGN_*`` -- ``tblpY`` Absolute Vertical Distance From Anchorin *twip* - -Available Row style options: - -- ``cantSplit``. Table row cannot break across pages, *true* or *false*. -- ``exactHeight``. Row height is exact or at least. -- ``tblHeader``. Repeat table row on every new page, *true* or *false*. - -Available Cell style options: - -- ``bgColor``. Background color, e.g. '9966CC'. -- ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'. -- ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*. -- ``border(Top|Right|Bottom|Left)Style``. Border style. You can use constants from ``\PhpOffice\PhpWord\SimpleType\Border`` -- ``gridSpan``. Number of columns spanned. -- ``textDirection(btLr|tbRl)``. Direction of text. - You can use constants ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_BTLR`` and ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_TBRL`` -- ``valign``. Vertical alignment, *top*, *center*, *both*, *bottom*. -- ``vMerge``. *restart* or *continue*. -- ``width``. Cell width in *twip*. - -.. _image-style: - -Image ------ - -Available Image style options: - -- ``alignment``. See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details. -- ``height``. Height in *pt*. -- ``marginLeft``. Left margin in inches, can be negative. -- ``marginTop``. Top margin in inches, can be negative. -- ``width``. Width in *pt*. -- ``wrappingStyle``. Wrapping style, *inline*, *square*, *tight*, *behind*, or *infront*. -- ``wrapDistanceTop``. Top text wrapping in pixels. -- ``wrapDistanceBottom``. Bottom text wrapping in pixels. -- ``wrapDistanceLeft``. Left text wrapping in pixels. -- ``wrapDistanceRight``. Right text wrapping in pixels. - -.. _numbering-level-style: - -Numbering level ---------------- - -Available NumberingLevel style options: - -- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. - See ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values. -- ``font``. Font name. -- ``format``. Numbering format bullet\|decimal\|upperRoman\|lowerRoman\|upperLetter\|lowerLetter. -- ``hanging``. See paragraph style. -- ``hint``. See font style. -- ``left``. See paragraph style. -- ``restart``. Restart numbering level symbol. -- ``start``. Starting value. -- ``suffix``. Content between numbering symbol and paragraph text tab\|space\|nothing. -- ``tabPos``. See paragraph style. -- ``text``. Numbering level text e.g. %1 for nonbullet or bullet character. - -.. _chart-style: - -Chart ------ - -Available Chart style options: - -- ``width``. Width (in EMU). -- ``height``. Height (in EMU). -- ``3d``. Is 3D; applies to pie, bar, line, area, *true* or *false*. -- ``colors``. A list of colors to use in the chart. -- ``title``. The title for the chart. -- ``showLegend``. Show legend, *true* or *false*. -- ``LegendPosition``. Legend position, *r* (default), *b*, *t*, *l* or *tr*. -- ``categoryLabelPosition``. Label position for categories, *nextTo* (default), *low* or *high*. -- ``valueLabelPosition``. Label position for values, *nextTo* (default), *low* or *high*. -- ``categoryAxisTitle``. The title for the category axis. -- ``valueAxisTitle``. The title for the values axis. -- ``majorTickMarkPos``. The position for major tick marks, *in*, *out*, *cross*, *none* (default). -- ``showAxisLabels``. Show labels for axis, *true* or *false*. -- ``gridX``. Show Gridlines for X-Axis, *true* or *false*. -- ``gridY``. Show Gridlines for Y-Axis, *true* or *false*. diff --git a/docs/templates-processing.rst b/docs/templates-processing.rst deleted file mode 100644 index 1f7f5f2b80..0000000000 --- a/docs/templates-processing.rst +++ /dev/null @@ -1,303 +0,0 @@ -.. _templates-processing: - -Templates processing -==================== - -You can create an OOXML document template with included search-patterns (macros) which can be replaced by any value you wish. Only single-line values can be replaced. -By default Macros are defined like this: ``${search-pattern}`` but you can define custom macros. -To load a template file, create a new instance of the TemplateProcessor. - -.. code-block:: php - - $templateProcessor = new TemplateProcessor('Template.docx'); - -setValue -"""""""" -Given a template containing - -.. code-block:: clean - - Hello ${firstname} ${lastname}! - -The following will replace ``${firstname}`` with ``John``, and ``${lastname}`` with ``Doe`` . -The resulting document will now contain ``Hello John Doe!`` - -.. code-block:: php - - $templateProcessor->setValue('firstname', 'John'); - $templateProcessor->setValue('lastname', 'Doe'); - -setValues -""""""""" -You can also set multiple values by passing all of them in an array. - -.. code-block:: php - - $templateProcessor->setValues(array('firstname' => 'John', 'lastname' => 'Doe')); - -setMacroOpeningChars -"""""""" -You can define a custom opening macro. The following will set ``{#`` as the opening search pattern. - -.. code-block:: php - - $templateProcessor->setMacroOpeningChars('{#'); - -setMacroClosingChars -"""""""" -You can define a custom closing macro. The following will set ``#}`` as the closing search pattern. - -.. code-block:: php - - $templateProcessor->setMacroClosingChars('#}'); - -setMacroChars -"""""""" -You can define a custom opening and closing macro at the same time . The following will set the search-pattern like this: ``{#search-pattern#}`` . - -.. code-block:: php - - $templateProcessor->setMacroChars('{#', '#}'); - -setImageValue -""""""""""""" -The search-pattern model for images can be like: - - ``${search-image-pattern}`` - - ``${search-image-pattern:[width]:[height]:[ratio]}`` - - ``${search-image-pattern:[width]x[height]}`` - - ``${search-image-pattern:size=[width]x[height]}`` - - ``${search-image-pattern:width=[width]:height=[height]:ratio=false}`` - -Where: - - [width] and [height] can be just numbers or numbers with measure, which supported by Word (cm, mm, in, pt, pc, px, %, em, ex) - - [ratio] uses only for ``false``, ``-`` or ``f`` to turn off respect aspect ration of image. By default template image size uses as 'container' size. - -Example: - -.. code-block:: clean - - ${CompanyLogo} - ${UserLogo:50:50} ${Name} - ${City} - ${Street} - -.. code-block:: php - - $templateProcessor = new TemplateProcessor('Template.docx'); - $templateProcessor->setValue('Name', 'John Doe'); - $templateProcessor->setValue(array('City', 'Street'), array('Detroit', '12th Street')); - - $templateProcessor->setImageValue('CompanyLogo', 'path/to/company/logo.png'); - $templateProcessor->setImageValue('UserLogo', array('path' => 'path/to/logo.png', 'width' => 100, 'height' => 100, 'ratio' => false)); - $templateProcessor->setImageValue('FeatureImage', function () { - // Closure will only be executed if the replacement tag is found in the template - - return array('path' => SlowFeatureImageGenerator::make(), 'width' => 100, 'height' => 100, 'ratio' => false); - }); - -cloneBlock -"""""""""" -Given a template containing -See ``Sample_23_TemplateBlock.php`` for an example. - -.. code-block:: clean - - ${block_name} - Customer: ${customer_name} - Address: ${customer_address} - ${/block_name} - -The following will duplicate everything between ``${block_name}`` and ``${/block_name}`` 3 times. - -.. code-block:: php - - $templateProcessor->cloneBlock('block_name', 3, true, true); - -The last parameter will rename any macro defined inside the block and add #1, #2, #3 ... to the macro name. -The result will be - -.. code-block:: clean - - Customer: ${customer_name#1} - Address: ${customer_address#1} - - Customer: ${customer_name#2} - Address: ${customer_address#2} - - Customer: ${customer_name#3} - Address: ${customer_address#3} - -It is also possible to pass an array with the values to replace the marcros with. -If an array with replacements is passed, the ``count`` argument is ignored, it is the size of the array that counts. - -.. code-block:: php - - $replacements = array( - array('customer_name' => 'Batman', 'customer_address' => 'Gotham City'), - array('customer_name' => 'Superman', 'customer_address' => 'Metropolis'), - ); - $templateProcessor->cloneBlock('block_name', 0, true, false, $replacements); - -The result will then be - -.. code-block:: clean - - Customer: Batman - Address: Gotham City - - Customer: Superman - Address: Metropolis - -replaceBlock -"""""""""""" -Given a template containing - -.. code-block:: clean - - ${block_name} - This block content will be replaced - ${/block_name} - -The following will replace everything between ``${block_name}`` and ``${/block_name}`` with the value passed. - -.. code-block:: php - - $templateProcessor->replaceBlock('block_name', 'This is the replacement text.'); - -deleteBlock -""""""""""" -Same as previous, but it deletes the block - -.. code-block:: php - - $templateProcessor->deleteBlock('block_name'); - -cloneRow -"""""""" -Clones a table row in a template document. -See ``Sample_07_TemplateCloneRow.php`` for an example. - -.. code-block:: clean - - +-----------+----------------+ - | ${userId} | ${userName} | - | |----------------+ - | | ${userAddress} | - +-----------+----------------+ - -.. code-block:: php - - $templateProcessor->cloneRow('userId', 2); - -Will result in - -.. code-block:: clean - - +-------------+------------------+ - | ${userId#1} | ${userName#1} | - | |------------------+ - | | ${userAddress#1} | - +-------------+------------------+ - | ${userId#2} | ${userName#2} | - | |------------------+ - | | ${userAddress#2} | - +-------------+------------------+ - -cloneRowAndSetValues -"""""""""""""""""""" -Finds a row in a table row identified by `$search` param and clones it as many times as there are entries in `$values`. - -.. code-block:: clean - - +-----------+----------------+ - | ${userId} | ${userName} | - | |----------------+ - | | ${userAddress} | - +-----------+----------------+ - -.. code-block:: php - - $values = [ - ['userId' => 1, 'userName' => 'Batman', 'userAddress' => 'Gotham City'], - ['userId' => 2, 'userName' => 'Superman', 'userAddress' => 'Metropolis'], - ]; - $templateProcessor->cloneRowAndSetValues('userId', $values); - -Will result in - -.. code-block:: clean - - +---+-------------+ - | 1 | Batman | - | |-------------+ - | | Gotham City | - +---+-------------+ - | 2 | Superman | - | |-------------+ - | | Metropolis | - +---+-------------+ - -applyXslStyleSheet -"""""""""""""""""" -Applies the XSL stylesheet passed to header part, footer part and main part - -.. code-block:: php - - $xslDomDocument = new \DOMDocument(); - $xslDomDocument->load('/path/to/my/stylesheet.xsl'); - $templateProcessor->applyXslStyleSheet($xslDomDocument); - -setComplexValue -""""""""""""""" -Replaces a ${macro} with the ComplexType passed. -See ``Sample_40_TemplateSetComplexValue.php`` for examples. - -.. code-block:: php - - $inline = new TextRun(); - $inline->addText('by a red italic text', array('italic' => true, 'color' => 'red')); - $templateProcessor->setComplexValue('inline', $inline); - -setComplexBlock -""""""""""""""" -Replaces a ${macro} with the ComplexType passed. -See ``Sample_40_TemplateSetComplexValue.php`` for examples. - -.. code-block:: php - - $table = new Table(array('borderSize' => 12, 'borderColor' => 'green', 'width' => 6000, 'unit' => TblWidth::TWIP)); - $table->addRow(); - $table->addCell(150)->addText('Cell A1'); - $table->addCell(150)->addText('Cell A2'); - $table->addCell(150)->addText('Cell A3'); - $table->addRow(); - $table->addCell(150)->addText('Cell B1'); - $table->addCell(150)->addText('Cell B2'); - $table->addCell(150)->addText('Cell B3'); - $templateProcessor->setComplexBlock('table', $table); - -setChartValue -""""""""""""" -Replace a variable by a chart. - -.. code-block:: php - - $categories = array('A', 'B', 'C', 'D', 'E'); - $series1 = array(1, 3, 2, 5, 4); - $chart = new Chart('doughnut', $categories, $series1); - $templateProcessor->setChartValue('myChart', $chart); - -save -"""" -Saves the loaded template within the current directory. Returns the file path. - -.. code-block:: php - - $filepath = $templateProcessor->save(); - -saveAs -"""""" -Saves a copy of the loaded template in the indicated path. - -.. code-block:: php - - $pathToSave = 'path/to/save/file.ext'; - $templateProcessor->saveAs($pathToSave); diff --git a/docs/containers.rst b/docs/usage/containers.md similarity index 59% rename from docs/containers.rst rename to docs/usage/containers.md index 9ee58efcd4..e85a700f48 100644 --- a/docs/containers.rst +++ b/docs/usage/containers.md @@ -1,79 +1,77 @@ -.. _containers: +# Containers -Containers -========== +Containers are objects where you can put elements (texts, lists, tables, etc). There are 3 main containers, i.e. sections, headers, and footers.There are 3 elements that can also act as containers, i.e. textruns, table cells, and footnotes. -Containers are objects where you can put elements (texts, lists, tables, -etc). There are 3 main containers, i.e. sections, headers, and footers. -There are 3 elements that can also act as containers, i.e. textruns, -table cells, and footnotes. +## Sections -Sections --------- +Every visible element in word is placed inside of a section. To create a section, use the following code: -Every visible element in word is placed inside of a section. To create a -section, use the following code: +``` php +addSection($sectionStyle); +``` - $section = $phpWord->addSection($sectionStyle); +The ``$sectionStyle`` is an optional associative array that sets the section. Example: -The ``$sectionStyle`` is an optional associative array that sets the -section. Example: +``` php + 'landscape', + 'marginTop' => 600, + 'colsNum' => 2, +); +``` - $sectionStyle = array( - 'orientation' => 'landscape', - 'marginTop' => 600, - 'colsNum' => 2, - ); - -Page number -~~~~~~~~~~~ +### Page number You can change a section page number by using the ``pageNumberingStart`` style of the section. -.. code-block:: php +``` php +addSection(array('pageNumberingStart' => 1)); +// Method 1 +$section = $phpWord->addSection(array('pageNumberingStart' => 1)); - // Method 2 - $section = $phpWord->addSection(); - $section->getStyle()->setPageNumberingStart(1); +// Method 2 +$section = $phpWord->addSection(); +$section->getStyle()->setPageNumberingStart(1); +``` -Multicolumn -~~~~~~~~~~~ +### Multicolumn You can change a section layout to multicolumn (like in a newspaper) by using the ``breakType`` and ``colsNum`` style of the section. -.. code-block:: php +``` php +addSection(array('breakType' => 'continuous', 'colsNum' => 2)); +// Method 1 +$section = $phpWord->addSection(array('breakType' => 'continuous', 'colsNum' => 2)); - // Method 2 - $section = $phpWord->addSection(); - $section->getStyle()->setBreakType('continuous'); - $section->getStyle()->setColsNum(2); +// Method 2 +$section = $phpWord->addSection(); +$section->getStyle()->setBreakType('continuous'); +$section->getStyle()->setColsNum(2); +``` -Line numbering -~~~~~~~~~~~~~~ +### Line numbering You can apply line numbering to a section by using the ``lineNumbering`` style of the section. -.. code-block:: php +``` php +addSection(array('lineNumbering' => array())); +// Method 1 +$section = $phpWord->addSection(array('lineNumbering' => array())); - // Method 2 - $section = $phpWord->addSection(); - $section->getStyle()->setLineNumbering(array()); +// Method 2 +$section = $phpWord->addSection(); +$section->getStyle()->setLineNumbering(array()); +``` Below are the properties of the line numbering style. @@ -83,15 +81,16 @@ Below are the properties of the line numbering style. - ``restart`` Line numbering restart setting continuous\|newPage\|newSection -Headers -------- +## Headers Each section can have its own header reference. To create a header use the ``addHeader`` method: -.. code-block:: php +``` php +addHeader(); +$header = $section->addHeader(); +``` Be sure to save the result in a local object. You can use all elements that are available for the footer. See "Footer" section for detail. @@ -106,19 +105,22 @@ You can pass an optional parameter to specify where the header/footer should be To change the evenAndOddHeaders use the ``getSettings`` method to return the Settings object, and then call the ``setEvenAndOddHeaders`` method: -.. code-block:: php +``` php +getSettings()->setEvenAndOddHeaders(true); +$phpWord->getSettings()->setEvenAndOddHeaders(true); +``` -Footers -------- +## Footers Each section can have its own footer reference. To create a footer, use the ``addFooter`` method: -.. code-block:: php +``` php +addFooter(); +$footer = $section->addFooter(); +``` Be sure to save the result in a local object to add elements to a footer. You can add the following elements to footers: @@ -131,8 +133,7 @@ footer. You can add the following elements to footers: See the "Elements" section for the detail of each elements. -Other containers ----------------- +### Other containers Textruns, table cells, and footnotes are elements that can also act as containers. See the corresponding "Elements" section for the detail of diff --git a/docs/usage/elements/chart.md b/docs/usage/elements/chart.md new file mode 100644 index 0000000000..d204425b18 --- /dev/null +++ b/docs/usage/elements/chart.md @@ -0,0 +1,15 @@ +# Chart + +Charts can be added using + +``` php +addChart('line', $categories, $series, $style); +``` + +For available styling options, see [`Styles > Chart`](../styles/chart.md). + +Check out the Sample_32_Chart.php for more options and styling. \ No newline at end of file diff --git a/docs/usage/elements/checkbox.md b/docs/usage/elements/checkbox.md new file mode 100644 index 0000000000..67c58163d1 --- /dev/null +++ b/docs/usage/elements/checkbox.md @@ -0,0 +1,14 @@ +# Checkbox + +Checkbox elements can be added to sections or table cells by using ``addCheckBox``. + +``` php +addCheckBox($name, $text, [$fontStyle], [$paragraphStyle]); +``` + +- ``$name``. Name of the check box. +- ``$text``. Text to be displayed in the document. +- ``$fontStyle``. See [`Styles > Font`](../styles/font.md). +- ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md). \ No newline at end of file diff --git a/docs/usage/elements/comment.md b/docs/usage/elements/comment.md new file mode 100644 index 0000000000..06a3866a3e --- /dev/null +++ b/docs/usage/elements/comment.md @@ -0,0 +1,23 @@ +# Comment + +Comments can be added to a document by using ``addComment``. +The comment can contain formatted text. Once the comment has been added, it can be linked to any element with ``setCommentStart``. + +``` php +addText('Test', array('bold' => true)); + +// add it to the document +$phpWord->addComment($comment); + +$textrun = $section->addTextRun(); +$textrun->addText('This '); +$text = $textrun->addText('is'); +// link the comment to the text you just created +$text->setCommentStart($comment); +``` + +If no end is set for a comment using the ``setCommentEnd``, the comment will be ended automatically at the end of the element it is started on. \ No newline at end of file diff --git a/docs/usage/elements/field.md b/docs/usage/elements/field.md new file mode 100644 index 0000000000..10492cc742 --- /dev/null +++ b/docs/usage/elements/field.md @@ -0,0 +1,39 @@ +# Field + +Currently the following fields are supported: + +- PAGE +- NUMPAGES +- DATE +- XE +- INDEX + +``` php +addField($fieldType, [$properties], [$options], [$fieldText], [$fontStyle]) +``` + +- ``$fontStyle``. See [`Styles > Font`](../styles/font.md). + +See ``\PhpOffice\PhpWord\Element\Field`` for list of properties and options available for each field type. +Options which are not specifically defined can be added. Those must start with a ``\``. + +For instance for the INDEX field, you can do the following (See `Index Field for list of available options `_ ): + +``` php +addText('My '); +$fieldText->addText('bold index', ['bold' => true]); +$fieldText->addText(' entry'); +$section->addField('XE', array(), array(), $fieldText); + +//this actually adds the index +$section->addField('INDEX', array(), array('\\e " " \\h "A" \\c "3"'), 'right click to update index'); +``` \ No newline at end of file diff --git a/docs/usage/elements/image.md b/docs/usage/elements/image.md new file mode 100644 index 0000000000..cb288bbf3d --- /dev/null +++ b/docs/usage/elements/image.md @@ -0,0 +1,36 @@ +# Image + +To add an image, use the ``addImage`` method to sections, headers, footers, textruns, or table cells. + +``` php +addImage($src, [$style]); +``` + +- ``$src``. String path to a local image, URL of a remote image or the image data, as a string. Warning: Do not pass user-generated strings here, as that would allow an attacker to read arbitrary files or perform server-side request forgery by passing file paths or URLs instead of image data. +- ``$style``. See [`Styles > Image`](../styles/image.md). + +Examples: + +``` php +addSection(); +$section->addImage( + 'mars.jpg', + array( + 'width' => 100, + 'height' => 100, + 'marginTop' => -1, + 'marginLeft' => -1, + 'wrappingStyle' => 'behind' + ) +); +$footer = $section->addFooter(); +$footer->addImage('http://example.com/image.php'); +$textrun = $section->addTextRun(); +$textrun->addImage('http://php.net/logo.jpg'); +$source = file_get_contents('/path/to/my/images/earth.jpg'); +$textrun->addImage($source); +``` \ No newline at end of file diff --git a/docs/usage/elements/index.md b/docs/usage/elements/index.md new file mode 100644 index 0000000000..6106c8914b --- /dev/null +++ b/docs/usage/elements/index.md @@ -0,0 +1,34 @@ +# Elements + +Below are the matrix of element availability in each container. The column shows the containers while the rows lists the elements. + +| Num | Element | Section | Header | Footer | Cell | Text Run | Footnote | +|-------|-----------------|-----------|----------|----------|---------|------------|------------| +| 1 | [Text](text.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| 2 | Text Run | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :red_circle: | :red_circle: | +| 3 | [Link](link.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| 4 | [Title](title.md) | :white_check_mark: | :question: | :question: | :question: | :question: | :question: | +| 5 | [Preserve Text](preservetext.md) | :question: | :white_check_mark: | :white_check_mark: | :material-check-decagram-outline: | :red_circle: | :red_circle: | +| 6 | [Text Break](textbreak.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| 7 | [Page Break](pagebreak.md) | :white_check_mark: | :red_circle: | :red_circle: | :red_circle: | :red_circle: | :red_circle: | +| 8 | [List](list.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :red_circle: | :red_circle: | +| 9 | [Table](table.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :red_circle: | :red_circle: | +| 10 | [Image](image.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| 11 | [Watermark](watermark.md) | :red_circle: | :white_check_mark: | :red_circle: | :red_circle: | :red_circle: | :red_circle: | +| 12 | [OLEObject](oleobject.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| 13 | [TOC](toc.md) | :white_check_mark: | :red_circle: | :red_circle: | :red_circle: | :red_circle: | :red_circle: | +| 14 | [Footnote](note.md) | :white_check_mark: | :red_circle: | :red_circle: | :material-check-decagram: | :material-check-decagram: | :red_circle: | +| 15 | [Endnote](note.md) | :white_check_mark: | :red_circle: | :red_circle: | :material-check-decagram: | :material-check-decagram: | :red_circle: | +| 16 | [CheckBox](checkbox.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :red_circle: | +| 17 | [TextBox](textbox.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :red_circle: | :red_circle: | +| 18 | [Field](field.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| 19 | [Line](line.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| 20 | [Chart](chart.md) | :white_check_mark: | | | :white_check_mark: | | | + +Legend: + +- :white_check_mark: : Available. +- :material-check-decagram-outline: : Available only when inside header/footer. +- :material-check-decagram: : Available only when inside section. +- :red_circle: : Not available. +- :question: : Should be available. \ No newline at end of file diff --git a/docs/usage/elements/line.md b/docs/usage/elements/line.md new file mode 100644 index 0000000000..7062f884da --- /dev/null +++ b/docs/usage/elements/line.md @@ -0,0 +1,21 @@ +# Line + +Line elements can be added to sections by using ``addLine``. + +``` php + 1, 'width' => 100, 'height' => 0, 'color' => 635552); +$section->addLine($lineStyle); +``` + +Available line style attributes: + +- ``weight``. Line width in *twip*. +- ``color``. Defines the color of stroke. +- ``dash``. Line types: dash, rounddot, squaredot, dashdot, longdash, longdashdot, longdashdotdot. +- ``beginArrow``. Start type of arrow: block, open, classic, diamond, oval. +- ``endArrow``. End type of arrow: block, open, classic, diamond, oval. +- ``width``. Line-object width in *pt*. +- ``height``. Line-object height in *pt*. +- ``flip``. Flip the line element: true, false. \ No newline at end of file diff --git a/docs/usage/elements/link.md b/docs/usage/elements/link.md new file mode 100644 index 0000000000..0719c1c018 --- /dev/null +++ b/docs/usage/elements/link.md @@ -0,0 +1,14 @@ +# Link + +You can add Hyperlinks to the document by using the function addLink: + +``` php +addLink($linkSrc, [$linkName], [$fontStyle], [$paragraphStyle]); +``` + +- ``$linkSrc``. The URL of the link. +- ``$linkName``. Placeholder of the URL that appears in the document. +- ``$fontStyle``. See [`Styles > Font`](../styles/font.md). +- ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md). \ No newline at end of file diff --git a/docs/usage/elements/list.md b/docs/usage/elements/list.md new file mode 100644 index 0000000000..4b51cd8634 --- /dev/null +++ b/docs/usage/elements/list.md @@ -0,0 +1,48 @@ +# List + +Lists can be added by using ``addListItem`` and ``addListItemRun`` methods. ``addListItem`` is used for creating lists that only contain plain text. ``addListItemRun`` is used for creating complex list items that contains texts with different style (some bold, other italics, etc) or other elements, e.g. images or links. The syntaxes are as follow: + +Basic usage: + +``` php +addListItem($text, [$depth], [$fontStyle], [$listStyle], [$paragraphStyle]); +$listItemRun = $section->addListItemRun([$depth], [$listStyle], [$paragraphStyle]) +``` + +Parameters: + +- ``$text``. Text that appears in the document. +- ``$depth``. Depth of list item. +- ``$fontStyle``. See [`Styles > Font`](../styles/font.md).. +- ``$listStyle``. List style of the current element TYPE\_NUMBER, + TYPE\_ALPHANUM, TYPE\_BULLET\_FILLED, etc. See list of constants in PHPWord\\Style\\ListItem. +- ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md).. + +See ``Sample_14_ListItem.php`` for more code sample. + +Advanced usage: + +You can also create your own numbering style by changing the ``$listStyle`` parameter with the name of your numbering style. + +``` php +addNumberingStyle( + 'multilevel', + array( + 'type' => 'multilevel', + 'levels' => array( + array('format' => 'decimal', 'text' => '%1.', 'left' => 360, 'hanging' => 360, 'tabPos' => 360), + array('format' => 'upperLetter', 'text' => '%2.', 'left' => 720, 'hanging' => 360, 'tabPos' => 720), + ) + ) +); +$section->addListItem('List Item I', 0, null, 'multilevel'); +$section->addListItem('List Item I.a', 1, null, 'multilevel'); +$section->addListItem('List Item I.b', 1, null, 'multilevel'); +$section->addListItem('List Item II', 0, null, 'multilevel'); +``` + +For available styling options see [`Styles > Numbering Level`](../styles/numberinglevel.md). \ No newline at end of file diff --git a/docs/usage/elements/note.md b/docs/usage/elements/note.md new file mode 100644 index 0000000000..69a1947357 --- /dev/null +++ b/docs/usage/elements/note.md @@ -0,0 +1,54 @@ +# Footnote & Endnote + +You can create footnotes with ``addFootnote`` and endnotes with``addEndnote`` in texts or textruns, but it's recommended to use textrun to have better layout. You can use ``addText``, ``addLink``,``addTextBreak``, ``addImage``, ``addOLEObject`` on footnotes and endnotes. + +On textrun: + +``` php +addTextRun(); +$textrun->addText('Lead text.'); +$footnote = $textrun->addFootnote(); +$footnote->addText('Footnote text can have '); +$footnote->addLink('http://test.com', 'links'); +$footnote->addText('.'); +$footnote->addTextBreak(); +$footnote->addText('And text break.'); +$textrun->addText('Trailing text.'); +$endnote = $textrun->addEndnote(); +$endnote->addText('Endnote put at the end'); +``` + +On text: + +``` php +addText('Lead text.'); +$footnote = $section->addFootnote(); +$footnote->addText('Footnote text.'); +``` + +By default the footnote reference number will be displayed with decimal number +starting from 1. This number uses the ``FooterReference`` style which you can +redefine with the ``addFontStyle`` method. Default value for this style is +``array('superScript' => true)``; + +The footnote numbering can be controlled by setting the FootnoteProperties on the Section. + +``` php +setPos(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::POSITION_BENEATH_TEXT); +//set the number format to use (decimal (default), upperRoman, upperLetter, ...) +$fp->setNumFmt(\PhpOffice\PhpWord\SimpleType\NumberFormat::LOWER_ROMAN); +//force starting at other than 1 +$fp->setNumStart(2); +//when to restart counting (continuous (default), eachSect, eachPage) +$fp->setNumRestart(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::RESTART_NUMBER_EACH_PAGE); +//And finaly, set it on the Section +$section->setFootnoteProperties($fp); +``` \ No newline at end of file diff --git a/docs/usage/elements/oleobject.md b/docs/usage/elements/oleobject.md new file mode 100644 index 0000000000..ebee5fbafa --- /dev/null +++ b/docs/usage/elements/oleobject.md @@ -0,0 +1,9 @@ +# Object + +You can add OLE embeddings, such as Excel spreadsheets or PowerPoint presentations to the document by using ``addOLEObject`` method. + +``` php +addOLEObject($src, [$style]); +``` \ No newline at end of file diff --git a/docs/usage/elements/pagebreak.md b/docs/usage/elements/pagebreak.md new file mode 100644 index 0000000000..12f0fad57b --- /dev/null +++ b/docs/usage/elements/pagebreak.md @@ -0,0 +1,9 @@ +# Page breaks + +There are two ways to insert a page break, using the ``addPageBreak`` method or using the ``pageBreakBefore`` style of paragraph. + +``` php +addPageBreak(); +``` \ No newline at end of file diff --git a/docs/usage/elements/preservetext.md b/docs/usage/elements/preservetext.md new file mode 100644 index 0000000000..67a9cb0920 --- /dev/null +++ b/docs/usage/elements/preservetext.md @@ -0,0 +1,9 @@ +# Preserve text + +The ``addPreserveText`` method is used to add a page number or page count to headers or footers. + +``` php +addPreserveText('Page {PAGE} of {NUMPAGES}.'); +``` \ No newline at end of file diff --git a/docs/usage/elements/table.md b/docs/usage/elements/table.md new file mode 100644 index 0000000000..04b06429e7 --- /dev/null +++ b/docs/usage/elements/table.md @@ -0,0 +1,41 @@ +# Table + +To add tables, rows, and cells, use the ``addTable``, ``addRow``, and ``addCell`` methods: + +``` php +addTable([$tableStyle]); +$table->addRow([$height], [$rowStyle]); +$cell = $table->addCell($width, [$cellStyle]); +``` + +Table style can be defined with ``addTableStyle``: + +``` php + '006699', + 'borderSize' => 6, + 'cellMargin' => 50 +); +$firstRowStyle = array('bgColor' => '66BBFF'); +$phpWord->addTableStyle('myTable', $tableStyle, $firstRowStyle); +$table = $section->addTable('myTable'); +``` + +For available styling options see [`Styles > Table`](../styles/table.md). + +## Cell span + +You can span a cell on multiple columns by using ``gridSpan`` or multiple rows by using ``vMerge``. + +``` php +addCell(200); +$cell->getStyle()->setGridSpan(5); +``` + +See ``Sample_09_Tables.php`` for more code sample. \ No newline at end of file diff --git a/docs/usage/elements/text.md b/docs/usage/elements/text.md new file mode 100644 index 0000000000..41984be095 --- /dev/null +++ b/docs/usage/elements/text.md @@ -0,0 +1,26 @@ +# Text + + +Text can be added by using ``addText`` and ``addTextRun`` methods. ``addText`` is used for creating simple paragraphs that only contain texts with the same style. ``addTextRun`` is used for creating complex paragraphs that contain text with different style (some bold, other italics, etc) or other elements, e.g. images or links. The syntaxes are as follow: + +``` php +addText($text, [$fontStyle], [$paragraphStyle]); +$textrun = $section->addTextRun([$paragraphStyle]); +``` + +- ``$text``. Text to be displayed in the document. +- ``$fontStyle``. See [`Styles > Font`](../styles/font.md). +- ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md). + +For available styling options, see [`Styles > Font`](../styles/font.md) and [`Styles > Paragraph`](../styles/paragraph.md). + +If you want to enable track changes on added text you can mark it as INSERTED or DELETED by a specific user at a given time: + +``` php +addText('Hello World!'); +$text->setChanged(\PhpOffice\PhpWord\Element\ChangedElement::TYPE_INSERTED, 'Fred', (new \DateTime())); +``` \ No newline at end of file diff --git a/docs/usage/elements/textbox.md b/docs/usage/elements/textbox.md new file mode 100644 index 0000000000..9341cdcbd9 --- /dev/null +++ b/docs/usage/elements/textbox.md @@ -0,0 +1,3 @@ +# TextBox + +To Be Completed... \ No newline at end of file diff --git a/docs/usage/elements/textbreak.md b/docs/usage/elements/textbreak.md new file mode 100644 index 0000000000..1937101cc8 --- /dev/null +++ b/docs/usage/elements/textbreak.md @@ -0,0 +1,13 @@ +# Text breaks + +Text breaks are empty new lines. To add text breaks, use the following syntax. All parameters are optional. + +``` php +addTextBreak([$breakCount], [$fontStyle], [$paragraphStyle]); +``` + +- ``$breakCount``. How many lines. +- ``$fontStyle``. See [`Styles > Font`](../styles/font.md). +- ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md). \ No newline at end of file diff --git a/docs/usage/elements/title.md b/docs/usage/elements/title.md new file mode 100644 index 0000000000..f778d6ddb7 --- /dev/null +++ b/docs/usage/elements/title.md @@ -0,0 +1,19 @@ +# Title + +If you want to structure your document or build table of contents, you need titles or headings. +To add a title to the document, use the ``addTitleStyle`` and ``addTitle`` method. +If `depth` is 0, a Title will be inserted, otherwise a Heading1, Heading2, ... + +``` php +addTitleStyle($depth, [$fontStyle], [$paragraphStyle]); +$section->addTitle($text, [$depth]); +``` + +- ``depth``. +- ``$fontStyle``. See [`Styles > Font`](../styles/font.md). +- ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md). +- ``$text``. Text to be displayed in the document. This can be `string` or a `\PhpOffice\PhpWord\Element\TextRun` + +It's necessary to add a title style to your document because otherwise the title won't be detected as a real title. \ No newline at end of file diff --git a/docs/usage/elements/toc.md b/docs/usage/elements/toc.md new file mode 100644 index 0000000000..d7b05c2e96 --- /dev/null +++ b/docs/usage/elements/toc.md @@ -0,0 +1,21 @@ +# Table of contents + +To add a table of contents (TOC), you can use the ``addTOC`` method. +Your TOC can only be generated if you have add at least one title (See "[Title](title.md)"). + +``` php +addTOC([$fontStyle], [$tocStyle], [$minDepth], [$maxDepth]); +``` + +- ``$fontStyle``. See font style section. +- ``$tocStyle``. See available options below. +- ``$minDepth``. Minimum depth of header to be shown. Default 1. +- ``$maxDepth``. Maximum depth of header to be shown. Default 9. + +Options for ``$tocStyle``: + +- ``tabLeader``. Fill type between the title text and the page number. Use the defined constants in ``\PhpOffice\PhpWord\Style\TOC``. +- ``tabPos``. The position of the tab where the page number appears in *twip*. +- ``indent``. The indent factor of the titles in *twip*. \ No newline at end of file diff --git a/docs/usage/elements/trackchanges.md b/docs/usage/elements/trackchanges.md new file mode 100644 index 0000000000..70cd312543 --- /dev/null +++ b/docs/usage/elements/trackchanges.md @@ -0,0 +1,25 @@ +# Track Changes + +Track changes can be set on text elements. There are 2 ways to set the change information on an element. +Either by calling the `setChangeInfo()`, or by setting the `TrackChange` instance on the element with `setTrackChange()`. + +``` php +addSection(); +$textRun = $section->addTextRun(); + +$text = $textRun->addText('Hello World! Time to '); + +$text = $textRun->addText('wake ', array('bold' => true)); +$text->setChangeInfo(TrackChange::INSERTED, 'Fred', time() - 1800); + +$text = $textRun->addText('up'); +$text->setTrackChange(new TrackChange(TrackChange::INSERTED, 'Fred')); + +$text = $textRun->addText('go to sleep'); +$text->setChangeInfo(TrackChange::DELETED, 'Barney', new \DateTime('@' . (time() - 3600))); +``` \ No newline at end of file diff --git a/docs/usage/elements/watermark.md b/docs/usage/elements/watermark.md new file mode 100644 index 0000000000..0b2bae6bf0 --- /dev/null +++ b/docs/usage/elements/watermark.md @@ -0,0 +1,13 @@ +# Watermark + +To add a watermark (or page background image), your section needs a +header reference. After creating a header, you can use the +``addWatermark`` method to add a watermark. + +``` php +addSection(); +$header = $section->addHeader(); +$header->addWatermark('resources/_earth.jpg', array('marginTop' => 200, 'marginLeft' => 55)); +``` \ No newline at end of file diff --git a/docs/usage/introduction.md b/docs/usage/introduction.md new file mode 100644 index 0000000000..94a6fd915d --- /dev/null +++ b/docs/usage/introduction.md @@ -0,0 +1,356 @@ +# Introduction + +## Basic example + +The following is a basic example of the PHPWord library. More examples +are provided in the [samples folder](https://github.com/PHPOffice/PHPWord/tree/master/samples/). + +``` php +addSection(); +// Adding Text element to the Section having font styled by default... +$section->addText( + '"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( + '"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( + '"The greatest accomplishment is not in never falling, ' + . 'but in rising again after you fall." ' + . '(Vince Lombardi)', + $fontStyleName +); + +// 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('"Believe you can and you\'re halfway there." (Theodor Roosevelt)'); +$myTextElement->setFontStyle($fontStyle); + +// 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. */ +``` + +## PHPWord Settings + +The ``PhpOffice\PhpWord\Settings`` class provides some options that will +affect the behavior of PHPWord. Below are the options. + +### XML Writer compatibility + +This option sets [XMLWriter::setIndent](http://www.php.net/manual/en/function.xmlwriter-set-indent.php) and [XMLWriter::setIndentString](http://www.php.net/manual/en/function.xmlwriter-set-indent-string.php>). The default value of this option is ``true`` (compatible), which is [required for OpenOffice](https://github.com/PHPOffice/PHPWord/issues/103) to render OOXML document correctly. You can set this option to ``false`` during development to make the resulting XML file easier to read. + +``` php +setDefaultFontName('Times New Roman'); +$phpWord->setDefaultFontSize(12); +``` + +## Document settings + +Settings for the generated document can be set using ``$phpWord->getSettings()`` + +### Magnification Setting + +The default zoom value is 100 percent. This can be changed either to another percentage + +``` php +getSettings()->setZoom(75); +``` + +Or to predefined values ``fullPage``, ``bestFit``, ``textFit`` + +``` php +getSettings()->setZoom(Zoom::BEST_FIT); +``` + +### Mirroring the Page Margins + +Use mirror margins to set up facing pages for double-sided documents, such as books or magazines. + +``` php +getSettings()->setMirrorMargins(true); +``` + +### Spelling and grammatical checks + +By default spelling and grammatical errors are shown as soon as you open a word document. +For big documents this can slow down the opening of the document. You can hide the spelling and/or grammatical errors with: + +``` php +getSettings()->setHideGrammaticalErrors(true); +$phpWord->getSettings()->setHideSpellingErrors(true); +``` + +You can also specify the status of the spell and grammar checks, marking spelling or grammar as dirty will force a re-check when opening the document. + +``` php +setGrammar(\PhpOffice\PhpWord\ComplexType\ProofState::CLEAN); +$proofState->setSpelling(\PhpOffice\PhpWord\ComplexType\ProofState::DIRTY); + +$phpWord->getSettings()->setProofState($proofState); +``` + +### Track Revisions + +Track changes can be activated using ``setTrackRevisions``, you can furture specify + +- Not to use move syntax, instead moved items will be seen as deleted in one place and added in another +- Not track formatting revisions + +``` php +getSettings()->setTrackRevisions(true); +$phpWord->getSettings()->setDoNotTrackMoves(true); +$phpWord->getSettings()->setDoNotTrackFormatting(true); +``` + +### Decimal Symbol + +The default symbol to represent a decimal figure is the ``.`` in english. In french you might want to change it to ``,`` for instance. + +``` php +getSettings()->setDecimalSymbol(','); +``` + +### Document Language + +The default language of the document can be change with the following. + +``` php +getSettings()->setThemeFontLang(new Language(Language::FR_BE)); +``` + +``Language`` has 3 parameters, one for Latin languages, one for East Asian languages and one for Complex (Bi-Directional) languages. +A couple of language codes are provided in the ``PhpOffice\PhpWord\Style\Language`` class but any valid code/ID can be used. + +In case you are generating an RTF document the language need to be set differently. + +``` php +setLangId(Language::EN_GB_ID); +$phpWord->getSettings()->setThemeFontLang($lang); +``` + +## Document information + +You can set the document information such as title, creator, and company +name. Use the following functions: + +``` php +getDocInfo(); +$properties->setCreator('My name'); +$properties->setCompany('My factory'); +$properties->setTitle('My title'); +$properties->setDescription('My description'); +$properties->setCategory('My category'); +$properties->setLastModifiedBy('My name'); +$properties->setCreated(mktime(0, 0, 0, 3, 12, 2014)); +$properties->setModified(mktime(0, 0, 0, 3, 14, 2014)); +$properties->setSubject('My subject'); +$properties->setKeywords('my, key, word'); +``` + +## Measurement units + +The base length unit in Open Office XML is twip. Twip means "TWentieth +of an Inch Point", i.e. 1 twip = 1/1440 inch. + +You can use PHPWord helper functions to convert inches, centimeters, or +points to twip. + +``` php +addParagraphStyle('My Style', array( + 'spaceAfter' => \PhpOffice\PhpWord\Shared\Converter::pointToTwip(6)) +); + +$section = $phpWord->addSection(); +$sectionStyle = $section->getStyle(); +// half inch left margin +$sectionStyle->setMarginLeft(\PhpOffice\PhpWord\Shared\Converter::inchToTwip(.5)); +// 2 cm right margin +$sectionStyle->setMarginRight(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(2)); +``` + +## Document protection + +The document (or parts of it) can be password protected. + +``` php +getSettings()->getDocumentProtection(); +$documentProtection->setEditing(DocProtect::READ_ONLY); +$documentProtection->setPassword('myPassword'); +``` + +## Automatically Recalculate Fields on Open + +To force an update of the fields present in the document, set updateFields to true + +``` php +getSettings()->setUpdateFields(true); +``` + +## Hyphenation + +Hyphenation describes the process of breaking words with hyphens. There are several options to control hyphenation. + +### Auto hyphenation + +To automatically hyphenate text set ``autoHyphenation`` to ``true``. + +``` php +getSettings()->setAutoHyphenation(true); +``` + +### Consecutive Hyphen Limit + +The maximum number of consecutive lines of text ending with a hyphen can be controlled by the ``consecutiveHyphenLimit`` option. +There is no limit if the option is not set or the provided value is ``0``. + +``` php +getSettings()->setConsecutiveHyphenLimit(2); +``` + +### Hyphenation Zone + +The hyphenation zone (in *twip*) is the allowed amount of whitespace before hyphenation is applied. +The smaller the hyphenation zone the more words are hyphenated. Or in other words, the wider the hyphenation zone the less words are hyphenated. + +``` php +getSettings()->setHyphenationZone(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(1)); +``` + +### Hyphenate Caps + +To control whether or not words in all capital letters shall be hyphenated use the `doNotHyphenateCaps` option. + +``` php +getSettings()->setDoNotHyphenateCaps(true); +``` \ No newline at end of file diff --git a/docs/usage/readers.md b/docs/usage/readers.md new file mode 100644 index 0000000000..9cd9c1c4d6 --- /dev/null +++ b/docs/usage/readers.md @@ -0,0 +1,51 @@ +# Readers + +## HTML +The name of the reader is `HTML`. + +``` php +load(__DIR__ . '/sample.html'); +``` + +## MsDoc +The name of the reader is `MsDoc`. + +``` php +load(__DIR__ . '/sample.doc'); +``` + +## ODText +The name of the reader is `ODText`. + +``` php +load(__DIR__ . '/sample.odt'); +``` + +## RTF +The name of the reader is `RTF`. + +``` php +load(__DIR__ . '/sample.rtf'); +``` + +## Word2007 +The name of the reader is `Word2007`. + +``` php +load(__DIR__ . '/sample.docx'); +``` \ No newline at end of file diff --git a/docs/usage/styles/chart.md b/docs/usage/styles/chart.md new file mode 100644 index 0000000000..f297718d24 --- /dev/null +++ b/docs/usage/styles/chart.md @@ -0,0 +1,19 @@ +# Chart + +Available Chart style options: + +- ``width``. Width (in EMU). +- ``height``. Height (in EMU). +- ``3d``. Is 3D; applies to pie, bar, line, area, *true* or *false*. +- ``colors``. A list of colors to use in the chart. +- ``title``. The title for the chart. +- ``showLegend``. Show legend, *true* or *false*. +- ``LegendPosition``. Legend position, *r* (default), *b*, *t*, *l* or *tr*. +- ``categoryLabelPosition``. Label position for categories, *nextTo* (default), *low* or *high*. +- ``valueLabelPosition``. Label position for values, *nextTo* (default), *low* or *high*. +- ``categoryAxisTitle``. The title for the category axis. +- ``valueAxisTitle``. The title for the values axis. +- ``majorTickMarkPos``. The position for major tick marks, *in*, *out*, *cross*, *none* (default). +- ``showAxisLabels``. Show labels for axis, *true* or *false*. +- ``gridX``. Show Gridlines for X-Axis, *true* or *false*. +- ``gridY``. Show Gridlines for Y-Axis, *true* or *false*. \ No newline at end of file diff --git a/docs/usage/styles/font.md b/docs/usage/styles/font.md new file mode 100644 index 0000000000..90e492bf0e --- /dev/null +++ b/docs/usage/styles/font.md @@ -0,0 +1,26 @@ +# Font + +Available Font style options: + +- ``allCaps``. All caps, *true* or *false*. +- ``bgColor``. Font background color, e.g. *FF0000*. +- ``bold``. Bold, *true* or *false*. +- ``color``. Font color, e.g. *FF0000*. +- ``doubleStrikethrough``. Double strikethrough, *true* or *false*. +- ``fgColor``. Font highlight color, e.g. *yellow*, *green*, *blue*. + See ``\PhpOffice\PhpWord\Style\Font::FGCOLOR_...`` class constants for possible values +- ``hint``. Font content type, *default*, *eastAsia*, or *cs*. +- ``italic``. Italic, *true* or *false*. +- ``name``. Font name, e.g. *Arial*. +- ``rtl``. Right to Left language, *true* or *false*. +- ``size``. Font size, e.g. *20*, *22*. +- ``smallCaps``. Small caps, *true* or *false*. +- ``strikethrough``. Strikethrough, *true* or *false*. +- ``subScript``. Subscript, *true* or *false*. +- ``superScript``. Superscript, *true* or *false*. +- ``underline``. Underline, *single*, *dash*, *dotted*, etc. + See ``\PhpOffice\PhpWord\Style\Font::UNDERLINE_...`` class constants for possible values +- ``lang``. Language, either a language code like *en-US*, *fr-BE*, etc. or an object (or as an array) if you need to set eastAsian or bidirectional languages + See ``\PhpOffice\PhpWord\Style\Language`` class for some language codes. +- ``position``. The text position, raised or lowered, in half points +- ``hidden``. Hidden text, *true* or *false*. \ No newline at end of file diff --git a/docs/usage/styles/image.md b/docs/usage/styles/image.md new file mode 100644 index 0000000000..b6c4ddf936 --- /dev/null +++ b/docs/usage/styles/image.md @@ -0,0 +1,14 @@ +# Image + +Available Image style options: + +- ``alignment``. See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details. +- ``height``. Height in *pt*. +- ``marginLeft``. Left margin in inches, can be negative. +- ``marginTop``. Top margin in inches, can be negative. +- ``width``. Width in *pt*. +- ``wrappingStyle``. Wrapping style, *inline*, *square*, *tight*, *behind*, or *infront*. +- ``wrapDistanceTop``. Top text wrapping in pixels. +- ``wrapDistanceBottom``. Bottom text wrapping in pixels. +- ``wrapDistanceLeft``. Left text wrapping in pixels. +- ``wrapDistanceRight``. Right text wrapping in pixels. \ No newline at end of file diff --git a/docs/usage/styles/numberinglevel.md b/docs/usage/styles/numberinglevel.md new file mode 100644 index 0000000000..392e820048 --- /dev/null +++ b/docs/usage/styles/numberinglevel.md @@ -0,0 +1,16 @@ +# Numbering level + +Available NumberingLevel style options: + +- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. + See ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values. +- ``font``. Font name. +- ``format``. Numbering format bullet\|decimal\|upperRoman\|lowerRoman\|upperLetter\|lowerLetter. +- ``hanging``. See paragraph style. +- ``hint``. See font style. +- ``left``. See paragraph style. +- ``restart``. Restart numbering level symbol. +- ``start``. Starting value. +- ``suffix``. Content between numbering symbol and paragraph text tab\|space\|nothing. +- ``tabPos``. See paragraph style. +- ``text``. Numbering level text e.g. %1 for nonbullet or bullet character. \ No newline at end of file diff --git a/docs/usage/styles/paragraph.md b/docs/usage/styles/paragraph.md new file mode 100644 index 0000000000..e9ca155005 --- /dev/null +++ b/docs/usage/styles/paragraph.md @@ -0,0 +1,29 @@ +# Paragraph + +Available Paragraph style options: + +- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. + See ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values. +- ``basedOn``. Parent style. +- ``hanging``. Hanging indentation in *half inches*. +- ``indent``. Indent (left indentation) in *half inches*. +- ``indentation``. An array of indentation key => value pairs in *twip*. Supports *left*, *right*, *firstLine* and *hanging* indentation. + See ``\PhpOffice\PhpWord\Style\Indentation`` for possible identation types. +- ``keepLines``. Keep all lines on one page, *true* or *false*. +- ``keepNext``. Keep paragraph with next paragraph, *true* or *false*. +- ``lineHeight``. Text line height, e.g. *1.0*, *1.5*, etc. +- ``next``. Style for next paragraph. +- ``pageBreakBefore``. Start paragraph on next page, *true* or *false*. +- ``spaceBefore``. Space before paragraph in *twip*. +- ``spaceAfter``. Space after paragraph in *twip*. +- ``spacing``. Space between lines in *twip*. If spacingLineRule is auto, 240 (height of 1 line) will be added, so if you want a double line height, set this to 240. +- ``spacingLineRule``. Line Spacing Rule. *auto*, *exact*, *atLeast* + See ``\PhpOffice\PhpWord\SimpleType\LineSpacingRule`` class constants for possible values. +- ``suppressAutoHyphens``. Hyphenation for paragraph, *true* or *false*. +- ``tabs``. Set of custom tab stops. +- ``widowControl``. Allow first/last line to display on a separate page, *true* or *false*. +- ``contextualSpacing``. Ignore Spacing Above and Below When Using Identical Styles, *true* or *false*. +- ``bidi``. Right to Left Paragraph Layout, *true* or *false*. +- ``shading``. Paragraph Shading. +- ``textAlignment``. Vertical Character Alignment on Line. + See ``\PhpOffice\PhpWord\SimpleType\TextAlignment`` class constants for possible values. \ No newline at end of file diff --git a/docs/usage/styles/section.md b/docs/usage/styles/section.md new file mode 100644 index 0000000000..2be22e8077 --- /dev/null +++ b/docs/usage/styles/section.md @@ -0,0 +1,28 @@ +# Section + +Available Section style options: + +- ``borderBottomColor``. Border bottom color. +- ``borderBottomSize``. Border bottom size in *twip*. +- ``borderLeftColor``. Border left color. +- ``borderLeftSize``. Border left size in *twip*. +- ``borderRightColor``. Border right color. +- ``borderRightSize``. Border right size in *twip*. +- ``borderTopColor``. Border top color. +- ``borderTopSize``. Border top size in *twip*. +- ``breakType``. Section break type (nextPage, nextColumn, continuous, evenPage, oddPage). +- ``colsNum``. Number of columns. +- ``colsSpace``. Spacing between columns. +- ``footerHeight``. Spacing to bottom of footer. +- ``gutter``. Page gutter spacing. +- ``headerHeight``. Spacing to top of header. +- ``marginTop``. Page margin top in *twip*. +- ``marginLeft``. Page margin left in *twip*. +- ``marginRight``. Page margin right in *twip*. +- ``marginBottom``. Page margin bottom in *twip*. +- ``orientation``. Page orientation (``portrait``, which is default, or ``landscape``). + See ``\PhpOffice\PhpWord\Style\Section::ORIENTATION_...`` class constants for possible values +- ``pageSizeH``. Page height in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged. +- ``pageSizeW``. Page width in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged. +- ``vAlign``. Vertical Page Alignment + See ``\PhpOffice\PhpWord\SimpleType\VerticalJc`` for possible values \ No newline at end of file diff --git a/docs/usage/styles/table.md b/docs/usage/styles/table.md new file mode 100644 index 0000000000..1f82f3c638 --- /dev/null +++ b/docs/usage/styles/table.md @@ -0,0 +1,49 @@ +# Table + +Available Table style options: + +- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. + See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values. +- ``bgColor``. Background color, e.g. '9966CC'. +- ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'. +- ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*. +- ``cellMargin(Top|Right|Bottom|Left)``. Cell margin in *twip*. +- ``indent``. Table indent from leading margin. Must be an instance of ``\PhpOffice\PhpWord\ComplexType\TblWidth``. +- ``width``. Table width in Fiftieths of a Percent or Twentieths of a Point. +- ``unit``. The unit to use for the width. One of ``\PhpOffice\PhpWord\SimpleType\TblWidth``. Defaults to *auto*. +- ``layout``. Table layout, either *fixed* or *autofit* See ``\PhpOffice\PhpWord\Style\Table`` for constants. +- ``cellSpacing`` Cell spacing in *twip* +- ``position`` Floating Table Positioning, see below for options +- ``bidiVisual`` Present table as Right-To-Left + +Floating Table Positioning options: + +- ``leftFromText`` Distance From Left of Table to Text in *twip* +- ``rightFromText`` Distance From Right of Table to Text in *twip* +- ``topFromText`` Distance From Top of Table to Text in *twip* +- ``bottomFromText`` Distance From Top of Table to Text in *twip* +- ``vertAnchor`` Table Vertical Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::VANCHOR_*`` +- ``horzAnchor`` Table Horizontal Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::HANCHOR_*`` +- ``tblpXSpec`` Relative Horizontal Alignment From Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::XALIGN_*`` +- ``tblpX`` Absolute Horizontal Distance From Anchorin *twip* +- ``tblpYSpec`` Relative Vertical Alignment From Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::YALIGN_*`` +- ``tblpY`` Absolute Vertical Distance From Anchorin *twip* + +Available Row style options: + +- ``cantSplit``. Table row cannot break across pages, *true* or *false*. +- ``exactHeight``. Row height is exact or at least. +- ``tblHeader``. Repeat table row on every new page, *true* or *false*. + +Available Cell style options: + +- ``bgColor``. Background color, e.g. '9966CC'. +- ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'. +- ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*. +- ``border(Top|Right|Bottom|Left)Style``. Border style. You can use constants from ``\PhpOffice\PhpWord\SimpleType\Border`` +- ``gridSpan``. Number of columns spanned. +- ``textDirection(btLr|tbRl)``. Direction of text. + You can use constants ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_BTLR`` and ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_TBRL`` +- ``valign``. Vertical alignment, *top*, *center*, *both*, *bottom*. +- ``vMerge``. *restart* or *continue*. +- ``width``. Cell width in *twip*. \ No newline at end of file diff --git a/docs/usage/template.md b/docs/usage/template.md new file mode 100644 index 0000000000..17612357fd --- /dev/null +++ b/docs/usage/template.md @@ -0,0 +1,347 @@ +# Template processing + +You can create an OOXML document template with included search-patterns (macros) which can be replaced by any value you wish. Only single-line values can be replaced. +By default Macros are defined like this: ``${search-pattern}`` but you can define custom macros. +To load a template file, create a new instance of the TemplateProcessor. + +``` php +setValue('firstname', 'John'); +$templateProcessor->setValue('lastname', 'Doe'); +``` + +## setValues + +You can also set multiple values by passing all of them in an array. + +``` php +setValues(array('firstname' => 'John', 'lastname' => 'Doe')); +``` + +## setMacroOpeningChars + +You can define a custom opening macro. The following will set ``{#`` as the opening search pattern. + +``` php +setMacroOpeningChars('{#'); +``` + +## setMacroClosingChars + +You can define a custom closing macro. The following will set ``#}`` as the closing search pattern. + +``` php +setMacroClosingChars('#}'); +``` + +## setMacroChars + +You can define a custom opening and closing macro at the same time . The following will set the search-pattern like this: ``{#search-pattern#}`` . + +``` php +setMacroChars('{#', '#}'); +``` + +## setImageValue + +The search-pattern model for images can be like: + - ``${search-image-pattern}`` + - ``${search-image-pattern:[width]:[height]:[ratio]}`` + - ``${search-image-pattern:[width]x[height]}`` + - ``${search-image-pattern:size=[width]x[height]}`` + - ``${search-image-pattern:width=[width]:height=[height]:ratio=false}`` + +Where: + - [width] and [height] can be just numbers or numbers with measure, which supported by Word (cm, mm, in, pt, pc, px, %, em, ex) + - [ratio] uses only for ``false``, ``-`` or ``f`` to turn off respect aspect ration of image. By default template image size uses as 'container' size. + +Example: + +``` clean + +${CompanyLogo} +${UserLogo:50:50} ${Name} - ${City} - ${Street} +``` + +``` php +setValue('Name', 'John Doe'); +$templateProcessor->setValue(array('City', 'Street'), array('Detroit', '12th Street')); + +$templateProcessor->setImageValue('CompanyLogo', 'path/to/company/logo.png'); +$templateProcessor->setImageValue('UserLogo', array('path' => 'path/to/logo.png', 'width' => 100, 'height' => 100, 'ratio' => false)); +$templateProcessor->setImageValue('FeatureImage', function () { + // Closure will only be executed if the replacement tag is found in the template + + return array('path' => SlowFeatureImageGenerator::make(), 'width' => 100, 'height' => 100, 'ratio' => false); +}); +``` + +## cloneBlock + +Given a template containing +See ``Sample_23_TemplateBlock.php`` for an example. + +``` clean + +${block_name} +Customer: ${customer_name} +Address: ${customer_address} +${/block_name} +``` + +The following will duplicate everything between ``${block_name}`` and ``${/block_name}`` 3 times. + +``` php +cloneBlock('block_name', 3, true, true); +``` + +The last parameter will rename any macro defined inside the block and add #1, #2, #3 ... to the macro name. +The result will be + +``` clean + +Customer: ${customer_name#1} +Address: ${customer_address#1} + +Customer: ${customer_name#2} +Address: ${customer_address#2} + +Customer: ${customer_name#3} +Address: ${customer_address#3} +``` + +It is also possible to pass an array with the values to replace the marcros with. +If an array with replacements is passed, the ``count`` argument is ignored, it is the size of the array that counts. + +``` php + 'Batman', 'customer_address' => 'Gotham City'), + array('customer_name' => 'Superman', 'customer_address' => 'Metropolis'), +); +$templateProcessor->cloneBlock('block_name', 0, true, false, $replacements); +``` + +The result will then be + +``` clean + +Customer: Batman +Address: Gotham City + +Customer: Superman +Address: Metropolis +``` + +## replaceBlock + +Given a template containing + +``` clean + +${block_name} +This block content will be replaced +${/block_name} +``` + +The following will replace everything between ``${block_name}`` and ``${/block_name}`` with the value passed. + +``` php +replaceBlock('block_name', 'This is the replacement text.'); +``` + +## deleteBlock + +Same as previous, but it deletes the block + +``` php +deleteBlock('block_name'); +``` + +## cloneRow + +Clones a table row in a template document. +See ``Sample_07_TemplateCloneRow.php`` for an example. + +``` clean + ++-----------+----------------+ +| ${userId} | ${userName} | +| |----------------+ +| | ${userAddress} | ++-----------+----------------+ +``` + +``` php +cloneRow('userId', 2); +``` + +Will result in + +``` clean + + +-------------+------------------+ +| ${userId#1} | ${userName#1} | +| |------------------+ +| | ${userAddress#1} | ++-------------+------------------+ +| ${userId#2} | ${userName#2} | +| |------------------+ +| | ${userAddress#2} | ++-------------+------------------+ +``` + +## cloneRowAndSetValues + +Finds a row in a table row identified by `$search` param and clones it as many times as there are entries in `$values`. + +``` clean + ++-----------+----------------+ +| ${userId} | ${userName} | +| |----------------+ +| | ${userAddress} | ++-----------+----------------+ +``` + +``` php + 1, 'userName' => 'Batman', 'userAddress' => 'Gotham City'], + ['userId' => 2, 'userName' => 'Superman', 'userAddress' => 'Metropolis'], +]; +$templateProcessor->cloneRowAndSetValues('userId', $values); +``` + +Will result in + +``` clean + ++---+-------------+ +| 1 | Batman | +| |-------------+ +| | Gotham City | ++---+-------------+ +| 2 | Superman | +| |-------------+ +| | Metropolis | ++---+-------------+ +``` + +## applyXslStyleSheet + +Applies the XSL stylesheet passed to header part, footer part and main part + +``` php +load('/path/to/my/stylesheet.xsl'); +$templateProcessor->applyXslStyleSheet($xslDomDocument); +``` + +## setComplexValue + +Replaces a ${macro} with the ComplexType passed. +See ``Sample_40_TemplateSetComplexValue.php`` for examples. + +``` php +addText('by a red italic text', array('italic' => true, 'color' => 'red')); +$templateProcessor->setComplexValue('inline', $inline); +``` + +## setComplexBlock + +Replaces a ${macro} with the ComplexType passed. +See ``Sample_40_TemplateSetComplexValue.php`` for examples. + +``` php + 12, 'borderColor' => 'green', 'width' => 6000, 'unit' => TblWidth::TWIP)); +$table->addRow(); +$table->addCell(150)->addText('Cell A1'); +$table->addCell(150)->addText('Cell A2'); +$table->addCell(150)->addText('Cell A3'); +$table->addRow(); +$table->addCell(150)->addText('Cell B1'); +$table->addCell(150)->addText('Cell B2'); +$table->addCell(150)->addText('Cell B3'); +$templateProcessor->setComplexBlock('table', $table); +``` + +## setChartValue + +Replace a variable by a chart. + +``` php +setChartValue('myChart', $chart); +``` + +## save + +Saves the loaded template within the current directory. Returns the file path. + +``` php +save(); +``` + +## saveAs + +Saves a copy of the loaded template in the indicated path. + +``` php +saveAs($pathToSave); +``` diff --git a/docs/usage/writers.md b/docs/usage/writers.md new file mode 100644 index 0000000000..86458cecef --- /dev/null +++ b/docs/usage/writers.md @@ -0,0 +1,65 @@ +# Writers + +## HTML +The name of the writer is `HTML`. + +``` php +save(__DIR__ . '/sample.html'); +``` + +## ODText +The name of the writer is `ODText`. + +``` php +save(__DIR__ . '/sample.docx'); +``` + +## PDF +The name of the writer is `PDF`. + +``` php +save(__DIR__ . '/sample.pdf'); +``` + +## RTF +The name of the writer is `RTF`. + +``` php +save(__DIR__ . '/sample.rtf'); +``` + +## Word2007 +The name of the writer is `Word2007`. + +``` php +save(__DIR__ . '/sample.docx'); +``` + +### ZIP Adapter +You can change the ZIP Adapter for the writer. By default, the ZIP Adapter is `ZipArchiveAdapter`. + +``` php +setZipAdapter(new PclZipAdapter()); +$writer->save(__DIR__ . '/sample.docx'); +``` diff --git a/docs/writersreaders.rst b/docs/writersreaders.rst deleted file mode 100644 index 33aacc72af..0000000000 --- a/docs/writersreaders.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. _writersreaders: - -Writers & readers -================= - -OOXML ------ - -The package of OOXML document consists of the following files. - -- \_rels/ - - - .rels - -- docProps/ - - - app.xml - - core.xml - - custom.xml - -- word/ - - - rels/ - - - document.rels.xml - - - media/ - - theme/ - - - theme1.xml - - - document.xml - - fontTable.xml - - numbering.xml - - settings.xml - - styles.xml - - webSettings.xml - -- [Content\_Types].xml - -OpenDocument ------------- - -Package -~~~~~~~ - -The package of OpenDocument document consists of the following files. - -- META-INF/ - - - manifest.xml - -- Pictures/ -- content.xml -- meta.xml -- styles.xml - -content.xml -~~~~~~~~~~~ - -The structure of ``content.xml`` is described below. - -- office:document-content - - - office:font-facedecls - - office:automatic-styles - - office:body - - - office:text - - - draw:\* - - office:forms - - table:table - - text:list - - text:numbered-paragraph - - text:p - - text:table-of-contents - - text:section - - - office:chart - - office:image - - office:drawing - -styles.xml -~~~~~~~~~~ - -The structure of ``styles.xml`` is described below. - -- office:document-styles - - - office:styles - - office:automatic-styles - - office:master-styles - - - office:master-page - -RTF ---- - -To be completed. - -HTML ----- - -To be completed. - -PDF ---- - -To be completed. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000000..5618dec88c --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,116 @@ +site_name: PHPWord +site_url: https://phpoffice.github.io/PHPWord +repo_url: https://github.com/PHPOffice/PHPWord +repo_name: PHPOffice/PHPWord +edit_uri: edit/develop/docs/ + +## Theme +theme: + name: material + palette: + primary: indigo + features: + - search.highlight + - search.suggest + +## Plugins +plugins: + - search + - autolink_references: + autolinks: + - reference_prefix: GP- + target_url: https://github.com/ + - reference_prefix: GH- + target_url: https://github.com/PHPOffice/PHPWord/issues/ + - reference_prefix: CP- + target_url: https://archive.codeplex.com/?p=phpword& + +## Config +extra: + generator: false +markdown_extensions: + ## Syntax highlighting + - pymdownx.highlight + - pymdownx.superfences + ## Support for emojis + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + ## Support for call-outs + - admonition + - pymdownx.details +use_directory_urls: false + +## Navigation +nav: + - Introduction: 'index.md' + - Install: 'install.md' + - Usage: + - Introduction: 'usage/introduction.md' + - Containers: 'usage/containers.md' + - Elements: + - Introduction: 'usage/elements/index.md' + - Chart: 'usage/elements/chart.md' + - Checkbox: 'usage/elements/checkbox.md' + - Comment: 'usage/elements/comment.md' + - Field: 'usage/elements/field.md' + - Footnote & Endnote: 'usage/elements/note.md' + - Image: 'usage/elements/image.md' + - Line: 'usage/elements/line.md' + - Link: 'usage/elements/link.md' + - List: 'usage/elements/list.md' + - OLE Object: 'usage/elements/oleobject.md' + - Page Break: 'usage/elements/pagebreak.md' + - Preserve Text: 'usage/elements/preservetext.md' + - Text: 'usage/elements/text.md' + - TextBox: 'usage/elements/textbox.md' + - Text Break: 'usage/elements/textbreak.md' + - Table: 'usage/elements/table.md' + - Table of contents: 'usage/elements/toc.md' + - Title: 'usage/elements/title.md' + - Track Changes: 'usage/elements/trackchanges.md' + - Watermark: 'usage/elements/watermark.md' + - Styles: + - Chart: 'usage/styles/chart.md' + - Font: 'usage/styles/font.md' + - Image: 'usage/styles/image.md' + - Numbering Level: 'usage/styles/numberinglevel.md' + - Paragraph: 'usage/styles/paragraph.md' + - Section: 'usage/styles/section.md' + - Table: 'usage/styles/table.md' + - Template Processing: 'usage/template.md' + - Readers: 'usage/readers.md' + - Writers: 'usage/writers.md' + - FAQ: 'faq.md' + - How to: 'howto.md' + - Credits: 'credits.md' + - Releases: + - '1.x': + - '1.2.0 (WIP)': 'changes/1.x/1.2.0.md' + - '1.1.0': 'changes/1.x/1.1.0.md' + - '1.0.0': 'changes/1.x/1.0.0.md' + - '0.x': + - '0.18.3': 'changes/0.x/0.18.3.md' + - '0.18.2': 'changes/0.x/0.18.2.md' + - '0.18.1': 'changes/0.x/0.18.1.md' + - '0.18.0': 'changes/0.x/0.18.0.md' + - '0.17.0': 'changes/0.x/0.17.0.md' + - '0.16.0': 'changes/0.x/0.16.0.md' + - '0.15.0': 'changes/0.x/0.15.0.md' + - '0.14.0': 'changes/0.x/0.14.0.md' + - '0.13.0': 'changes/0.x/0.13.0.md' + - '0.12.1': 'changes/0.x/0.12.1.md' + - '0.12.0': 'changes/0.x/0.12.0.md' + - '0.11.1': 'changes/0.x/0.11.1.md' + - '0.11.0': 'changes/0.x/0.11.0.md' + - '0.10.1': 'changes/0.x/0.10.1.md' + - '0.10.0': 'changes/0.x/0.10.0.md' + - '0.9.1': 'changes/0.x/0.9.1.md' + - '0.9.0': 'changes/0.x/0.9.0.md' + - '0.8.1': 'changes/0.x/0.8.1.md' + - '0.8.0': 'changes/0.x/0.8.0.md' + - '0.7.0': 'changes/0.x/0.7.0.md' + - Developers: + - 'Coveralls': 'https://coveralls.io/github/PHPOffice/PHPWord' + - 'Code Coverage': 'coverage/index.html' + - 'PHPDoc': 'docs/index.html' diff --git a/samples/Sample_26_Html.php b/samples/Sample_26_Html.php index 84468faaa5..daf109966c 100644 --- a/samples/Sample_26_Html.php +++ b/samples/Sample_26_Html.php @@ -12,7 +12,7 @@ $html .= '

Some well-formed HTML snippet needs to be used

'; $html .= '

With for example some1 inline formatting1

'; -$html .= '

A link to Read the docs

'; +$html .= '

A link to Read the docs

'; $html .= '

היי, זה פסקה מימין לשמאל

'; diff --git a/samples/Sample_Header.php b/samples/Sample_Header.php index 53674b7914..8d05a2a34e 100644 --- a/samples/Sample_Header.php +++ b/samples/Sample_Header.php @@ -165,8 +165,8 @@ function getEndingNotes($writers, $filename) diff --git a/samples/index.php b/samples/index.php index a867eb3d80..a9733d2c7c 100644 --- a/samples/index.php +++ b/samples/index.php @@ -19,7 +19,7 @@

 

Fork us on Github! - Read the Docs + Read the Docs

Adding element via HTML

Double height

Includes images

- + diff --git a/sonar-project.properties b/sonar-project.properties deleted file mode 100644 index 7741cfb475..0000000000 --- a/sonar-project.properties +++ /dev/null @@ -1,17 +0,0 @@ -# must be unique in a given SonarQube instance -sonar.projectKey=phpoffice:phpword -# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1. -sonar.projectName=PHPWord -sonar.projectVersion=0.16 - -# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows. -# This property is optional if sonar.modules is set. -sonar.sources=src -sonar.tests=tests -sonar.php.coverage.reportPaths=build/logs/clover.xml -sonar.php.tests.reportPath=build/logs/logfile.xml - -# Encoding of the source code. Default is default system encoding -#sonar.sourceEncoding=UTF-8 - -sonar.host.url=http://localhost:9000 \ No newline at end of file diff --git a/src/PhpWord/Reader/MsDoc.php b/src/PhpWord/Reader/MsDoc.php index c76f5df3e0..fed6c99188 100644 --- a/src/PhpWord/Reader/MsDoc.php +++ b/src/PhpWord/Reader/MsDoc.php @@ -1141,7 +1141,7 @@ private function readFibContent(): void /** * Section and information about them. * - * @see : http://msdn.microsoft.com/en-us/library/dd924458%28v=office.12%29.aspx + * @see http://msdn.microsoft.com/en-us/library/dd924458%28v=office.12%29.aspx */ private function readRecordPlcfSed(): void { @@ -1187,7 +1187,7 @@ private function readRecordPlcfSed(): void /** * Specifies the fonts that are used in the document. * - * @see : http://msdn.microsoft.com/en-us/library/dd943880%28v=office.12%29.aspx + * @see http://msdn.microsoft.com/en-us/library/dd943880%28v=office.12%29.aspx */ private function readRecordSttbfFfn(): void { @@ -1271,7 +1271,7 @@ private function readRecordPlcfBtePapx(): void } $arrayRGB = []; for ($inc = 1; $inc <= $numRun; ++$inc) { - // @see http://msdn.microsoft.com/en-us/library/dd925804(v=office.12).aspx + //@see http://msdn.microsoft.com/en-us/library/dd925804(v=office.12).aspx $arrayRGB[$inc] = self::getInt1d($this->dataWorkDocument, $offset); ++$offset; // reserved @@ -1478,7 +1478,7 @@ private function readRecordPlcfBteChpx(): void $offset = $offsetBase; // ChpxFkp - // @see : http://msdn.microsoft.com/en-us/library/dd910989%28v=office.12%29.aspx + //@see : http://msdn.microsoft.com/en-us/library/dd910989%28v=office.12%29.aspx $numRGFC = self::getInt1d($this->dataWorkDocument, $offset + 511); $arrayRGFC = []; for ($inc = 0; $inc <= $numRGFC; ++$inc) { @@ -1501,7 +1501,7 @@ private function readRecordPlcfBteChpx(): void if ($rgb > 0) { // Chp Structure - // @see : http://msdn.microsoft.com/en-us/library/dd772849%28v=office.12%29.aspx + //@see : http://msdn.microsoft.com/en-us/library/dd772849%28v=office.12%29.aspx $posRGB = $offsetBase + $rgb * 2; $cb = self::getInt1d($this->dataWorkDocument, $posRGB); diff --git a/src/PhpWord/Writer/Word2007.php b/src/PhpWord/Writer/Word2007.php index 9e17efa611..ae10ba5a74 100644 --- a/src/PhpWord/Writer/Word2007.php +++ b/src/PhpWord/Writer/Word2007.php @@ -121,7 +121,7 @@ public function save($filename = null): void $this->addHeaderFooterMedia($zip, 'footer'); // Add header/footer contents - $rId = Media::countElements('section') + 6; // @see Rels::writeDocRels for 6 first elements + $rId = Media::countElements('section') + 6; //@see Rels::writeDocRels for 6 first elements $sections = $phpWord->getSections(); foreach ($sections as $section) { $this->addHeaderFooterContent($section, $zip, 'header', $rId); diff --git a/tests/PhpWordTests/Shared/HtmlTest.php b/tests/PhpWordTests/Shared/HtmlTest.php index d65066d54c..b0ab159150 100644 --- a/tests/PhpWordTests/Shared/HtmlTest.php +++ b/tests/PhpWordTests/Shared/HtmlTest.php @@ -891,7 +891,7 @@ public function testParseLink(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); - $html = '

link text

'; + $html = '

link text

'; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007');