Clientbase
/
PHPWord
mirror of https://github.com/basemaster/PHPWord.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix(documentation): snippet for FootnoteProperties 

The documentation contained an incorrect code snippet for
configuring FootnoteProperties. Now the code is valid.
This commit is contained in:
Michaël Dupont 2019-12-09 11:22:08 +01:00
parent 4852028743
commit cb3e211135
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/elements.rst
View File

@ -359,17 +359,17 @@ The footnote numbering can be controlled by setting the FootnoteProperties on th
.. code-block:: php .. code-block:: php
$fp = new PhpWord\SimpleType\FootnoteProperties(); $fp = new \PhpOffice\PhpWord\ComplexType\FootnoteProperties();
//sets the position of the footnote (pageBottom (default), beneathText, sectEnd, docEnd) //sets the position of the footnote (pageBottom (default), beneathText, sectEnd, docEnd)
$fp->setPos(FootnoteProperties::POSITION_DOC_END); $fp->setPos(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::POSITION_BENEATH_TEXT);
//set the number format to use (decimal (default), upperRoman, upperLetter, ...) //set the number format to use (decimal (default), upperRoman, upperLetter, ...)
$fp->setNumFmt(FootnoteProperties::NUMBER_FORMAT_LOWER_ROMAN); $fp->setNumFmt(\PhpOffice\PhpWord\SimpleType\NumberFormat::LOWER_ROMAN);
//force starting at other than 1 //force starting at other than 1
$fp->setNumStart(2); $fp->setNumStart(2);
//when to restart counting (continuous (default), eachSect, eachPage) //when to restart counting (continuous (default), eachSect, eachPage)
$fp->setNumRestart(FootnoteProperties::RESTART_NUMBER_EACH_PAGE); $fp->setNumRestart(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::RESTART_NUMBER_EACH_PAGE);
//And finaly, set it on the Section //And finaly, set it on the Section
$section->setFootnoteProperties($properties); $section->setFootnoteProperties($fp);
Checkboxes Checkboxes
---------- ----------