rspec/rules/S1778/xml/rule.adoc

42 lines
784 B
Plaintext
Raw Normal View History

2021-04-28 16:49:39 +02:00
The prolog header is the following piece of code that some XML documents start with:
----
<?xml version="y.x" encoding="zzzzz"?>
----
When the prolog exists in an XML document, it should be at the beginning of the file to enable programs to determine the encoding of non-UTF-8, non-UTF-16 files.
2021-04-28 16:49:39 +02:00
== Noncompliant Code Example
2022-02-04 17:28:24 +01:00
[source,xml]
2021-04-28 16:49:39 +02:00
----
<!-- Generated file --> <!-- Noncompliant -->
<?xml version="1.0" encoding="UTF-8"?>
<firstNode>
content
</firstNode>
----
2021-04-28 16:49:39 +02:00
== Compliant Solution
2022-02-04 17:28:24 +01:00
[source,xml]
2021-04-28 16:49:39 +02:00
----
<?xml version="1.0" encoding="UTF-8"?>
<!-- Generated file -->
<firstNode>
content
</firstNode>
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
endif::env-github,rspecator-view[]