Skip to content

Commit cc57eb9

Browse files
authored
Merge pull request #1286 from meteocontrol/feature-consistent-twip-naming
Use consistent name for twip unit
2 parents 7324070 + fede4f7 commit cc57eb9

File tree

4 files changed

+23
-23
lines changed

4 files changed

+23
-23
lines changed

docs/containers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Below are the properties of the line numbering style.
7979

8080
- ``start`` Line numbering starting value
8181
- ``increment`` Line number increments
82-
- ``distance`` Distance between text and line numbering in twip
82+
- ``distance`` Distance between text and line numbering in *twip*
8383
- ``restart`` Line numbering restart setting
8484
continuous\|newPage\|newSection
8585

docs/elements.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -307,8 +307,8 @@ Your TOC can only be generated if you have add at least one title (See "Titles")
307307
Options for ``$tocStyle``:
308308

309309
- ``tabLeader``. Fill type between the title text and the page number. Use the defined constants in ``\PhpOffice\PhpWord\Style\TOC``.
310-
- ``tabPos``. The position of the tab where the page number appears in twips.
311-
- ``indent``. The indent factor of the titles in twips.
310+
- ``tabPos``. The position of the tab where the page number appears in *twip*.
311+
- ``indent``. The indent factor of the titles in *twip*.
312312

313313
Footnotes & endnotes
314314
--------------------
@@ -429,7 +429,7 @@ Line elements can be added to sections by using ``addLine``.
429429
430430
Available line style attributes:
431431

432-
- ``weight``. Line width in twips.
432+
- ``weight``. Line width in *twip*.
433433
- ``color``. Defines the color of stroke.
434434
- ``dash``. Line types: dash, rounddot, squaredot, dashdot, longdash, longdashdot, longdashdotdot.
435435
- ``beginArrow``. Start type of arrow: block, open, classic, diamond, oval.

docs/general.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ The base length unit in Open Office XML is twip. Twip means "TWentieth
255255
of an Inch Point", i.e. 1 twip = 1/1440 inch.
256256

257257
You can use PHPWord helper functions to convert inches, centimeters, or
258-
points to twips.
258+
points to twip.
259259

260260
.. code-block:: php
261261

docs/styles.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,26 @@ Section
1111
Available Section style options:
1212

1313
- ``borderBottomColor``. Border bottom color.
14-
- ``borderBottomSize``. Border bottom size (in twips).
14+
- ``borderBottomSize``. Border bottom size in *twip*.
1515
- ``borderLeftColor``. Border left color.
16-
- ``borderLeftSize``. Border left size (in twips).
16+
- ``borderLeftSize``. Border left size in *twip*.
1717
- ``borderRightColor``. Border right color.
18-
- ``borderRightSize``. Border right size (in twips).
18+
- ``borderRightSize``. Border right size in *twip*.
1919
- ``borderTopColor``. Border top color.
20-
- ``borderTopSize``. Border top size (in twips).
20+
- ``borderTopSize``. Border top size in *twip*.
2121
- ``breakType``. Section break type (nextPage, nextColumn, continuous, evenPage, oddPage).
2222
- ``colsNum``. Number of columns.
2323
- ``colsSpace``. Spacing between columns.
2424
- ``footerHeight``. Spacing to bottom of footer.
2525
- ``gutter``. Page gutter spacing.
2626
- ``headerHeight``. Spacing to top of header.
27-
- ``marginTop``. Page margin top (in twips).
28-
- ``marginLeft``. Page margin left (in twips).
29-
- ``marginRight``. Page margin right (in twips).
30-
- ``marginBottom``. Page margin bottom (in twips).
27+
- ``marginTop``. Page margin top in *twip*.
28+
- ``marginLeft``. Page margin left in *twip*.
29+
- ``marginRight``. Page margin right in *twip*.
30+
- ``marginBottom``. Page margin bottom in *twip*.
3131
- ``orientation``. Page orientation (``portrait``, which is default, or ``landscape``).
32-
- ``pageSizeH``. Page height (in twips). Implicitly defined by ``orientation`` option. Any changes are discouraged.
33-
- ``pageSizeW``. Page width (in twips). Implicitly defined by ``orientation`` option. Any changes are discouraged.
32+
- ``pageSizeH``. Page height in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged.
33+
- ``pageSizeW``. Page width in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged.
3434

3535
.. _font-style:
3636

@@ -70,15 +70,15 @@ Available Paragraph style options:
7070
- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
7171
See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details.
7272
- ``basedOn``. Parent style.
73-
- ``hanging``. Hanging by how much.
74-
- ``indent``. Indent by how much.
73+
- ``hanging``. Hanging in *twip*.
74+
- ``indent``. Indent in *twip*.
7575
- ``keepLines``. Keep all lines on one page, *true* or *false*.
7676
- ``keepNext``. Keep paragraph with next paragraph, *true* or *false*.
7777
- ``lineHeight``. Text line height, e.g. *1.0*, *1.5*, etc.
7878
- ``next``. Style for next paragraph.
7979
- ``pageBreakBefore``. Start paragraph on next page, *true* or *false*.
80-
- ``spaceBefore``. Space before paragraph.
81-
- ``spaceAfter``. Space after paragraph.
80+
- ``spaceBefore``. Space before paragraph in *twip*.
81+
- ``spaceAfter``. Space after paragraph in *twip*.
8282
- ``spacing``. Space between lines.
8383
- ``spacingLineRule``. Line Spacing Rule. *auto*, *exact*, *atLeast*
8484
- ``tabs``. Set of custom tab stops.
@@ -100,8 +100,8 @@ Available Table style options:
100100
See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` classes for the details.
101101
- ``bgColor``. Background color, e.g. '9966CC'.
102102
- ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'.
103-
- ``border(Top|Right|Bottom|Left)Size``. Border size in twips.
104-
- ``cellMargin(Top|Right|Bottom|Left)``. Cell margin in twips.
103+
- ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*.
104+
- ``cellMargin(Top|Right|Bottom|Left)``. Cell margin in *twip*.
105105
- ``width``. Table width in percent.
106106
- ``layout``. Table layout, either *fixed* or *autofit* See ``\PhpOffice\PhpWord\Style\Table`` for constants.
107107

@@ -115,13 +115,13 @@ Available Cell style options:
115115

116116
- ``bgColor``. Background color, e.g. '9966CC'.
117117
- ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'.
118-
- ``border(Top|Right|Bottom|Left)Size``. Border size in twips.
118+
- ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*.
119119
- ``gridSpan``. Number of columns spanned.
120120
- ``textDirection(btLr|tbRl)``. Direction of text.
121121
You can use constants ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_BTLR`` and ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_TBRL``
122122
- ``valign``. Vertical alignment, *top*, *center*, *both*, *bottom*.
123123
- ``vMerge``. *restart* or *continue*.
124-
- ``width``. Cell width in twips.
124+
- ``width``. Cell width in *twip*.
125125

126126
.. _image-style:
127127

0 commit comments

Comments
 (0)