1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
|
Breaks
======
Word supports a variety of breaks that interrupt the flow of text in the
document:
* line break
* page break
* column break
* section break (new page, even page, odd page)
In addition, a page break can be forced by formatting a paragraph with the
"page break before" setting.
This analysis is limited to line, page, and column breaks. A section break is
implemented using a completely different set of elements and is covered
separately.
Candidate protocol -- run.add_break()
-------------------------------------
The following interactive session demonstrates the protocol for adding a page
break::
>>> run = p.add_run()
>>> run.breaks
[]
>>> run.add_break() # by default adds WD_BREAK.LINE
>>> run.breaks
[<docx.text.Break object at 0x10a7c4f50>]
>>> run.breaks[0].type.__name__
WD_BREAK.LINE
>>> run.add_break(WD_BREAK.LINE)
>>> run.breaks
[<docx.text.Break object at 0x10a7c4f50>, <docx.text.Break object at 0x10a7c4f58>]
>>> run.add_break(WD_BREAK.PAGE)
>>> run.add_break(WD_BREAK.COLUMN)
>>> run.add_break(WD_BREAK.LINE_CLEAR_LEFT)
>>> run.add_break(WD_BREAK.LINE_CLEAR_RIGHT)
>>> run.add_break(WD_BREAK.TEXT_WRAPPING)
Enumeration -- WD_BREAK_TYPE
----------------------------
* WD_BREAK.LINE
* WD_BREAK.LINE_CLEAR_LEFT
* WD_BREAK.LINE_CLEAR_RIGHT
* WD_BREAK.TEXT_WRAPPING (e.g. LINE_CLEAR_ALL)
* WD_BREAK.PAGE
* WD_BREAK.COLUMN
* WD_BREAK.SECTION_NEXT_PAGE
* WD_BREAK.SECTION_CONTINUOUS
* WD_BREAK.SECTION_EVEN_PAGE
* WD_BREAK.SECTION_ODD_PAGE
Specimen XML
------------
.. highlight:: xml
Line break
~~~~~~~~~~
This XML is produced by Word after inserting a line feed with Shift-Enter::
<w:p>
<w:r>
<w:t>Text before</w:t>
</w:r>
<w:r>
<w:br/>
<w:t>and after line break</w:t>
</w:r>
</w:p>
Word loads this more straightforward generation just fine, although it changes
it back on next save. I'm not sure of the advantage in creating a fresh run
such that the ``<w:br/>`` element is the first child::
<w:p>
<w:r>
<w:t>Text before</w:t>
<w:br/>
<w:t>and after line break</w:t>
</w:r>
</w:p>
Page break
~~~~~~~~~~
Starting with this XML ... ::
<w:p>
<w:r>
<w:t>Before inserting a page break, the cursor was here }</w:t>
</w:r>
</w:p>
<w:p>
<w:r>
<w:t>This was the following paragraph, the last in the document</w:t>
</w:r>
</w:p>
... this XML is produced by Word on inserting a hard page::
<w:p>
<w:r>
<w:t>Before inserting a page break, the cursor was here }</w:t>
</w:r>
</w:p>
<w:p>
<w:r>
<w:br w:type="page"/>
</w:r>
</w:p>
<w:p>
<w:bookmarkStart w:id="0" w:name="_GoBack"/>
<w:bookmarkEnd w:id="0"/>
</w:p>
<w:p>
<w:r>
<w:t>This was the following paragraph, the last in the document</w:t>
</w:r>
</w:p>
Word loads the following simplified form fine ... ::
<w:p>
<w:r>
<w:t>Text before an intra-run page break</w:t>
<w:br w:type="page"/>
<w:t>Text after an intra-run page break</w:t>
</w:r>
</w:p>
<w:p>
<w:r>
<w:t>following paragraph</w:t>
</w:r>
</w:p>
... although on saving it converts it to this::
<w:p>
<w:r>
<w:t>Text before an intra-run page break</w:t>
</w:r>
<w:r>
<w:br w:type="page"/>
</w:r>
<w:r>
<w:lastRenderedPageBreak/>
<w:t>Text after an intra-run page break</w:t>
</w:r>
</w:p>
<w:p>
<w:r>
<w:t>following paragraph</w:t>
</w:r>
</w:p>
Schema excerpt
--------------
.. highlight:: xml
::
<xsd:complexType name="CT_R">
<xsd:sequence>
<xsd:group ref="EG_RPr" minOccurs="0"/>
<xsd:group ref="EG_RunInnerContent" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="rsidRPr" type="ST_LongHexNumber"/>
<xsd:attribute name="rsidDel" type="ST_LongHexNumber"/>
<xsd:attribute name="rsidR" type="ST_LongHexNumber"/>
</xsd:complexType>
<xsd:group name="EG_RunInnerContent">
<xsd:choice>
<xsd:element name="br" type="CT_Br"/>
<xsd:element name="t" type="CT_Text"/>
<xsd:element name="contentPart" type="CT_Rel"/>
<xsd:element name="delText" type="CT_Text"/>
<xsd:element name="instrText" type="CT_Text"/>
<xsd:element name="delInstrText" type="CT_Text"/>
<xsd:element name="noBreakHyphen" type="CT_Empty"/>
<xsd:element name="softHyphen" type="CT_Empty"/>
<xsd:element name="dayShort" type="CT_Empty"/>
<xsd:element name="monthShort" type="CT_Empty"/>
<xsd:element name="yearShort" type="CT_Empty"/>
<xsd:element name="dayLong" type="CT_Empty"/>
<xsd:element name="monthLong" type="CT_Empty"/>
<xsd:element name="yearLong" type="CT_Empty"/>
<xsd:element name="annotationRef" type="CT_Empty"/>
<xsd:element name="footnoteRef" type="CT_Empty"/>
<xsd:element name="endnoteRef" type="CT_Empty"/>
<xsd:element name="separator" type="CT_Empty"/>
<xsd:element name="continuationSeparator" type="CT_Empty"/>
<xsd:element name="sym" type="CT_Sym"/>
<xsd:element name="pgNum" type="CT_Empty"/>
<xsd:element name="cr" type="CT_Empty"/>
<xsd:element name="tab" type="CT_Empty"/>
<xsd:element name="object" type="CT_Object"/>
<xsd:element name="pict" type="CT_Picture"/>
<xsd:element name="fldChar" type="CT_FldChar"/>
<xsd:element name="ruby" type="CT_Ruby"/>
<xsd:element name="footnoteReference" type="CT_FtnEdnRef"/>
<xsd:element name="endnoteReference" type="CT_FtnEdnRef"/>
<xsd:element name="commentReference" type="CT_Markup"/>
<xsd:element name="drawing" type="CT_Drawing"/>
<xsd:element name="ptab" type="CT_PTab"/>
<xsd:element name="lastRenderedPageBreak" type="CT_Empty"/>
</xsd:choice>
</xsd:group>
<xsd:complexType name="CT_Br">
<xsd:attribute name="type" type="ST_BrType"/>
<xsd:attribute name="clear" type="ST_BrClear"/>
</xsd:complexType>
<xsd:simpleType name="ST_BrType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="page"/>
<xsd:enumeration value="column"/>
<xsd:enumeration value="textWrapping"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="ST_BrClear">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="none"/>
<xsd:enumeration value="left"/>
<xsd:enumeration value="right"/>
<xsd:enumeration value="all"/>
</xsd:restriction>
</xsd:simpleType>
Resources
---------
* `WdBreakType Enumeration on MSDN`_
* `Range.InsertBreak Method (Word) on MSDN`_
.. _WdBreakType Enumeration on MSDN:
http://msdn.microsoft.com/en-us/library/office/ff195905.aspx
.. _Range.InsertBreak Method (Word) on MSDN:
http://msdn.microsoft.com/en-us/library/office/ff835132.aspx
Relevant sections in the ISO Spec
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* 17.18.3 ST_BrClear (Line Break Text Wrapping Restart Location)
|