Merge pull request #1286 from meteocontrol/feature-consistent-twip-naming

Use consistent name for twip unit
This commit is contained in:
troosan 2018-02-17 08:40:48 +01:00 committed by GitHub
commit cc57eb987e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 23 additions and 23 deletions

View File

@ -79,7 +79,7 @@ Below are the properties of the line numbering style.
- ``start`` Line numbering starting value - ``start`` Line numbering starting value
- ``increment`` Line number increments - ``increment`` Line number increments
- ``distance`` Distance between text and line numbering in twip - ``distance`` Distance between text and line numbering in *twip*
- ``restart`` Line numbering restart setting - ``restart`` Line numbering restart setting
continuous\|newPage\|newSection continuous\|newPage\|newSection

View File

@ -307,8 +307,8 @@ Your TOC can only be generated if you have add at least one title (See "Titles")
Options for ``$tocStyle``: Options for ``$tocStyle``:
- ``tabLeader``. Fill type between the title text and the page number. Use the defined constants in ``\PhpOffice\PhpWord\Style\TOC``. - ``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 twips. - ``tabPos``. The position of the tab where the page number appears in *twip*.
- ``indent``. The indent factor of the titles in twips. - ``indent``. The indent factor of the titles in *twip*.
Footnotes & endnotes Footnotes & endnotes
-------------------- --------------------
@ -429,7 +429,7 @@ Line elements can be added to sections by using ``addLine``.
Available line style attributes: Available line style attributes:
- ``weight``. Line width in twips. - ``weight``. Line width in *twip*.
- ``color``. Defines the color of stroke. - ``color``. Defines the color of stroke.
- ``dash``. Line types: dash, rounddot, squaredot, dashdot, longdash, longdashdot, longdashdotdot. - ``dash``. Line types: dash, rounddot, squaredot, dashdot, longdash, longdashdot, longdashdotdot.
- ``beginArrow``. Start type of arrow: block, open, classic, diamond, oval. - ``beginArrow``. Start type of arrow: block, open, classic, diamond, oval.

View File

@ -255,7 +255,7 @@ The base length unit in Open Office XML is twip. Twip means "TWentieth
of an Inch Point", i.e. 1 twip = 1/1440 inch. of an Inch Point", i.e. 1 twip = 1/1440 inch.
You can use PHPWord helper functions to convert inches, centimeters, or You can use PHPWord helper functions to convert inches, centimeters, or
points to twips. points to twip.
.. code-block:: php .. code-block:: php

View File

@ -11,26 +11,26 @@ Section
Available Section style options: Available Section style options:
- ``borderBottomColor``. Border bottom color. - ``borderBottomColor``. Border bottom color.
- ``borderBottomSize``. Border bottom size (in twips). - ``borderBottomSize``. Border bottom size in *twip*.
- ``borderLeftColor``. Border left color. - ``borderLeftColor``. Border left color.
- ``borderLeftSize``. Border left size (in twips). - ``borderLeftSize``. Border left size in *twip*.
- ``borderRightColor``. Border right color. - ``borderRightColor``. Border right color.
- ``borderRightSize``. Border right size (in twips). - ``borderRightSize``. Border right size in *twip*.
- ``borderTopColor``. Border top color. - ``borderTopColor``. Border top color.
- ``borderTopSize``. Border top size (in twips). - ``borderTopSize``. Border top size in *twip*.
- ``breakType``. Section break type (nextPage, nextColumn, continuous, evenPage, oddPage). - ``breakType``. Section break type (nextPage, nextColumn, continuous, evenPage, oddPage).
- ``colsNum``. Number of columns. - ``colsNum``. Number of columns.
- ``colsSpace``. Spacing between columns. - ``colsSpace``. Spacing between columns.
- ``footerHeight``. Spacing to bottom of footer. - ``footerHeight``. Spacing to bottom of footer.
- ``gutter``. Page gutter spacing. - ``gutter``. Page gutter spacing.
- ``headerHeight``. Spacing to top of header. - ``headerHeight``. Spacing to top of header.
- ``marginTop``. Page margin top (in twips). - ``marginTop``. Page margin top in *twip*.
- ``marginLeft``. Page margin left (in twips). - ``marginLeft``. Page margin left in *twip*.
- ``marginRight``. Page margin right (in twips). - ``marginRight``. Page margin right in *twip*.
- ``marginBottom``. Page margin bottom (in twips). - ``marginBottom``. Page margin bottom in *twip*.
- ``orientation``. Page orientation (``portrait``, which is default, or ``landscape``). - ``orientation``. Page orientation (``portrait``, which is default, or ``landscape``).
- ``pageSizeH``. Page height (in twips). Implicitly defined by ``orientation`` option. Any changes are discouraged. - ``pageSizeH``. Page height in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged.
- ``pageSizeW``. Page width (in twips). Implicitly defined by ``orientation`` option. Any changes are discouraged. - ``pageSizeW``. Page width in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged.
.. _font-style: .. _font-style:
@ -70,15 +70,15 @@ Available Paragraph style options:
- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. - ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details. See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details.
- ``basedOn``. Parent style. - ``basedOn``. Parent style.
- ``hanging``. Hanging by how much. - ``hanging``. Hanging in *twip*.
- ``indent``. Indent by how much. - ``indent``. Indent in *twip*.
- ``keepLines``. Keep all lines on one page, *true* or *false*. - ``keepLines``. Keep all lines on one page, *true* or *false*.
- ``keepNext``. Keep paragraph with next paragraph, *true* or *false*. - ``keepNext``. Keep paragraph with next paragraph, *true* or *false*.
- ``lineHeight``. Text line height, e.g. *1.0*, *1.5*, etc. - ``lineHeight``. Text line height, e.g. *1.0*, *1.5*, etc.
- ``next``. Style for next paragraph. - ``next``. Style for next paragraph.
- ``pageBreakBefore``. Start paragraph on next page, *true* or *false*. - ``pageBreakBefore``. Start paragraph on next page, *true* or *false*.
- ``spaceBefore``. Space before paragraph. - ``spaceBefore``. Space before paragraph in *twip*.
- ``spaceAfter``. Space after paragraph. - ``spaceAfter``. Space after paragraph in *twip*.
- ``spacing``. Space between lines. - ``spacing``. Space between lines.
- ``spacingLineRule``. Line Spacing Rule. *auto*, *exact*, *atLeast* - ``spacingLineRule``. Line Spacing Rule. *auto*, *exact*, *atLeast*
- ``tabs``. Set of custom tab stops. - ``tabs``. Set of custom tab stops.
@ -100,8 +100,8 @@ Available Table style options:
See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` classes for the details. See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` classes for the details.
- ``bgColor``. Background color, e.g. '9966CC'. - ``bgColor``. Background color, e.g. '9966CC'.
- ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'. - ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'.
- ``border(Top|Right|Bottom|Left)Size``. Border size in twips. - ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*.
- ``cellMargin(Top|Right|Bottom|Left)``. Cell margin in twips. - ``cellMargin(Top|Right|Bottom|Left)``. Cell margin in *twip*.
- ``width``. Table width in percent. - ``width``. Table width in percent.
- ``layout``. Table layout, either *fixed* or *autofit* See ``\PhpOffice\PhpWord\Style\Table`` for constants. - ``layout``. Table layout, either *fixed* or *autofit* See ``\PhpOffice\PhpWord\Style\Table`` for constants.
@ -115,13 +115,13 @@ Available Cell style options:
- ``bgColor``. Background color, e.g. '9966CC'. - ``bgColor``. Background color, e.g. '9966CC'.
- ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'. - ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'.
- ``border(Top|Right|Bottom|Left)Size``. Border size in twips. - ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*.
- ``gridSpan``. Number of columns spanned. - ``gridSpan``. Number of columns spanned.
- ``textDirection(btLr|tbRl)``. Direction of text. - ``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`` 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*. - ``valign``. Vertical alignment, *top*, *center*, *both*, *bottom*.
- ``vMerge``. *restart* or *continue*. - ``vMerge``. *restart* or *continue*.
- ``width``. Cell width in twips. - ``width``. Cell width in *twip*.
.. _image-style: .. _image-style: