Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename p:ixml to p:invisible-xml #627

Merged
merged 1 commit into from
Sep 11, 2024
Merged

Rename p:ixml to p:invisible-xml #627

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions step-ixml/src/main/xml/specification.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ specifications</holder>
</authorgroup>

<abstract>
<para>This specification describes the <code>p:ixml</code>
<para>This specification describes the <code>p:invisible-xml</code>
step for
<citetitle>XProc 3.1: An XML Pipeline Language</citetitle>.</para>
</abstract>
Expand Down Expand Up @@ -62,7 +62,7 @@ step for
<section xml:id="introduction">
<title>Introduction</title>

<para>This specification describes the <code>p:ixml</code> XProc step.
<para>This specification describes the <code>p:invisible-xml</code> XProc step.
A machine-readable description of this step may be found in
<link xlink:href="steps.xpl">steps.xpl</link>.
</para>
Expand All @@ -75,13 +75,13 @@ steps is assumed.</para>
<title>Step library</title>

<section xml:id="c.ixml">
<title>p:ixml</title>
<title>p:invisible-xml</title>

<para>The <tag>p:ixml</tag> step performs Invisible XML processing per
<para>The <tag>p:invisible-xml</tag> step performs Invisible XML processing per
<biblioref linkend="invisible-xml"/>. It transforms a non-XML input into XML by applying
the specified Invisible XML grammar.</para>

<p:declare-step type="p:ixml">
<p:declare-step type="p:invisible-xml">
<p:input port="grammar" sequence="true" content-types="text xml"/>
<p:input port="source" primary="true" content-types="any -xml -html"/>
<p:output port="result" sequence="true" content-types="any"/>
Expand All @@ -104,7 +104,7 @@ from applying to an arbitrary sequence of characters.</para>
<para>The <port>result</port> <rfc2119>should</rfc2119> be XML.
<impl>It is <glossterm>implementation-defined</glossterm> if other result
formats are possible.</impl> (An implementation might, for example, provide a
way for the <tag>p:ixml</tag> step to compile an Invisible XML grammar into some
way for the <tag>p:invisible-xml</tag> step to compile an Invisible XML grammar into some
format that can be processed more efficiently.)</para>

<itemizedlist>
Expand Down Expand Up @@ -272,6 +272,20 @@ select a particular parse:
<para>As before, there is nothing standardized about the results in this case.</para>
</section>
</section>

<section>
<title>Formerly the <code>p:ixml</code> step</title>

<para>In earlier drafts of this specification, the <tag>p:invisible-xml</tag> step
was named <code>p:ixml</code>. Changing the name of the step to <tag>p:invisible-xml</tag>
brings the name into better alignment with the naming conventions used for most other
XProc steps and aligns its name with the <code>fn:invisible-xml()</code> function
in XPath 4.0.</para>

<para>Implementors may wish to support both names for some period of time in order
to avoid breaking changes in existing pipelines. <impl>Support for the alternative name <code>p:ixml</code>
is <glossterm>implementation-defined</glossterm>.</impl></para>
</section>

<simplesect>
<title>Document properties</title>
Expand Down