XProc 3.1: text steps

Draft Community Group Report

Editor's Draft at (build 71)
Latest editor’s draft:
https://spec.xproc.org/master/head/text/
Editors:
Norman Walsh
Achim Berndzen
Gerrit Imsieke
Erik Siegel
Participate:
GitHub xproc/3.0-steps
Report an issue
Changes:
Diff against current “status quo” draft
Commits for this specification

This document is also available in these non-normative formats: XML and HTML with automatic change markup courtesy of DeltaXML.

Copyright © 2018, 2019, 2020 the Contributors to the XProc 3.1: text steps specification, published by the XProc Next Community Group under the W3C Community Contributor License Agreement (CLA). A human-readable summary is available.

Abstract

This specification describes the optional text related steps for XProc 3.1: An XML Pipeline Language.

Status of this Document

This document is an editor's draft that has no official standing.

This specification was published by the XProc Next Community Group. It is not a W3C Standard nor is it on the W3C Standards Track. Please note that under the W3C Community Contributor License Agreement (CLA) there is a limited opt-out and other conditions apply. Learn more about W3C Community and Business Groups.

If you wish to make comments regarding this document, please send them to xproc-dev@w3.org. (subscribe, archives).

Note

This draft is the “editor’s working draft” and may continue to evolve.

1. Introduction

This specification describes the optional text related XProc steps. A machine-readable description of these steps may be found in steps.xpl.

Familarity with the general nature of [XProc 3.1] steps is assumed.

2. Step library

2.1. p:markdown-to-html

The p:markdown-to-html step converts a text document in Markdown to XHTML.

Summary

Input portPrimarySequenceContent types
source✔  text 
Output portPrimarySequenceContent types
result✔  html 
Option nameTypeDefault value
parametersmap(xs:QName, item()*)?()
Implementation details
ImplementationDescription
DefinedThe flavor(s) of Markdown supported and the parameters allowed are implementation-defined.
Declaration

<p:declare-step type="p:markdown-to-html">
     <p:input port="source" primary="true" content-types="text"/>
     <p:output port="result" primary="true" content-types="html"/>
     <p:option name="parameters" as="map(xs:QName, item()*)?"/>    
</p:declare-step>

The p:markdown-to-html step transforms a text document containing Markdown, for example [CommonMark], into HTML. The flavor(s) of Markdown supported and the parameters allowed are implementation-defined.

Document properties

No document properties are preserved.

A. Conformance

Conformant processors must implement all of the features described in this specification except those that are explicitly identified as optional.

Some aspects of processor behavior are not completely specified; those features are either implementation-dependent or implementation-defined.

[Definition: An implementation-dependent feature is one where the implementation has discretion in how it is performed. Implementations are not required to document or explain how implementation-dependent features are performed.]

[Definition: An implementation-defined feature is one where the implementation has discretion in how it is performed. Conformant implementations must document how implementation-defined features are performed.]

A.1. Implementation-defined features

The following features are implementation-defined:

  1. The flavor(s) of Markdown supported and the parameters allowed are implementation-defined. See Section 2.1, “p:markdown-to-html”.

B. References

[CommonMark] CommonMark Spec. John MacFarlane. 6 April 2019.

[XProc 3.1] XProc 3.1: An XML Pipeline Language. Norman Walsh, Achim Berndzen, Gerrit Imsieke and Erik Siegel, editors.

C. Glossary

implementation-defined

An implementation-defined feature is one where the implementation has discretion in how it is performed. Conformant implementations must document how implementation-defined features are performed.

implementation-dependent

An implementation-dependent feature is one where the implementation has discretion in how it is performed. Implementations are not required to document or explain how implementation-dependent features are performed.

D. Ancillary files

This specification includes by reference a number of ancillary files.

steps.xpl

An XProc step library for the declared steps.