Skip to content

Commit 33c9bca

Browse files
JessicaJHeedatho7561
authored andcommitted
Update xml.format.joinContentLines settings documentation
Signed-off-by: Jessica He <jhe@redhat.com>
1 parent dfc0562 commit 33c9bca

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

docs/Formatting.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,8 @@ Set to `true` to normalize the whitespace of content inside an element. Newlines
309309

310310
When `xml.format.joinContentLines` is set to `false`, the following edits will be made:
311311

312-
* text following a line separator will be appropriately indented
312+
* text following a line separator will be appropriately indented (not applied to cases where the element is categorized as `mixed content`)
313+
* Please see [xml.format.experimental](#xmlformatexperimental) for more information on mixed content
313314
* spaces between text in the same line will be normalized
314315
* any exisiting new lines will be treated with respect to the [`xml.format.preservedNewlines`](#xmlformatpreservednewlines) setting
315316

@@ -318,29 +319,25 @@ For example, before formatting:
318319
```xml
319320
<?xml version='1.0' encoding='UTF-8'?>
320321
<root>
321-
Interesting text content
322+
<a>
323+
Interesting
322324

323-
<a>
324-
test
325-
326-
</a> values and 1234 numbers
325+
text content
326+
</a> values and
327327

328-
</root>
328+
1234 numbers </root>
329329
```
330330

331331
After formatting with `xml.format.joinContentLines` is set to `false` and `xml.format.preservedNewlines` set to `2`:
332332

333333
```xml
334334
<?xml version='1.0' encoding='UTF-8'?>
335335
<root>
336-
Interesting text content
337-
338336
<a>
339-
test
337+
Interesting
340338

341-
</a> values and 1234 numbers
342-
343-
</root>
339+
text content
340+
</a> values and 1234 numbers </root>
344341
```
345342

346343
To remove all empty new lines, set `xml.format.preservedNewlines` to `0` for the following result:
@@ -350,18 +347,18 @@ After formatting with `xml.format.joinContentLines` is set to `false` and `xml.f
350347
```xml
351348
<?xml version='1.0' encoding='UTF-8'?>
352349
<root>
353-
Interesting text content
354350
<a>
355-
test
356-
</a> values and 1234 numbers
357-
</root>
351+
Interesting
352+
text content
353+
</a> values and 1234 numbers </root>
358354
```
359355

360356
If `xml.format.joinContentLines` is set to `true`, the above document becomes:
361357

362358
```xml
363359
<?xml version='1.0' encoding='UTF-8'?>
364-
<root> Interesting text content <a> test </a> values and 1234 numbers </root>
360+
<root>
361+
<a> Interesting text content </a> values and 1234 numbers </root>
365362
```
366363

367364
* line breaks will be inserted where needed with respect to the [`xml.format.maxLineWidth`](#xmlformatmaxlinewidth) setting

0 commit comments

Comments
 (0)