2017 © Pedro PelĂĄez
 

library docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

image

gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  • Thursday, May 31, 2018
  • by kstenschke
  • Repository
  • 2 Watchers
  • 2 Stars
  • 831 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 1 Open issues
  • 13 Versions
  • 4 % Grown

The README.md

DocxTidy

Total Downloads Latest Stable Version, (*1)

Description

A PHP library to tidy DOCX XML files: merges successive elements of same type and properties., (*2)

By simplifying the markup of DOCX XML, DocxTidy alleviates the efforts needed for custom modifications (for instance DOCX-based templating)., (*3)

  • 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:, (*4)

  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., (*5)

Installation

The recommended way to install is via Composer:, (*6)

$ composer require gyselroth/docx-tidy

PHP 7.1 is required since DocxTidy version 0.5.0 (PHP 5.6 until version 0.4.5), (*7)

Usage

Example 1: Tidy a whole DOCX file

<?php

use DocxTidy\DocxTidy;

// tidy a DOCX file
(new DocxTidy())->tidyDocx('path/to/your.docx');

Example 2: Tidy an XML (string)

<?php

use DocxTidy\DocxTidy;

// read DOCX XML, e.g. "document.xml" / "header1.xml" / etc
$xml = file_get_contents('path/to/your_unzipped_docx/word/document.xml');

// tidy DOCX XML string
$xml = (new DocxTidy())->tidyXml($xml);

Changelog

https://github.com/gyselroth/docx-tidy/blob/master/CHANGELOG.md, (*8)

Submitting bugs and feature requests

Bugs and feature request are tracked on GitHub, (*9)

Third party acknowledgements

Microsoft Office and Word are registered trademarks of Microsoft Corporation., (*10)

Author and License

Copyright 2017 gyselrothℱ (http://www.gyselroth.com), (*11)

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, (*12)

http://www.apache.org/licenses/LICENSE-2.0":http://www.apache.org/licenses/LICENSE-2.0, (*13)

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., (*14)

The Versions

31/05 2018

dev-master

9999999-dev https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=7.1.0

 

by gyselroth

xml markup word office tidy minification docx

16/01 2018

0.5.1

0.5.1.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=7.1.0

 

by gyselroth

xml markup word office tidy minification docx

11/01 2018

0.5.0

0.5.0.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=7.1.0

 

by gyselroth

xml markup word office tidy minification docx

09/10 2017

0.4.5

0.4.5.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

by gyselroth

xml markup word office tidy minification docx

08/05 2017

0.4.4

0.4.4.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

by gyselroth

xml markup word office tidy minification docx

23/03 2017

0.4.3

0.4.3.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

by gyselroth

xml markup word office tidy minification docx

22/02 2017

0.4.2

0.4.2.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

by gyselroth

xml markup word office tidy minification docx

22/02 2017

0.4.1

0.4.1.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

by gyselroth

xml markup word office tidy minification docx

21/02 2017

0.4.0

0.4.0.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

by gyselroth

xml markup word office tidy minification docx

21/02 2017

0.3.0

0.3.0.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

by gyselroth

xml markup word office tidy minification docx

20/02 2017

0.2.0

0.2.0.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

by gyselroth

xml markup word office tidy minification docx

16/02 2017

0.1.1

0.1.1.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

The Development Requires

by gyselroth

xml markup word office tidy minification docx

15/02 2017

0.1.0

0.1.0.0 https://github.com/gyselroth/docx-tidy

Simplify markup of DOCX XML by tidying successive elements w/ redundant properties / types.

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

by gyselroth

xml tidy docx