Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gyselroth/docx-tidy
PHP library to tidy DOCX XML files: merges successive elements of same type and properties
https://github.com/gyselroth/docx-tidy
docx markup minification office php tidy word wordml wordprocessingml xml
Last synced: 4 days ago
JSON representation
PHP library to tidy DOCX XML files: merges successive elements of same type and properties
- Host: GitHub
- URL: https://github.com/gyselroth/docx-tidy
- Owner: gyselroth
- License: other
- Created: 2017-02-15T16:01:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-31T11:51:38.000Z (over 6 years ago)
- Last Synced: 2024-09-25T12:29:02.933Z (about 2 months ago)
- Topics: docx, markup, minification, office, php, tidy, word, wordml, wordprocessingml, xml
- Language: PHP
- Homepage: http://www.gyselroth.com
- Size: 64.5 KB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
DocxTidy
========
[](https://packagist.org/packages/gyselroth/docx-tidy)
[](https://packagist.org/packages/gyselroth/docx-tidy)
Description
-----------
A PHP library to tidy DOCX XML files: merges successive elements of same type and properties.
By simplifying the markup of DOCX XML, DocxTidy alleviates the efforts needed for custom modifications (for instance DOCX-based templating).
* Merges successive runs having identical run-properties
* Merges successive elements of same type (<w:t>, <w:instrText>) within each run
DocxTidy supports two tidying modes:
1. DOCX files (includes unpacking and re-archiving of contained XML files)
2. XML string
Please Note
-----------
* By merging segmented tags, DocxTidy removes versioning/editing history information
* When run with default settings, DocxTidy removes spellchecking flags ("noProof", "proofErr", "lang")
* DocxTidy removes all xml:space="preserve" flags and re-inserts xml:space="preserve" into all <w:t> and <w:instrText> tags
* To standardize run properties, DocxTidy deletes any font hints
* After unifying consecutive runs w/ identical properties and removing any spellchecking flags, DocxTidy removes any resulting empty tags
This library is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied.
Installation
------------
The recommended way to install is via Composer:
```bash
$ composer require gyselroth/docx-tidy
```
PHP 7.1 is required since DocxTidy version 0.5.0 (PHP 5.6 until version 0.4.5)
Usage
-----
### Example 1: Tidy a whole DOCX file
```php
tidyDocx('path/to/your.docx');
```
### Example 2: Tidy an XML (string)
```php
tidyXml($xml);
```
Changelog
---------
https://github.com/gyselroth/docx-tidy/blob/master/CHANGELOG.md
Submitting bugs and feature requests
------------------------------------
Bugs and feature request are tracked on [GitHub](https://github.com/gyselroth/docx-tidy/issues)
Third party acknowledgements
----------------------------
Microsoft Office and Word are registered trademarks of Microsoft Corporation.
Author and License
------------------
Copyright 2017 gyselroth™ (http://www.gyselroth.com)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0":http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.