You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/xproc-pages.html
+11-4Lines changed: 11 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -172,16 +172,23 @@ <h1>Researching XProc</h1>
172
172
specifications</q> (from <aclass="internal"
173
173
href="">XProc.org</a>).</p>
174
174
</details>
175
+
<div>
176
+
<h2>Channels</h2>
177
+
<p>
178
+
<ahref="https://xml.com">XML.com</a> hosts a <ahref="https://www.xml.com/news/2020-04-slack-workspace-for-the-xml-community/">Slack workspace</a> to which XProc practitioners contribute.</p>
<p>Since 2026 an informal XProc Users Group has met from time to time (quarterly) using synchronous video: read the mailing list or watch the Slack channel for invitations.</p>
introductory-level material and many remarks and observations that reward coming
52
-
back to.</p>
53
-
<p>Also available <ahref="https://store.xmlpress.com/product/xproc/">direct from
54
-
the publisher in electronic formats</a> (EPUB, PDF).</p>
55
-
</div>
56
-
<div>
47
+
<div>
48
+
<h2>Channels</h2>
49
+
<p><ahref="https://xml.com">XML.com</a> hosts a <ahref="https://www.xml.com/news/2020-04-slack-workspace-for-the-xml-community/">Slack workspace</a> to which XProc practitioners contribute.</p>
<p>Since 2026 an informal XProc Users Group has met from time to time (quarterly) using synchronous video: read the mailing list or watch the Slack channel for invitations.</p>
Copy file name to clipboardExpand all lines: setup/readme.md
+36-10Lines changed: 36 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,13 @@ Use *both* (or again, PowerXML) if:
54
54
- You wish to be able to rule out processor bugs (by cross-testing) when diagnosing deep problems
55
55
- You are building an XProc engine and wish to compare against other implementations known to be conformant
56
56
57
-
Finally, being able to call on expert assistance from someone who knows is a good reason to use either processor.
57
+
Both processors (and PowerXML) are actively supported by their developers as well as the broader XProc user community, so help is always available. One approach is to identify your support lines first, then follow their leads and recommendations.
58
+
59
+
### Xproc Support
60
+
61
+
Some XProc support channels are described on the [XProc Zone portal](xproc-pages.html) web site.
62
+
63
+
58
64
59
65
### Why so many options?
60
66
@@ -74,23 +80,23 @@ The same set of SMOKETEST pipelines will work for all processors. Run them using
74
80
75
81
### Using the scripts, check your paths
76
82
77
-
The scripts [xz.sh](xz.sh) and [xz.bat](xz.bat) call scripts in the Morgana distribution. If the path to Morgana changes, or the path to the Morgana configuration file, these scripts must be updated to work.
83
+
The scripts [xz.sh](../xz.sh) and [xz.bat](../xz.bat) call scripts in the Morgana distribution. If the path to Morgana changes, or the path to the Morgana configuration file, these scripts must be updated to work.
78
84
79
-
Same for the scripts [xc.bat](xc.bat) and [xc.ps1](xc.ps1) calling XML Calabash.
85
+
Same for the scripts [xc.bat](../xc.bat) and [xc.ps1](../xc.ps1) calling XML Calabash.
80
86
81
87
Scripts in other shells or with other usage should be straightforward to contrive based on these examples.
82
88
83
89
### Run the smoke tests
84
90
85
91
Because it reduces to (nearly) the most minimal use of XProc, if the [smoke test](./smoketest/TEST-XPROC3.xpl) application doesn't work, nothing can be expected to work.
86
92
87
-
Likewise, tests are provided that can show that XSLT and Schematron capabilities are correctly provided for (by the Saxon and SchXSLT libraries). See [TESTING.md](TESTING.md) for more information.
93
+
Likewise, tests are provided that can show that XSLT and Schematron capabilities are correctly provided for (by the Saxon and SchXSLT libraries).
Note that since Schematron and XSpec depend on XSLT and hence invoke Saxon, the Saxon-only smoketest can often be skipped.
99
+
This folder also provides other tests as requirements are addressed over time.
94
100
95
101
### Smoke tests work, but a pipeline does not?
96
102
@@ -100,7 +106,7 @@ XProc being XML-centric, you will typically see information about errors and war
100
106
101
107
Any problems with any pipelines on this site (or any pipelines not otherwise called out in documentation or comments) can be [reported](https://github.com/wendellpiez/xproc-zone/issues). Of course, if your aim is to learn XProc and related tech, we also hope you are looking at useful error messages very soon - signposts on your journey.
102
108
103
-
## How to run XProc (more detail)
109
+
## Using a script to invoke XProc (more detail)
104
110
105
111
At the repository root, four scripts are offered, all of which do the same thing - invoke an XProc engine to execute an XProc pipeline. Use the one that works best on your system.
106
112
@@ -111,19 +117,39 @@ At the repository root, four scripts are offered, all of which do the same thing
111
117
112
118
A bash shell script for XML Calabash or a Powershell script for Morgana can be contrived from these as well.
113
119
114
-
As described above, there are many other ways ...
120
+
For example, in Windows, from the `setup` directory:
121
+
122
+
```
123
+
> ..\xc.bat PROCESSOR-REPORT.xpl
124
+
```
125
+
126
+
On a different platform using a different script, adjust the syntax accordingly:
127
+
128
+
```
129
+
$ ../xc.sh PROCESSOR-REPORT.xpl
130
+
```
131
+
132
+
If you need to provide a script with arguments, use the same syntax as you would using the engine directly. For example, to provide an value to XML Calabash for an option `exclamation` offered by the pipeline `ECHO-OPTION.xpl`:
This test pipeline returns a bit of XML: `<ECHO>Away!</ECHO>`.
115
139
116
140
### Hints and tips
117
141
118
142
If you plan to run XProc from a command line, consider putting the repository path on your system PATH for greater convenience, making the repository scripts (or your versions of them) available across your system.
119
143
120
-
On a Windows system it is also possible to associate an entire file type (such as `*.xpl`) with a a `bat` file executable - offering a convenient way to run standalone XProc pipelines requiring no special runtime settings, with the **Open** choice on the context menu (right click on file) in Explorer. The same, or the equivalent, is possible in other operating system shells.
144
+
On a Windows system it is also possible to associate an entire file type (such as `*.xpl`) with a `bat` file executable - offering a convenient way to run standalone XProc pipelines requiring no special runtime settings, with the **Open** choice on the context menu (right click on file) in Explorer. The same, or the equivalent, is possible in other operating system shells.
121
145
122
146
### No network
123
147
124
-
Once downloaded, installed and running, nothing in this stack should require an Internet connection to work.
148
+
Once downloaded and installed, nothing in this stack should depend on or require an Internet connection to run.
149
+
150
+
Note that this does not mean that a processor might not attempt to connect without your knowledge, as directed by a pipeline. A (painful) example: a processor unequipped with a cache may download a copy of the W3C SVG 1.0 DTD every time an SVG is processed with a prescribed `DOCTYPE`. (Solution: do without the `DOCTYPE` declaration.)
125
151
126
-
Note that this does not mean that a processor might not attempt to connect without your knowledge, such as (painful example) to download a copy of the W3C SVG 1.0 DTD every time an SVG is called with a prescribed `DOCTYPE`. (Solution: do without the DTD.) Keep an eye on your data and processes since this is where such dependencies are often hidden. The typical symptom of this problem is that your XProc engine hangs up or pauses longer than it should.
152
+
Keep an eye on your data and processes since this is where such dependencies are often hidden. The typical symptom of this problem is that your XProc engine hangs up or pauses longer than it should.
0 commit comments